Make util.typing.restify sanitise unreproducible output #9755
Conversation
This file contains 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
…ddresses) Whilst working on the Reproducible Builds effort [0] I noticed that sphinx generates output that is not reproducible, causing a number of packages in Debian to unreproducible. Specifically, when Sphinx locates an alias of an instance when generating 'autodoc' documentation, it uses the raw Python repr(...) of the object and does not sanitise it for memory addresses (etc.) like elsewhere in Sphinx. This can result in documentation like this: -<dd><p>alias of <webob.client.SendRequest object at 0x7fd769189df0></p> +<dd><p>alias of <webob.client.SendRequest object at 0x7f0f02233df0></p> Patch attached that uses the object_description method, which was added to fix precisely this kind of issue. I originally filed this in Debian as bug #996948 [1]. [0] https://reproducible-builds.org/ [1] https://bugs.debian.org/996948
lamby
force-pushed
the
996948-sphinx-please-make-the-output-of-instance-aliases-reproducible
branch
from
3284ca6
to
ef7dfcd
Compare
|
Thanks! |
tk0miya
added a commit
that referenced
this pull request
Oct 22, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Whilst working on the Reproducible Builds effort I noticed that sphinx generates output that is not reproducible, causing a number of packages in Debian to unreproducible.
Specifically, when Sphinx locates an alias of an instance when generating
autodocdocumentation, it uses the raw Pythonrepr(...)of the object and does not sanitise it for memory addresses (etc.) like elsewhere in Sphinx.This can result in documentation like this:
Patch attached that uses the
object_descriptionmethod, which was added to fix precisely this kind of issue.I originally filed this in Debian as bug #996948.