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
|
from array import array
import copy
import pickle
import msgpack
import numpy as np
import pytest
from tlz import identity
from dask.utils_test import inc
from distributed import wait
from distributed.protocol import (
register_serialization,
serialize,
deserialize,
nested_deserialize,
Serialize,
Serialized,
to_serialize,
serialize_bytes,
deserialize_bytes,
serialize_bytelist,
register_serialization_family,
dask_serialize,
dumps,
loads,
)
from distributed.protocol.serialize import check_dask_serializable
from distributed.utils import nbytes
from distributed.utils_test import inc, gen_test
from distributed.comm.utils import to_frames, from_frames
class MyObj:
def __init__(self, data):
self.data = data
def __getstate__(self):
raise Exception("Not picklable")
def serialize_myobj(x):
return {}, [pickle.dumps(x.data)]
def deserialize_myobj(header, frames):
return MyObj(pickle.loads(frames[0]))
register_serialization(MyObj, serialize_myobj, deserialize_myobj)
def test_dumps_serialize():
for x in [123, [1, 2, 3, 4, 5, 6]]:
header, frames = serialize(x)
assert header["serializer"] == "pickle"
assert len(frames) == 1
result = deserialize(header, frames)
assert result == x
x = MyObj(123)
header, frames = serialize(x)
assert header["type"]
assert len(frames) == 1
result = deserialize(header, frames)
assert result.data == x.data
def test_serialize_bytestrings():
for b in (b"123", bytearray(b"4567")):
header, frames = serialize(b)
assert frames[0] is b
bb = deserialize(header, frames)
assert type(bb) == type(b)
assert bb == b
bb = deserialize(header, list(map(memoryview, frames)))
assert type(bb) == type(b)
assert bb == b
bb = deserialize(header, [b"", *frames])
assert type(bb) == type(b)
assert bb == b
@pytest.mark.parametrize(
"typecode", ["b", "B", "h", "H", "i", "I", "l", "L", "q", "Q", "f", "d"]
)
def test_serialize_arrays(typecode):
a = array(typecode)
a.extend(range(5))
header, frames = serialize(a)
assert frames[0] == memoryview(a)
a2 = deserialize(header, frames)
assert type(a2) == type(a)
assert a2.typecode == a.typecode
assert a2 == a
def test_Serialize():
s = Serialize(123)
assert "123" in str(s)
assert s.data == 123
t = Serialize((1, 2))
assert str(t)
u = Serialize(123)
assert s == u
assert not (s != u)
assert s != t
assert not (s == t)
assert hash(s) == hash(u)
assert hash(s) != hash(t) # most probably
def test_Serialized():
s = Serialized(*serialize(123))
t = Serialized(*serialize((1, 2)))
u = Serialized(*serialize(123))
assert s == u
assert not (s != u)
assert s != t
assert not (s == t)
def test_nested_deserialize():
x = {
"op": "update",
"x": [to_serialize(123), to_serialize(456), 789],
"y": {"a": ["abc", Serialized(*serialize("def"))], "b": b"ghi"},
}
x_orig = copy.deepcopy(x)
assert nested_deserialize(x) == {
"op": "update",
"x": [123, 456, 789],
"y": {"a": ["abc", "def"], "b": b"ghi"},
}
assert x == x_orig # x wasn't mutated
from distributed.utils_test import gen_cluster
from dask import delayed
@gen_cluster(client=True)
async def test_object_in_graph(c, s, a, b):
o = MyObj(123)
v = delayed(o)
v2 = delayed(identity)(v)
future = c.compute(v2)
result = await future
assert isinstance(result, MyObj)
assert result.data == 123
@gen_cluster(client=True)
async def test_scatter(c, s, a, b):
o = MyObj(123)
[future] = await c._scatter([o])
await c._replicate(o)
o2 = await c._gather(future)
assert isinstance(o2, MyObj)
assert o2.data == 123
@gen_cluster(client=True)
async def test_inter_worker_comms(c, s, a, b):
o = MyObj(123)
[future] = await c._scatter([o], workers=a.address)
future2 = c.submit(identity, future, workers=b.address)
o2 = await c._gather(future2)
assert isinstance(o2, MyObj)
assert o2.data == 123
class Empty:
def __getstate__(self):
raise Exception("Not picklable")
def serialize_empty(x):
return {}, []
def deserialize_empty(header, frames):
return Empty()
register_serialization(Empty, serialize_empty, deserialize_empty)
def test_empty():
e = Empty()
e2 = deserialize(*serialize(e))
assert isinstance(e2, Empty)
def test_empty_loads():
e = Empty()
e2 = loads(dumps([to_serialize(e)]))
assert isinstance(e2[0], Empty)
def test_empty_loads_deep():
e = Empty()
e2 = loads(dumps([[[to_serialize(e)]]]))
assert isinstance(e2[0][0][0], Empty)
@pytest.mark.parametrize("kwargs", [{}, {"serializers": ["pickle"]}])
def test_serialize_bytes(kwargs):
for x in [
1,
"abc",
np.arange(5),
b"ab" * int(40e6),
int(2 ** 26) * b"ab",
(int(2 ** 25) * b"ab", int(2 ** 25) * b"ab"),
]:
b = serialize_bytes(x, **kwargs)
assert isinstance(b, bytes)
y = deserialize_bytes(b)
assert str(x) == str(y)
def test_serialize_list_compress():
pytest.importorskip("lz4")
x = np.ones(1000000)
L = serialize_bytelist(x)
assert sum(map(nbytes, L)) < x.nbytes / 2
b = b"".join(L)
y = deserialize_bytes(b)
assert (x == y).all()
def test_malicious_exception():
class BadException(Exception):
def __setstate__(self):
return Exception("Sneaky deserialization code")
class MyClass:
def __getstate__(self):
raise BadException()
obj = MyClass()
header, frames = serialize(obj, serializers=[])
with pytest.raises(Exception) as info:
deserialize(header, frames)
assert "Sneaky" not in str(info.value)
assert "MyClass" in str(info.value)
header, frames = serialize(obj, serializers=["pickle"])
with pytest.raises(Exception) as info:
deserialize(header, frames)
assert "Sneaky" not in str(info.value)
assert "BadException" in str(info.value)
def test_errors():
msg = {"data": {"foo": to_serialize(inc)}, "a": 1, "b": 2, "c": 3, "d": 4, "e": 5}
header, frames = serialize(msg, serializers=["msgpack", "pickle"])
assert header["serializer"] == "pickle"
header, frames = serialize(msg, serializers=["msgpack"])
assert header["serializer"] == "error"
with pytest.raises(TypeError):
serialize(msg, serializers=["msgpack"], on_error="raise")
@gen_test()
async def test_err_on_bad_deserializer():
frames = await to_frames({"x": to_serialize(1234)}, serializers=["pickle"])
result = await from_frames(frames, deserializers=["pickle", "foo"])
assert result == {"x": 1234}
with pytest.raises(TypeError):
await from_frames(frames, deserializers=["msgpack"])
class MyObject:
def __init__(self, **kwargs):
self.__dict__.update(kwargs)
def my_dumps(obj, context=None):
if type(obj).__name__ == "MyObject":
header = {"serializer": "my-ser"}
frames = [
msgpack.dumps(obj.__dict__, use_bin_type=True),
msgpack.dumps(context, use_bin_type=True),
]
return header, frames
else:
raise NotImplementedError()
def my_loads(header, frames):
obj = MyObject(**msgpack.loads(frames[0], raw=False))
# to provide something to test against, lets just attach the context to
# the object itself
obj.context = msgpack.loads(frames[1], raw=False)
return obj
@gen_cluster(
client=True,
client_kwargs={"serializers": ["my-ser", "pickle"]},
worker_kwargs={"serializers": ["my-ser", "pickle"]},
)
async def test_context_specific_serialization(c, s, a, b):
register_serialization_family("my-ser", my_dumps, my_loads)
try:
# Create the object on A, force communication to B
x = c.submit(MyObject, x=1, y=2, workers=a.address)
y = c.submit(lambda x: x, x, workers=b.address)
await wait(y)
key = y.key
def check(dask_worker):
# Get the context from the object stored on B
my_obj = dask_worker.data[key]
return my_obj.context
result = await c.run(check, workers=[b.address])
expected = {"sender": a.address, "recipient": b.address}
assert result[b.address]["sender"]["address"] == a.address # see origin worker
z = await y # bring object to local process
assert z.x == 1 and z.y == 2
assert z.context["sender"]["address"] == b.address
finally:
from distributed.protocol.serialize import families
del families["my-ser"]
@gen_cluster(client=True)
async def test_context_specific_serialization_class(c, s, a, b):
register_serialization(MyObject, my_dumps, my_loads)
# Create the object on A, force communication to B
x = c.submit(MyObject, x=1, y=2, workers=a.address)
y = c.submit(lambda x: x, x, workers=b.address)
await wait(y)
key = y.key
def check(dask_worker):
# Get the context from the object stored on B
my_obj = dask_worker.data[key]
return my_obj.context
result = await c.run(check, workers=[b.address])
assert result[b.address]["sender"]["address"] == a.address # see origin worker
z = await y # bring object to local process
assert z.x == 1 and z.y == 2
assert z.context["sender"]["address"] == b.address
def test_serialize_raises():
class Foo:
pass
@dask_serialize.register(Foo)
def dumps(f):
raise Exception("Hello-123")
with pytest.raises(Exception) as info:
deserialize(*serialize(Foo()))
assert "Hello-123" in str(info.value)
@pytest.mark.asyncio
async def test_profile_nested_sizeof():
# https://github.com/dask/distributed/issues/1674
n = 500
original = outer = {}
inner = {}
for i in range(n):
outer["children"] = inner
outer, inner = inner, {}
msg = {"data": original}
frames = await to_frames(msg)
def test_compression_numpy_list():
class MyObj:
pass
@dask_serialize.register(MyObj)
def _(x):
header = {"compression": [False]}
frames = [b""]
return header, frames
header, frames = serialize([MyObj(), MyObj()])
assert header["compression"] == [False, False]
@pytest.mark.parametrize(
"data,is_serializable",
[
([], False),
({}, False),
({i: i for i in range(10)}, False),
(set(range(10)), False),
(tuple(range(100)), False),
({"x": MyObj(5)}, True),
({"x": {"y": MyObj(5)}}, True),
pytest.param(
[1, MyObj(5)],
True,
marks=pytest.mark.xfail(reason="Only checks 0th element for now."),
),
([MyObj([0, 1, 2]), 1], True),
(tuple([MyObj(None)]), True),
({("x", i): MyObj(5) for i in range(100)}, True),
(memoryview(b"hello"), True),
(memoryview(np.random.random((3, 4))), True),
],
)
def test_check_dask_serializable(data, is_serializable):
result = check_dask_serializable(data)
expected = is_serializable
assert result == expected
@pytest.mark.parametrize(
"serializers",
[["msgpack"], ["pickle"], ["msgpack", "pickle"], ["pickle", "msgpack"]],
)
def test_serialize_lists(serializers):
data_in = ["a", 2, "c", None, "e", 6]
header, frames = serialize(data_in, serializers=serializers)
data_out = deserialize(header, frames)
assert data_in == data_out
@pytest.mark.parametrize(
"data_in", [memoryview(b"hello"), memoryview(np.random.random((3, 4)))]
)
def test_deser_memoryview(data_in):
header, frames = serialize(data_in)
assert header["type"] == "builtins.memoryview"
assert frames[0] is data_in
data_out = deserialize(header, frames)
assert data_in == data_out
def test_ser_memoryview_object():
data_in = memoryview(np.array(["hello"], dtype=object))
with pytest.raises(TypeError):
serialize(data_in, on_error="raise")
|