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

hugovk · 2025-02-21T13:04:42Z

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/

ned-deily

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 · 2025-02-22T15:26:05Z

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

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 · 2025-02-23T00:04:26Z

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 · 2025-02-24T13:04:53Z

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

ned-deily · 2025-02-25T07:04:46Z

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).

python-cla-bot · 2025-04-18T09:29:05Z

All commit authors signed the Contributor License Agreement.

ned-deily · 2025-06-16T22:06:53Z

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).

miss-islington-app · 2025-06-16T22:07:29Z

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

…nGH-130400) (cherry picked from commit 21bac3a) Co-authored-by: Hugo van Kemenade <[email protected]>

bedevere-app · 2025-06-16T22:07:41Z

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

…nGH-130400) (cherry picked from commit 21bac3aecd03805ea74ca67a3a291a9eb347588f) Co-authored-by: Hugo van Kemenade <[email protected]>

bedevere-app · 2025-06-16T22:07:46Z

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

…GH-130400) (#135586) (cherry picked from commit 21bac3a) Co-authored-by: Hugo van Kemenade <[email protected]>

…GH-130400) (#135587) (cherry picked from commit 21bac3a) Co-authored-by: Hugo van Kemenade <[email protected]>

bedevere-bot · 2025-06-16T23:41:42Z

⚠️⚠️⚠️ 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:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
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.
Check if the failure is related to this commit (a2c4791) or if it is a false positive.
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

…n#130400)

hugovk added 3 commits February 21, 2025 14:36

Move usemac replacements from mac.rst to conf.py

d9d3019

Replace usemac replacements with existing ones

929dc1c

Generalise the other usemac replacements

efc3f13

hugovk requested a review from AA-Turner as a code owner February 21, 2025 13:04

hugovk added the needs backport to 3.13 bugs and security fixes label Feb 21, 2025

bedevere-app bot added the awaiting core review label Feb 21, 2025

hugovk added skip issue skip news docs Documentation in the Doc dir labels Feb 21, 2025

ned-deily reviewed Feb 22, 2025

View reviewed changes

Replace more hardcoded version numbers

f5ac18e

hugovk added 2 commits February 24, 2025 14:19

Replace replacements with parsed literal blocks

d33b1ab

Use parsed literal blocks for 'Installing using the command line'

0016c13

ned-deily mentioned this pull request Feb 25, 2025

gh-128039: Clarify the uninstallation instructions for macOS #129930

Open

serhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025

Merge branch 'main' into 3.14-doc-usemac-replacements

8da7b24

ned-deily merged commit 21bac3a into python:main Jun 16, 2025
24 checks passed

github-project-automation bot moved this from Todo to Done in Docs PRs Jun 16, 2025

bedevere-app bot removed the awaiting core review label Jun 16, 2025

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 16, 2025

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 bot removed the needs backport to 3.14 bugs and security fixes label Jun 16, 2025

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

[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

[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]>

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

Use replacements to update versions in "Using Python on macOS" (pytho…

c6e5069

…n#130400)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

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

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

Uh oh!

hugovk commented Feb 21, 2025 •

edited by github-actions bot

Loading

Uh oh!

ned-deily left a comment

Uh oh!

hugovk commented Feb 22, 2025

Uh oh!

AA-Turner commented Feb 23, 2025

Uh oh!

hugovk commented Feb 24, 2025

Uh oh!

ned-deily commented Feb 25, 2025 •

edited

Loading

Uh oh!

python-cla-bot bot commented Apr 18, 2025 •

edited

Loading

Uh oh!

ned-deily commented Jun 16, 2025

Uh oh!

Uh oh!

miss-islington-app bot commented Jun 16, 2025

Uh oh!

bedevere-app bot commented Jun 16, 2025

Uh oh!

bedevere-app bot commented Jun 16, 2025

Uh oh!

bedevere-bot commented Jun 16, 2025

Uh oh!

Uh oh!

Uh oh!

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

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

Uh oh!

Conversation

hugovk commented Feb 21, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ned-deily left a comment

Choose a reason for hiding this comment

Uh oh!

hugovk commented Feb 22, 2025

Uh oh!

AA-Turner commented Feb 23, 2025

Uh oh!

hugovk commented Feb 24, 2025

Uh oh!

ned-deily commented Feb 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

python-cla-bot bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ned-deily commented Jun 16, 2025

Uh oh!

Uh oh!

miss-islington-app bot commented Jun 16, 2025

Uh oh!

bedevere-app bot commented Jun 16, 2025

Uh oh!

bedevere-app bot commented Jun 16, 2025

Uh oh!

bedevere-bot commented Jun 16, 2025

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

Uh oh!

Uh oh!

hugovk commented Feb 21, 2025 •

edited by github-actions bot

Loading

ned-deily commented Feb 25, 2025 •

edited

Loading

python-cla-bot bot commented Apr 18, 2025 •

edited

Loading