File size: 13,294 Bytes
d1ceb73 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 |
"""Pickle related utilities. Perhaps this should be called 'can'."""
# Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
import copy
import pickle
import sys
import typing
import warnings
from types import FunctionType
# This registers a hook when it's imported
try:
from ipyparallel.serialize import codeutil # noqa: F401
except ImportError:
pass
from traitlets.log import get_logger
from traitlets.utils.importstring import import_item
warnings.warn(
"ipykernel.pickleutil is deprecated. It has moved to ipyparallel.",
DeprecationWarning,
stacklevel=2,
)
buffer = memoryview
class_type = type
PICKLE_PROTOCOL = pickle.DEFAULT_PROTOCOL
def _get_cell_type(a=None):
"""the type of a closure cell doesn't seem to be importable,
so just create one
"""
def inner():
return a
return type(inner.__closure__[0]) # type:ignore[index]
cell_type = _get_cell_type()
# -------------------------------------------------------------------------------
# Functions
# -------------------------------------------------------------------------------
def interactive(f):
"""decorator for making functions appear as interactively defined.
This results in the function being linked to the user_ns as globals()
instead of the module globals().
"""
# build new FunctionType, so it can have the right globals
# interactive functions never have closures, that's kind of the point
if isinstance(f, FunctionType):
mainmod = __import__("__main__")
f = FunctionType(
f.__code__,
mainmod.__dict__,
f.__name__,
f.__defaults__,
)
# associate with __main__ for uncanning
f.__module__ = "__main__"
return f
def use_dill():
"""use dill to expand serialization support
adds support for object methods and closures to serialization.
"""
# import dill causes most of the magic
import dill
# dill doesn't work with cPickle,
# tell the two relevant modules to use plain pickle
global pickle # noqa: PLW0603
pickle = dill
try:
from ipykernel import serialize
except ImportError:
pass
else:
serialize.pickle = dill # type:ignore[attr-defined]
# disable special function handling, let dill take care of it
can_map.pop(FunctionType, None)
def use_cloudpickle():
"""use cloudpickle to expand serialization support
adds support for object methods and closures to serialization.
"""
import cloudpickle
global pickle # noqa: PLW0603
pickle = cloudpickle
try:
from ipykernel import serialize
except ImportError:
pass
else:
serialize.pickle = cloudpickle # type:ignore[attr-defined]
# disable special function handling, let cloudpickle take care of it
can_map.pop(FunctionType, None)
# -------------------------------------------------------------------------------
# Classes
# -------------------------------------------------------------------------------
class CannedObject:
"""A canned object."""
def __init__(self, obj, keys=None, hook=None):
"""can an object for safe pickling
Parameters
----------
obj
The object to be canned
keys : list (optional)
list of attribute names that will be explicitly canned / uncanned
hook : callable (optional)
An optional extra callable,
which can do additional processing of the uncanned object.
Notes
-----
large data may be offloaded into the buffers list,
used for zero-copy transfers.
"""
self.keys = keys or []
self.obj = copy.copy(obj)
self.hook = can(hook)
for key in keys:
setattr(self.obj, key, can(getattr(obj, key)))
self.buffers = []
def get_object(self, g=None):
"""Get an object."""
if g is None:
g = {}
obj = self.obj
for key in self.keys:
setattr(obj, key, uncan(getattr(obj, key), g))
if self.hook:
self.hook = uncan(self.hook, g)
self.hook(obj, g)
return self.obj
class Reference(CannedObject):
"""object for wrapping a remote reference by name."""
def __init__(self, name):
"""Initialize the reference."""
if not isinstance(name, str):
raise TypeError("illegal name: %r" % name)
self.name = name
self.buffers = []
def __repr__(self):
"""Get the string repr of the reference."""
return "<Reference: %r>" % self.name
def get_object(self, g=None):
"""Get an object in the reference."""
if g is None:
g = {}
return eval(self.name, g)
class CannedCell(CannedObject):
"""Can a closure cell"""
def __init__(self, cell):
"""Initialize the canned cell."""
self.cell_contents = can(cell.cell_contents)
def get_object(self, g=None):
"""Get an object in the cell."""
cell_contents = uncan(self.cell_contents, g)
def inner():
"""Inner function."""
return cell_contents
return inner.__closure__[0] # type:ignore[index]
class CannedFunction(CannedObject):
"""Can a function."""
def __init__(self, f):
"""Initialize the can"""
self._check_type(f)
self.code = f.__code__
self.defaults: typing.Optional[typing.List[typing.Any]]
if f.__defaults__:
self.defaults = [can(fd) for fd in f.__defaults__]
else:
self.defaults = None
self.closure: typing.Any
closure = f.__closure__
if closure:
self.closure = tuple(can(cell) for cell in closure)
else:
self.closure = None
self.module = f.__module__ or "__main__"
self.__name__ = f.__name__
self.buffers = []
def _check_type(self, obj):
assert isinstance(obj, FunctionType), "Not a function type"
def get_object(self, g=None):
"""Get an object out of the can."""
# try to load function back into its module:
if not self.module.startswith("__"):
__import__(self.module)
g = sys.modules[self.module].__dict__
if g is None:
g = {}
defaults = tuple(uncan(cfd, g) for cfd in self.defaults) if self.defaults else None
closure = tuple(uncan(cell, g) for cell in self.closure) if self.closure else None
return FunctionType(self.code, g, self.__name__, defaults, closure)
class CannedClass(CannedObject):
"""A canned class object."""
def __init__(self, cls):
"""Initialize the can."""
self._check_type(cls)
self.name = cls.__name__
self.old_style = not isinstance(cls, type)
self._canned_dict = {}
for k, v in cls.__dict__.items():
if k not in ("__weakref__", "__dict__"):
self._canned_dict[k] = can(v)
mro = [] if self.old_style else cls.mro()
self.parents = [can(c) for c in mro[1:]]
self.buffers = []
def _check_type(self, obj):
assert isinstance(obj, class_type), "Not a class type"
def get_object(self, g=None):
"""Get an object from the can."""
parents = tuple(uncan(p, g) for p in self.parents)
return type(self.name, parents, uncan_dict(self._canned_dict, g=g))
class CannedArray(CannedObject):
"""A canned numpy array."""
def __init__(self, obj):
"""Initialize the can."""
from numpy import ascontiguousarray
self.shape = obj.shape
self.dtype = obj.dtype.descr if obj.dtype.fields else obj.dtype.str
self.pickled = False
if sum(obj.shape) == 0:
self.pickled = True
elif obj.dtype == "O":
# can't handle object dtype with buffer approach
self.pickled = True
elif obj.dtype.fields and any(dt == "O" for dt, sz in obj.dtype.fields.values()):
self.pickled = True
if self.pickled:
# just pickle it
self.buffers = [pickle.dumps(obj, PICKLE_PROTOCOL)]
else:
# ensure contiguous
obj = ascontiguousarray(obj, dtype=None)
self.buffers = [buffer(obj)]
def get_object(self, g=None):
"""Get the object."""
from numpy import frombuffer
data = self.buffers[0]
if self.pickled:
# we just pickled it
return pickle.loads(data)
return frombuffer(data, dtype=self.dtype).reshape(self.shape)
class CannedBytes(CannedObject):
"""A canned bytes object."""
@staticmethod
def wrap(buf: typing.Union[memoryview, bytes, typing.SupportsBytes]) -> bytes:
"""Cast a buffer or memoryview object to bytes"""
if isinstance(buf, memoryview):
return buf.tobytes()
if not isinstance(buf, bytes):
return bytes(buf)
return buf
def __init__(self, obj):
"""Initialize the can."""
self.buffers = [obj]
def get_object(self, g=None):
"""Get the canned object."""
data = self.buffers[0]
return self.wrap(data)
class CannedBuffer(CannedBytes):
"""A canned buffer."""
wrap = buffer # type:ignore[assignment]
class CannedMemoryView(CannedBytes):
"""A canned memory view."""
wrap = memoryview # type:ignore[assignment]
# -------------------------------------------------------------------------------
# Functions
# -------------------------------------------------------------------------------
def _import_mapping(mapping, original=None):
"""import any string-keys in a type mapping"""
log = get_logger()
log.debug("Importing canning map")
for key, _ in list(mapping.items()):
if isinstance(key, str):
try:
cls = import_item(key)
except Exception:
if original and key not in original:
# only message on user-added classes
log.error("canning class not importable: %r", key, exc_info=True) # noqa: G201
mapping.pop(key)
else:
mapping[cls] = mapping.pop(key)
def istype(obj, check):
"""like isinstance(obj, check), but strict
This won't catch subclasses.
"""
if isinstance(check, tuple):
return any(type(obj) is cls for cls in check)
return type(obj) is check
def can(obj):
"""prepare an object for pickling"""
import_needed = False
for cls, canner in can_map.items():
if isinstance(cls, str):
import_needed = True
break
if istype(obj, cls):
return canner(obj)
if import_needed:
# perform can_map imports, then try again
# this will usually only happen once
_import_mapping(can_map, _original_can_map)
return can(obj)
return obj
def can_class(obj):
"""Can a class object."""
if isinstance(obj, class_type) and obj.__module__ == "__main__":
return CannedClass(obj)
return obj
def can_dict(obj):
"""can the *values* of a dict"""
if istype(obj, dict):
newobj = {}
for k, v in obj.items():
newobj[k] = can(v)
return newobj
return obj
sequence_types = (list, tuple, set)
def can_sequence(obj):
"""can the elements of a sequence"""
if istype(obj, sequence_types):
t = type(obj)
return t([can(i) for i in obj])
return obj
def uncan(obj, g=None):
"""invert canning"""
import_needed = False
for cls, uncanner in uncan_map.items():
if isinstance(cls, str):
import_needed = True
break
if isinstance(obj, cls):
return uncanner(obj, g)
if import_needed:
# perform uncan_map imports, then try again
# this will usually only happen once
_import_mapping(uncan_map, _original_uncan_map)
return uncan(obj, g)
return obj
def uncan_dict(obj, g=None):
"""Uncan a dict object."""
if istype(obj, dict):
newobj = {}
for k, v in obj.items():
newobj[k] = uncan(v, g)
return newobj
return obj
def uncan_sequence(obj, g=None):
"""Uncan a sequence."""
if istype(obj, sequence_types):
t = type(obj)
return t([uncan(i, g) for i in obj])
return obj
# -------------------------------------------------------------------------------
# API dictionaries
# -------------------------------------------------------------------------------
# These dicts can be extended for custom serialization of new objects
can_map = {
"numpy.ndarray": CannedArray,
FunctionType: CannedFunction,
bytes: CannedBytes,
memoryview: CannedMemoryView,
cell_type: CannedCell,
class_type: can_class,
}
if buffer is not memoryview:
can_map[buffer] = CannedBuffer
uncan_map: typing.Dict[type, typing.Any] = {
CannedObject: lambda obj, g: obj.get_object(g),
dict: uncan_dict,
}
# for use in _import_mapping:
_original_can_map = can_map.copy()
_original_uncan_map = uncan_map.copy()
|