Skip to content

gh-131524: Update platform CLI to use argparse - #131542

Merged
hugovk merged 17 commits into
python:mainfrom
Harry-Lees:131524-patch-1
May 3, 2025
Merged

gh-131524: Update platform CLI to use argparse#131542
hugovk merged 17 commits into
python:mainfrom
Harry-Lees:131524-patch-1

Conversation

@Harry-Lees

@Harry-LeesHarry-Lees commented Mar 21, 2025

Copy link
Copy Markdown
Contributor

Closes: #131524
Related To: #131178

This PR updates the platform CLI to use argparse which adds --help flags and a usage section which was previously unavailable.

Comment threadLib/platform.py Outdated
Comment threadLib/platform.py Outdated

@sobolevnsobolevn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

And don't forget about a NEWS entry :)

@sobolevn
sobolevn requested a review from hugovkMarch 21, 2025 17:43

@hugovkhugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We now have help which shows the arguments:

./python.exe -m platform -husage: python.exe -m platform [-h] [--terse] [--nonaliased] [{nonaliased,terse} ...]positional arguments: {nonaliased,terse}options: -h, --help show this help message and exit --terse --nonaliased

But doesn't say what they do. Please can you add short descriptions?

Comment threadLib/test/test_platform.py
Comment threadLib/test/test_platform.py
Harry-Leesand others added 4 commits March 21, 2025 22:41
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@Harry-Lees

Copy link
Copy Markdown
ContributorAuthor

But doesn't say what they do. Please can you add short descriptions?

The help message now gives a short description of each flag

usage: python.exe -m platform [-h] [--terse] [--nonaliased] [{nonaliased,terse} ...]
positional arguments:
{nonaliased,terse}
options:
-h, --help show this help message and exit
--terse return only the absolute minimum information needed to identify the platform
--nonaliased disable system/ OS name aliasing. If aliasing is enabled, some platforms will report system names which differ from their common names, e.g. SunOS will be reported
as Solaris

@Harry-Lees
Harry-Lees requested a review from hugovkMarch 21, 2025 23:11
Comment threadLib/platform.py
Comment threadLib/test/test_platform.py Outdated
Comment threadLib/test/test_platform.py Outdated
Comment threadLib/test/test_platform.py Outdated
Comment threadLib/test/test_platform.py
Comment threadLib/test/test_platform.py Outdated
Comment threadLib/test/test_platform.py Outdated
Comment threadLib/test/test_platform.py Outdated
Harry-Leesand others added 5 commits March 23, 2025 12:42
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Comment threadLib/test/test_platform.py Outdated
Comment threadLib/test/test_platform.py Outdated
Comment threadLib/test/test_platform.py
Comment threadLib/test/test_platform.py Outdated
Comment threadLib/platform.py Outdated
Comment threadLib/platform.py Outdated
Comment threadLib/test/test_platform.py Outdated
Comment threadLib/test/test_platform.py Outdated
Comment threadLib/platform.py Outdated
Comment threadLib/platform.py Outdated
@donbarbos

Copy link
Copy Markdown
Contributor

Maybe it's worth adding a Command-line Usage section to the platform documentation?

@hugovk

Copy link
Copy Markdown
Member

Maybe it's worth adding a Command-line Usage section to the platform documentation?

This can be a followup PR.

@hugovkhugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

@hugovk

Copy link
Copy Markdown
Member

@donbarbos GitHub says you requested changes, is there anything outstanding on this PR?

@donbarbosdonbarbos left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

sorry, I thought I was only leaving comments

@hugovk
hugovk enabled auto-merge (squash) May 3, 2025 08:55
@hugovk
hugovk merged commit 77c391a into python:mainMay 3, 2025
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve platform CLI

5 participants

@Harry-Lees@donbarbos@hugovk@sobolevn@picnixz