pythongh-93096: Port a bunch of stdlib cli to ArgumentParser

Author: arhadthedev

Lib/filecmp.py

@@ -298,13 +298,14 @@ def _filter(flist, skip):
 # Demonstration and testing.
 #
 def demo():
-    import sys
-    import getopt
-    options, args = getopt.getopt(sys.argv[1:], 'r')
-    if len(args) != 2:
-        raise getopt.GetoptError('need exactly two args', None)
-    dd = dircmp(args[0], args[1])
-    if ('-r', '') in options:
+    from argparse import ArgumentParser
+    parser = ArgumentParser(description='compare directories and files')
+    parser.add_argument('-r', action='store_true', help='recursive comparison')
+    parser.add_argument('dir_a', help='one side of the comparison')
+    parser.add_argument('dir_b', help='another side of the comparison')
+    arguments = parser.parse_args()
+    dd = dircmp(arguments['dir_a'], arguments['dir_b'])
+    if arguments['r']:
         dd.report_full_closure()
     else:
         dd.report()

Lib/fileinput.py

@@ -423,20 +423,21 @@ def openhook(filename, mode):
     return openhook
 
 
-def _test():
-    import getopt
-    inplace = False
-    backup = False
-    opts, args = getopt.getopt(sys.argv[1:], "ib:")
-    for o, a in opts:
-        if o == '-i': inplace = True
-        if o == '-b': backup = a
-    for line in input(args, inplace=inplace, backup=backup):
-        if line[-1:] == '\n': line = line[:-1]
-        if line[-1:] == '\r': line = line[:-1]
-        print("%d: %s[%d]%s %s" % (lineno(), filename(), filelineno(),
-                                   isfirstline() and "*" or "", line))
-    print("%d: %s[%d]" % (lineno(), filename(), filelineno()))
+def _cli():
+    from argparse import ArgumentParser
+    parser = ArgumentParser(description='show glued content of files')
+    parser.add_argument('-i', '--inplace', action='store_true',
+                        help='access original files, not copies')
+    parser.add_argument('-b', '--backup', action='store_true',
+                        help='file extension for the copies')
+    parser.add_argument('file', nargs='+', help='input path')
+    arguments = parser.parse_args()
+
+    for line in input(arguments.file, arguments.inplace, arguments.backup):
+        line = line.rstrip('\r\n')
+        start_flag = '*' if isfirstline() else ''
+        print(f'{lineno()}: {filename()}[{filelineno()}]{start_flag} {line}')
+    print(f'{lineno()}: {filename()}[{filelineno()}]')
 
 if __name__ == '__main__':
-    _test()
+    _cli()

Lib/idlelib/pyshell.py

@@ -1460,34 +1460,14 @@ def fix_x11_paste(root):
                         root.bind_class(cls, '<<Paste>>'))
 
 
-usage_msg = """\
-
-USAGE: idle  [-deins] [-t title] [file]*
-       idle  [-dns] [-t title] (-c cmd | -r file) [arg]*
-       idle  [-dns] [-t title] - [arg]*
-
-  -h         print this help message and exit
-  -n         run IDLE without a subprocess (DEPRECATED,
-             see Help/IDLE Help for details)
-
-The following options will override the IDLE 'settings' configuration:
-
-  -e         open an edit window
-  -i         open a shell window
-
-The following options imply -i and will open a shell:
-
-  -c cmd     run the command in a shell, or
-  -r file    run script from file
-
-  -d         enable the debugger
-  -s         run $IDLESTARTUP or $PYTHONSTARTUP before anything else
-  -t title   set title of shell window
+usage="""%(prog)s -h
+       %(prog)s [-deins] [-t title] [file ...]
+       %(prog)s [-dns] [-t title] (-c cmd | -r file) [arg ...]
+       %(prog)s [-dns] [-t title] - [arg ...]"""
 
+epilog = """\
 A default edit window will be bypassed when -c, -r, or - are used.
 
-[arg]* are passed to the command (-c) or script (-r) in sys.argv[1:].
-
 Examples:
 
 idle
@@ -1511,30 +1491,45 @@ def fix_x11_paste(root):
 
 echo "import sys; print(sys.argv)" | idle - "foobar"
         Open a shell window, run the script piped in, passing '' in sys.argv[0]
-        and "foobar" in sys.argv[1].
-"""
+        and "foobar" in sys.argv[1]."""
 
 def main():
-    import getopt
+    from argparse import ArgumentParser, RawTextHelpFormatter
     from platform import system
     from idlelib import testing  # bool value
     from idlelib import macosx
 
     global flist, root, use_subprocess
 
     capture_warnings(True)
-    use_subprocess = True
-    enable_shell = False
-    enable_edit = False
-    debug = False
-    cmd = None
-    script = None
-    startup = False
-    try:
-        opts, args = getopt.getopt(sys.argv[1:], "c:deihnr:st:")
-    except getopt.error as msg:
-        print("Error: %s\n%s" % (msg, usage_msg), file=sys.stderr)
-        sys.exit(2)
+    parser = ArgumentParser(description='Python’s Integrated Development and '
+                            'Learning Environment', usage=usage, epilog=epilog,
+                            formatter_class=RawTextHelpFormatter)
+    parser.add_argument('-n', action='store_true', help='run IDLE without a '
+                        'subprocess (DEPRECATED, see Help/IDLE Help for '
+                        'details)')
+    parser.add_argument('file', nargs='*', help='file path to open')
+    parser.add_argument('arg', nargs='*', help='parameter passed to the '
+                        'command (-c), script (-r), or REPL (-) in '
+                        'sys.argv[1:]')
+    settings = parser.add_argument_group(description="the following options "
+                                         "have priority over the IDLE "
+                                         "'settings' configuration:")
+    settings.add_argument('-e', '--edit', action='store_true', help='open an edit window')
+    settings.add_argument('-i', '--interactive', action='store_true', help='open a shell window')
+    shell = parser.add_argument_group(description='the following options '
+                                      'imply -i:')
+    run = parser.add_mutually_exclusive_group()
+    run.add_argument('-c', '--command', metavar='cmd',
+                       help='run the command in a shell, or')
+    run.add_argument('-r', '--run', metavar='file', help='run script from file')
+    shell.add_argument('-d', '--debug', action='store_true', help='enable the debugger')
+    shell.add_argument('-s', action='store_true', help='run $IDLESTARTUP or '
+                       '$PYTHONSTARTUP before anything else')
+    shell.add_argument('-t', '--title', metavar='title', help='set title of shell window')
+
+    arguments = parser.parse_args()
+
     for o, a in opts:
         if o == '-c':
             cmd = a

Lib/imaplib.py

@@ -1544,32 +1544,29 @@ def Time2Internaldate(date_time):
 
 if __name__ == '__main__':
 
-    # To test: invoke either as 'python imaplib.py [IMAP4_server_hostname]'
-    # or 'python imaplib.py -s "rsh IMAP4_server_hostname exec /etc/rimapd"'
-    # to test the IMAP4_stream class
+    epilog = ("to test, invoke either as 'python imaplib.py "
+              "[IMAP4_server_hostname]' or 'python imaplib.py -s \"rsh "
+              "IMAP4_server_hostname exec /etc/rimapd\"' to test the "
+              "IMAP4_stream class")
 
-    import getopt, getpass
+    from argparse import ArgumentParser
+    import getpass
 
     try:
-        optlist, args = getopt.getopt(sys.argv[1:], 'd:s:')
+        parser = ArgumentParser(description='test IMAP4rev1 servers',
+                                epilog=epilog)
+        parser.add_argument('host', type=int, help='server hostname')
+        parser.add_argument('-d', type=int, help='debug output level')
+        parser.add_argument('-s', help=('execute a command line and attach '
+                            'IMAP4_stream to it'))
+        arguments = parser.parse_args()
+
     except getopt.error as val:
         optlist, args = (), ()
 
-    stream_command = None
-    for opt,val in optlist:
-        if opt == '-d':
-            Debug = int(val)
-        elif opt == '-s':
-            stream_command = val
-            if not args: args = (stream_command,)
-
-    if not args: args = ('',)
-
-    host = args[0]
-
     USER = getpass.getuser()
-    PASSWD = getpass.getpass("IMAP password for %s on %s: " % (USER, host or "localhost"))
-
+    host = arguments['host'] or "localhost"
+    PASSWD = getpass.getpass(f"IMAP password for {USER} on {host}: ")
     test_mesg = 'From: %(user)s@localhost%(lf)sSubject: IMAP4 test%(lf)s%(lf)sdata...%(lf)s' % {'user':USER, 'lf':'\n'}
     test_seq1 = (
     ('login', (USER, PASSWD)),
@@ -1606,10 +1603,7 @@ def run(cmd, args):
         return dat
 
     try:
-        if stream_command:
-            M = IMAP4_stream(stream_command)
-        else:
-            M = IMAP4(host)
+        M = IMAP4_stream(arguments['s']) if arguments['s'] else IMAP4(host)
         if M.state == 'AUTH':
             test_seq1 = test_seq1[1:]   # Login not needed
         M._mesg('PROTOCOL_VERSION = %s' % M.PROTOCOL_VERSION)
@@ -1640,7 +1634,7 @@ def run(cmd, args):
     except:
         print('\nTests failed.')
 
-        if not Debug:
+        if not arguments['d']:
             print('''
 If you would like to see debugging output,
 try: %s -d5

Lib/modulefinder.py

@@ -600,67 +600,40 @@ def replace_paths_in_code(self, co):
         return co.replace(co_consts=tuple(consts), co_filename=new_filename)
 
 
-def test():
-    # Parse command line
-    import getopt
-    try:
-        opts, args = getopt.getopt(sys.argv[1:], "dmp:qx:")
-    except getopt.error as msg:
-        print(msg)
-        return
-
-    # Process options
-    debug = 1
-    domods = 0
-    addpath = []
-    exclude = []
-    for o, a in opts:
-        if o == '-d':
-            debug = debug + 1
-        if o == '-m':
-            domods = 1
-        if o == '-p':
-            addpath = addpath + a.split(os.pathsep)
-        if o == '-q':
-            debug = 0
-        if o == '-x':
-            exclude.append(a)
-
-    # Provide default arguments
-    if not args:
-        script = "hello.py"
-    else:
-        script = args[0]
+def _cli():
+    from argparse import ArgumentParser
+    parser = ArgumentParser(description='list modules imported by a script')
+    parser.add_argument('-d', '--debug', action='store_true', help='')
+    parser.add_argument('-q', '--quiet', action='store_true', help='')
+    parser.add_argument('-m', '--domods', action='store_true', help='')
+    parser.add_argument('-p', '--path', nargs='*', help='path to search for modules; if not specified, sys.path is used')
+    parser.add_argument('-x', '--exclude', nargs='*', help='')
+    parser.add_argument('script', default='hello.py', help='path to a script')
+    arguments = parser.parse_args()
 
     # Set the path based on sys.path and the script directory
     path = sys.path[:]
     path[0] = os.path.dirname(script)
-    path = addpath + path
-    if debug > 1:
+    path = arguments['path'] + path
+    if arguments['debug']:
         print("path:")
         for item in path:
             print("   ", repr(item))
 
     # Create the module finder and turn its crank
-    mf = ModuleFinder(path, debug, exclude)
-    for arg in args[1:]:
-        if arg == '-m':
-            domods = 1
-            continue
-        if domods:
-            if arg[-2:] == '.*':
-                mf.import_hook(arg[:-2], None, ["*"])
-            else:
-                mf.import_hook(arg)
-        else:
-            mf.load_file(arg)
+    mf = ModuleFinder(arguments['path'], arguments['debug'], arguments['exclude'])
+    if arguments['domods']
+        for path in arguments['domods']:
+            mf.import_hook(path, None, ["*"] if path == '.*' else None)
+    else:
+        mf.load_file(arg)
     mf.run_script(script)
     mf.report()
     return mf  # for -i debugging
 
 
 if __name__ == '__main__':
     try:
-        mf = test()
+        mf = _cli()
     except KeyboardInterrupt:
         print("\n[interrupted]")

Lib/pdb.py

@@ -1757,44 +1757,30 @@ def help():
     import pydoc
     pydoc.pager(__doc__)
 
-_usage = """\
-usage: pdb.py [-c command] ... [-m module | pyfile] [arg] ...
-
-Debug the Python program given by pyfile. Alternatively,
-an executable module or package to debug can be specified using
-the -m switch.
-
+epilog = """\
 Initial commands are read from .pdbrc files in your home directory
-and in the current directory, if they exist.  Commands supplied with
--c are executed after commands from .pdbrc files.
+and in the current directory, if they exist.
 
 To let the script run until an exception occurs, use "-c continue".
 To let the script run up to a given line X in the debugged file, use
 "-c 'until X'"."""
 
 
-def main():
-    import getopt
-
-    opts, args = getopt.getopt(sys.argv[1:], 'mhc:', ['help', 'command='])
-
-    if not args:
-        print(_usage)
-        sys.exit(2)
-
-    if any(opt in ['-h', '--help'] for opt, optarg in opts):
-        print(_usage)
-        sys.exit()
-
-    commands = [optarg for opt, optarg in opts if opt in ['-c', '--command']]
-
-    module_indicated = any(opt in ['-m'] for opt, optarg in opts)
-    cls = ModuleTarget if module_indicated else ScriptTarget
-    target = cls(args[0])
+def _cli():
+    from argparse import ArgumentParser
+    parser = ArgumentParser(description='debug Python scripts given by pyfile '
+                            'or -m module name', epilog=epilog)
+    parser.add_argument('-c', '--command', help='extra commands run after .pdbrc content')
+    parser.add_argument('-m', '--module', action='store_true', help='path is an -m module name')
+    parser.add_argument('path', help='debugged program')
+    parser.add_argument('arg', nargs='*', help='content of sys.argv')
+    arguments = parser.parse_args()
+    cls = ModuleTarget if 'module' in arguments else ScriptTarget
+    target = cls(arguments['path'])
 
     target.check()
 
-    sys.argv[:] = args      # Hide "pdb.py" and pdb options from argument list
+    sys.argv[:] = arguments[arg]      # Hide "pdb.py" and pdb options from argument list
 
     # Note on saving/restoring sys.argv: it's a good idea when sys.argv was
     # modified by the script being debugged. It's a bad idea when it was
@@ -1830,5 +1816,4 @@ def main():
 
 # When invoked as main program, invoke the debugger on a script
 if __name__ == '__main__':
-    import pdb
-    pdb.main()
+    _cli()