fix: Prevent PendingObject from pickling ObjDomain reference#61
Merged
Conversation
Storing ObjDomain directly in the PendingObject dataclass causes pickle failures during doctree serialization because the domain contains unpicklable local functions (XRefRole closures in _role_cache). Store the domain name (str) instead of the domain instance, and look up the domain at resolve time via env.get_domain(). This depends on sphinx-notes/render#14 which adds the env parameter to UnresolvedContext.resolve(). Co-Authored-By: DeepSeek V4 Pro <service@deepseek.com>
SilverRainZ
force-pushed
the
fix/unpicklable-pending-object
branch
from
76554f1 to
94f8191
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
PendingObject.domainfromObjDomaintodomain: strenv.get_domain()inresolve()to look up the domain at runtimeRoot Cause
PendingObject(anUnresolvedContext) stored a direct reference toObjDomain, which contains unpicklable local functions (XRefRole closuresin
_role_cache). When Sphinx serializes the doctree viapickle.dump(doctree), it fails because these closures cannot be pickled.Dependencies
Requires sphinx-notes/render#14 (adds
envparameter to
UnresolvedContext.resolve()).