[docs] [issue28973] The fact that multiprocess.Queue uses serialization should be documented.

Davin Potts report at bugs.python.org
Wed Dec 14 11:33:49 EST 2016

Davin Potts added the comment:

All communication between processes in multiprocessing has consistently used pickle to serialize the data being communicated (this includes what is described in the "Shared memory" section of the docs).  The documentation has not done a great job of making this clear, instead only describing the requirement that data be pickleable in select places.  For example, in the section on Queues:
    Note: When an object is put on a queue, the object is pickled and a
    background thread later flushes the pickled data to an underlying pipe.

Though it only applies to 3.6+, issue28053 still needs its own documentation improvement to make clear that the mechanism for communicating data defaults to serialization by pickle but that this can be replaced by alternatives.

I agree that the documentation around the use of pickle in multiprocessing deserves improvement.

nosy: +davin
stage:  -> needs patch
type: behavior -> enhancement
versions: +Python 3.6, Python 3.7

Python tracker <report at bugs.python.org>

More information about the docs mailing list