Synced docs and docstring for `sysconfig.get_platform` #135530

ivanbelenky · 2025-06-15T05:38:59Z

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/

python-cla-bot · 2025-06-15T05:39:03Z

All commit authors signed the Contributor License Agreement.

bedevere-app · 2025-06-15T05:39:04Z

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 · 2025-06-15T06:05:13Z

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

ivanbelenky · 2025-06-15T07:52:48Z

@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 · 2025-06-15T09:20:13Z

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

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 · 2025-06-15T23:01:39Z

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.

ivanbelenky · 2025-06-16T12:25:16Z

Thanks @ned-deily

I have made the requested changes; please review again

bedevere-app · 2025-06-16T12:25:20Z

Thanks for making the requested changes!

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

efimov-mikhail · 2025-06-16T13:28:44Z

Doc/library/sysconfig.rst

-   Examples of returned values:
+   Returned values:
+
+   Examples of Linux returned values:


Repeating "returned values" doesn't look very nice, IMO.

efimov-mikhail · 2025-06-16T13:29:45Z

Doc/library/sysconfig.rst

   - win-amd64 (64-bit Windows on AMD64, aka x86_64, Intel64, and EM64T)
   - win-arm64 (64-bit Windows on ARM64, aka AArch64)
-   - win32 (all others - specifically, sys.platform is returned)
+   - win-arm32 (32-bit Windows on ARM)


Maybe it's better to have examples for each platform, and remove win-arm32 here.

What do you mean by examples for each platform here? you mean 1 example per architecture, and not adressing arm32? something like

Examples of Windows platforms: - win-amd64 (64-bit Windows on AMD64, aka x86_64, Intel64, and EM64T) - win-arm64 (64-bit Windows on ARM64, aka AArch64)

I feel like it can be repetitive as well to have a title preceding each OS: "Examples of {OS} platforms:", but at least is consistent. I have no preference between this or a general

Example of returned values: Windows ... linux ... macOs ...

Yes, I mean "Examples of returned values" for each platform. And win-arm32 value seems to be little redundant here in list of examples. I suggest to revert Windows platform examples list. Examples on Linux and macOS on current PR state looks fine, IMO

Lib/sysconfig/__init__.py

Doc/library/sysconfig.rst


   - win-amd64 (64-bit Windows on AMD64, aka x86_64, Intel64, and EM64T)
   - win-arm64 (64-bit Windows on ARM64, aka AArch64)
-   - win32 (all others - specifically, sys.platform is returned)


efimov-mikhail · 2025-06-17T03:58:41Z

Doc/library/sysconfig.rst

   - linux-i586
+   - linux-i686
   - linux-alpha (?)


Suggested change

- linux-alpha (?)

- android-9-arm64_v8a

efimov-mikhail · 2025-06-17T03:58:57Z

Lib/sysconfig/__init__.py

-    For other non-POSIX platforms, currently just returns 'sys.platform'.
+    - linux-i586
+    - linux-i686
+    - linux-alpha (?)


Suggested change

- linux-alpha (?)

- android-24-arm64_v8a

I know you probably got the Android example from the unit test, but this isn't actually a possible value because Android didn't add 64-bit support until API level 21. Also, this could mislead the reader into thinking it's the user-visible Android version rather than the API level. Suggest android-24-arm64_v8a, which is the version we're compiling against for Python 3.14.

Thanks for catch! I've had a little feeling that something is wrong.

efimov-mikhail · 2025-06-17T04:01:13Z

Doc/library/sysconfig.rst

@@ -382,22 +382,24 @@ Other functions

   Examples of returned values:

+   Linux


Suggested change

Linux

POSIX based OS:

macOS is also POSIX-based, so this would be confusing. How about reordering it as follows:

macOS

Other POSIX platforms

Windows

Other non-POSIX platforms

macOS is also POSIX-based, so this would be confusing

Of course, you're right.
Maybe this list would be better?

Windows

POSIX platfroms

Other non-POSIX platforms

And include just one line for macOS at the POSIX section (macosx-15.5-arm64) after linux-x86_64 line and before android-9-arm64_v8a line.

Yes, that would be reasonable.

@mhsmith @efimov-mikhail thanks a lot for your suggestions and comments

As far as this conversation goes I understand that this is the desired

Windows: - win-amd64 (64-bit Windows on AMD64, aka x86_64, Intel64, and EM64T) - win-arm64 (64-bit Windows on ARM64, aka AArch64) POSIX based OS: - linux-x86_64 - macosx-15.5-arm64 - android-9-arm64_v8a Other non-POSIX platforms ...

I don't understand what will be the best option under non POSIX OS ? Is it reasonable is to remove the section and just leave the last sentence "For other non-POSIX platforms, currently just returns :data:sys.platform."?

Doc/library/sysconfig.rst

efimov-mikhail · 2025-06-17T04:04:53Z

Lib/sysconfig/__init__.py

