Skip to content

Avoid __file__ in hashlib example #134540

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
May 22, 2025
Merged

Avoid __file__ in hashlib example #134540

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
abcce09
Update hashlib.rst
thejcannon May 22, 2025
3918338
Update Doc/library/hashlib.rst
thejcannon May 22, 2025
0760ae8
Update hashlib.rst
thejcannon May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/library/hashlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ a file or file-like object.
Example:

>>> import io, hashlib, hmac
>>> with open(hashlib.__file__, "rb") as f:
>>> with open("path/to/file", "rb") as f:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the previous code worked because it passes doctest. It probably runs from the repo root, what happens if you use "Doc/library/hashlib.rst" here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, now its even cleverer in that this was hand-picked because we know its gonna pass doctest? 🤦

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
>>> with open("path/to/file", "rb") as f:
>>> with open("Doc/library/hashlib.rst", "rb") as f:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

    FileNotFoundError: [Errno 2] No such file or directory: 'Doc/library/hashlib.rst'

https://github.com/python/cpython/actions/runs/15196498586/job/42741793385?pr=134540#step:8:405

... digest = hashlib.file_digest(f, "sha256")
...
>>> digest.hexdigest() # doctest: +ELLIPSIS
Expand Down
Loading