Skip to content

Use replacements to update versions in "Using Python on macOS"#130400

Merged
ned-deily merged 7 commits into
python:mainfrom
hugovk:3.14-doc-usemac-replacements
Jun 16, 2025
Merged

Use replacements to update versions in "Using Python on macOS"#130400
ned-deily merged 7 commits into
python:mainfrom
hugovk:3.14-doc-usemac-replacements

Conversation

@hugovk
Copy link
Copy Markdown
Member

@hugovk hugovk commented Feb 21, 2025 •
edited by github-actions Bot
Loading

So the versions in https://docs.python.org/3.13/using/mac.html and https://docs.python.org/3.14/using/mac.html aren't hardcoded to "3.13", and reflect the current version.

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

@hugovk hugovk requested a review from AA-Turner as a code owner February 21, 2025 13:04
@hugovk hugovk added the needs backport to 3.13 bugs and security fixes label Feb 21, 2025
@hugovk hugovk added skip issue skip news docs Documentation in the Doc dir labels Feb 21, 2025
ned-deily
ned-deily reviewed Feb 22, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@ned-deily ned-deily left a comment

Choose a reason for hiding this comment

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

Thanks for doing this. Note there are still some hardwired 3.13 path references in the Advanced Topics section; it would be nice to address those, too.

@hugovk
Copy link
Copy Markdown
Member Author

hugovk commented Feb 22, 2025

Thanks, I've replaced some more. Unfortunately the formatting isn't as good, but I think it's acceptable from a maintenance point of view, if there's no better solution?

Before After
image image

But I've not replaced the hardcoded versions in this section, I don't have a good method for that:

https://docs.python.org/dev/using/mac.html#installing-using-the-command-line

@AA-Turner
Copy link
Copy Markdown
Member

AA-Turner commented Feb 23, 2025

Would an alternative be to have a test/lint ensuring that the version is current? It would be a shame to accept strictly worse aesthetics for a tooling problem.

A

@hugovk
Copy link
Copy Markdown
Member Author

hugovk commented Feb 24, 2025

That could work, what sort of thing do you have in mind?

Of course, it would be great if Sphinx directly supported replacements in code blocks ;)

Oh, I've just discovered parsed literal blocks:

This gives improved formatting, although no syntax highlighting:

Before After
image image
image image

@ned-deily
Copy link
Copy Markdown
Member

ned-deily commented Feb 25, 2025 •
edited
Loading

I struggled with how to handle versions in formatted code when I did the rewrite for 3.13. I'm glad I'm not the only one! If it could be done without a lot of trouble, the linting solution sounds fine until (if ever) there is a better solution with Sphinx / Docutils as this only needs to be updated once a year. But I'll leave it up to you(s).

@ned-deily ned-deily mentioned this pull request Feb 25, 2025
Open
@python-cla-bot
Copy link
Copy Markdown

python-cla-bot Bot commented Apr 18, 2025 •
edited
Loading

All commit authors signed the Contributor License Agreement.

CLA signed

@serhiy-storchaka serhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025
@ned-deily
Copy link
Copy Markdown
Member

ned-deily commented Jun 16, 2025

Getting back to this, it looks fine to me. Thanks, @hugovk! I'm going to merge it now and backport to 3.14 and 3.13 before any further editing (like removing the experimental qualification for free-threading and potentially updating the images).

@ned-deily ned-deily merged commit 21bac3a into python:main Jun 16, 2025
24 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jun 16, 2025
@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented Jun 16, 2025

Thanks @hugovk for the PR, and @ned-deily 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 Jun 16, 2025
@hugovk @miss-islington
Use replacements to update versions in "Using Python on macOS" (pytho…
b7bfdec 
…nGH-130400)

(cherry picked from commit 21bac3a)

Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Jun 16, 2025

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 16, 2025
@hugovk @miss-islington
Use replacements to update versions in "Using Python on macOS" (pytho…
4d06377 
…nGH-130400)

