Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions docs/messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -243,3 +243,32 @@ already allows construction from mapping types.
song_dict = Song.to_dict(song)

new_song = Song(song_dict)

.. note::

Protobuf messages **CANNOT** be safely pickled or unpickled. This has serious consequences for programs that use multiprocessing or write messages to files.
The preferred mechanism for serializing proto messages is :meth:`~.Message.serialize`.

Multiprocessing example:

.. code-block:: python

import proto
from multiprocessing import Pool

class Composer(proto.Message):
name = proto.Field(proto.STRING, number=1)
genre = proto.Field(proto.STRING, number=2)

composers = [Composer(name=n) for n in ["Bach", "Mozart", "Brahms", "Strauss"]]

with multiprocessing.Pool(2) as p:
def add_genre(comp_bytes):
composer = Composer.deserialize(comp_bytes)
composer.genre = "classical"
return Composer.serialize(composer)

updated_composers = [
Composer.deserialize(comp_bytes)
for comp_bytes in p.map(add_genre, (Composer.serialize(comp) for comp in composers))
]
2 changes: 1 addition & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def unitcpp(session):
return unit(session, proto="cpp")


@nox.session(python="3.7")
@nox.session(python="3.9")
def docs(session):
"""Build the docs."""

Expand Down