-       win-amd64 (64-bit Windows on AMD64 (aka x86_64, Intel64, EM64T, etc)
-       win-arm64 (64-bit Windows on ARM64 (aka AArch64)
-       win32 (all others - specifically, sys.platform is returned)
+    Linux


Suggested change

Linux

POSIX based OS:

Lib/sysconfig/__init__.py

efimov-mikhail · 2025-06-17T04:09:21Z

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 · 2025-06-17T09:23:36Z

Doc/library/sysconfig.rst

@@ -382,22 +382,24 @@ Other functions

   Examples of returned values:

+   Linux


macOS is also POSIX-based, so this would be confusing. How about reordering it as follows:

macOS

Other POSIX platforms

Windows

Other non-POSIX platforms

mhsmith · 2025-06-17T09:23:59Z

Doc/library/sysconfig.rst

   - linux-i586
+   - linux-i686


linux-i586 and linux-i686 are both obsolete. linux-x86_64 would be a better example.

efimov-mikhail · 2025-06-20T06:55:19Z

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

Doc/library/sysconfig.rst

efimov-mikhail · 2025-06-20T08:56:54Z

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.

Co-authored-by: Mikhail Efimov <[email protected]>

efimov-mikhail

LGTM

efimov-mikhail · 2025-06-21T07:03:32Z

CC @zooba @ned-deily

Added missing macos return to sysconfig.get_platform()

0964298

ivanbelenky requested a review from FFY00 as a code owner June 15, 2025 05:39

bedevere-app bot added the awaiting review label Jun 15, 2025

This comment was marked as duplicate.

Sign in to view

updated with exhaustive list and tests for >=11

7ab7580

ivanbelenky force-pushed the add-macos-docs-get_platform branch from a6537bc to 7ab7580 Compare June 15, 2025 07:51

This comment was marked as duplicate.

Sign in to view

ned-deily requested changes Jun 15, 2025

View reviewed changes

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

bedevere-app bot added the awaiting changes label Jun 15, 2025

removed exhaustive list for macOS

5db6178

This comment was marked as duplicate.

Sign in to view

ivanbelenky requested a review from ned-deily June 16, 2025 12:06

bedevere-app bot added awaiting change review and removed awaiting changes labels Jun 16, 2025

efimov-mikhail reviewed Jun 16, 2025

View reviewed changes

ZeroIntensity added the skip news label Jun 16, 2025

removed windows configs + format change

cb393a0

ivanbelenky requested a review from efimov-mikhail June 17, 2025 03:41

efimov-mikhail suggested changes Jun 17, 2025

View reviewed changes

mhsmith reviewed Jun 17, 2025

View reviewed changes

missing non posix example or removal

f159723

ivanbelenky force-pushed the add-macos-docs-get_platform branch from 1fbd476 to f159723 Compare June 20, 2025 05:51

efimov-mikhail suggested changes Jun 20, 2025

View reviewed changes

Doc/library/sysconfig.rst Show resolved Hide resolved

Doc/library/sysconfig.rst Outdated Show resolved Hide resolved

Doc/library/sysconfig.rst Outdated Show resolved Hide resolved

ivanbelenky and others added 5 commits June 21, 2025 00:43

remove Non POSIX

0548360

Co-authored-by: Mikhail Efimov <[email protected]>

windows

d7a2364

Co-authored-by: Mikhail Efimov <[email protected]>

Update Doc/library/sysconfig.rst

3aa49e4

Co-authored-by: Mikhail Efimov <[email protected]>

Update Lib/sysconfig/__init__.py

3805299

Co-authored-by: Mikhail Efimov <[email protected]>

sync on Doc

56d56e3

efimov-mikhail approved these changes Jun 21, 2025

View reviewed changes

		@@ -382,22 +382,24 @@ Other functions

		Examples of returned values:

		Linux

Uh oh!

Synced docs and docstring for sysconfig.get_platform #135530

Are you sure you want to change the base?

Synced docs and docstring for sysconfig.get_platform #135530

Conversation

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

bedevere-app bot commented Jun 15, 2025

Uh oh!

efimov-mikhail commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as duplicate.

This comment was marked as duplicate.

ivanbelenky commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

efimov-mikhail commented Jun 15, 2025

Uh oh!

ned-deily left a comment

Choose a reason for hiding this comment

Uh oh!

bedevere-app bot commented Jun 15, 2025

Uh oh!

This comment was marked as duplicate.

ivanbelenky commented Jun 16, 2025

Uh oh!

bedevere-app bot commented Jun 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ivanbelenky Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

efimov-mikhail Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment was marked as duplicate.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

efimov-mikhail Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mhsmith Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

efimov-mikhail Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

efimov-mikhail Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ivanbelenky Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Synced docs and docstring for `sysconfig.get_platform` #135530

Synced docs and docstring for `sysconfig.get_platform` #135530

ivanbelenky commented Jun 15, 2025 •

edited by github-actions bot

Loading

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

edited

Loading

efimov-mikhail commented Jun 15, 2025 •

edited

Loading

ivanbelenky commented Jun 15, 2025 •

edited

Loading

ivanbelenky Jun 16, 2025 •

edited

Loading

efimov-mikhail Jun 16, 2025 •

edited

Loading

efimov-mikhail Jun 17, 2025 •

edited

Loading

mhsmith Jun 17, 2025 •

edited

Loading

efimov-mikhail Jun 17, 2025 •

edited

Loading

efimov-mikhail Jun 17, 2025 •

edited

Loading

ivanbelenky Jun 20, 2025 •

edited

Loading

efimov-mikhail commented Jun 17, 2025 •

edited

Loading

efimov-mikhail commented Jun 20, 2025 •

edited

Loading