-
-
Notifications
You must be signed in to change notification settings - Fork 29.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
gh-121874: Define audit-event open parameters consistently #121883
Conversation
as in Doc/library/io.rst: .. audit-event:: open path,mode,flags io.open Doc/library/os.rst: .. audit-event:: open path,mode,flags os.open to avoid triggering a race-condition in Sphinx that causes non-deterministic output. See https://reproducible-builds.org/ for why this matters. Fixes: python#121874 This patch was done while working on reproducible builds for openSUSE, sponsored by the NLnet NGI0 fund.
https://docs.python.org/3/library/functions.html#open says:
https://docs.python.org/3/library/io.html#io.open says:
Should we change both to |
as in Doc/library/functions.rst: .. audit-event:: open file,mode,flags open Doc/library/io.rst: .. audit-event:: open path,mode,flags io.open Doc/library/os.rst: .. audit-event:: open path,mode,flags os.open to avoid triggering a race-condition in Sphinx that causes non-deterministic output. See https://reproducible-builds.org/ for why this matters. Fixes: python#121874 Alternative to: python#121883 This patch was done while working on reproducible builds for openSUSE, sponsored by the NLnet NGI0 fund.
I tried that and found that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is incorrect. The name of the parameter is file
, not path
.
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
I have made the requested changes; please review again. |
Thanks for making the requested changes! @serhiy-storchaka: please review the changes made to this pull request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Thanks @bmwiedemann for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12. |
Thanks @bmwiedemann for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
…honGH-121883) Use same names for parameters to avoid triggering a race-condition in Sphinx that causes non-deterministic output. (cherry picked from commit 24cf867) Co-authored-by: Bernhard M. Wiedemann <bwiedemann@suse.de>
…honGH-121883) Use same names for parameters to avoid triggering a race-condition in Sphinx that causes non-deterministic output. (cherry picked from commit 24cf867) Co-authored-by: Bernhard M. Wiedemann <bwiedemann@suse.de>
GH-121955 is a backport of this pull request to the 3.12 branch. |
GH-121956 is a backport of this pull request to the 3.13 branch. |
Define
audit-event
open
parameters consistently to be the same as into avoid triggering a race-condition in Sphinx
that causes non-deterministic output.
See https://reproducible-builds.org/ for why this matters.
Fixes: #121874
This patch was done while working on reproducible builds for openSUSE, sponsored by the NLnet NGI0 fund.
📚 Documentation preview 📚: https://cpython-previews--121883.org.readthedocs.build/