From 8fc0f3f1f1a82f7c88a4606bc5c36856eee65d39 Mon Sep 17 00:00:00 2001 From: dhirschf Date: Fri, 13 Jul 2018 12:25:29 +1000 Subject: [PATCH] Use type hints to further emphasize the custom serialization api --- distributed/protocol/serialize.py | 4 ++-- docs/source/serialization.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/distributed/protocol/serialize.py b/distributed/protocol/serialize.py index c2a1274afe2..cb3b802c504 100644 --- a/distributed/protocol/serialize.py +++ b/distributed/protocol/serialize.py @@ -380,8 +380,8 @@ def register_serialization(cls, serialize, deserialize): Parameters ---------- cls: type - serialize: function - deserialize: function + serialize: callable(cls) -> Tuple[Dict, List[bytes]] + deserialize: callable(header: Dict, frames: List[bytes]) -> cls Examples -------- diff --git a/docs/source/serialization.rst b/docs/source/serialization.rst index e457681a662..cdb765c380a 100644 --- a/docs/source/serialization.rst +++ b/docs/source/serialization.rst @@ -150,12 +150,12 @@ register them with Dask. def __init__(self, name): self.name = name - def serialize(human): + def serialize(human: Human) -> Tuple[Dict, List[bytes]]: header = {} frames = [human.name.encode()] return header, frames - def deserialize(header, frames): + def deserialize(header: Dict, frames: List[bytes]) -> Human: return Human(frames[0].decode()) from distributed.protocol.serialize import register_serialization