Skip to content

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

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
Merged
hugovk merged 17 commits into from
May 3, 2025
Merged

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

hugovk merged 17 commits into from
May 3, 2025

Conversation

@Harry-Lees
Copy link
Contributor

@Harry-Lees Harry-Lees commented Mar 21, 2025 •
edited
Loading

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.

@bedevere-app bedevere-app bot mentioned this pull request Mar 21, 2025
Closed
@donbarbos donbarbos mentioned this pull request Mar 16, 2025
Open
9 tasks
sobolevn
sobolevn reviewed Mar 21, 2025
View reviewed changes
sobolevn
sobolevn reviewed Mar 21, 2025
View reviewed changes
Copy link
Member

@sobolevn sobolevn left a comment

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 hugovk March 21, 2025 17:43
hugovk
hugovk reviewed Mar 21, 2025
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

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 -h
usage: 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?

@Harry-Lees
Copy link
Contributor Author

Harry-Lees commented Mar 21, 2025

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 hugovk March 21, 2025 23:11
picnixz
picnixz reviewed Mar 23, 2025
View reviewed changes
donbarbos
donbarbos suggested changes Apr 18, 2025
View reviewed changes
hugovk
hugovk reviewed Apr 26, 2025
View reviewed changes
hugovk
hugovk reviewed Apr 26, 2025
View reviewed changes
@donbarbos
Copy link
Contributor

donbarbos commented Apr 30, 2025

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

@hugovk
Copy link
Member

hugovk commented May 3, 2025

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

This can be a followup PR.

hugovk
hugovk approved these changes May 3, 2025
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks!

@hugovk
Copy link
Member

hugovk commented May 3, 2025

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

donbarbos
donbarbos approved these changes May 3, 2025
View reviewed changes
Copy link
Contributor

@donbarbos donbarbos left a comment •
edited
Loading

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