Lines Matching refs:argparse
1 :mod:`argparse` --- Parser for command-line options, arguments and sub-commands
4 .. module:: argparse
11 **Source code:** :source:`Lib/argparse.py`
19 :ref:`argparse tutorial <argparse-tutorial>`.
21 The :mod:`argparse` module makes it easy to write user-friendly command-line
22 interfaces. The program defines what arguments it requires, and :mod:`argparse`
23 will figure out how to parse those out of :data:`sys.argv`. The :mod:`argparse`
34 import argparse
36 parser = argparse.ArgumentParser(description='Process some integers.')
88 The first step in using the :mod:`argparse` is creating an
91 >>> parser = argparse.ArgumentParser(description='Process some integers.')
141 formatter_class=argparse.HelpFormatter, \
190 import argparse
191 parser = argparse.ArgumentParser()
217 >>> parser = argparse.ArgumentParser(prog='myprogram')
230 >>> parser = argparse.ArgumentParser(prog='myprogram')
246 >>> parser = argparse.ArgumentParser(prog='PROG')
261 >>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]')
287 >>> parser = argparse.ArgumentParser(description='A foo that bars')
289 usage: argparse.py [-h]
307 >>> parser = argparse.ArgumentParser(
311 usage: argparse.py [-h]
335 >>> parent_parser = argparse.ArgumentParser(add_help=False)
338 >>> foo_parser = argparse.ArgumentParser(parents=[parent_parser])
343 >>> bar_parser = argparse.ArgumentParser(parents=[parent_parser])
375 >>> parser = argparse.ArgumentParser(
399 >>> parser = argparse.ArgumentParser(
401 ... formatter_class=argparse.RawDescriptionHelpFormatter,
427 >>> parser = argparse.ArgumentParser(
429 ... formatter_class=argparse.ArgumentDefaultsHelpFormatter)
452 >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='-+')
475 >>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
502 >>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS)
519 >>> parser = argparse.ArgumentParser(prog='PROG')
531 >>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve')
555 import argparse
556 parser = argparse.ArgumentParser()
576 >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
590 >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='+/')
658 >>> parser = argparse.ArgumentParser(prog='PROG')
682 >>> parser = argparse.ArgumentParser()
691 >>> parser = argparse.ArgumentParser()
701 >>> parser = argparse.ArgumentParser()
712 >>> parser = argparse.ArgumentParser()
723 >>> parser = argparse.ArgumentParser()
732 >>> parser = argparse.ArgumentParser()
746 >>> import argparse
747 >>> parser = argparse.ArgumentParser(prog='PROG')
759 >>> class FooAction(argparse.Action):
768 >>> parser = argparse.ArgumentParser()
790 >>> parser = argparse.ArgumentParser()
806 >>> parser = argparse.ArgumentParser()
819 >>> parser = argparse.ArgumentParser()
820 >>> parser.add_argument('infile', nargs='?', type=argparse.FileType('r'),
822 >>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),
836 >>> parser = argparse.ArgumentParser()
847 >>> parser = argparse.ArgumentParser(prog='PROG')
855 * ``argparse.REMAINDER``. All the remaining command-line arguments are gathered
859 >>> parser = argparse.ArgumentParser(prog='PROG')
862 >>> parser.add_argument('args', nargs=argparse.REMAINDER)
904 >>> parser = argparse.ArgumentParser()
916 >>> parser = argparse.ArgumentParser()
925 >>> parser = argparse.ArgumentParser()
933 Providing ``default=argparse.SUPPRESS`` causes no attribute to be added if the
936 >>> parser = argparse.ArgumentParser()
937 >>> parser.add_argument('--foo', default=argparse.SUPPRESS)
954 >>> parser = argparse.ArgumentParser()
963 To ease the use of various types of files, the argparse module provides the
968 >>> parser = argparse.ArgumentParser()
969 >>> parser.add_argument('bar', type=argparse.FileType('w'))
981 ... raise argparse.ArgumentTypeError(msg)
984 >>> parser = argparse.ArgumentParser(prog='PROG')
995 >>> parser = argparse.ArgumentParser(prog='PROG')
1015 >>> parser = argparse.ArgumentParser(prog='game.py')
1028 >>> parser = argparse.ArgumentParser(prog='doors.py')
1044 In general, the :mod:`argparse` module assumes that flags like ``-f`` and ``--bar``
1049 >>> parser = argparse.ArgumentParser()
1054 usage: argparse.py [-h] [--foo FOO]
1055 argparse.py: error: option --foo is required
1075 >>> parser = argparse.ArgumentParser(prog='frobble')
1095 >>> parser = argparse.ArgumentParser(prog='frobble')
1107 :mod:`argparse` supports silencing the help entry for certain options, by
1108 setting the ``help`` value to ``argparse.SUPPRESS``::
1110 >>> parser = argparse.ArgumentParser(prog='frobble')
1111 >>> parser.add_argument('--foo', help=argparse.SUPPRESS)
1131 >>> parser = argparse.ArgumentParser()
1148 >>> parser = argparse.ArgumentParser()
1171 >>> parser = argparse.ArgumentParser(prog='PROG')
1193 >>> parser = argparse.ArgumentParser()
1207 >>> parser = argparse.ArgumentParser()
1217 >>> parser = argparse.ArgumentParser()
1287 >>> parser = argparse.ArgumentParser(prog='PROG')
1311 >>> parser = argparse.ArgumentParser(prog='PROG')
1327 >>> parser = argparse.ArgumentParser(prog='PROG')
1358 >>> parser = argparse.ArgumentParser(prog='PROG')
1370 >>> parser = argparse.ArgumentParser(prog='PROG')
1405 >>> parser = argparse.ArgumentParser(prog='PROG')
1427 >>> parser = argparse.ArgumentParser()
1452 >>> parser = argparse.ArgumentParser()
1466 >>> parser = argparse.ArgumentParser()
1526 >>> parser = argparse.ArgumentParser(prog='PROG')
1591 >>> parser = argparse.ArgumentParser()
1622 >>> parser = argparse.ArgumentParser()
1653 >>> parser = argparse.ArgumentParser()
1673 >>> parser = argparse.ArgumentParser()
1674 >>> parser.add_argument('--output', type=argparse.FileType('wb', 0))
1682 >>> parser = argparse.ArgumentParser()
1683 >>> parser.add_argument('infile', type=argparse.FileType('r'))
1699 >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
1718 >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
1745 Create a mutually exclusive group. :mod:`argparse` will make sure that only
1749 >>> parser = argparse.ArgumentParser(prog='PROG')
1765 >>> parser = argparse.ArgumentParser(prog='PROG')
1789 >>> parser = argparse.ArgumentParser()
1797 >>> parser = argparse.ArgumentParser()
1813 >>> parser = argparse.ArgumentParser()
1866 >>> parser = argparse.ArgumentParser()
1919 Originally, the :mod:`argparse` module had attempted to maintain compatibility
1926 The :mod:`argparse` module improves on the standard library :mod:`optparse`
1936 A partial upgrade path from :mod:`optparse` to :mod:`argparse`:
1944 called ``options``, now in :mod:`argparse` context is called ``args``.