Skip to content

Use type hints to further emphasize the custom serialization api #2116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrocklin merged 1 commit into from
Jul 13, 2018
Merged

Use type hints to further emphasize the custom serialization api #2116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions distributed/protocol/serialize.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down
4 changes: 2 additions & 2 deletions docs/source/serialization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down