Ensure frozen object descriptions are reproducible #5388
Merged
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
lamby
changed the title
lamby
force-pushed
the
reproducbible-frozenset
branch
from
c146f6e
to
fb9dadc
Compare
Codecov Report
@@ Coverage Diff @@
## master #5388 +/- ##
==========================================
- Coverage 82.5% 82.49% -0.01%
==========================================
Files 286 286
Lines 39112 39131 +19
Branches 5932 5936 +4
==========================================
+ Hits 32268 32283 +15
- Misses 5431 5433 +2
- Partials 1413 1415 +2
Continue to review full report at Codecov.
|
tk0miya
requested changes
Sep 5, 2018
Whilst working on the Reproducible Builds effort [0], we noticed
that sphinx could generate output that is not reproducible.
In particular, the rendering of `frozenset` objects in default
arguments and elsewhere is currently non-determinstic.
For example:
frozenset(['a', 'b', 'c'])
Might be rendered as any of:
frozenset({'a', 'b', 'c'})
frozenset({'a', 'c', 'b'})
frozenset({'b', 'a', 'c'})
frozenset({'b', 'c', 'a'})
frozenset({'c', 'a', 'b'})
frozenset({'c', 'b', 'a'})
Patch attached that sorts the contents of frozensets whilst rendering.
This is parallel to the `dict` and `set` type logic
[0] https://reproducible-builds.org/
lamby
force-pushed
the
reproducbible-frozenset
branch
from
fb9dadc
to
17d32d6
Compare
|
Rebased against |
tk0miya
approved these changes
Sep 5, 2018
|
Thanks a lot! |
tk0miya
added a commit
that referenced
this pull request
Sep 5, 2018
|
Thanks @tk0miya. Do you know when this might hit a release? :) |
|
It will be released within a few days. Please watch #4986. |
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.
Whilst working on the Reproducible Builds effort, we noticed that sphinx could generate output that is not reproducible.
In particular, the rendering of
frozensetobjects in default arguments and elsewhere is currently non-determinstic.For example:
Might be rendered as any of:
Patch attached that sorts the contents of frozensets whilst rendering. This is parallel to the
dictandsettype logic