(cherry picked from commit 21bac3a)

Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jun 16, 2025
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Jun 16, 2025

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Jun 16, 2025
ned-deily pushed a commit that referenced this pull request Jun 16, 2025
@miss-islington @hugovk
[3.14] Use replacements to update versions in "Using Python on macOS" (…
a2c4791 
…GH-130400) (#135586)

(cherry picked from commit 21bac3a)

Co-authored-by: Hugo van Kemenade <[email protected]>
ned-deily pushed a commit that referenced this pull request Jun 16, 2025
@miss-islington @hugovk
[3.13] Use replacements to update versions in "Using Python on macOS" (…
be1ca79 
…GH-130400) (#135587)

(cherry picked from commit 21bac3a)

Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Jun 16, 2025

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot ARM64 MacOS M1 Refleaks NoGIL 3.14 (tier-2) has failed when building commit a2c4791.

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1714/builds/205) and take a look at the build logs.
  4. Check if the failure is related to this commit (a2c4791) or if it is a false positive.
  5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1714/builds/205

Failed tests:

  • test.test_multiprocessing_spawn.test_processes

Test leaking resources:

  • test_processes: references
  • test_processes: memory blocks

Summary of the results of the build (if available):

==

Click to see traceback logs 
Traceback (most recent call last):
  File "<string>", line 1, in <module>
    from multiprocessing.resource_tracker import main;main(7)
                                                      ~~~~^^^
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/resource_tracker.py", line 317, in main
    warnings.warn('resource_tracker: %r: %s' % (name, e))
    ~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
UserWarning: resource_tracker: '/mp-nvkm09zy': [Errno 2] No such file or directory


Traceback (most recent call last):
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/util.py", line 291, in __call__
    res = self._callback(*self._args, **self._kwargs)
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/synchronize.py", line 87, in _cleanup
    unregister(name, "semaphore")
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/resource_tracker.py", line 216, in unregister
    self._send('UNREGISTER', name, rtype)
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/resource_tracker.py", line 226, in _send
    warnings.warn(
UserWarning: ResourceTracker called reentrantly for resource cleanup, which is unsupported. The semaphore object '/mp-z615kmhc' might leak.
Warning -- Unraisable exception
Exception ignored while calling weakref callback <Finalize object, dead>:
Traceback (most recent call last):
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/util.py", line 291, in __call__
    res = self._callback(*self._args, **self._kwargs)
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/synchronize.py", line 87, in _cleanup
    unregister(name, "semaphore")
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/resource_tracker.py", line 216, in unregister
    self._send('UNREGISTER', name, rtype)
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/resource_tracker.py", line 226, in _send
    warnings.warn(
UserWarning: ResourceTracker called reentrantly for resource cleanup, which is unsupported. The semaphore object '/mp-nvkm09zy' might leak.
k


Traceback (most recent call last):
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/process.py", line 320, in _bootstrap
    self.run()
    ~~~~~~~~^^
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/process.py", line 108, in run
    self._target(*self._args, **self._kwargs)
    ~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/test/_test_multiprocessing.py", line 518, in _sleep_some_event
    time.sleep(100)
    ~~~~~~~~~~^^^^^
KeyboardInterrupt
k


Traceback (most recent call last):
  File "/Users/ec2-user/buildbot/buildarea/3.14.itamaro-macos-arm64-aws.macos-with-brew.refleak.nogil/build/Lib/multiprocessing/resource_tracker.py", line 314, in main
    _CLEANUP_FUNCS[rtype](name)
    ~~~~~~~~~~~~~~~~~~~~~^^^^^^
FileNotFoundError: [Errno 2] No such file or directory

@hugovk hugovk deleted the 3.14-doc-usemac-replacements branch June 17, 2025 11:53
lkollar pushed a commit to lkollar/cpython that referenced this pull request Jun 19, 2025
@hugovk @lkollar
Use replacements to update versions in "Using Python on macOS" (pytho…
c6e5069 
…n#130400)
@ned-deily ned-deily mentioned this pull request Jun 26, 2025
Open
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
@hugovk @Pranjal095
Use replacements to update versions in "Using Python on macOS" (pytho…
b941e7b 
…n#130400)
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
@hugovk @taegyunkim
Use replacements to update versions in "Using Python on macOS" (pytho…
0d6b0d7 
…n#130400)
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@hugovk @Agent-Hellboy
Use replacements to update versions in "Using Python on macOS" (pytho…
9760f4b 
…n#130400)
@Taeknology Taeknology mentioned this pull request May 19, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ned-deily ned-deily ned-deily left review comments

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees

No one assigned

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.

6 participants

@hugovk @AA-Turner @ned-deily @bedevere-bot @serhiy-storchaka @Huzumak1