Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Synced docs and docstring for sysconfig.get_platform #135530

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

Jump to bottom
Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Synced docs and docstring for sysconfig.get_platform #135530

wants to merge 10 commits into from
+24 −18

Conversation

ivanbelenky
Copy link

@ivanbelenky ivanbelenky commented Jun 15, 2025 •
edited by github-actions bot
Loading

  • added missing arm64 macos return to sysconfig.get_platform
  • synced docstring and docs for the get_platform

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

@ivanbelenky ivanbelenky requested a review from FFY00 as a code owner June 15, 2025 05:39
@python-cla-bot
Copy link

python-cla-bot bot commented Jun 15, 2025 •
edited
Loading

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app
Copy link

bedevere-app bot commented Jun 15, 2025

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 skip news label instead.

@efimov-mikhail
Copy link
Contributor

efimov-mikhail commented Jun 15, 2025 •
edited
Loading

Thanks for the catch!

It seems that still there are some possible return values of sysconfig.get_platform which aren't in the list, macosx-10.3-x86_64, macosx-10.4-universal and win-arm32, for example.
See sysconfig.get_platform at Lib/sysconfig/__init__.py and test_get_platform at Lib/test/test_sysconfig.py.
IMO, all those values should be addressed in the same PR.

Moreover, improving test_get_platform for the new macosx-11.0-arm64 (and maybe other macosx-11.0 versions?) also feels valueable.

On the other hand, general rewording can be more useful.
Remove "will return one of"/"can return" phrases and provide only examples for different platform instead of list of all possible values.

Some links to related previous PRs and commits:
#128701, 1875570

@bedevere-app

This comment was marked as duplicate.

Sign in to view
@ivanbelenky ivanbelenky force-pushed the add-macos-docs-get_platform branch from a6537bc to 7ab7580 Compare June 15, 2025 07:51
@bedevere-app

This comment was marked as duplicate.

Sign in to view
@ivanbelenky
Copy link
Author

ivanbelenky commented Jun 15, 2025 •
edited
Loading

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

@efimov-mikhail
Copy link
Contributor

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
ned-deily requested changes Jun 15, 2025
View reviewed changes
Copy link
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 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)

@bedevere-app
Copy link

bedevere-app bot commented Jun 15, 2025

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 I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@bedevere-app

This comment was marked as duplicate.

Sign in to view
@ivanbelenky ivanbelenky requested a review from ned-deily June 16, 2025 12:06
@ivanbelenky
Copy link
Author

Thanks @ned-deily

I have made the requested changes; please review again

@bedevere-app
Copy link

bedevere-app bot commented Jun 16, 2025

Thanks for making the requested changes!

@ned-deily: please review the changes made to this pull request.

efimov-mikhail
efimov-mikhail reviewed Jun 16, 2025
View reviewed changes
efimov-mikhail
efimov-mikhail suggested changes Jun 17, 2025
View reviewed changes
@efimov-mikhail
Copy link
Contributor

efimov-mikhail commented Jun 17, 2025 •
edited
Loading

I've digged into code and observed some important platforms such as Android.
So, I suggest to replace Linux section with more general POSIX based OS.

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
mhsmith reviewed Jun 17, 2025
View reviewed changes
@ivanbelenky ivanbelenky force-pushed the add-macos-docs-get_platform branch from 1fbd476 to f159723 Compare June 20, 2025 05:51
@efimov-mikhail
Copy link
Contributor

Ivan, you don't have to force push something, all commits will be squashed into one at merging stage.

efimov-mikhail
efimov-mikhail suggested changes Jun 20, 2025
View reviewed changes
@efimov-mikhail
Copy link
Contributor

efimov-mikhail commented Jun 20, 2025 •
edited
Loading

I've added some changes that I thought will be useful after all discussions.
Of course, we want such changes at Lib/sysconfig/__init__.py too.

ivanbelenky and others added 5 commits June 21, 2025 00:43
@ivanbelenky @efimov-mikhail
remove Non POSIX
0548360 
Co-authored-by: Mikhail Efimov <[email protected]>
@ivanbelenky @efimov-mikhail
windows
d7a2364 
Co-authored-by: Mikhail Efimov <[email protected]>
@ivanbelenky @efimov-mikhail
Update Doc/library/sysconfig.rst
3aa49e4 
Co-authored-by: Mikhail Efimov <[email protected]>
@ivanbelenky @efimov-mikhail
Update Lib/sysconfig/__init__.py
3805299 
Co-authored-by: Mikhail Efimov <[email protected]>
@ivanbelenky
sync on Doc
56d56e3
efimov-mikhail
efimov-mikhail approved these changes Jun 21, 2025
View reviewed changes
Copy link
Contributor

@efimov-mikhail efimov-mikhail left a comment

Choose a reason for hiding this comment

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

LGTM

@efimov-mikhail
Copy link
Contributor

CC @zooba @ned-deily

@mhsmith mhsmith added docs Documentation in the Doc dir skip issue labels Jun 21, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jun 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mhsmith mhsmith mhsmith left review comments

@efimov-mikhail efimov-mikhail efimov-mikhail approved these changes

@FFY00 FFY00 Awaiting requested review from FFY00 FFY00 is a code owner

@ned-deily ned-deily Awaiting requested review from ned-deily

Assignees
No one assigned
Labels
awaiting change review docs Documentation in the Doc dir skip issue skip news
Projects
Docs PRs
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ivanbelenky @efimov-mikhail @mhsmith @ned-deily @ZeroIntensity