Mercurial > cpython-lru_cache-weakref

annotate Lib/argparse.py @ 59642:c19b4bfb806a legacy-trunk

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