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

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
+100 −5
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
5eed43f
Convert platform CLI to use argparse
Harry-Lees Mar 21, 2025
119de84
Exit using sys.exit(0)
Harry-Lees Mar 21, 2025
994f46f
Parse position and flag arguments
Harry-Lees Mar 21, 2025
a0bb407
test flag parsing
Harry-Lees Mar 21, 2025
a21a6be
Add NEWS entry
Harry-Lees Mar 21, 2025
b4e0ed2
Sort imports alphabetically
Harry-Lees Mar 21, 2025
67cebfd
Sort imports alphabetically
Harry-Lees Mar 21, 2025
9ca5a96
Add help messages to included commands
Harry-Lees Mar 21, 2025
2c9a01c
Add help messages to included commands
Harry-Lees Mar 21, 2025
fb133e1
Use `platform.invalidate_caches()` in test setUp and teardown
Harry-Lees Mar 23, 2025
5fd4601
Fix typo in `Lib/test/test_platform.py`
Harry-Lees Mar 23, 2025
6381470
Update docstring in `text_normalize` function
Harry-Lees Mar 23, 2025
1f230f2
re-flow strings to improve formatting
Harry-Lees Mar 24, 2025
a5dcbf2
Convert shlex call to an array of flags
Harry-Lees Mar 24, 2025
48e3559
Remove redundant textwrap.dedent()
Harry-Lees Apr 24, 2025
cd389f5
Check for start of help command in tests which show help
Harry-Lees Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 33 additions & 4 deletions Lib/platform.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1464,9 +1464,38 @@ def invalidate_caches():

### Command line interface

if __name__ == '__main__':
# Default is to print the aliased verbose platform string
terse = ('terse' in sys.argv or '--terse' in sys.argv)
aliased = (not 'nonaliased' in sys.argv and not '--nonaliased' in sys.argv)
def _parse_args(args: list[str] | None):
import argparse

parser = argparse.ArgumentParser()
parser.add_argument("args", nargs="*", choices=["nonaliased", "terse"])
parser.add_argument(
"--terse",
action="store_true",
help=("return only the absolute minimum information needed to identify the "
"platform"),
Comment on lines +1475 to +1476
Copy link
Member

Choose a reason for hiding this comment

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

Either align to opening delimiter:

Suggested change
help=("return only the absolute minimum information needed to identify the "
"platform"),
help=("return only the absolute minimum information needed "
"to identify the platform"),

Or I'd just go for Black style:

Suggested change
help=("return only the absolute minimum information needed to identify the "
"platform"),
help=(
"return only the absolute minimum information needed "
"to identify the platform"
),

)
parser.add_argument(
"--nonaliased",
dest="aliased",
action="store_false",
help=("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"),
Comment on lines +1482 to +1484
Copy link
Member

Choose a reason for hiding this comment

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

Slightly shorter, with align:

Suggested change
help=("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"),
help=("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"),

Or if using Black style above:

Suggested change
help=("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"),
help=(
"disable system/OS name aliasing. If aliasing is enabled, "
"some platforms report system names different from "
"their common names, e.g. SunOS is reported as Solaris"
),

)

return parser.parse_args(args)


def _main(args: list[str] | None = None):
args = _parse_args(args)

terse = args.terse or ("terse" in args.args)
aliased = args.aliased and ('nonaliased' not in args.args)

print(platform(aliased, terse))


if __name__ == "__main__":
_main()
sys.exit(0)
Copy link
Member

Choose a reason for hiding this comment

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

I realise this was in the original, but looks redundant, especially with a single call under if __name__ == "__main__:

Suggested change
sys.exit(0)

66 changes: 65 additions & 1 deletion Lib/test/test_platform.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import os
import contextlib
import copy
import io
import itertools
import os
import pickle
import platform
import subprocess
Expand Down Expand Up @@ -741,5 +744,66 @@ def test_parse_os_release(self):
self.assertEqual(len(info["SPECIALS"]), 5)


class CommandLineTest(unittest.TestCase):
def setUp(self):
platform.invalidate_caches()
self.addCleanup(platform.invalidate_caches)

def invoke_platform(self, *flags):
output = io.StringIO()
with contextlib.redirect_stdout(output):
platform._main(args=flags)
return output.getvalue()

def test_unknown_flag(self):
with self.assertRaises(SystemExit):
output = io.StringIO()
# suppress argparse error message
with contextlib.redirect_stderr(output):
_ = self.invoke_platform('--unknown')
self.assertStartsWith(output, "usage: ")

def test_invocation(self):
flags = (
"--terse", "--nonaliased", "terse", "nonaliased"
)

for r in range(len(flags) + 1):
for combination in itertools.combinations(flags, r):
self.invoke_platform(*combination)

def test_arg_parsing(self):
# Due to backwards compatibility, the `aliased` and `terse` parameters
# are computed based on a combination of positional arguments and flags.
#
Comment on lines +776 to +777
Copy link
Member

Choose a reason for hiding this comment

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

Remember to try and limit lines to 79 chars: https://peps.python.org/pep-0008/#maximum-line-length

Suggested change
# Due to backwards compatibility, the `aliased` and `terse` parameters
# are computed based on a combination of positional arguments and flags.
# For backwards compatibility, the `aliased` and `terse` parameters are
# computed based on a combination of positional arguments and flags.

# This test tests that the arguments are correctly passed to the underlying
# `platform.platform()` call. The parameters are two booleans for `aliased`
# and `terse`.
options = (
(["--nonaliased"], (False, False)),
(["nonaliased"], (False, False)),
(["--terse"], (True, True)),
(["terse"], (True, True)),
(["nonaliased", "terse"], (False, True)),
(["--nonaliased", "terse"], (False, True)),
(["--terse", "nonaliased"], (False, True)),
)

for flags, args in options:
with self.subTest(flags=flags, args=args):
with mock.patch.object(platform, 'platform') as obj:
self.invoke_platform(*flags)
obj.assert_called_once_with(*args)

Comment on lines +779 to +796
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps like this, to document the parameters with variable names?

Suggested change
# This test tests that the arguments are correctly passed to the underlying
# `platform.platform()` call. The parameters are two booleans for `aliased`
# and `terse`.
options = (
(["--nonaliased"], (False, False)),
(["nonaliased"], (False, False)),
(["--terse"], (True, True)),
(["terse"], (True, True)),
(["nonaliased", "terse"], (False, True)),
(["--nonaliased", "terse"], (False, True)),
(["--terse", "nonaliased"], (False, True)),
)
for flags, args in options:
with self.subTest(flags=flags, args=args):
with mock.patch.object(platform, 'platform') as obj:
self.invoke_platform(*flags)
obj.assert_called_once_with(*args)
# Test that the arguments are correctly passed to the underlying
# `platform.platform()` call.
options = (
(["--nonaliased"], False, False),
(["nonaliased"], False, False),
(["--terse"], True, True),
(["terse"], True, True),
(["nonaliased", "terse"], False, True),
(["--nonaliased", "terse"], False, True),
(["--terse", "nonaliased"], False, True),
)
for flags, aliased, terse in options:
with self.subTest(flags=flags, aliased=aliased, terse=terse):
with mock.patch.object(platform, 'platform') as obj:
self.invoke_platform(*flags)
obj.assert_called_once_with(aliased, terse)

def test_help(self):
output = io.StringIO()

with self.assertRaises(SystemExit):
with contextlib.redirect_stdout(output):
platform._main(args=["--help"])

self.assertStartsWith(output.getvalue(), "usage:")


if __name__ == '__main__':
unittest.main()
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2025-03-21-17-34-27.gh-issue-131524.Vj1pO_.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add help message to :mod:`platform` command-line interface. Contributed by
Harry Lees.
Loading