Display the invoked executable name when displaying help #91818

Activity

1. scrummyin

   added

   type-featureA feature request or enhancementA feature request or enhancement

   on Apr 22, 2022
2. hugovk commented on Apr 22, 2022

   

   hugovk

   on Apr 22, 2022

   Member

   More actions

   This could be done something like this:

   diff --git a/Lib/json/tool.py b/Lib/json/tool.py
   index 0490b8c0be..e0e196c722 100644
   --- a/Lib/json/tool.py
   +++ b/Lib/json/tool.py
   @@ -16,8 +16,11 @@
    from pathlib import Path
    
    
   +_python_exe = sys.executable
   +
   +
    def main():
   -    prog = 'python -m json.tool'
   +    prog = f'{_python_exe} -m json.tool'
        description = ('A simple command line interface for json module '
                       'to validate and pretty-print JSON objects.')
        parser = argparse.ArgumentParser(prog=prog, description=description)

   $ ./python.exe -m json.tool -h
   usage: /Users/hugo/github/cpython/python.exe -m json.tool [-h] [--sort-keys] [--no-ensure-ascii] [--json-lines] [--indent INDENT | --tab | --no-indent | --compact]
                                                                 [infile] [outfile]
   ...

   ---

   Or (less helpfully?) without the full path:

   diff --git a/Lib/json/tool.py b/Lib/json/tool.py
   index 0490b8c0be..43754cdd59 100644
   --- a/Lib/json/tool.py
   +++ b/Lib/json/tool.py
   @@ -12,12 +12,16 @@
    """
    import argparse
    import json
   +import os
    import sys
    from pathlib import Path
    
    
   +_python_exe = os.path.basename(sys.executable)
   +
   +
    def main():
   -    prog = 'python -m json.tool'
   +    prog = f'{_python_exe} -m json.tool'
        description = ('A simple command line interface for json module '
                       'to validate and pretty-print JSON objects.')
        parser = argparse.ArgumentParser(prog=prog, description=description)

   $ ./python.exe -m json.tool -h
   usage: python.exe -m json.tool [-h] [--sort-keys] [--no-ensure-ascii] [--json-lines] [--indent INDENT | --tab | --no-indent | --compact] [infile] [outfile]
   ...

   ---

   pip does something along these lines:

   https://github.com/pypa/pip/blob/c247ddce123513198858d4589c5ee198dcc6ba40/src/pip/_internal/cli/main_parser.py#L21

   https://github.com/pypa/pip/blob/c247ddce123513198858d4589c5ee198dcc6ba40/src/pip/_internal/utils/misc.py#L109-L118
3. scrummyin commented on Apr 22, 2022

   

   scrummyin

   on Apr 22, 2022

   ContributorAuthor

   More actions

   I did a little more than that with #91819 , partially to guarantee that something comes out when sys.executable might fail, since it can return None.
4. erlend-aasland

   added this to Argparse issueson Jul 30, 2022
5. erlend-aasland

   moved this to Features in Argparse issueson Feb 21, 2023
6. iritkatriel

   added

   stdlibStandard Library Python modules in the Lib/ directoryStandard Library Python modules in the Lib/ directory

   on Nov 27, 2023
7. serhiy-storchaka

   added this to JSON issues and removed this from Argparse issueson Sep 28, 2024
8. serhiy-storchaka commented on Sep 28, 2024

   

   serhiy-storchaka

   on Sep 28, 2024

   Member

   More actions

   The general issue is a duplicate of #66436.

   Leaving this issue open as json.tools specific issue.
9. serhiy-storchaka

   added a commit that references this issue on Oct 1, 2024

   pythongh-91818: Use default program name in the CLI of many modules

   ...

   97400c1
10. serhiy-storchaka

    added a commit that references this issue on Oct 9, 2024

    gh-91818: Use default program name in the CLI of many modules (GH-124867

    ...

    7d2c397
11. serhiy-storchaka

    closed this as completedon Oct 9, 2024
12. github-project-automation

    moved this to Done in JSON issueson Oct 9, 2024