Synced docs and docstring for sysconfig.get_platform
#135530
Merged
Conversation
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
|
All commit authors signed the Contributor License Agreement. |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
|
Thanks for the catch! It seems that still there are some possible return values of Moreover, improving On the other hand, general rewording can be more useful. Some links to related previous PRs and commits: |
This comment was marked as duplicate.
This comment was marked as duplicate.
ivanbelenky
force-pushed
the
add-macos-docs-get_platform
branch
from
a6537bc to
7ab7580
Compare
This comment was marked as duplicate.
This comment was marked as duplicate.
|
@efimov-mikhail thanks for your swift response, I also thought that the phrasing "macOs can return" as well as "Examples of returned values" was implicitly assuming that an exhaustive list is not necessary. But did not know if this was intentional or not. I agree that exhaustive is better. I've added what I think is an exhaustive list + the tests for the >=11 macOS releases. Maybe this is a redundancy. I lack expertise on many aspects of the platform and sysconfig logic, so I may be missing something here. |
|
Thanks for the changes. IMO, now it looks better. But I'm also not an expert here. We probably should wait for someone with greater expertise. |
ned-deily
requested changes
Jun 15, 2025
There was a problem hiding this comment.
Thanks for the PR. But I don't think it is a good idea to attempt to provide an exhaustive list here. As already noted in the paragraph above in sysconfig.rst:
This is used mainly to distinguish platform-specific build directories and platform-specific built distributions
By implication, the exact values are not intended to be parsed. They are just configuration-unique values.
I would support changing the wording for macOS and to replace the macOS list with a few more modern examples, like:
Examples of macOS returned values:
- macosx-10.13-x86_64
- macosx-11-universal2
- macosx-15.5-arm64
Perhaps @zooba has an opinion on updates to the list of Windows values.
Also note that reST markup requires a blank line before the start of a list. The changes here disturb that. (See the doc preview)
|
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 |
This comment was marked as duplicate.
This comment was marked as duplicate.
|
Thanks @ned-deily I have made the requested changes; please review again |
|
Thanks for making the requested changes! @ned-deily: please review the changes made to this pull request. |
efimov-mikhail
suggested changes
Jun 17, 2025
|
I've digged into code and observed some important platforms such as Android. Speaking about text organization I'm not exactly sure that subsection with colons under section with colon is the best way, but I don't like raw "Windows" / "macOS" text before platform list. |
mhsmith
reviewed
Jun 17, 2025
|
CC @zooba @ned-deily |
ned-deily
approved these changes
Sep 16, 2025
ned-deily
added
needs backport to 3.13
|
Thanks @ivanbelenky for the PR, and @ned-deily for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
|
Thanks @ivanbelenky for the PR, and @ned-deily for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Sep 16, 2025
(cherry picked from commit 01cc532) Co-authored-by: ivan <[email protected]> Co-authored-by: Mikhail Efimov <[email protected]> Co-authored-by: Ned Deily <[email protected]>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Sep 16, 2025
(cherry picked from commit 01cc532) Co-authored-by: ivan <[email protected]> Co-authored-by: Mikhail Efimov <[email protected]> Co-authored-by: Ned Deily <[email protected]>
|
GH-138975 is a backport of this pull request to the 3.13 branch. |
|
GH-138976 is a backport of this pull request to the 3.14 branch. |
|
Thanks for everyone's contribution. I did add one more macOS platform example to illustrate both the release number jump to 26 for macOS Tahoe and that the platform name might contain a universal build configuration name, like |
|
ned-deily
added a commit
that referenced
this pull request
Sep 17, 2025
) (#138975) (cherry picked from commit 01cc532) Co-authored-by: ivan <[email protected]> Co-authored-by: Mikhail Efimov <[email protected]> Co-authored-by: Ned Deily <[email protected]>
hugovk
pushed a commit
that referenced
this pull request
Oct 4, 2025
) (#138976) Synced docs and docstring for `sysconfig.get_platform` (GH-135530) (cherry picked from commit 01cc532) Co-authored-by: ivan <[email protected]> Co-authored-by: Mikhail Efimov <[email protected]> Co-authored-by: Ned Deily <[email protected]> Co-authored-by: Filipe Laíns 🇵🇸 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
arm64macos return tosysconfig.get_platformget_platform📚 Documentation preview 📚: https://cpython-previews--135530.org.readthedocs.build/