Mercurial > cpython-lru_cache-weakref

annotate Lib/argparse.py @ 78233:bd2c167dfabc 2.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
#13922: argparse no longer incorrectly strips '--' after the first one. Patch by Jeff Knupp.
author R David Murray <rdmurray@bitdance.com>
date Sat, 21 Jul 2012 22:54:34 -0400
parents c9806f0aaefb
children 62b5667ef2f4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
59986
4ceb5dc35cc6 replace copy right notice with simple attribution
Benjamin Peterson <benjamin@python.org>
parents: 59423
diff changeset
1 # Author: Steven J. Bethard <steven.bethard@gmail.com>.
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
3 """Command-line parsing library
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
4
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
5 This module is an optparse-inspired command-line parsing library that:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
6
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
7 - handles both optional and positional arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
8 - produces highly informative usage messages
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
9 - supports parsers that dispatch to sub-parsers
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
10
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
11 The following is a simple usage example that sums integers from the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
12 command-line and writes the result to a file::
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
13
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
14 parser = argparse.ArgumentParser(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
15 description='sum the integers at the command line')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
16 parser.add_argument(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
17 'integers', metavar='int', nargs='+', type=int,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
18 help='an integer to be summed')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
19 parser.add_argument(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
20 '--log', default=sys.stdout, type=argparse.FileType('w'),
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
21 help='the file where the sum should be written')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
22 args = parser.parse_args()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
23 args.log.write('%s' % sum(args.integers))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
24 args.log.close()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
25
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
26 The module contains the following public classes:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
27
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
28 - ArgumentParser -- The main entry point for command-line parsing. As the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
29 example above shows, the add_argument() method is used to populate
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
30 the parser with actions for optional and positional arguments. Then
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
31 the parse_args() method is invoked to convert the args at the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
32 command-line into an object with attributes.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
33
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
34 - ArgumentError -- The exception raised by ArgumentParser objects when
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
35 there are errors with the parser's actions. Errors raised while
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
36 parsing the command-line are caught by ArgumentParser and emitted
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
37 as command-line messages.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
38
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
39 - FileType -- A factory for defining types of files to be created. As the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
40 example above shows, instances of FileType are typically passed as
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
41 the type= argument of add_argument() calls.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
42
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
43 - Action -- The base class for parser actions. Typically actions are
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
44 selected by passing strings like 'store_true' or 'append_const' to
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
45 the action= argument of add_argument(). However, for greater
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
46 customization of ArgumentParser actions, subclasses of Action may
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
47 be defined and passed as the action= argument.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
48
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
49 - HelpFormatter, RawDescriptionHelpFormatter, RawTextHelpFormatter,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
50 ArgumentDefaultsHelpFormatter -- Formatter classes which
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
51 may be passed as the formatter_class= argument to the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
52 ArgumentParser constructor. HelpFormatter is the default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
53 RawDescriptionHelpFormatter and RawTextHelpFormatter tell the parser
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
54 not to change the formatting for help text, and
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
55 ArgumentDefaultsHelpFormatter adds information about argument defaults
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
56 to the help.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
57
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
58 All other classes in this module are considered implementation details.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
59 (Also note that HelpFormatter and RawDescriptionHelpFormatter are only
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
60 considered public as object names -- the API of the formatter objects is
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
61 still considered an implementation detail.)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
62 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
63
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
64 __version__ = '1.1'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
65 __all__ = [
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
66 'ArgumentParser',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
67 'ArgumentError',
65864
493a2d407c94 Merged revisions 86086 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 63691
diff changeset
68 'ArgumentTypeError',
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
69 'FileType',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
70 'HelpFormatter',
65864
493a2d407c94 Merged revisions 86086 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 63691
diff changeset
71 'ArgumentDefaultsHelpFormatter',
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
72 'RawDescriptionHelpFormatter',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
73 'RawTextHelpFormatter',
65864
493a2d407c94 Merged revisions 86086 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 63691
diff changeset
74 'Namespace',
493a2d407c94 Merged revisions 86086 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 63691
diff changeset
75 'Action',
493a2d407c94 Merged revisions 86086 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 63691
diff changeset
76 'ONE_OR_MORE',
493a2d407c94 Merged revisions 86086 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 63691
diff changeset
77 'OPTIONAL',
493a2d407c94 Merged revisions 86086 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 63691
diff changeset
78 'PARSER',
493a2d407c94 Merged revisions 86086 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 63691
diff changeset
79 'REMAINDER',
493a2d407c94 Merged revisions 86086 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 63691
diff changeset
80 'SUPPRESS',
493a2d407c94 Merged revisions 86086 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 63691
diff changeset
81 'ZERO_OR_MORE',
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
82 ]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
83
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
84
69005
75ec20b4c50e Issue #9026: Fix order of argparse sub-commands in help messages. (Merged from 3.2.)
Steven Bethard <steven.bethard@gmail.com>
parents: 68969
diff changeset
85 import collections as _collections
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
86 import copy as _copy
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
87 import os as _os
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
88 import re as _re
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
89 import sys as _sys
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
90 import textwrap as _textwrap
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
91
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
92 from gettext import gettext as _
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
93
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
94
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
95 def _callable(obj):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
96 return hasattr(obj, '__call__') or hasattr(obj, '__bases__')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
97
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
98
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
99 SUPPRESS = '==SUPPRESS=='
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
100
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
101 OPTIONAL = '?'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
102 ZERO_OR_MORE = '*'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
103 ONE_OR_MORE = '+'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
104 PARSER = 'A...'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
105 REMAINDER = '...'
65888
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
106 _UNRECOGNIZED_ARGS_ATTR = '_unrecognized_args'
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
107
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
108 # =============================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
109 # Utility functions and classes
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
110 # =============================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
111
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
112 class _AttributeHolder(object):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
113 """Abstract base class that provides __repr__.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
114
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
115 The __repr__ method returns a string in the format::
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
116 ClassName(attr=name, attr=name, ...)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
117 The attributes are determined either by a class-level attribute,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
118 '_kwarg_names', or by inspecting the instance __dict__.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
119 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
120
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
121 def __repr__(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
122 type_name = type(self).__name__
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
123 arg_strings = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
124 for arg in self._get_args():
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
125 arg_strings.append(repr(arg))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
126 for name, value in self._get_kwargs():
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
127 arg_strings.append('%s=%r' % (name, value))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
128 return '%s(%s)' % (type_name, ', '.join(arg_strings))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
129
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
130 def _get_kwargs(self):
59281
eba942e77895 remove cross-version compatibility code
Benjamin Peterson <benjamin@python.org>
parents: 59280
diff changeset
131 return sorted(self.__dict__.items())
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
132
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
133 def _get_args(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
134 return []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
135
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
136
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
137 def _ensure_value(namespace, name, value):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
138 if getattr(namespace, name, None) is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
139 setattr(namespace, name, value)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
140 return getattr(namespace, name)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
141
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
142
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
143 # ===============
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
144 # Formatting Help
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
145 # ===============
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
146
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
147 class HelpFormatter(object):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
148 """Formatter for generating usage messages and argument help strings.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
149
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
150 Only the name of this class is considered a public API. All the methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
151 provided by the class are considered an implementation detail.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
152 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
153
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
154 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
155 prog,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
156 indent_increment=2,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
157 max_help_position=24,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
158 width=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
159
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
160 # default setting for width
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
161 if width is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
162 try:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
163 width = int(_os.environ['COLUMNS'])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
164 except (KeyError, ValueError):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
165 width = 80
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
166 width -= 2
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
167
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
168 self._prog = prog
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
169 self._indent_increment = indent_increment
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
170 self._max_help_position = max_help_position
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
171 self._width = width
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
172
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
173 self._current_indent = 0
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
174 self._level = 0
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
175 self._action_max_length = 0
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
176
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
177 self._root_section = self._Section(self, None)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
178 self._current_section = self._root_section
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
179
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
180 self._whitespace_matcher = _re.compile(r'\s+')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
181 self._long_break_matcher = _re.compile(r'\n\n\n+')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
182
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
183 # ===============================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
184 # Section and indentation methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
185 # ===============================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
186 def _indent(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
187 self._current_indent += self._indent_increment
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
188 self._level += 1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
189
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
190 def _dedent(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
191 self._current_indent -= self._indent_increment
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
192 assert self._current_indent >= 0, 'Indent decreased below 0.'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
193 self._level -= 1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
194
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
195 class _Section(object):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
196
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
197 def __init__(self, formatter, parent, heading=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
198 self.formatter = formatter
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
199 self.parent = parent
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
200 self.heading = heading
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
201 self.items = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
202
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
203 def format_help(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
204 # format the indented section
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
205 if self.parent is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
206 self.formatter._indent()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
207 join = self.formatter._join_parts
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
208 for func, args in self.items:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
209 func(*args)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
210 item_help = join([func(*args) for func, args in self.items])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
211 if self.parent is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
212 self.formatter._dedent()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
213
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
214 # return nothing if the section was empty
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
215 if not item_help:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
216 return ''
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
217
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
218 # add the heading if the section was non-empty
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
219 if self.heading is not SUPPRESS and self.heading is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
220 current_indent = self.formatter._current_indent
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
221 heading = '%*s%s:\n' % (current_indent, '', self.heading)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
222 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
223 heading = ''
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
224
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
225 # join the section-initial newline, the heading and the help
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
226 return join(['\n', heading, item_help, '\n'])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
227
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
228 def _add_item(self, func, args):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
229 self._current_section.items.append((func, args))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
230
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
231 # ========================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
232 # Message building methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
233 # ========================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
234 def start_section(self, heading):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
235 self._indent()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
236 section = self._Section(self, self._current_section, heading)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
237 self._add_item(section.format_help, [])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
238 self._current_section = section
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
239
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
240 def end_section(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
241 self._current_section = self._current_section.parent
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
242 self._dedent()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
243
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
244 def add_text(self, text):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
245 if text is not SUPPRESS and text is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
246 self._add_item(self._format_text, [text])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
247
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
248 def add_usage(self, usage, actions, groups, prefix=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
249 if usage is not SUPPRESS:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
250 args = usage, actions, groups, prefix
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
251 self._add_item(self._format_usage, args)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
252
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
253 def add_argument(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
254 if action.help is not SUPPRESS:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
255
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
256 # find all invocations
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
257 get_invocation = self._format_action_invocation
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
258 invocations = [get_invocation(action)]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
259 for subaction in self._iter_indented_subactions(action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
260 invocations.append(get_invocation(subaction))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
261
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
262 # update the maximum item length
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
263 invocation_length = max([len(s) for s in invocations])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
264 action_length = invocation_length + self._current_indent
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
265 self._action_max_length = max(self._action_max_length,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
266 action_length)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
268 # add the item to the list
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
269 self._add_item(self._format_action, [action])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
270
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
271 def add_arguments(self, actions):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
272 for action in actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
273 self.add_argument(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
274
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
275 # =======================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
276 # Help-formatting methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
277 # =======================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
278 def format_help(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
279 help = self._root_section.format_help()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
280 if help:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
281 help = self._long_break_matcher.sub('\n\n', help)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
282 help = help.strip('\n') + '\n'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
283 return help
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
284
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
285 def _join_parts(self, part_strings):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
286 return ''.join([part
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
287 for part in part_strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
288 if part and part is not SUPPRESS])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
289
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
290 def _format_usage(self, usage, actions, groups, prefix):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
291 if prefix is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
292 prefix = _('usage: ')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
293
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
294 # if usage is specified, use that
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
295 if usage is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
296 usage = usage % dict(prog=self._prog)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
297
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
298 # if no optionals or positionals are available, usage is just prog
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
299 elif usage is None and not actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
300 usage = '%(prog)s' % dict(prog=self._prog)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
301
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
302 # if optionals and positionals are available, calculate usage
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
303 elif usage is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
304 prog = '%(prog)s' % dict(prog=self._prog)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
305
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
306 # split optionals from positionals
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
307 optionals = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
308 positionals = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
309 for action in actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
310 if action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
311 optionals.append(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
312 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
313 positionals.append(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
314
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
315 # build full usage string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
316 format = self._format_actions_usage
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
317 action_usage = format(optionals + positionals, groups)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
318 usage = ' '.join([s for s in [prog, action_usage] if s])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
319
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
320 # wrap the usage parts if it's too long
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
321 text_width = self._width - self._current_indent
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
322 if len(prefix) + len(usage) > text_width:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
323
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
324 # break usage into wrappable parts
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
325 part_regexp = r'\(.*?\)+|\[.*?\]+|\S+'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
326 opt_usage = format(optionals, groups)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
327 pos_usage = format(positionals, groups)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
328 opt_parts = _re.findall(part_regexp, opt_usage)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
329 pos_parts = _re.findall(part_regexp, pos_usage)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
330 assert ' '.join(opt_parts) == opt_usage
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
331 assert ' '.join(pos_parts) == pos_usage
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
332
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
333 # helper for wrapping lines
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
334 def get_lines(parts, indent, prefix=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
335 lines = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
336 line = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
337 if prefix is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
338 line_len = len(prefix) - 1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
339 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
340 line_len = len(indent) - 1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
341 for part in parts:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
342 if line_len + 1 + len(part) > text_width:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
343 lines.append(indent + ' '.join(line))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
344 line = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
345 line_len = len(indent) - 1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
346 line.append(part)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
347 line_len += len(part) + 1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
348 if line:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
349 lines.append(indent + ' '.join(line))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
350 if prefix is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
351 lines[0] = lines[0][len(indent):]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
352 return lines
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
353
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
354 # if prog is short, follow it with optionals or positionals
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
355 if len(prefix) + len(prog) <= 0.75 * text_width:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
356 indent = ' ' * (len(prefix) + len(prog) + 1)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
357 if opt_parts:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
358 lines = get_lines([prog] + opt_parts, indent, prefix)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
359 lines.extend(get_lines(pos_parts, indent))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
360 elif pos_parts:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
361 lines = get_lines([prog] + pos_parts, indent, prefix)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
362 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
363 lines = [prog]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
364
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
365 # if prog is long, put it on its own line
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
366 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
367 indent = ' ' * len(prefix)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
368 parts = opt_parts + pos_parts
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
369 lines = get_lines(parts, indent)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
370 if len(lines) > 1:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
371 lines = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
372 lines.extend(get_lines(opt_parts, indent))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
373 lines.extend(get_lines(pos_parts, indent))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
374 lines = [prog] + lines
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
375
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
376 # join lines into usage
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
377 usage = '\n'.join(lines)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
378
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
379 # prefix with 'usage:'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
380 return '%s%s\n\n' % (prefix, usage)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
381
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
382 def _format_actions_usage(self, actions, groups):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
383 # find group indices and identify actions in groups
59281
eba942e77895 remove cross-version compatibility code
Benjamin Peterson <benjamin@python.org>
parents: 59280
diff changeset
384 group_actions = set()
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
385 inserts = {}
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
386 for group in groups:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
387 try:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
388 start = actions.index(group._group_actions[0])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
389 except ValueError:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
390 continue
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
391 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
392 end = start + len(group._group_actions)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
393 if actions[start:end] == group._group_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
394 for action in group._group_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
395 group_actions.add(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
396 if not group.required:
65870
5952b937ab9a Merged revisions 86092 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65868
diff changeset
397 if start in inserts:
5952b937ab9a Merged revisions 86092 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65868
diff changeset
398 inserts[start] += ' ['
5952b937ab9a Merged revisions 86092 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65868
diff changeset
399 else:
5952b937ab9a Merged revisions 86092 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65868
diff changeset
400 inserts[start] = '['
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
401 inserts[end] = ']'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
402 else:
65870
5952b937ab9a Merged revisions 86092 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65868
diff changeset
403 if start in inserts:
5952b937ab9a Merged revisions 86092 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65868
diff changeset
404 inserts[start] += ' ('
5952b937ab9a Merged revisions 86092 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65868
diff changeset
405 else:
5952b937ab9a Merged revisions 86092 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65868
diff changeset
406 inserts[start] = '('
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
407 inserts[end] = ')'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
408 for i in range(start + 1, end):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
409 inserts[i] = '|'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
410
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
411 # collect all actions format strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
412 parts = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
413 for i, action in enumerate(actions):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
414
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
415 # suppressed arguments are marked with None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
416 # remove | separators for suppressed arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
417 if action.help is SUPPRESS:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
418 parts.append(None)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
419 if inserts.get(i) == '|':
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
420 inserts.pop(i)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
421 elif inserts.get(i + 1) == '|':
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
422 inserts.pop(i + 1)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
423
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
424 # produce all arg strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
425 elif not action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
426 part = self._format_args(action, action.dest)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
427
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
428 # if it's in a group, strip the outer []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
429 if action in group_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
430 if part[0] == '[' and part[-1] == ']':
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
431 part = part[1:-1]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
432
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
433 # add the action string to the list
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
434 parts.append(part)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
435
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
436 # produce the first way to invoke the option in brackets
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
437 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
438 option_string = action.option_strings[0]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
439
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
440 # if the Optional doesn't take a value, format is:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
441 # -s or --long
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
442 if action.nargs == 0:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
443 part = '%s' % option_string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
444
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
445 # if the Optional takes a value, format is:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
446 # -s ARGS or --long ARGS
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
447 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
448 default = action.dest.upper()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
449 args_string = self._format_args(action, default)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
450 part = '%s %s' % (option_string, args_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
451
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
452 # make it look optional if it's not required or in a group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
453 if not action.required and action not in group_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
454 part = '[%s]' % part
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
455
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
456 # add the action string to the list
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
457 parts.append(part)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
458
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
459 # insert things at the necessary indices
59281
eba942e77895 remove cross-version compatibility code
Benjamin Peterson <benjamin@python.org>
parents: 59280
diff changeset
460 for i in sorted(inserts, reverse=True):
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
461 parts[i:i] = [inserts[i]]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
462
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
463 # join all the action items with spaces
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
464 text = ' '.join([item for item in parts if item is not None])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
465
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
466 # clean up separators for mutually exclusive groups
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
467 open = r'[\[(]'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
468 close = r'[\])]'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
469 text = _re.sub(r'(%s) ' % open, r'\1', text)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
470 text = _re.sub(r' (%s)' % close, r'\1', text)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
471 text = _re.sub(r'%s *%s' % (open, close), r'', text)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
472 text = _re.sub(r'\(([^|]*)\)', r'\1', text)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
473 text = text.strip()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
474
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
475 # return the text
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
476 return text
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
477
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
478 def _format_text(self, text):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
479 if '%(prog)' in text:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
480 text = text % dict(prog=self._prog)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
481 text_width = self._width - self._current_indent
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
482 indent = ' ' * self._current_indent
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
483 return self._fill_text(text, text_width, indent) + '\n\n'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
484
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
485 def _format_action(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
486 # determine the required width and the entry label
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
487 help_position = min(self._action_max_length + 2,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
488 self._max_help_position)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
489 help_width = self._width - help_position
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
490 action_width = help_position - self._current_indent - 2
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
491 action_header = self._format_action_invocation(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
492
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
493 # ho nelp; start on same line and add a final newline
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
494 if not action.help:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
495 tup = self._current_indent, '', action_header
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
496 action_header = '%*s%s\n' % tup
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
497
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
498 # short action name; start on the same line and pad two spaces
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
499 elif len(action_header) <= action_width:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
500 tup = self._current_indent, '', action_width, action_header
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
501 action_header = '%*s%-*s ' % tup
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
502 indent_first = 0
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
503
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
504 # long action name; start on the next line
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
505 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
506 tup = self._current_indent, '', action_header
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
507 action_header = '%*s%s\n' % tup
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
508 indent_first = help_position
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
509
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
510 # collect the pieces of the action help
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
511 parts = [action_header]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
512
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
513 # if there was help for the action, add lines of help text
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
514 if action.help:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
515 help_text = self._expand_help(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
516 help_lines = self._split_lines(help_text, help_width)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
517 parts.append('%*s%s\n' % (indent_first, '', help_lines[0]))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
518 for line in help_lines[1:]:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
519 parts.append('%*s%s\n' % (help_position, '', line))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
520
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
521 # or add a newline if the description doesn't end with one
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
522 elif not action_header.endswith('\n'):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
523 parts.append('\n')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
524
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
525 # if there are any sub-actions, add their help as well
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
526 for subaction in self._iter_indented_subactions(action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
527 parts.append(self._format_action(subaction))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
528
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
529 # return a single string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
530 return self._join_parts(parts)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
531
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
532 def _format_action_invocation(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
533 if not action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
534 metavar, = self._metavar_formatter(action, action.dest)(1)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
535 return metavar
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
536
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
537 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
538 parts = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
539
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
540 # if the Optional doesn't take a value, format is:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
541 # -s, --long
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
542 if action.nargs == 0:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
543 parts.extend(action.option_strings)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
544
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
545 # if the Optional takes a value, format is:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
546 # -s ARGS, --long ARGS
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
547 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
548 default = action.dest.upper()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
549 args_string = self._format_args(action, default)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
550 for option_string in action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
551 parts.append('%s %s' % (option_string, args_string))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
552
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
553 return ', '.join(parts)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
554
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
555 def _metavar_formatter(self, action, default_metavar):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
556 if action.metavar is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
557 result = action.metavar
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
558 elif action.choices is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
559 choice_strs = [str(choice) for choice in action.choices]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
560 result = '{%s}' % ','.join(choice_strs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
561 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
562 result = default_metavar
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
563
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
564 def format(tuple_size):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
565 if isinstance(result, tuple):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
566 return result
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
567 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
568 return (result, ) * tuple_size
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
569 return format
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
570
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
571 def _format_args(self, action, default_metavar):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
572 get_metavar = self._metavar_formatter(action, default_metavar)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
573 if action.nargs is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
574 result = '%s' % get_metavar(1)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
575 elif action.nargs == OPTIONAL:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
576 result = '[%s]' % get_metavar(1)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
577 elif action.nargs == ZERO_OR_MORE:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
578 result = '[%s [%s ...]]' % get_metavar(2)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
579 elif action.nargs == ONE_OR_MORE:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
580 result = '%s [%s ...]' % get_metavar(2)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
581 elif action.nargs == REMAINDER:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
582 result = '...'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
583 elif action.nargs == PARSER:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
584 result = '%s ...' % get_metavar(1)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
585 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
586 formats = ['%s' for _ in range(action.nargs)]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
587 result = ' '.join(formats) % get_metavar(action.nargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
588 return result
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
589
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
590 def _expand_help(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
591 params = dict(vars(action), prog=self._prog)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
592 for name in list(params):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
593 if params[name] is SUPPRESS:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
594 del params[name]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
595 for name in list(params):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
596 if hasattr(params[name], '__name__'):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
597 params[name] = params[name].__name__
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
598 if params.get('choices') is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
599 choices_str = ', '.join([str(c) for c in params['choices']])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
600 params['choices'] = choices_str
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
601 return self._get_help_string(action) % params
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
602
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
603 def _iter_indented_subactions(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
604 try:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
605 get_subactions = action._get_subactions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
606 except AttributeError:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
607 pass
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
608 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
609 self._indent()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
610 for subaction in get_subactions():
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
611 yield subaction
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
612 self._dedent()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
613
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
614 def _split_lines(self, text, width):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
615 text = self._whitespace_matcher.sub(' ', text).strip()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
616 return _textwrap.wrap(text, width)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
617
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
618 def _fill_text(self, text, width, indent):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
619 text = self._whitespace_matcher.sub(' ', text).strip()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
620 return _textwrap.fill(text, width, initial_indent=indent,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
621 subsequent_indent=indent)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
622
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
623 def _get_help_string(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
624 return action.help
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
625
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
626
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
627 class RawDescriptionHelpFormatter(HelpFormatter):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
628 """Help message formatter which retains any formatting in descriptions.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
629
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
630 Only the name of this class is considered a public API. All the methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
631 provided by the class are considered an implementation detail.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
632 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
633
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
634 def _fill_text(self, text, width, indent):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
635 return ''.join([indent + line for line in text.splitlines(True)])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
636
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
637
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
638 class RawTextHelpFormatter(RawDescriptionHelpFormatter):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
639 """Help message formatter which retains formatting of all help text.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
640
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
641 Only the name of this class is considered a public API. All the methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
642 provided by the class are considered an implementation detail.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
643 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
644
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
645 def _split_lines(self, text, width):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
646 return text.splitlines()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
647
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
648
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
649 class ArgumentDefaultsHelpFormatter(HelpFormatter):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
650 """Help message formatter which adds default values to argument help.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
651
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
652 Only the name of this class is considered a public API. All the methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
653 provided by the class are considered an implementation detail.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
654 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
655
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
656 def _get_help_string(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
657 help = action.help
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
658 if '%(default)' not in action.help:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
659 if action.default is not SUPPRESS:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
660 defaulting_nargs = [OPTIONAL, ZERO_OR_MORE]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
661 if action.option_strings or action.nargs in defaulting_nargs:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
662 help += ' (default: %(default)s)'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
663 return help
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
664
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
665
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
666 # =====================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
667 # Options and Arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
668 # =====================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
669
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
670 def _get_action_name(argument):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
671 if argument is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
672 return None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
673 elif argument.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
674 return '/'.join(argument.option_strings)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
675 elif argument.metavar not in (None, SUPPRESS):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
676 return argument.metavar
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
677 elif argument.dest not in (None, SUPPRESS):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
678 return argument.dest
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
679 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
680 return None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
681
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
682
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
683 class ArgumentError(Exception):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
684 """An error from creating or using an argument (optional or positional).
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
685
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
686 The string value of this exception is the message, augmented with
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
687 information about the argument that caused it.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
688 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
689
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
690 def __init__(self, argument, message):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
691 self.argument_name = _get_action_name(argument)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
692 self.message = message
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
693
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
694 def __str__(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
695 if self.argument_name is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
696 format = '%(message)s'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
697 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
698 format = 'argument %(argument_name)s: %(message)s'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
699 return format % dict(message=self.message,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
700 argument_name=self.argument_name)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
701
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
702
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
703 class ArgumentTypeError(Exception):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
704 """An error from trying to convert a command line string to a type."""
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
705 pass
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
706
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
707
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
708 # ==============
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
709 # Action classes
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
710 # ==============
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
711
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
712 class Action(_AttributeHolder):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
713 """Information about how to convert command line strings to Python objects.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
714
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
715 Action objects are used by an ArgumentParser to represent the information
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
716 needed to parse a single argument from one or more strings from the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
717 command line. The keyword arguments to the Action constructor are also
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
718 all attributes of Action instances.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
719
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
720 Keyword Arguments:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
721
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
722 - option_strings -- A list of command-line option strings which
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
723 should be associated with this action.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
724
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
725 - dest -- The name of the attribute to hold the created object(s)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
726
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
727 - nargs -- The number of command-line arguments that should be
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
728 consumed. By default, one argument will be consumed and a single
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
729 value will be produced. Other values include:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
730 - N (an integer) consumes N arguments (and produces a list)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
731 - '?' consumes zero or one arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
732 - '*' consumes zero or more arguments (and produces a list)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
733 - '+' consumes one or more arguments (and produces a list)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
734 Note that the difference between the default and nargs=1 is that
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
735 with the default, a single value will be produced, while with
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
736 nargs=1, a list containing a single value will be produced.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
737
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
738 - const -- The value to be produced if the option is specified and the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
739 option uses an action that takes no values.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
740
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
741 - default -- The value to be produced if the option is not specified.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
742
78228
905d9bdae970 #14391: clarify docstring discussion of Action's 'type' argument's value.
R David Murray <rdmurray@bitdance.com>
parents: 69125
diff changeset
743 - type -- A callable that accepts a single string argument, and
905d9bdae970 #14391: clarify docstring discussion of Action's 'type' argument's value.
R David Murray <rdmurray@bitdance.com>
parents: 69125
diff changeset
744 returns the converted value. The standard Python types str, int,
905d9bdae970 #14391: clarify docstring discussion of Action's 'type' argument's value.
R David Murray <rdmurray@bitdance.com>
parents: 69125
diff changeset
745 float, and complex are useful examples of such callables. If None,
905d9bdae970 #14391: clarify docstring discussion of Action's 'type' argument's value.
R David Murray <rdmurray@bitdance.com>
parents: 69125
diff changeset
746 str is used.
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
747
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
748 - choices -- A container of values that should be allowed. If not None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
749 after a command-line argument has been converted to the appropriate
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
750 type, an exception will be raised if it is not a member of this
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
751 collection.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
752
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
753 - required -- True if the action must always be specified at the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
754 command line. This is only meaningful for optional command-line
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
755 arguments.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
756
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
757 - help -- The help string describing the argument.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
758
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
759 - metavar -- The name to be used for the option's argument with the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
760 help string. If None, the 'dest' value will be used as the name.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
761 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
762
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
763 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
764 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
765 dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
766 nargs=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
767 const=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
768 default=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
769 type=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
770 choices=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
771 required=False,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
772 help=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
773 metavar=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
774 self.option_strings = option_strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
775 self.dest = dest
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
776 self.nargs = nargs
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
777 self.const = const
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
778 self.default = default
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
779 self.type = type
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
780 self.choices = choices
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
781 self.required = required
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
782 self.help = help
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
783 self.metavar = metavar
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
784
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
785 def _get_kwargs(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
786 names = [
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
787 'option_strings',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
788 'dest',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
789 'nargs',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
790 'const',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
791 'default',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
792 'type',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
793 'choices',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
794 'help',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
795 'metavar',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
796 ]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
797 return [(name, getattr(self, name)) for name in names]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
798
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
799 def __call__(self, parser, namespace, values, option_string=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
800 raise NotImplementedError(_('.__call__() not defined'))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
801
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
802
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
803 class _StoreAction(Action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
804
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
805 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
806 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
807 dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
808 nargs=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
809 const=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
810 default=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
811 type=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
812 choices=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
813 required=False,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
814 help=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
815 metavar=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
816 if nargs == 0:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
817 raise ValueError('nargs for store actions must be > 0; if you '
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
818 'have nothing to store, actions such as store '
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
819 'true or store const may be more appropriate')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
820 if const is not None and nargs != OPTIONAL:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
821 raise ValueError('nargs must be %r to supply const' % OPTIONAL)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
822 super(_StoreAction, self).__init__(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
823 option_strings=option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
824 dest=dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
825 nargs=nargs,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
826 const=const,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
827 default=default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
828 type=type,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
829 choices=choices,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
830 required=required,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
831 help=help,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
832 metavar=metavar)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
833
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
834 def __call__(self, parser, namespace, values, option_string=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
835 setattr(namespace, self.dest, values)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
836
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
837
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
838 class _StoreConstAction(Action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
839
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
840 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
841 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
842 dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
843 const,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
844 default=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
845 required=False,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
846 help=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
847 metavar=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
848 super(_StoreConstAction, self).__init__(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
849 option_strings=option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
850 dest=dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
851 nargs=0,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
852 const=const,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
853 default=default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
854 required=required,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
855 help=help)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
856
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
857 def __call__(self, parser, namespace, values, option_string=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
858 setattr(namespace, self.dest, self.const)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
859
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
860
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
861 class _StoreTrueAction(_StoreConstAction):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
862
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
863 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
864 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
865 dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
866 default=False,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
867 required=False,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
868 help=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
869 super(_StoreTrueAction, self).__init__(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
870 option_strings=option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
871 dest=dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
872 const=True,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
873 default=default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
874 required=required,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
875 help=help)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
876
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
877
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
878 class _StoreFalseAction(_StoreConstAction):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
879
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
880 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
881 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
882 dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
883 default=True,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
884 required=False,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
885 help=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
886 super(_StoreFalseAction, self).__init__(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
887 option_strings=option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
888 dest=dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
889 const=False,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
890 default=default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
891 required=required,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
892 help=help)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
893
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
894
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
895 class _AppendAction(Action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
896
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
897 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
898 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
899 dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
900 nargs=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
901 const=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
902 default=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
903 type=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
904 choices=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
905 required=False,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
906 help=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
907 metavar=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
908 if nargs == 0:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
909 raise ValueError('nargs for append actions must be > 0; if arg '
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
910 'strings are not supplying the value to append, '
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
911 'the append const action may be more appropriate')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
912 if const is not None and nargs != OPTIONAL:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
913 raise ValueError('nargs must be %r to supply const' % OPTIONAL)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
914 super(_AppendAction, self).__init__(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
915 option_strings=option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
916 dest=dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
917 nargs=nargs,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
918 const=const,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
919 default=default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
920 type=type,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
921 choices=choices,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
922 required=required,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
923 help=help,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
924 metavar=metavar)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
925
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
926 def __call__(self, parser, namespace, values, option_string=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
927 items = _copy.copy(_ensure_value(namespace, self.dest, []))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
928 items.append(values)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
929 setattr(namespace, self.dest, items)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
930
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
931
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
932 class _AppendConstAction(Action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
933
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
934 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
935 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
936 dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
937 const,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
938 default=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
939 required=False,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
940 help=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
941 metavar=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
942 super(_AppendConstAction, self).__init__(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
943 option_strings=option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
944 dest=dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
945 nargs=0,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
946 const=const,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
947 default=default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
948 required=required,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
949 help=help,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
950 metavar=metavar)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
951
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
952 def __call__(self, parser, namespace, values, option_string=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
953 items = _copy.copy(_ensure_value(namespace, self.dest, []))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
954 items.append(self.const)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
955 setattr(namespace, self.dest, items)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
956
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
957
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
958 class _CountAction(Action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
959
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
960 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
961 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
962 dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
963 default=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
964 required=False,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
965 help=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
966 super(_CountAction, self).__init__(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
967 option_strings=option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
968 dest=dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
969 nargs=0,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
970 default=default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
971 required=required,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
972 help=help)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
973
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
974 def __call__(self, parser, namespace, values, option_string=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
975 new_count = _ensure_value(namespace, self.dest, 0) + 1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
976 setattr(namespace, self.dest, new_count)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
977
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
978
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
979 class _HelpAction(Action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
980
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
981 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
982 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
983 dest=SUPPRESS,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
984 default=SUPPRESS,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
985 help=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
986 super(_HelpAction, self).__init__(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
987 option_strings=option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
988 dest=dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
989 default=default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
990 nargs=0,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
991 help=help)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
992
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
993 def __call__(self, parser, namespace, values, option_string=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
994 parser.print_help()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
995 parser.exit()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
996
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
997
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
998 class _VersionAction(Action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
999
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1000 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1001 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1002 version=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1003 dest=SUPPRESS,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1004 default=SUPPRESS,
61879
e64ea1619820 Fix default value for version help. Approved by Benjamin on python-dev: http://mail.python.org/pipermail/python-dev/2010-May/100231.html
Steven Bethard <steven.bethard@gmail.com>
parents: 59986
diff changeset
1005 help="show program's version number and exit"):
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1006 super(_VersionAction, self).__init__(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1007 option_strings=option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1008 dest=dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1009 default=default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1010 nargs=0,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1011 help=help)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1012 self.version = version
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1013
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1014 def __call__(self, parser, namespace, values, option_string=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1015 version = self.version
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1016 if version is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1017 version = parser.version
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1018 formatter = parser._get_formatter()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1019 formatter.add_text(version)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1020 parser.exit(message=formatter.format_help())
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1021
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1022
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1023 class _SubParsersAction(Action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1024
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1025 class _ChoicesPseudoAction(Action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1026
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1027 def __init__(self, name, help):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1028 sup = super(_SubParsersAction._ChoicesPseudoAction, self)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1029 sup.__init__(option_strings=[], dest=name, help=help)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1030
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1031 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1032 option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1033 prog,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1034 parser_class,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1035 dest=SUPPRESS,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1036 help=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1037 metavar=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1038
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1039 self._prog_prefix = prog
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1040 self._parser_class = parser_class
69005
75ec20b4c50e Issue #9026: Fix order of argparse sub-commands in help messages. (Merged from 3.2.)
Steven Bethard <steven.bethard@gmail.com>
parents: 68969
diff changeset
1041 self._name_parser_map = _collections.OrderedDict()
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1042 self._choices_actions = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1043
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1044 super(_SubParsersAction, self).__init__(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1045 option_strings=option_strings,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1046 dest=dest,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1047 nargs=PARSER,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1048 choices=self._name_parser_map,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1049 help=help,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1050 metavar=metavar)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1051
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1052 def add_parser(self, name, **kwargs):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1053 # set prog from the existing prefix
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1054 if kwargs.get('prog') is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1055 kwargs['prog'] = '%s %s' % (self._prog_prefix, name)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1056
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1057 # create a pseudo-action to hold the choice help
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1058 if 'help' in kwargs:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1059 help = kwargs.pop('help')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1060 choice_action = self._ChoicesPseudoAction(name, help)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1061 self._choices_actions.append(choice_action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1062
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1063 # create the parser and add it to the map
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1064 parser = self._parser_class(**kwargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1065 self._name_parser_map[name] = parser
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1066 return parser
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1067
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1068 def _get_subactions(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1069 return self._choices_actions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1070
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1071 def __call__(self, parser, namespace, values, option_string=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1072 parser_name = values[0]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1073 arg_strings = values[1:]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1074
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1075 # set the parser name if requested
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1076 if self.dest is not SUPPRESS:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1077 setattr(namespace, self.dest, parser_name)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1078
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1079 # select the parser
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1080 try:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1081 parser = self._name_parser_map[parser_name]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1082 except KeyError:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1083 tup = parser_name, ', '.join(self._name_parser_map)
66659
556df087de4f Merged revisions 86985 via svnmerge from
Éric Araujo <merwok@netwok.org>
parents: 65888
diff changeset
1084 msg = _('unknown parser %r (choices: %s)') % tup
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1085 raise ArgumentError(self, msg)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1086
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1087 # parse all the remaining options into the namespace
65888
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1088 # store any unrecognized options on the object, so that the top
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1089 # level parser can decide what to do with them
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1090 namespace, arg_strings = parser.parse_known_args(arg_strings, namespace)
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1091 if arg_strings:
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1092 vars(namespace).setdefault(_UNRECOGNIZED_ARGS_ATTR, [])
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1093 getattr(namespace, _UNRECOGNIZED_ARGS_ATTR).extend(arg_strings)
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1094
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1095
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1096 # ==============
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1097 # Type classes
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1098 # ==============
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1099
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1100 class FileType(object):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1101 """Factory for creating file object types
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1102
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1103 Instances of FileType are typically passed as type= arguments to the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1104 ArgumentParser add_argument() method.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1105
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1106 Keyword Arguments:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1107 - mode -- A string indicating how the file is to be opened. Accepts the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1108 same values as the builtin open() function.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1109 - bufsize -- The file's desired buffer size. Accepts the same values as
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1110 the builtin open() function.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1111 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1112
67744
7f9a98f766d7 Issue #9509: make argarse properly handle IOErrors raised by argparse.FileType. Approved by Georg in the tracker.
Steven Bethard <steven.bethard@gmail.com>
parents: 66659
diff changeset
1113 def __init__(self, mode='r', bufsize=-1):
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1114 self._mode = mode
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1115 self._bufsize = bufsize
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1116
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1117 def __call__(self, string):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1118 # the special argument "-" means sys.std{in,out}
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1119 if string == '-':
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1120 if 'r' in self._mode:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1121 return _sys.stdin
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1122 elif 'w' in self._mode:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1123 return _sys.stdout
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1124 else:
66659
556df087de4f Merged revisions 86985 via svnmerge from
Éric Araujo <merwok@netwok.org>
parents: 65888
diff changeset
1125 msg = _('argument "-" with mode %r') % self._mode
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1126 raise ValueError(msg)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1127
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1128 # all other arguments are used as file names
67744
7f9a98f766d7 Issue #9509: make argarse properly handle IOErrors raised by argparse.FileType. Approved by Georg in the tracker.
Steven Bethard <steven.bethard@gmail.com>
parents: 66659
diff changeset
1129 try:
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1130 return open(string, self._mode, self._bufsize)
67744
7f9a98f766d7 Issue #9509: make argarse properly handle IOErrors raised by argparse.FileType. Approved by Georg in the tracker.
Steven Bethard <steven.bethard@gmail.com>
parents: 66659
diff changeset
1131 except IOError as e:
7f9a98f766d7 Issue #9509: make argarse properly handle IOErrors raised by argparse.FileType. Approved by Georg in the tracker.
Steven Bethard <steven.bethard@gmail.com>
parents: 66659
diff changeset
1132 message = _("can't open '%s': %s")
7f9a98f766d7 Issue #9509: make argarse properly handle IOErrors raised by argparse.FileType. Approved by Georg in the tracker.
Steven Bethard <steven.bethard@gmail.com>
parents: 66659
diff changeset
1133 raise ArgumentTypeError(message % (string, e))
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1134
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1135 def __repr__(self):
67744
7f9a98f766d7 Issue #9509: make argarse properly handle IOErrors raised by argparse.FileType. Approved by Georg in the tracker.
Steven Bethard <steven.bethard@gmail.com>
parents: 66659
diff changeset
1136 args = self._mode, self._bufsize
7f9a98f766d7 Issue #9509: make argarse properly handle IOErrors raised by argparse.FileType. Approved by Georg in the tracker.
Steven Bethard <steven.bethard@gmail.com>
parents: 66659
diff changeset
1137 args_str = ', '.join(repr(arg) for arg in args if arg != -1)
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1138 return '%s(%s)' % (type(self).__name__, args_str)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1139
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1140 # ===========================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1141 # Optional and Positional Parsing
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1142 # ===========================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1143
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1144 class Namespace(_AttributeHolder):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1145 """Simple object for storing attributes.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1146
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1147 Implements equality by attribute names and values, and provides a simple
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1148 string representation.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1149 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1150
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1151 def __init__(self, **kwargs):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1152 for name in kwargs:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1153 setattr(self, name, kwargs[name])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1154
59423
0802bc973b32 eliminate py3k warnings in argparse
Benjamin Peterson <benjamin@python.org>
parents: 59281
diff changeset
1155 __hash__ = None
0802bc973b32 eliminate py3k warnings in argparse
Benjamin Peterson <benjamin@python.org>
parents: 59281
diff changeset
1156
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1157 def __eq__(self, other):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1158 return vars(self) == vars(other)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1159
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1160 def __ne__(self, other):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1161 return not (self == other)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1162
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1163 def __contains__(self, key):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1164 return key in self.__dict__
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1165
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1166
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1167 class _ActionsContainer(object):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1168
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1169 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1170 description,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1171 prefix_chars,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1172 argument_default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1173 conflict_handler):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1174 super(_ActionsContainer, self).__init__()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1175
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1176 self.description = description
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1177 self.argument_default = argument_default
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1178 self.prefix_chars = prefix_chars
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1179 self.conflict_handler = conflict_handler
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1180
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1181 # set up registries
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1182 self._registries = {}
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1183
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1184 # register actions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1185 self.register('action', None, _StoreAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1186 self.register('action', 'store', _StoreAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1187 self.register('action', 'store_const', _StoreConstAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1188 self.register('action', 'store_true', _StoreTrueAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1189 self.register('action', 'store_false', _StoreFalseAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1190 self.register('action', 'append', _AppendAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1191 self.register('action', 'append_const', _AppendConstAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1192 self.register('action', 'count', _CountAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1193 self.register('action', 'help', _HelpAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1194 self.register('action', 'version', _VersionAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1195 self.register('action', 'parsers', _SubParsersAction)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1196
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1197 # raise an exception if the conflict handler is invalid
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1198 self._get_handler()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1199
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1200 # action storage
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1201 self._actions = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1202 self._option_string_actions = {}
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1203
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1204 # groups
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1205 self._action_groups = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1206 self._mutually_exclusive_groups = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1207
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1208 # defaults storage
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1209 self._defaults = {}
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1210
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1211 # determines whether an "option" looks like a negative number
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1212 self._negative_number_matcher = _re.compile(r'^-\d+$|^-\d*\.\d+$')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1213
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1214 # whether or not there are any optionals that look like negative
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1215 # numbers -- uses a list so it can be shared and edited
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1216 self._has_negative_number_optionals = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1217
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1218 # ====================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1219 # Registration methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1220 # ====================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1221 def register(self, registry_name, value, object):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1222 registry = self._registries.setdefault(registry_name, {})
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1223 registry[value] = object
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1224
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1225 def _registry_get(self, registry_name, value, default=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1226 return self._registries[registry_name].get(value, default)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1227
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1228 # ==================================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1229 # Namespace default accessor methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1230 # ==================================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1231 def set_defaults(self, **kwargs):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1232 self._defaults.update(kwargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1233
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1234 # if these defaults match any existing arguments, replace
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1235 # the previous default on the object with the new one
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1236 for action in self._actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1237 if action.dest in kwargs:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1238 action.default = kwargs[action.dest]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1239
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1240 def get_default(self, dest):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1241 for action in self._actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1242 if action.dest == dest and action.default is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1243 return action.default
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1244 return self._defaults.get(dest, None)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1245
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1246
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1247 # =======================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1248 # Adding argument actions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1249 # =======================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1250 def add_argument(self, *args, **kwargs):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1251 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1252 add_argument(dest, ..., name=value, ...)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1253 add_argument(option_string, option_string, ..., name=value, ...)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1254 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1255
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1256 # if no positional args are supplied or only one is supplied and
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1257 # it doesn't look like an option string, parse a positional
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1258 # argument
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1259 chars = self.prefix_chars
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1260 if not args or len(args) == 1 and args[0][0] not in chars:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1261 if args and 'dest' in kwargs:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1262 raise ValueError('dest supplied twice for positional argument')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1263 kwargs = self._get_positional_kwargs(*args, **kwargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1264
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1265 # otherwise, we're adding an optional argument
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1266 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1267 kwargs = self._get_optional_kwargs(*args, **kwargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1268
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1269 # if no default was supplied, use the parser-level default
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1270 if 'default' not in kwargs:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1271 dest = kwargs['dest']
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1272 if dest in self._defaults:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1273 kwargs['default'] = self._defaults[dest]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1274 elif self.argument_default is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1275 kwargs['default'] = self.argument_default
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1276
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1277 # create the action object, and add it to the parser
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1278 action_class = self._pop_action_class(kwargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1279 if not _callable(action_class):
69125
f961e9179998 Issue #9347: Fix formatting for tuples in argparse type= error messages.
Steven Bethard <steven.bethard@gmail.com>
parents: 69005
diff changeset
1280 raise ValueError('unknown action "%s"' % (action_class,))
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1281 action = action_class(**kwargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1282
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1283 # raise an error if the action type is not callable
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1284 type_func = self._registry_get('type', action.type, action.type)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1285 if not _callable(type_func):
69125
f961e9179998 Issue #9347: Fix formatting for tuples in argparse type= error messages.
Steven Bethard <steven.bethard@gmail.com>
parents: 69005
diff changeset
1286 raise ValueError('%r is not callable' % (type_func,))
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1287
68969
4bb651eb7539 Issue #9348: Raise an early error if argparse nargs and metavar don't match. (Merge from 3.2.)
Steven Bethard <steven.bethard@gmail.com>
parents: 67824
diff changeset
1288 # raise an error if the metavar does not match the type
4bb651eb7539 Issue #9348: Raise an early error if argparse nargs and metavar don't match. (Merge from 3.2.)
Steven Bethard <steven.bethard@gmail.com>
parents: 67824
diff changeset
1289 if hasattr(self, "_get_formatter"):
4bb651eb7539 Issue #9348: Raise an early error if argparse nargs and metavar don't match. (Merge from 3.2.)
Steven Bethard <steven.bethard@gmail.com>
parents: 67824
diff changeset
1290 try:
4bb651eb7539 Issue #9348: Raise an early error if argparse nargs and metavar don't match. (Merge from 3.2.)
Steven Bethard <steven.bethard@gmail.com>
parents: 67824
diff changeset
1291 self._get_formatter()._format_args(action, None)
4bb651eb7539 Issue #9348: Raise an early error if argparse nargs and metavar don't match. (Merge from 3.2.)
Steven Bethard <steven.bethard@gmail.com>
parents: 67824
diff changeset
1292 except TypeError:
4bb651eb7539 Issue #9348: Raise an early error if argparse nargs and metavar don't match. (Merge from 3.2.)
Steven Bethard <steven.bethard@gmail.com>
parents: 67824
diff changeset
1293 raise ValueError("length of metavar tuple does not match nargs")
4bb651eb7539 Issue #9348: Raise an early error if argparse nargs and metavar don't match. (Merge from 3.2.)
Steven Bethard <steven.bethard@gmail.com>
parents: 67824
diff changeset
1294
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1295 return self._add_action(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1296
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1297 def add_argument_group(self, *args, **kwargs):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1298 group = _ArgumentGroup(self, *args, **kwargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1299 self._action_groups.append(group)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1300 return group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1301
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1302 def add_mutually_exclusive_group(self, **kwargs):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1303 group = _MutuallyExclusiveGroup(self, **kwargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1304 self._mutually_exclusive_groups.append(group)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1305 return group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1306
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1307 def _add_action(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1308 # resolve any conflicts
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1309 self._check_conflict(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1310
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1311 # add to actions list
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1312 self._actions.append(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1313 action.container = self
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1314
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1315 # index the action by any option strings it has
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1316 for option_string in action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1317 self._option_string_actions[option_string] = action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1318
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1319 # set the flag if any option strings look like negative numbers
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1320 for option_string in action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1321 if self._negative_number_matcher.match(option_string):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1322 if not self._has_negative_number_optionals:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1323 self._has_negative_number_optionals.append(True)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1324
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1325 # return the created action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1326 return action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1327
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1328 def _remove_action(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1329 self._actions.remove(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1330
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1331 def _add_container_actions(self, container):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1332 # collect groups by titles
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1333 title_group_map = {}
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1334 for group in self._action_groups:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1335 if group.title in title_group_map:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1336 msg = _('cannot merge actions - two groups are named %r')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1337 raise ValueError(msg % (group.title))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1338 title_group_map[group.title] = group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1339
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1340 # map each action to its group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1341 group_map = {}
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1342 for group in container._action_groups:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1343
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1344 # if a group with the title exists, use that, otherwise
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1345 # create a new group matching the container's group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1346 if group.title not in title_group_map:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1347 title_group_map[group.title] = self.add_argument_group(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1348 title=group.title,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1349 description=group.description,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1350 conflict_handler=group.conflict_handler)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1351
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1352 # map the actions to their new group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1353 for action in group._group_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1354 group_map[action] = title_group_map[group.title]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1355
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1356 # add container's mutually exclusive groups
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1357 # NOTE: if add_mutually_exclusive_group ever gains title= and
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1358 # description= then this code will need to be expanded as above
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1359 for group in container._mutually_exclusive_groups:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1360 mutex_group = self.add_mutually_exclusive_group(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1361 required=group.required)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1362
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1363 # map the actions to their new mutex group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1364 for action in group._group_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1365 group_map[action] = mutex_group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1366
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1367 # add all actions to this container or their group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1368 for action in container._actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1369 group_map.get(action, self)._add_action(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1370
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1371 def _get_positional_kwargs(self, dest, **kwargs):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1372 # make sure required is not specified
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1373 if 'required' in kwargs:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1374 msg = _("'required' is an invalid argument for positionals")
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1375 raise TypeError(msg)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1376
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1377 # mark positional arguments as required if at least one is
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1378 # always required
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1379 if kwargs.get('nargs') not in [OPTIONAL, ZERO_OR_MORE]:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1380 kwargs['required'] = True
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1381 if kwargs.get('nargs') == ZERO_OR_MORE and 'default' not in kwargs:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1382 kwargs['required'] = True
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1383
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1384 # return the keyword arguments with no option strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1385 return dict(kwargs, dest=dest, option_strings=[])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1386
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1387 def _get_optional_kwargs(self, *args, **kwargs):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1388 # determine short and long option strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1389 option_strings = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1390 long_option_strings = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1391 for option_string in args:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1392 # error on strings that don't start with an appropriate prefix
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1393 if not option_string[0] in self.prefix_chars:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1394 msg = _('invalid option string %r: '
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1395 'must start with a character %r')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1396 tup = option_string, self.prefix_chars
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1397 raise ValueError(msg % tup)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1398
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1399 # strings starting with two prefix characters are long options
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1400 option_strings.append(option_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1401 if option_string[0] in self.prefix_chars:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1402 if len(option_string) > 1:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1403 if option_string[1] in self.prefix_chars:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1404 long_option_strings.append(option_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1405
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1406 # infer destination, '--foo-bar' -> 'foo_bar' and '-x' -> 'x'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1407 dest = kwargs.pop('dest', None)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1408 if dest is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1409 if long_option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1410 dest_option_string = long_option_strings[0]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1411 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1412 dest_option_string = option_strings[0]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1413 dest = dest_option_string.lstrip(self.prefix_chars)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1414 if not dest:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1415 msg = _('dest= is required for options like %r')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1416 raise ValueError(msg % option_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1417 dest = dest.replace('-', '_')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1418
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1419 # return the updated keyword arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1420 return dict(kwargs, dest=dest, option_strings=option_strings)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1421
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1422 def _pop_action_class(self, kwargs, default=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1423 action = kwargs.pop('action', default)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1424 return self._registry_get('action', action, action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1425
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1426 def _get_handler(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1427 # determine function from conflict handler string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1428 handler_func_name = '_handle_conflict_%s' % self.conflict_handler
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1429 try:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1430 return getattr(self, handler_func_name)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1431 except AttributeError:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1432 msg = _('invalid conflict_resolution value: %r')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1433 raise ValueError(msg % self.conflict_handler)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1434
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1435 def _check_conflict(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1436
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1437 # find all options that conflict with this option
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1438 confl_optionals = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1439 for option_string in action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1440 if option_string in self._option_string_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1441 confl_optional = self._option_string_actions[option_string]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1442 confl_optionals.append((option_string, confl_optional))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1443
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1444 # resolve any conflicts
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1445 if confl_optionals:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1446 conflict_handler = self._get_handler()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1447 conflict_handler(action, confl_optionals)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1448
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1449 def _handle_conflict_error(self, action, conflicting_actions):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1450 message = _('conflicting option string(s): %s')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1451 conflict_string = ', '.join([option_string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1452 for option_string, action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1453 in conflicting_actions])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1454 raise ArgumentError(action, message % conflict_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1455
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1456 def _handle_conflict_resolve(self, action, conflicting_actions):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1457
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1458 # remove all conflicting options
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1459 for option_string, action in conflicting_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1460
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1461 # remove the conflicting option
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1462 action.option_strings.remove(option_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1463 self._option_string_actions.pop(option_string, None)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1464
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1465 # if the option now has no option string, remove it from the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1466 # container holding it
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1467 if not action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1468 action.container._remove_action(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1469
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1470
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1471 class _ArgumentGroup(_ActionsContainer):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1472
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1473 def __init__(self, container, title=None, description=None, **kwargs):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1474 # add any missing keyword arguments by checking the container
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1475 update = kwargs.setdefault
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1476 update('conflict_handler', container.conflict_handler)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1477 update('prefix_chars', container.prefix_chars)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1478 update('argument_default', container.argument_default)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1479 super_init = super(_ArgumentGroup, self).__init__
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1480 super_init(description=description, **kwargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1481
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1482 # group attributes
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1483 self.title = title
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1484 self._group_actions = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1485
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1486 # share most attributes with the container
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1487 self._registries = container._registries
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1488 self._actions = container._actions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1489 self._option_string_actions = container._option_string_actions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1490 self._defaults = container._defaults
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1491 self._has_negative_number_optionals = \
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1492 container._has_negative_number_optionals
67824
e82501812ae3 #10680: fix mutually exclusive arguments in argument groups.
Steven Bethard <steven.bethard@gmail.com>
parents: 67744
diff changeset
1493 self._mutually_exclusive_groups = container._mutually_exclusive_groups
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1494
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1495 def _add_action(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1496 action = super(_ArgumentGroup, self)._add_action(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1497 self._group_actions.append(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1498 return action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1499
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1500 def _remove_action(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1501 super(_ArgumentGroup, self)._remove_action(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1502 self._group_actions.remove(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1503
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1504
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1505 class _MutuallyExclusiveGroup(_ArgumentGroup):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1506
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1507 def __init__(self, container, required=False):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1508 super(_MutuallyExclusiveGroup, self).__init__(container)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1509 self.required = required
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1510 self._container = container
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1511
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1512 def _add_action(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1513 if action.required:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1514 msg = _('mutually exclusive arguments must be optional')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1515 raise ValueError(msg)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1516 action = self._container._add_action(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1517 self._group_actions.append(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1518 return action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1519
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1520 def _remove_action(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1521 self._container._remove_action(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1522 self._group_actions.remove(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1523
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1524
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1525 class ArgumentParser(_AttributeHolder, _ActionsContainer):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1526 """Object for parsing command line strings into Python objects.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1527
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1528 Keyword Arguments:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1529 - prog -- The name of the program (default: sys.argv[0])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1530 - usage -- A usage message (default: auto-generated from arguments)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1531 - description -- A description of what the program does
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1532 - epilog -- Text following the argument descriptions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1533 - parents -- Parsers whose arguments should be copied into this one
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1534 - formatter_class -- HelpFormatter class for printing help messages
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1535 - prefix_chars -- Characters that prefix optional arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1536 - fromfile_prefix_chars -- Characters that prefix files containing
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1537 additional arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1538 - argument_default -- The default value for all arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1539 - conflict_handler -- String indicating how to handle conflicts
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1540 - add_help -- Add a -h/-help option
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1541 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1542
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1543 def __init__(self,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1544 prog=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1545 usage=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1546 description=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1547 epilog=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1548 version=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1549 parents=[],
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1550 formatter_class=HelpFormatter,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1551 prefix_chars='-',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1552 fromfile_prefix_chars=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1553 argument_default=None,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1554 conflict_handler='error',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1555 add_help=True):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1556
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1557 if version is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1558 import warnings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1559 warnings.warn(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1560 """The "version" argument to ArgumentParser is deprecated. """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1561 """Please use """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1562 """"add_argument(..., action='version', version="N", ...)" """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1563 """instead""", DeprecationWarning)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1564
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1565 superinit = super(ArgumentParser, self).__init__
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1566 superinit(description=description,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1567 prefix_chars=prefix_chars,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1568 argument_default=argument_default,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1569 conflict_handler=conflict_handler)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1570
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1571 # default setting for prog
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1572 if prog is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1573 prog = _os.path.basename(_sys.argv[0])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1574
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1575 self.prog = prog
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1576 self.usage = usage
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1577 self.epilog = epilog
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1578 self.version = version
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1579 self.formatter_class = formatter_class
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1580 self.fromfile_prefix_chars = fromfile_prefix_chars
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1581 self.add_help = add_help
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1582
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1583 add_group = self.add_argument_group
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1584 self._positionals = add_group(_('positional arguments'))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1585 self._optionals = add_group(_('optional arguments'))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1586 self._subparsers = None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1587
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1588 # register types
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1589 def identity(string):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1590 return string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1591 self.register('type', None, identity)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1592
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1593 # add help and version arguments if necessary
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1594 # (using explicit default to override global argument_default)
63691
23c089dc5cff Merged revisions 83675 via svnmerge from
R. David Murray <rdmurray@bitdance.com>
parents: 61879
diff changeset
1595 default_prefix = '-' if '-' in prefix_chars else prefix_chars[0]
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1596 if self.add_help:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1597 self.add_argument(
63691
23c089dc5cff Merged revisions 83675 via svnmerge from
R. David Murray <rdmurray@bitdance.com>
parents: 61879
diff changeset
1598 default_prefix+'h', default_prefix*2+'help',
23c089dc5cff Merged revisions 83675 via svnmerge from
R. David Murray <rdmurray@bitdance.com>
parents: 61879
diff changeset
1599 action='help', default=SUPPRESS,
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1600 help=_('show this help message and exit'))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1601 if self.version:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1602 self.add_argument(
63691
23c089dc5cff Merged revisions 83675 via svnmerge from
R. David Murray <rdmurray@bitdance.com>
parents: 61879
diff changeset
1603 default_prefix+'v', default_prefix*2+'version',
23c089dc5cff Merged revisions 83675 via svnmerge from
R. David Murray <rdmurray@bitdance.com>
parents: 61879
diff changeset
1604 action='version', default=SUPPRESS,
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1605 version=self.version,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1606 help=_("show program's version number and exit"))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1607
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1608 # add parent arguments and defaults
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1609 for parent in parents:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1610 self._add_container_actions(parent)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1611 try:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1612 defaults = parent._defaults
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1613 except AttributeError:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1614 pass
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1615 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1616 self._defaults.update(defaults)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1617
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1618 # =======================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1619 # Pretty __repr__ methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1620 # =======================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1621 def _get_kwargs(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1622 names = [
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1623 'prog',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1624 'usage',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1625 'description',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1626 'version',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1627 'formatter_class',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1628 'conflict_handler',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1629 'add_help',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1630 ]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1631 return [(name, getattr(self, name)) for name in names]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1632
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1633 # ==================================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1634 # Optional/Positional adding methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1635 # ==================================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1636 def add_subparsers(self, **kwargs):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1637 if self._subparsers is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1638 self.error(_('cannot have multiple subparser arguments'))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1639
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1640 # add the parser class to the arguments if it's not present
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1641 kwargs.setdefault('parser_class', type(self))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1642
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1643 if 'title' in kwargs or 'description' in kwargs:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1644 title = _(kwargs.pop('title', 'subcommands'))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1645 description = _(kwargs.pop('description', None))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1646 self._subparsers = self.add_argument_group(title, description)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1647 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1648 self._subparsers = self._positionals
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1649
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1650 # prog defaults to the usage message of this parser, skipping
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1651 # optional arguments and with no "usage:" prefix
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1652 if kwargs.get('prog') is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1653 formatter = self._get_formatter()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1654 positionals = self._get_positional_actions()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1655 groups = self._mutually_exclusive_groups
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1656 formatter.add_usage(self.usage, positionals, groups, '')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1657 kwargs['prog'] = formatter.format_help().strip()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1658
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1659 # create the parsers action and add it to the positionals list
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1660 parsers_class = self._pop_action_class(kwargs, 'parsers')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1661 action = parsers_class(option_strings=[], **kwargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1662 self._subparsers._add_action(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1663
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1664 # return the created parsers action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1665 return action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1666
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1667 def _add_action(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1668 if action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1669 self._optionals._add_action(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1670 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1671 self._positionals._add_action(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1672 return action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1673
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1674 def _get_optional_actions(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1675 return [action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1676 for action in self._actions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1677 if action.option_strings]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1678
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1679 def _get_positional_actions(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1680 return [action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1681 for action in self._actions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1682 if not action.option_strings]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1683
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1684 # =====================================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1685 # Command line argument parsing methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1686 # =====================================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1687 def parse_args(self, args=None, namespace=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1688 args, argv = self.parse_known_args(args, namespace)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1689 if argv:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1690 msg = _('unrecognized arguments: %s')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1691 self.error(msg % ' '.join(argv))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1692 return args
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1693
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1694 def parse_known_args(self, args=None, namespace=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1695 # args default to the system args
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1696 if args is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1697 args = _sys.argv[1:]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1698
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1699 # default Namespace built from parser defaults
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1700 if namespace is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1701 namespace = Namespace()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1702
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1703 # add any action defaults that aren't present
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1704 for action in self._actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1705 if action.dest is not SUPPRESS:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1706 if not hasattr(namespace, action.dest):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1707 if action.default is not SUPPRESS:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1708 default = action.default
59281
eba942e77895 remove cross-version compatibility code
Benjamin Peterson <benjamin@python.org>
parents: 59280
diff changeset
1709 if isinstance(action.default, basestring):
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1710 default = self._get_value(action, default)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1711 setattr(namespace, action.dest, default)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1712
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1713 # add any parser defaults that aren't present
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1714 for dest in self._defaults:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1715 if not hasattr(namespace, dest):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1716 setattr(namespace, dest, self._defaults[dest])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1717
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1718 # parse the arguments and exit if there are any errors
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1719 try:
65888
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1720 namespace, args = self._parse_known_args(args, namespace)
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1721 if hasattr(namespace, _UNRECOGNIZED_ARGS_ATTR):
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1722 args.extend(getattr(namespace, _UNRECOGNIZED_ARGS_ATTR))
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1723 delattr(namespace, _UNRECOGNIZED_ARGS_ATTR)
573db2af2dda Merged revisions 86111 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65870
diff changeset
1724 return namespace, args
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1725 except ArgumentError:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1726 err = _sys.exc_info()[1]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1727 self.error(str(err))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1728
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1729 def _parse_known_args(self, arg_strings, namespace):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1730 # replace arg strings that are file references
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1731 if self.fromfile_prefix_chars is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1732 arg_strings = self._read_args_from_files(arg_strings)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1733
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1734 # map all mutually exclusive arguments to the other arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1735 # they can't occur with
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1736 action_conflicts = {}
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1737 for mutex_group in self._mutually_exclusive_groups:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1738 group_actions = mutex_group._group_actions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1739 for i, mutex_action in enumerate(mutex_group._group_actions):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1740 conflicts = action_conflicts.setdefault(mutex_action, [])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1741 conflicts.extend(group_actions[:i])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1742 conflicts.extend(group_actions[i + 1:])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1743
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1744 # find all option indices, and determine the arg_string_pattern
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1745 # which has an 'O' if there is an option at an index,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1746 # an 'A' if there is an argument, or a '-' if there is a '--'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1747 option_string_indices = {}
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1748 arg_string_pattern_parts = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1749 arg_strings_iter = iter(arg_strings)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1750 for i, arg_string in enumerate(arg_strings_iter):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1751
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1752 # all args after -- are non-options
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1753 if arg_string == '--':
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1754 arg_string_pattern_parts.append('-')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1755 for arg_string in arg_strings_iter:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1756 arg_string_pattern_parts.append('A')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1757
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1758 # otherwise, add the arg to the arg strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1759 # and note the index if it was an option
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1760 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1761 option_tuple = self._parse_optional(arg_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1762 if option_tuple is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1763 pattern = 'A'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1764 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1765 option_string_indices[i] = option_tuple
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1766 pattern = 'O'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1767 arg_string_pattern_parts.append(pattern)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1768
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1769 # join the pieces together to form the pattern
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1770 arg_strings_pattern = ''.join(arg_string_pattern_parts)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1771
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1772 # converts arg strings to the appropriate and then takes the action
59281
eba942e77895 remove cross-version compatibility code
Benjamin Peterson <benjamin@python.org>
parents: 59280
diff changeset
1773 seen_actions = set()
eba942e77895 remove cross-version compatibility code
Benjamin Peterson <benjamin@python.org>
parents: 59280
diff changeset
1774 seen_non_default_actions = set()
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1775
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1776 def take_action(action, argument_strings, option_string=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1777 seen_actions.add(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1778 argument_values = self._get_values(action, argument_strings)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1779
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1780 # error if this argument is not allowed with other previously
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1781 # seen arguments, assuming that actions that use the default
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1782 # value don't really count as "present"
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1783 if argument_values is not action.default:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1784 seen_non_default_actions.add(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1785 for conflict_action in action_conflicts.get(action, []):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1786 if conflict_action in seen_non_default_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1787 msg = _('not allowed with argument %s')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1788 action_name = _get_action_name(conflict_action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1789 raise ArgumentError(action, msg % action_name)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1790
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1791 # take the action if we didn't receive a SUPPRESS value
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1792 # (e.g. from a default)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1793 if argument_values is not SUPPRESS:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1794 action(self, namespace, argument_values, option_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1795
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1796 # function to convert arg_strings into an optional action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1797 def consume_optional(start_index):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1798
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1799 # get the optional identified at this index
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1800 option_tuple = option_string_indices[start_index]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1801 action, option_string, explicit_arg = option_tuple
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1802
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1803 # identify additional optionals in the same arg string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1804 # (e.g. -xyz is the same as -x -y -z if no args are required)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1805 match_argument = self._match_argument
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1806 action_tuples = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1807 while True:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1808
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1809 # if we found no optional action, skip it
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1810 if action is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1811 extras.append(arg_strings[start_index])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1812 return start_index + 1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1813
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1814 # if there is an explicit argument, try to match the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1815 # optional's string arguments to only this
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1816 if explicit_arg is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1817 arg_count = match_argument(action, 'A')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1818
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1819 # if the action is a single-dash option and takes no
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1820 # arguments, try to parse more single-dash options out
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1821 # of the tail of the option string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1822 chars = self.prefix_chars
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1823 if arg_count == 0 and option_string[1] not in chars:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1824 action_tuples.append((action, [], option_string))
65868
848912789b79 Merged revisions 86090 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65864
diff changeset
1825 char = option_string[0]
848912789b79 Merged revisions 86090 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65864
diff changeset
1826 option_string = char + explicit_arg[0]
848912789b79 Merged revisions 86090 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65864
diff changeset
1827 new_explicit_arg = explicit_arg[1:] or None
848912789b79 Merged revisions 86090 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65864
diff changeset
1828 optionals_map = self._option_string_actions
848912789b79 Merged revisions 86090 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65864
diff changeset
1829 if option_string in optionals_map:
848912789b79 Merged revisions 86090 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65864
diff changeset
1830 action = optionals_map[option_string]
848912789b79 Merged revisions 86090 via svnmerge from
Steven Bethard <steven.bethard@gmail.com>
parents: 65864
diff changeset
1831 explicit_arg = new_explicit_arg
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1832 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1833 msg = _('ignored explicit argument %r')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1834 raise ArgumentError(action, msg % explicit_arg)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1835
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1836 # if the action expect exactly one argument, we've
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1837 # successfully matched the option; exit the loop
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1838 elif arg_count == 1:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1839 stop = start_index + 1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1840 args = [explicit_arg]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1841 action_tuples.append((action, args, option_string))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1842 break
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1843
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1844 # error if a double-dash option did not use the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1845 # explicit argument
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1846 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1847 msg = _('ignored explicit argument %r')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1848 raise ArgumentError(action, msg % explicit_arg)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1849
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1850 # if there is no explicit argument, try to match the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1851 # optional's string arguments with the following strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1852 # if successful, exit the loop
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1853 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1854 start = start_index + 1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1855 selected_patterns = arg_strings_pattern[start:]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1856 arg_count = match_argument(action, selected_patterns)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1857 stop = start + arg_count
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1858 args = arg_strings[start:stop]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1859 action_tuples.append((action, args, option_string))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1860 break
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1861
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1862 # add the Optional to the list and return the index at which
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1863 # the Optional's string args stopped
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1864 assert action_tuples
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1865 for action, args, option_string in action_tuples:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1866 take_action(action, args, option_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1867 return stop
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1868
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1869 # the list of Positionals left to be parsed; this is modified
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1870 # by consume_positionals()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1871 positionals = self._get_positional_actions()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1872
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1873 # function to convert arg_strings into positional actions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1874 def consume_positionals(start_index):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1875 # match as many Positionals as possible
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1876 match_partial = self._match_arguments_partial
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1877 selected_pattern = arg_strings_pattern[start_index:]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1878 arg_counts = match_partial(positionals, selected_pattern)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1879
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1880 # slice off the appropriate arg strings for each Positional
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1881 # and add the Positional and its args to the list
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1882 for action, arg_count in zip(positionals, arg_counts):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1883 args = arg_strings[start_index: start_index + arg_count]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1884 start_index += arg_count
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1885 take_action(action, args)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1886
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1887 # slice off the Positionals that we just parsed and return the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1888 # index at which the Positionals' string args stopped
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1889 positionals[:] = positionals[len(arg_counts):]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1890 return start_index
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1891
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1892 # consume Positionals and Optionals alternately, until we have
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1893 # passed the last option string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1894 extras = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1895 start_index = 0
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1896 if option_string_indices:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1897 max_option_string_index = max(option_string_indices)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1898 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1899 max_option_string_index = -1
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1900 while start_index <= max_option_string_index:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1901
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1902 # consume any Positionals preceding the next option
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1903 next_option_string_index = min([
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1904 index
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1905 for index in option_string_indices
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1906 if index >= start_index])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1907 if start_index != next_option_string_index:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1908 positionals_end_index = consume_positionals(start_index)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1909
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1910 # only try to parse the next optional if we didn't consume
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1911 # the option string during the positionals parsing
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1912 if positionals_end_index > start_index:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1913 start_index = positionals_end_index
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1914 continue
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1915 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1916 start_index = positionals_end_index
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1917
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1918 # if we consumed all the positionals we could and we're not
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1919 # at the index of an option string, there were extra arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1920 if start_index not in option_string_indices:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1921 strings = arg_strings[start_index:next_option_string_index]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1922 extras.extend(strings)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1923 start_index = next_option_string_index
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1924
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1925 # consume the next optional and any arguments for it
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1926 start_index = consume_optional(start_index)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1927
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1928 # consume any positionals following the last Optional
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1929 stop_index = consume_positionals(start_index)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1930
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1931 # if we didn't consume all the argument strings, there were extras
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1932 extras.extend(arg_strings[stop_index:])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1933
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1934 # if we didn't use all the Positional objects, there were too few
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1935 # arg strings supplied.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1936 if positionals:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1937 self.error(_('too few arguments'))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1938
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1939 # make sure all required actions were present
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1940 for action in self._actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1941 if action.required:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1942 if action not in seen_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1943 name = _get_action_name(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1944 self.error(_('argument %s is required') % name)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1945
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1946 # make sure all required groups had one option present
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1947 for group in self._mutually_exclusive_groups:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1948 if group.required:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1949 for action in group._group_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1950 if action in seen_non_default_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1951 break
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1952
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1953 # if no actions were used, report the error
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1954 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1955 names = [_get_action_name(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1956 for action in group._group_actions
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1957 if action.help is not SUPPRESS]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1958 msg = _('one of the arguments %s is required')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1959 self.error(msg % ' '.join(names))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1960
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1961 # return the updated namespace and the extra arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1962 return namespace, extras
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1963
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1964 def _read_args_from_files(self, arg_strings):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1965 # expand arguments referencing files
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1966 new_arg_strings = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1967 for arg_string in arg_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1968
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1969 # for regular arguments, just add them back into the list
78231
c9806f0aaefb #12353: argparse now correctly handles null argument values.
R David Murray <rdmurray@bitdance.com>
parents: 78228
diff changeset
1970 if not arg_string or arg_string[0] not in self.fromfile_prefix_chars:
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1971 new_arg_strings.append(arg_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1972
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1973 # replace arguments referencing files with the file content
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1974 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1975 try:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1976 args_file = open(arg_string[1:])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1977 try:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1978 arg_strings = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1979 for arg_line in args_file.read().splitlines():
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1980 for arg in self.convert_arg_line_to_args(arg_line):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1981 arg_strings.append(arg)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1982 arg_strings = self._read_args_from_files(arg_strings)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1983 new_arg_strings.extend(arg_strings)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1984 finally:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1985 args_file.close()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1986 except IOError:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1987 err = _sys.exc_info()[1]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1988 self.error(str(err))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1989
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1990 # return the modified argument list
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1991 return new_arg_strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1992
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1993 def convert_arg_line_to_args(self, arg_line):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1994 return [arg_line]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1995
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1996 def _match_argument(self, action, arg_strings_pattern):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1997 # match the pattern for this action to the arg strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1998 nargs_pattern = self._get_nargs_pattern(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
1999 match = _re.match(nargs_pattern, arg_strings_pattern)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2000
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2001 # raise an exception if we weren't able to find a match
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2002 if match is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2003 nargs_errors = {
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2004 None: _('expected one argument'),
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2005 OPTIONAL: _('expected at most one argument'),
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2006 ONE_OR_MORE: _('expected at least one argument'),
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2007 }
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2008 default = _('expected %s argument(s)') % action.nargs
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2009 msg = nargs_errors.get(action.nargs, default)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2010 raise ArgumentError(action, msg)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2011
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2012 # return the number of arguments matched
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2013 return len(match.group(1))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2014
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2015 def _match_arguments_partial(self, actions, arg_strings_pattern):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2016 # progressively shorten the actions list by slicing off the
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2017 # final actions until we find a match
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2018 result = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2019 for i in range(len(actions), 0, -1):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2020 actions_slice = actions[:i]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2021 pattern = ''.join([self._get_nargs_pattern(action)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2022 for action in actions_slice])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2023 match = _re.match(pattern, arg_strings_pattern)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2024 if match is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2025 result.extend([len(string) for string in match.groups()])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2026 break
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2027
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2028 # return the list of arg string counts
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2029 return result
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2030
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2031 def _parse_optional(self, arg_string):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2032 # if it's an empty string, it was meant to be a positional
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2033 if not arg_string:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2034 return None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2035
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2036 # if it doesn't start with a prefix, it was meant to be positional
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2037 if not arg_string[0] in self.prefix_chars:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2038 return None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2039
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2040 # if the option string is present in the parser, return the action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2041 if arg_string in self._option_string_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2042 action = self._option_string_actions[arg_string]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2043 return action, arg_string, None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2044
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2045 # if it's just a single character, it was meant to be positional
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2046 if len(arg_string) == 1:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2047 return None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2048
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2049 # if the option string before the "=" is present, return the action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2050 if '=' in arg_string:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2051 option_string, explicit_arg = arg_string.split('=', 1)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2052 if option_string in self._option_string_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2053 action = self._option_string_actions[option_string]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2054 return action, option_string, explicit_arg
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2055
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2056 # search through all possible prefixes of the option string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2057 # and all actions in the parser for possible interpretations
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2058 option_tuples = self._get_option_tuples(arg_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2059
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2060 # if multiple actions match, the option string was ambiguous
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2061 if len(option_tuples) > 1:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2062 options = ', '.join([option_string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2063 for action, option_string, explicit_arg in option_tuples])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2064 tup = arg_string, options
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2065 self.error(_('ambiguous option: %s could match %s') % tup)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2066
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2067 # if exactly one action matched, this segmentation is good,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2068 # so return the parsed action
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2069 elif len(option_tuples) == 1:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2070 option_tuple, = option_tuples
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2071 return option_tuple
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2072
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2073 # if it was not found as an option, but it looks like a negative
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2074 # number, it was meant to be positional
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2075 # unless there are negative-number-like options
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2076 if self._negative_number_matcher.match(arg_string):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2077 if not self._has_negative_number_optionals:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2078 return None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2079
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2080 # if it contains a space, it was meant to be a positional
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2081 if ' ' in arg_string:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2082 return None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2083
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2084 # it was meant to be an optional but there is no such option
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2085 # in this parser (though it might be a valid option in a subparser)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2086 return None, arg_string, None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2087
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2088 def _get_option_tuples(self, option_string):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2089 result = []
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2090
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2091 # option strings starting with two prefix characters are only
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2092 # split at the '='
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2093 chars = self.prefix_chars
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2094 if option_string[0] in chars and option_string[1] in chars:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2095 if '=' in option_string:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2096 option_prefix, explicit_arg = option_string.split('=', 1)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2097 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2098 option_prefix = option_string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2099 explicit_arg = None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2100 for option_string in self._option_string_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2101 if option_string.startswith(option_prefix):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2102 action = self._option_string_actions[option_string]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2103 tup = action, option_string, explicit_arg
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2104 result.append(tup)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2105
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2106 # single character options can be concatenated with their arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2107 # but multiple character options always have to have their argument
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2108 # separate
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2109 elif option_string[0] in chars and option_string[1] not in chars:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2110 option_prefix = option_string
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2111 explicit_arg = None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2112 short_option_prefix = option_string[:2]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2113 short_explicit_arg = option_string[2:]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2114
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2115 for option_string in self._option_string_actions:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2116 if option_string == short_option_prefix:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2117 action = self._option_string_actions[option_string]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2118 tup = action, option_string, short_explicit_arg
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2119 result.append(tup)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2120 elif option_string.startswith(option_prefix):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2121 action = self._option_string_actions[option_string]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2122 tup = action, option_string, explicit_arg
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2123 result.append(tup)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2124
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2125 # shouldn't ever get here
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2126 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2127 self.error(_('unexpected option string: %s') % option_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2128
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2129 # return the collected option tuples
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2130 return result
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2131
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2132 def _get_nargs_pattern(self, action):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2133 # in all examples below, we have to allow for '--' args
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2134 # which are represented as '-' in the pattern
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2135 nargs = action.nargs
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2136
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2137 # the default (None) is assumed to be a single argument
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2138 if nargs is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2139 nargs_pattern = '(-*A-*)'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2140
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2141 # allow zero or one arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2142 elif nargs == OPTIONAL:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2143 nargs_pattern = '(-*A?-*)'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2144
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2145 # allow zero or more arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2146 elif nargs == ZERO_OR_MORE:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2147 nargs_pattern = '(-*[A-]*)'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2148
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2149 # allow one or more arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2150 elif nargs == ONE_OR_MORE:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2151 nargs_pattern = '(-*A[A-]*)'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2152
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2153 # allow any number of options or arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2154 elif nargs == REMAINDER:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2155 nargs_pattern = '([-AO]*)'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2156
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2157 # allow one argument followed by any number of options or arguments
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2158 elif nargs == PARSER:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2159 nargs_pattern = '(-*A[-AO]*)'
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2160
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2161 # all others should be integers
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2162 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2163 nargs_pattern = '(-*%s-*)' % '-*'.join('A' * nargs)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2164
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2165 # if this is an optional action, -- is not allowed
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2166 if action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2167 nargs_pattern = nargs_pattern.replace('-*', '')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2168 nargs_pattern = nargs_pattern.replace('-', '')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2169
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2170 # return the pattern
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2171 return nargs_pattern
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2172
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2173 # ========================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2174 # Value conversion methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2175 # ========================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2176 def _get_values(self, action, arg_strings):
78233
bd2c167dfabc #13922: argparse no longer incorrectly strips '--' after the first one.
R David Murray <rdmurray@bitdance.com>
parents: 78231
diff changeset
2177 # for everything but PARSER, REMAINDER args, strip out first '--'
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2178 if action.nargs not in [PARSER, REMAINDER]:
78233
bd2c167dfabc #13922: argparse no longer incorrectly strips '--' after the first one.
R David Murray <rdmurray@bitdance.com>
parents: 78231
diff changeset
2179 try:
bd2c167dfabc #13922: argparse no longer incorrectly strips '--' after the first one.
R David Murray <rdmurray@bitdance.com>
parents: 78231
diff changeset
2180 arg_strings.remove('--')
bd2c167dfabc #13922: argparse no longer incorrectly strips '--' after the first one.
R David Murray <rdmurray@bitdance.com>
parents: 78231
diff changeset
2181 except ValueError:
bd2c167dfabc #13922: argparse no longer incorrectly strips '--' after the first one.
R David Murray <rdmurray@bitdance.com>
parents: 78231
diff changeset
2182 pass
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2183
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2184 # optional argument produces a default when not present
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2185 if not arg_strings and action.nargs == OPTIONAL:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2186 if action.option_strings:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2187 value = action.const
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2188 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2189 value = action.default
59281
eba942e77895 remove cross-version compatibility code
Benjamin Peterson <benjamin@python.org>
parents: 59280
diff changeset
2190 if isinstance(value, basestring):
59267
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2191 value = self._get_value(action, value)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2192 self._check_value(action, value)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2193
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2194 # when nargs='*' on a positional, if there were no command-line
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2195 # args, use the default if it is anything other than None
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2196 elif (not arg_strings and action.nargs == ZERO_OR_MORE and
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2197 not action.option_strings):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2198 if action.default is not None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2199 value = action.default
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2200 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2201 value = arg_strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2202 self._check_value(action, value)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2203
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2204 # single argument or optional argument produces a single value
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2205 elif len(arg_strings) == 1 and action.nargs in [None, OPTIONAL]:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2206 arg_string, = arg_strings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2207 value = self._get_value(action, arg_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2208 self._check_value(action, value)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2209
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2210 # REMAINDER arguments convert all values, checking none
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2211 elif action.nargs == REMAINDER:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2212 value = [self._get_value(action, v) for v in arg_strings]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2213
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2214 # PARSER arguments convert all values, but check only the first
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2215 elif action.nargs == PARSER:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2216 value = [self._get_value(action, v) for v in arg_strings]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2217 self._check_value(action, value[0])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2218
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2219 # all other types of nargs produce a list
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2220 else:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2221 value = [self._get_value(action, v) for v in arg_strings]
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2222 for v in value:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2223 self._check_value(action, v)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2224
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2225 # return the converted value
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2226 return value
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2227
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2228 def _get_value(self, action, arg_string):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2229 type_func = self._registry_get('type', action.type, action.type)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2230 if not _callable(type_func):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2231 msg = _('%r is not callable')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2232 raise ArgumentError(action, msg % type_func)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2233
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2234 # convert the value to the appropriate type
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2235 try:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2236 result = type_func(arg_string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2237
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2238 # ArgumentTypeErrors indicate errors
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2239 except ArgumentTypeError:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2240 name = getattr(action.type, '__name__', repr(action.type))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2241 msg = str(_sys.exc_info()[1])
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2242 raise ArgumentError(action, msg)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2243
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2244 # TypeErrors or ValueErrors also indicate errors
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2245 except (TypeError, ValueError):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2246 name = getattr(action.type, '__name__', repr(action.type))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2247 msg = _('invalid %s value: %r')
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2248 raise ArgumentError(action, msg % (name, arg_string))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2249
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2250 # return the converted value
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2251 return result
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2252
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2253 def _check_value(self, action, value):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2254 # converted value must be one of the choices (if specified)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2255 if action.choices is not None and value not in action.choices:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2256 tup = value, ', '.join(map(repr, action.choices))
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2257 msg = _('invalid choice: %r (choose from %s)') % tup
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2258 raise ArgumentError(action, msg)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2259
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2260 # =======================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2261 # Help-formatting methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2262 # =======================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2263 def format_usage(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2264 formatter = self._get_formatter()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2265 formatter.add_usage(self.usage, self._actions,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2266 self._mutually_exclusive_groups)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2267 return formatter.format_help()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2268
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2269 def format_help(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2270 formatter = self._get_formatter()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2271
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2272 # usage
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2273 formatter.add_usage(self.usage, self._actions,
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2274 self._mutually_exclusive_groups)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2275
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2276 # description
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2277 formatter.add_text(self.description)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2278
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2279 # positionals, optionals and user-defined groups
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2280 for action_group in self._action_groups:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2281 formatter.start_section(action_group.title)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2282 formatter.add_text(action_group.description)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2283 formatter.add_arguments(action_group._group_actions)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2284 formatter.end_section()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2285
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2286 # epilog
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2287 formatter.add_text(self.epilog)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2288
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2289 # determine help from format above
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2290 return formatter.format_help()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2291
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2292 def format_version(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2293 import warnings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2294 warnings.warn(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2295 'The format_version method is deprecated -- the "version" '
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2296 'argument to ArgumentParser is no longer supported.',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2297 DeprecationWarning)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2298 formatter = self._get_formatter()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2299 formatter.add_text(self.version)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2300 return formatter.format_help()
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2301
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2302 def _get_formatter(self):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2303 return self.formatter_class(prog=self.prog)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2304
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2305 # =====================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2306 # Help-printing methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2307 # =====================
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2308 def print_usage(self, file=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2309 if file is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2310 file = _sys.stdout
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2311 self._print_message(self.format_usage(), file)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2312
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2313 def print_help(self, file=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2314 if file is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2315 file = _sys.stdout
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2316 self._print_message(self.format_help(), file)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2317
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2318 def print_version(self, file=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2319 import warnings
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2320 warnings.warn(
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2321 'The print_version method is deprecated -- the "version" '
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2322 'argument to ArgumentParser is no longer supported.',
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2323 DeprecationWarning)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2324 self._print_message(self.format_version(), file)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2325
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2326 def _print_message(self, message, file=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2327 if message:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2328 if file is None:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2329 file = _sys.stderr
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2330 file.write(message)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2331
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2332 # ===============
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2333 # Exiting methods
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2334 # ===============
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2335 def exit(self, status=0, message=None):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2336 if message:
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2337 self._print_message(message, _sys.stderr)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2338 _sys.exit(status)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2339
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2340 def error(self, message):
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2341 """error(message: string)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2342
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2343 Prints a usage message incorporating the message to stderr and
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2344 exits.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2345
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2346 If you override this in a subclass, it should not return -- it
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2347 should either exit or raise an exception.
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2348 """
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2349 self.print_usage(_sys.stderr)
4ca83c5b8551 set svn:eol-style
Benjamin Peterson <benjamin@python.org>
parents: 59266
diff changeset
2350 self.exit(2, _('%s: error: %s\n') % (self.prog, message))