FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Avoid `__file__` in `hashlib` example by thejcannon · Pull Request #134540 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

Avoid __file__ in hashlib example - #134540

Merged
gpshead merged 3 commits into
python:mainfrom
thejcannon:patch-2
May 22, 2025
ConversationCommits (3)ChecksFiles changed
Merged

Avoid __file__ in hashlib example#134540
gpshead merged 3 commits into
python:mainfrom
thejcannon:patch-2

Conversation

thejcannon commented May 22, 2025 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

I love the cleverness and quirkiness of the hashlib documentation choosing to hash the hashlib module itself, however it is exactly that: "clever" and "quirky". Unfortunately, I've seen Python newbies and intermediates struggling to understand this example when trying to hash files themselves (not the least because the example does hashlib.__file__ and not __file__ or some_other_module.__file__).

So, let's move to something more "obvious" 👍 at the cost of being a slightly less silly place 👎

Open question to the room on whether this should be backported.

📚 Documentation preview 📚: https://cpython-previews--134540.org.readthedocs.build/

bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels May 22, 2025
github-project-automation Bot moved this to Todo in Docs PRs May 22, 2025
gpshead reviewed May 22, 2025
View reviewed changes
Comment thread Doc/library/hashlib.rst Outdated

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

gpshead May 22, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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?

thejcannon May 22, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

thejcannon May 22, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
Suggested change
>>> with open("path/to/file", "rb") as f:
>>> with open("Doc/library/hashlib.rst", "rb") as f:

thejcannon May 22, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality 
    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

gpshead self-assigned this May 22, 2025
gpshead added needs backport to 3.13 only security fixes needs backport to 3.14 bugs and security fixes skip issue labels May 22, 2025
gpshead merged commit 9b292ff into python:main May 22, 2025
github-project-automation Bot moved this from Todo to Done in Docs PRs May 22, 2025

miss-islington-app Bot commented May 22, 2025

Copy link
Copy Markdown

Thanks @thejcannon for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 22, 2025
Avoid __file__ in hashlib example (pythonGH-134540)
c729d6e 
(cherry picked from commit 9b292ff)

Co-authored-by: Josh Cannon <joshdcannon@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 22, 2025
Avoid __file__ in hashlib example (pythonGH-134540)
4ffd553 
(cherry picked from commit 9b292ff)

Co-authored-by: Josh Cannon <joshdcannon@gmail.com>

bedevere-app Bot commented May 22, 2025

Copy link
Copy Markdown

GH-134549 is a backport of this pull request to the 3.14 branch.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label May 22, 2025

bedevere-app Bot commented May 22, 2025

Copy link
Copy Markdown

GH-134550 is a backport of this pull request to the 3.13 branch.

bedevere-app Bot removed the needs backport to 3.13 only security fixes label May 22, 2025
thejcannon deleted the patch-2 branch May 22, 2025 21:32
gpshead pushed a commit that referenced this pull request May 22, 2025
[3.14] Avoid __file__ in hashlib example (GH-134540) (#134549)
06a3a85 
Avoid `__file__` in `hashlib` example (GH-134540)
(cherry picked from commit 9b292ff)

Co-authored-by: Josh Cannon <joshdcannon@gmail.com>
gpshead pushed a commit that referenced this pull request May 22, 2025
[3.13] Avoid __file__ in hashlib example (GH-134540) (#134550)
b212653 
Avoid `__file__` in `hashlib` example (GH-134540)
(cherry picked from commit 9b292ff)

Co-authored-by: Josh Cannon <joshdcannon@gmail.com>
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
Avoid __file__ in hashlib example (pythonGH-134540)
4da1409
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
Avoid __file__ in hashlib example (pythonGH-134540)
4d7b198
gostak-dd pushed a commit to gostak-dd/cpython that referenced this pull request Jun 2, 2026
Avoid __file__ in hashlib example (pythonGH-134540)
996f566
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

gpshead gpshead approved these changes
tiran Awaiting requested review from tiran
picnixz Awaiting requested review from picnixz picnixz is a code owner

Assignees

gpshead

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL