Fix obscure pickling bug affecting Python 3.11 #2426
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This primarily affected multiprocessing in dials.integrate on Windows using Python 3.11.
The Executor base class is defined in C++ with
.enable_pickling
to enable lightweight pickle support. This is then subclassed e.g. for the IntegratorExecutor class, where a__getinitargs__()
method is defined to provide support for pickling. For Python <= 3.10 this works just fine. However, bpo-26579 adds a defaultobject.__getstate__()
method in Python 3.11 which then triggers theIncomplete pickle support (__getstate_manages_dict__ not set)
error message in Boost.Python. Adding__getstate_manages_dict__ = 1
to these subclasses appears to workaround the problem.For example, the code
print(f"{executor.__getstate__=}")
on python 3.11 gives:while on python 3.10 raises an
AttributeError
: