Lines Matching full:argparse
1 :mod:`argparse` --- Parser for command-line options, arguments and sub-commands
4 .. module:: argparse
12 **Source code:** :source:`Lib/argparse.py`
20 :ref:`argparse tutorial <argparse-tutorial>`.
22 The :mod:`argparse` module makes it easy to write user-friendly command-line
23 interfaces. The program defines what arguments it requires, and :mod:`argparse`
24 will figure out how to parse those out of :data:`sys.argv`. The :mod:`argparse`
32 The :mod:`argparse` module's support for command-line interfaces is built
33 around an instance of :class:`argparse.ArgumentParser`. It is a container for
36 parser = argparse.ArgumentParser(
51 the extracted data in a :class:`argparse.Namespace` object::
72 …t an argument to the given type :class:`int`, :class:`float`, ``argparse.FileType('w')``, …
82 import argparse
84 parser = argparse.ArgumentParser(description='Process some integers.')
136 The first step in using the :mod:`argparse` is creating an
139 >>> parser = argparse.ArgumentParser(description='Process some integers.')
189 formatter_class=argparse.HelpFormatter, \
258 import argparse
259 parser = argparse.ArgumentParser()
285 >>> parser = argparse.ArgumentParser(prog='myprogram')
298 >>> parser = argparse.ArgumentParser(prog='myprogram')
314 >>> parser = argparse.ArgumentParser(prog='PROG')
329 >>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]')
357 >>> parser = argparse.ArgumentParser(description='A foo that bars')
359 usage: argparse.py [-h]
377 >>> parser = argparse.ArgumentParser(
381 usage: argparse.py [-h]
405 >>> parent_parser = argparse.ArgumentParser(add_help=False)
408 >>> foo_parser = argparse.ArgumentParser(parents=[parent_parser])
413 >>> bar_parser = argparse.ArgumentParser(parents=[parent_parser])
447 >>> parser = argparse.ArgumentParser(
471 >>> parser = argparse.ArgumentParser(
473 ... formatter_class=argparse.RawDescriptionHelpFormatter,
501 >>> parser = argparse.ArgumentParser(
503 ... formatter_class=argparse.ArgumentDefaultsHelpFormatter)
520 >>> parser = argparse.ArgumentParser(
522 ... formatter_class=argparse.MetavarTypeHelpFormatter)
545 >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='-+')
568 >>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
595 >>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS)
614 >>> parser = argparse.ArgumentParser(prog='PROG', allow_abbrev=False)
632 >>> parser = argparse.ArgumentParser(prog='PROG')
644 >>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve')
668 import argparse
669 parser = argparse.ArgumentParser()
689 >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
703 >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='+/')
720 >>> parser = argparse.ArgumentParser(exit_on_error=False)
725 ... except argparse.ArgumentError:
796 >>> parser = argparse.ArgumentParser(prog='PROG')
822 >>> parser = argparse.ArgumentParser()
832 >>> parser = argparse.ArgumentParser()
842 >>> parser = argparse.ArgumentParser()
855 >>> parser = argparse.ArgumentParser()
866 >>> parser = argparse.ArgumentParser()
875 >>> parser = argparse.ArgumentParser()
891 >>> import argparse
892 >>> parser = argparse.ArgumentParser(prog='PROG')
901 >>> parser = argparse.ArgumentParser()
910 is available in ``argparse`` and adds support for boolean actions such as
913 >>> import argparse
914 >>> parser = argparse.ArgumentParser()
915 >>> parser.add_argument('--foo', action=argparse.BooleanOptionalAction)
927 >>> class FooAction(argparse.Action):
936 >>> parser = argparse.ArgumentParser()
961 >>> parser = argparse.ArgumentParser()
970 .. index:: single: ? (question mark); in argparse module
979 >>> parser = argparse.ArgumentParser()
992 >>> parser = argparse.ArgumentParser()
993 >>> parser.add_argument('infile', nargs='?', type=argparse.FileType('r'),
995 >>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),
1004 .. index:: single: * (asterisk); in argparse module
1011 >>> parser = argparse.ArgumentParser()
1018 .. index:: single: + (plus); in argparse module
1024 >>> parser = argparse.ArgumentParser(prog='PROG')
1077 >>> parser = argparse.ArgumentParser()
1087 >>> parser = argparse.ArgumentParser()
1089 >>> parser.parse_args([], namespace=argparse.Namespace(foo=101))
1097 >>> parser = argparse.ArgumentParser()
1106 >>> parser = argparse.ArgumentParser()
1114 Providing ``default=argparse.SUPPRESS`` causes no attribute to be added if the
1117 >>> parser = argparse.ArgumentParser()
1118 >>> parser.add_argument('--foo', default=argparse.SUPPRESS)
1148 import argparse
1151 parser = argparse.ArgumentParser()
1157 parser.add_argument('dest_file', type=argparse.FileType('w', encoding='latin-1'))
1167 >>> parser = argparse.ArgumentParser()
1186 Even :class:`~argparse.FileType` has its limitations for use with the ``type``
1207 >>> parser = argparse.ArgumentParser(prog='game.py')
1220 >>> parser = argparse.ArgumentParser(prog='doors.py')
1245 In general, the :mod:`argparse` module assumes that flags like ``-f`` and ``--bar``
1250 >>> parser = argparse.ArgumentParser()
1278 >>> parser = argparse.ArgumentParser(prog='frobble')
1298 >>> parser = argparse.ArgumentParser(prog='frobble')
1313 :mod:`argparse` supports silencing the help entry for certain options, by
1314 setting the ``help`` value to ``argparse.SUPPRESS``::
1316 >>> parser = argparse.ArgumentParser(prog='frobble')
1317 >>> parser.add_argument('--foo', help=argparse.SUPPRESS)
1339 >>> parser = argparse.ArgumentParser()
1356 >>> parser = argparse.ArgumentParser()
1379 >>> parser = argparse.ArgumentParser(prog='PROG')
1403 >>> parser = argparse.ArgumentParser()
1417 >>> parser = argparse.ArgumentParser()
1427 >>> parser = argparse.ArgumentParser()
1505 >>> parser = argparse.ArgumentParser(prog='PROG')
1529 >>> parser = argparse.ArgumentParser(prog='PROG')
1545 >>> parser = argparse.ArgumentParser(prog='PROG')
1576 >>> parser = argparse.ArgumentParser(prog='PROG')
1588 >>> parser = argparse.ArgumentParser(prog='PROG')
1623 >>> parser = argparse.ArgumentParser(prog='PROG')
1647 >>> parser = argparse.ArgumentParser()
1673 >>> parser = argparse.ArgumentParser()
1687 >>> parser = argparse.ArgumentParser()
1750 >>> parser = argparse.ArgumentParser(prog='PROG')
1815 >>> parser = argparse.ArgumentParser()
1836 >>> parser = argparse.ArgumentParser()
1856 >>> parser = argparse.ArgumentParser()
1887 >>> parser = argparse.ArgumentParser()
1911 >>> parser = argparse.ArgumentParser()
1912 >>> parser.add_argument('--raw', type=argparse.FileType('wb', 0))
1913 >>> parser.add_argument('out', type=argparse.FileType('w', encoding='UTF-8'))
1921 >>> parser = argparse.ArgumentParser()
1922 >>> parser.add_argument('infile', type=argparse.FileType('r'))
1941 >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
1960 >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
1993 Create a mutually exclusive group. :mod:`argparse` will make sure that only
1997 >>> parser = argparse.ArgumentParser(prog='PROG')
2013 >>> parser = argparse.ArgumentParser(prog='PROG')
2043 >>> parser = argparse.ArgumentParser()
2051 >>> parser = argparse.ArgumentParser()
2067 >>> parser = argparse.ArgumentParser()
2120 >>> parser = argparse.ArgumentParser()
2150 class MyArgumentParser(argparse.ArgumentParser):
2164 class ErrorCatchingArgumentParser(argparse.ArgumentParser):
2187 These parsers do not support all the argparse features, and will raise
2198 >>> parser = argparse.ArgumentParser()
2219 Originally, the :mod:`argparse` module had attempted to maintain compatibility
2226 The :mod:`argparse` module improves on the standard library :mod:`optparse`
2236 A partial upgrade path from :mod:`optparse` to :mod:`argparse`:
2244 called ``options``, now in the :mod:`argparse` context is called ``args``.