~bzr-pqm/bzr/bzr.dev

2598.1.4 by Martin Pool
Fix up tests for option help cleanups
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
16
1684.1.6 by Martin Pool
(patch) --diff-prefix option (goffredo, alexander)
17
# TODO: For things like --diff-prefix, we want a way to customize the display
18
# of the option argument.
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
19
3224.5.3 by Andrew Bennetts
Avoid importing bzrlib.log unnecessarily, and always import bzrlib.registry and optparse directly in bzrlib.option because it always uses it.
20
import optparse
1996.3.28 by John Arbash Meinel
lazy import revisionspec and errors for bzrlib.options
21
import re
22
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
25
from bzrlib import (
26
    errors,
3236.1.1 by Michael Hudson
clean up option.py imports
27
    revisionspec,
28
    )
29
""")
30
3224.5.3 by Andrew Bennetts
Avoid importing bzrlib.log unnecessarily, and always import bzrlib.registry and optparse directly in bzrlib.option because it always uses it.
31
from bzrlib import (
32
    registry as _mod_registry,
33
    )
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
34
35
36
def _parse_revision_str(revstr):
37
    """This handles a revision string -> revno.
38
39
    This always returns a list.  The list will have one element for
40
    each revision specifier supplied.
41
42
    >>> _parse_revision_str('234')
1948.4.31 by John Arbash Meinel
fix bugs in the test_annonate.py suite, which was passing '-r 3' as n argument not '-r3' or '-r', '3'
43
    [<RevisionSpec_revno 234>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
44
    >>> _parse_revision_str('234..567')
1948.4.31 by John Arbash Meinel
fix bugs in the test_annonate.py suite, which was passing '-r 3' as n argument not '-r3' or '-r', '3'
45
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
46
    >>> _parse_revision_str('..')
47
    [<RevisionSpec None>, <RevisionSpec None>]
48
    >>> _parse_revision_str('..234')
1948.4.31 by John Arbash Meinel
fix bugs in the test_annonate.py suite, which was passing '-r 3' as n argument not '-r3' or '-r', '3'
49
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
50
    >>> _parse_revision_str('234..')
1948.4.31 by John Arbash Meinel
fix bugs in the test_annonate.py suite, which was passing '-r 3' as n argument not '-r3' or '-r', '3'
51
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
52
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
1948.4.31 by John Arbash Meinel
fix bugs in the test_annonate.py suite, which was passing '-r 3' as n argument not '-r3' or '-r', '3'
53
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
54
    >>> _parse_revision_str('234....789') #Error ?
1948.4.31 by John Arbash Meinel
fix bugs in the test_annonate.py suite, which was passing '-r 3' as n argument not '-r3' or '-r', '3'
55
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
56
    >>> _parse_revision_str('revid:test@other.com-234234')
57
    [<RevisionSpec_revid revid:test@other.com-234234>]
58
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
59
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
60
    >>> _parse_revision_str('revid:test@other.com-234234..23')
1948.4.31 by John Arbash Meinel
fix bugs in the test_annonate.py suite, which was passing '-r 3' as n argument not '-r3' or '-r', '3'
61
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
62
    >>> _parse_revision_str('date:2005-04-12')
63
    [<RevisionSpec_date date:2005-04-12>]
64
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
65
    [<RevisionSpec_date date:2005-04-12 12:24:33>]
66
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
67
    [<RevisionSpec_date date:2005-04-12T12:24:33>]
68
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
69
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
70
    >>> _parse_revision_str('-5..23')
1948.4.31 by John Arbash Meinel
fix bugs in the test_annonate.py suite, which was passing '-r 3' as n argument not '-r3' or '-r', '3'
71
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
72
    >>> _parse_revision_str('-5')
1948.4.31 by John Arbash Meinel
fix bugs in the test_annonate.py suite, which was passing '-r 3' as n argument not '-r3' or '-r', '3'
73
    [<RevisionSpec_revno -5>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
74
    >>> _parse_revision_str('123a')
75
    Traceback (most recent call last):
76
      ...
1948.4.32 by John Arbash Meinel
Clean up __repr__, as well as add tests that we can handle -r12:branch/
77
    NoSuchRevisionSpec: No namespace registered for string: '123a'
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
78
    >>> _parse_revision_str('abc')
79
    Traceback (most recent call last):
80
      ...
1948.4.32 by John Arbash Meinel
Clean up __repr__, as well as add tests that we can handle -r12:branch/
81
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
82
    >>> _parse_revision_str('branch:../branch2')
83
    [<RevisionSpec_branch branch:../branch2>]
1545.1.1 by Denys Duchier
distinguish ../ as path to branch and .. as revspec separator
84
    >>> _parse_revision_str('branch:../../branch2')
85
    [<RevisionSpec_branch branch:../../branch2>]
86
    >>> _parse_revision_str('branch:../../branch2..23')
1948.4.31 by John Arbash Meinel
fix bugs in the test_annonate.py suite, which was passing '-r 3' as n argument not '-r3' or '-r', '3'
87
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
2747.1.1 by Lukáš Lalinský
Accept ..\ as a path in revision specifiers
88
    >>> _parse_revision_str('branch:..\\\\branch2')
89
    [<RevisionSpec_branch branch:..\\branch2>]
90
    >>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
91
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_revno 23>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
92
    """
93
    # TODO: Maybe move this into revisionspec.py
94
    revs = []
2747.1.1 by Lukáš Lalinský
Accept ..\ as a path in revision specifiers
95
    # split on .. that is not followed by a / or \
96
    sep = re.compile(r'\.\.(?![\\/])')
1948.4.28 by John Arbash Meinel
Remove some places that were directly instantiating a RevisionSpec object. Also get rid of support for --revision 1:2, it has been deprecated for a long time
97
    for x in sep.split(revstr):
1996.3.28 by John Arbash Meinel
lazy import revisionspec and errors for bzrlib.options
98
        revs.append(revisionspec.RevisionSpec.from_string(x or None))
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
99
    return revs
100
101
2745.4.1 by Lukáš Lalinsky
New option -C/--change for diff and status to show changes in one revision. (#56299)
102
def _parse_change_str(revstr):
2745.4.5 by Lukáš Lalinsky
'..' in the revision string doesn't always mean a range, so parse the string using _parse_revision_str and then check the number of returned revisions
103
    """Parse the revision string and return a tuple with left-most
104
    parent of the revision.
105
106
    >>> _parse_change_str('123')
107
    (<RevisionSpec_before before:123>, <RevisionSpec_revno 123>)
108
    >>> _parse_change_str('123..124')
109
    Traceback (most recent call last):
110
      ...
111
    RangeInChangeOption: Option --change does not accept revision ranges
112
    """
113
    revs = _parse_revision_str(revstr)
114
    if len(revs) > 1:
2745.4.4 by Lukáš Lalinsky
- Make the description of --change more general
115
        raise errors.RangeInChangeOption()
2745.4.1 by Lukáš Lalinsky
New option -C/--change for diff and status to show changes in one revision. (#56299)
116
    return (revisionspec.RevisionSpec.from_string('before:' + revstr),
2745.4.5 by Lukáš Lalinsky
'..' in the revision string doesn't always mean a range, so parse the string using _parse_revision_str and then check the number of returned revisions
117
            revs[0])
2745.4.1 by Lukáš Lalinsky
New option -C/--change for diff and status to show changes in one revision. (#56299)
118
119
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
120
def _parse_merge_type(typestring):
1185.12.62 by Aaron Bentley
Restored merge-type selection
121
    return get_merge_type(typestring)
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
122
1185.12.62 by Aaron Bentley
Restored merge-type selection
123
def get_merge_type(typestring):
124
    """Attempt to find the merge class/factory associated with a string."""
125
    from merge import merge_types
126
    try:
127
        return merge_types[typestring][0]
128
    except KeyError:
129
        templ = '%s%%7s: %%s' % (' '*12)
130
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
131
        type_list = '\n'.join(lines)
132
        msg = "No known merge type %s. Supported types are:\n%s" %\
133
            (typestring, type_list)
1996.3.28 by John Arbash Meinel
lazy import revisionspec and errors for bzrlib.options
134
        raise errors.BzrCommandError(msg)
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
135
2227.1.2 by mbp at sourcefrog
Add a simple DeprecatedDict class
136
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
137
class Option(object):
2190.2.1 by Martin Pool
remove global registration of short options
138
    """Description of a command line option
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
139
2227.1.1 by mbp at sourcefrog
Back out previous incompatible change: Option.short_name is now again
140
    :ivar _short_name: If this option has a single-letter name, this is it.
2190.2.1 by Martin Pool
remove global registration of short options
141
    Otherwise None.
142
    """
143
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
144
    # The dictionary of standard options. These are always legal.
145
    STD_OPTIONS = {}
1185.16.45 by Martin Pool
- refactor handling of short option names
146
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
147
    # The dictionary of commonly used options. these are only legal
148
    # if a command explicitly references them by name in the list
149
    # of supported options.
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
150
    OPTIONS = {}
151
2190.2.1 by Martin Pool
remove global registration of short options
152
    def __init__(self, name, help='', type=None, argname=None,
2768.1.15 by Ian Clatworthy
Merge bzr.dev
153
                 short_name=None, param_name=None, custom_callback=None):
1185.16.45 by Martin Pool
- refactor handling of short option names
154
        """Make a new command option.
155
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
156
        :param name: regular name of the command, used in the double-dash
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
157
            form and also as the parameter to the command's run()
2745.4.2 by Lukáš Lalinsky
Allow options to be stored in attributes that differ from their 'name' and use this to let '--change' and '--revision' to override each other.
158
            method (unless param_name is specified).
1185.16.45 by Martin Pool
- refactor handling of short option names
159
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
160
        :param help: help message displayed in command help
1185.16.45 by Martin Pool
- refactor handling of short option names
161
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
162
        :param type: function called to parse the option argument, or
1185.16.45 by Martin Pool
- refactor handling of short option names
163
            None (default) if this option doesn't take an argument.
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
164
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
165
        :param argname: name of option argument, if any
166
167
        :param short_name: short option code for use with a single -, e.g.
168
            short_name="v" to enable parsing of -v.
169
2768.1.15 by Ian Clatworthy
Merge bzr.dev
170
        :param param_name: name of the parameter which will be passed to
2745.4.2 by Lukáš Lalinsky
Allow options to be stored in attributes that differ from their 'name' and use this to let '--change' and '--revision' to override each other.
171
            the command's run() method.
2768.1.15 by Ian Clatworthy
Merge bzr.dev
172
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
173
        :param custom_callback: a callback routine to be called after normal
2768.1.11 by Ian Clatworthy
Add new option tests for custom help, callbacks and verbose/quiet linkage
174
            processing. The signature of the callback routine is
175
            (option, name, new_value, parser).
1185.16.45 by Martin Pool
- refactor handling of short option names
176
        """
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
177
        self.name = name
178
        self.help = help
179
        self.type = type
2227.1.1 by mbp at sourcefrog
Back out previous incompatible change: Option.short_name is now again
180
        self._short_name = short_name
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
181
        if type is None:
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
182
            if argname:
183
                raise ValueError('argname not valid for booleans')
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
184
        elif argname is None:
185
            argname = 'ARG'
186
        self.argname = argname
2745.4.2 by Lukáš Lalinsky
Allow options to be stored in attributes that differ from their 'name' and use this to let '--change' and '--revision' to override each other.
187
        if param_name is None:
3668.2.1 by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name.
188
            self._param_name = self.name.replace('-', '_')
2745.4.2 by Lukáš Lalinsky
Allow options to be stored in attributes that differ from their 'name' and use this to let '--change' and '--revision' to override each other.
189
        else:
190
            self._param_name = param_name
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
191
        self.custom_callback = custom_callback
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
192
2227.1.1 by mbp at sourcefrog
Back out previous incompatible change: Option.short_name is now again
193
    def short_name(self):
2227.1.3 by mbp at sourcefrog
Restore access to SHORT_OPTIONS for compatibility
194
        if self._short_name:
195
            return self._short_name
2227.1.1 by mbp at sourcefrog
Back out previous incompatible change: Option.short_name is now again
196
2227.1.4 by mbp at sourcefrog
add test that legacy SHORT_OPTIONS really works, and set_short_name
197
    def set_short_name(self, short_name):
198
        self._short_name = short_name
199
1857.1.9 by Aaron Bentley
Add hidden negation options
200
    def get_negation_name(self):
201
        if self.name.startswith('no-'):
202
            return self.name[3:]
203
        else:
204
            return 'no-' + self.name
205
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
206
    def add_option(self, parser, short_name):
207
        """Add this option to an Optparse parser"""
208
        option_strings = ['--%s' % self.name]
209
        if short_name is not None:
210
            option_strings.append('-%s' % short_name)
211
        optargfn = self.type
212
        if optargfn is None:
3668.2.1 by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name.
213
            parser.add_option(action='callback',
214
                              callback=self._optparse_bool_callback,
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
215
                              callback_args=(True,),
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
216
                              help=self.help,
217
                              *option_strings)
1857.1.9 by Aaron Bentley
Add hidden negation options
218
            negation_strings = ['--%s' % self.get_negation_name()]
3668.2.1 by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name.
219
            parser.add_option(action='callback',
220
                              callback=self._optparse_bool_callback,
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
221
                              callback_args=(False,),
1857.1.22 by Aaron Bentley
Negations set value to False, instead of Optparser.DEFAULT_VALUE
222
                              help=optparse.SUPPRESS_HELP, *negation_strings)
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
223
        else:
3668.2.1 by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name.
224
            parser.add_option(action='callback',
225
                              callback=self._optparse_callback,
1857.1.12 by Aaron Bentley
Fix a bunch of test cases that assumed --merge-type or log-format
226
                              type='string', metavar=self.argname.upper(),
1857.1.4 by Aaron Bentley
Set metavar according to option
227
                              help=self.help,
3668.2.1 by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name.
228
                              default=OptionParser.DEFAULT_VALUE,
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
229
                              *option_strings)
230
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
231
    def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
2768.1.15 by Ian Clatworthy
Merge bzr.dev
232
        setattr(parser.values, self._param_name, bool_v)
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
233
        if self.custom_callback is not None:
2768.1.15 by Ian Clatworthy
Merge bzr.dev
234
            self.custom_callback(option, self._param_name, bool_v, parser)
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
235
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
236
    def _optparse_callback(self, option, opt, value, parser):
2768.1.11 by Ian Clatworthy
Add new option tests for custom help, callbacks and verbose/quiet linkage
237
        v = self.type(value)
2768.1.15 by Ian Clatworthy
Merge bzr.dev
238
        setattr(parser.values, self._param_name, v)
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
239
        if self.custom_callback is not None:
2768.1.11 by Ian Clatworthy
Add new option tests for custom help, callbacks and verbose/quiet linkage
240
            self.custom_callback(option, self.name, v, parser)
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
241
1857.1.14 by Aaron Bentley
Fix man page generation
242
    def iter_switches(self):
243
        """Iterate through the list of switches provided by the option
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
244
1857.1.14 by Aaron Bentley
Fix man page generation
245
        :return: an iterator of (name, short_name, argname, help)
246
        """
247
        argname =  self.argname
248
        if argname is not None:
249
            argname = argname.upper()
2227.1.1 by mbp at sourcefrog
Back out previous incompatible change: Option.short_name is now again
250
        yield self.name, self.short_name(), argname, self.help
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
251
1551.18.12 by Aaron Bentley
Man page doesn't list hidden options (#131667)
252
    def is_hidden(self, name):
253
        return False
254
1857.1.15 by Aaron Bentley
Add tests for generating an option parser
255
2376.4.1 by jml at canonical
Blackbox-driven --fixes option to commit.
256
class ListOption(Option):
2376.4.22 by Jonathan Lange
Variety of whitespace cleanups, tightening of tests and docstring changes in
257
    """Option used to provide a list of values.
258
259
    On the command line, arguments are specified by a repeated use of the
260
    option. '-' is a special argument that resets the list. For example,
261
      --foo=a --foo=b
262
    sets the value of the 'foo' option to ['a', 'b'], and
263
      --foo=a --foo=b --foo=- --foo=c
264
    sets the value of the 'foo' option to ['c'].
265
    """
266
2376.4.1 by jml at canonical
Blackbox-driven --fixes option to commit.
267
    def add_option(self, parser, short_name):
268
        """Add this option to an Optparse parser."""
269
        option_strings = ['--%s' % self.name]
270
        if short_name is not None:
271
            option_strings.append('-%s' % short_name)
272
        parser.add_option(action='callback',
273
                          callback=self._optparse_callback,
274
                          type='string', metavar=self.argname.upper(),
275
                          help=self.help, default=[],
276
                          *option_strings)
277
278
    def _optparse_callback(self, option, opt, value, parser):
2768.1.15 by Ian Clatworthy
Merge bzr.dev
279
        values = getattr(parser.values, self._param_name)
2376.4.11 by Jonathan Lange
Provide a way of resetting list options (specifying '-' as the argument)
280
        if value == '-':
281
            del values[:]
282
        else:
283
            values.append(self.type(value))
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
284
        if self.custom_callback is not None:
2768.1.15 by Ian Clatworthy
Merge bzr.dev
285
            self.custom_callback(option, self._param_name, values, parser)
2376.4.1 by jml at canonical
Blackbox-driven --fixes option to commit.
286
287
2221.4.1 by Aaron Bentley
Get registry options working
288
class RegistryOption(Option):
2221.4.6 by Aaron Bentley
Improve text and naming
289
    """Option based on a registry
2221.4.9 by Aaron Bentley
Zap trailing whitespace
290
2221.4.6 by Aaron Bentley
Improve text and naming
291
    The values for the options correspond to entries in the registry.  Input
292
    must be a registry key.  After validation, it is converted into an object
293
    using Registry.get or a caller-provided converter.
294
    """
2221.4.1 by Aaron Bentley
Get registry options working
295
296
    def validate_value(self, value):
2221.4.3 by Aaron Bentley
Add docstrings
297
        """Validate a value name"""
2221.4.1 by Aaron Bentley
Get registry options working
298
        if value not in self.registry:
2221.4.6 by Aaron Bentley
Improve text and naming
299
            raise errors.BadOptionValue(self.name, value)
2221.4.1 by Aaron Bentley
Get registry options working
300
2221.4.2 by Aaron Bentley
Implement RegistryOption on init
301
    def convert(self, value):
2221.4.3 by Aaron Bentley
Add docstrings
302
        """Convert a value name into an output type"""
303
        self.validate_value(value)
2221.4.1 by Aaron Bentley
Get registry options working
304
        if self.converter is None:
2221.4.2 by Aaron Bentley
Implement RegistryOption on init
305
            return self.registry.get(value)
2221.4.1 by Aaron Bentley
Get registry options working
306
        else:
2221.4.2 by Aaron Bentley
Implement RegistryOption on init
307
            return self.converter(value)
2221.4.1 by Aaron Bentley
Get registry options working
308
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
309
    def __init__(self, name, help, registry=None, converter=None,
310
        value_switches=False, title=None, enum_switch=True,
311
        lazy_registry=None):
2221.4.3 by Aaron Bentley
Add docstrings
312
        """
313
        Constructor.
314
315
        :param name: The option name.
316
        :param help: Help for the option.
317
        :param registry: A Registry containing the values
318
        :param converter: Callable to invoke with the value name to produce
2221.4.6 by Aaron Bentley
Improve text and naming
319
            the value.  If not supplied, self.registry.get is used.
2221.4.3 by Aaron Bentley
Add docstrings
320
        :param value_switches: If true, each possible value is assigned its
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
321
            own switch.  For example, instead of '--format knit',
322
            '--knit' can be used interchangeably.
1551.12.18 by Aaron Bentley
Allow RegistryOption to omit the value-taking option
323
        :param enum_switch: If true, a switch is provided with the option name,
324
            which takes a value.
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
325
        :param lazy_registry: A tuple of (module name, attribute name) for a
326
            registry to be lazily loaded.
2221.4.3 by Aaron Bentley
Add docstrings
327
        """
328
        Option.__init__(self, name, help, type=self.convert)
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
329
        self._registry = registry
330
        if registry is None:
3224.5.34 by Andrew Bennetts
Polish lazy_registry feature a little.
331
            if lazy_registry is None:
332
                raise AssertionError(
333
                    'One of registry or lazy_registry must be given.')
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
334
            self._lazy_registry = _mod_registry._LazyObjectGetter(
335
                *lazy_registry)
3224.5.34 by Andrew Bennetts
Polish lazy_registry feature a little.
336
        if registry is not None and lazy_registry is not None:
337
            raise AssertionError(
338
                'registry and lazy_registry are mutually exclusive')
2221.4.1 by Aaron Bentley
Get registry options working
339
        self.name = name
340
        self.converter = converter
2221.4.2 by Aaron Bentley
Implement RegistryOption on init
341
        self.value_switches = value_switches
1551.12.18 by Aaron Bentley
Allow RegistryOption to omit the value-taking option
342
        self.enum_switch = enum_switch
2221.4.12 by Aaron Bentley
Add option grouping to RegistryOption and clean up format options
343
        self.title = title
344
        if self.title is None:
345
            self.title = name
2221.4.1 by Aaron Bentley
Get registry options working
346
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
347
    @property
348
    def registry(self):
3224.5.34 by Andrew Bennetts
Polish lazy_registry feature a little.
349
        if self._registry is None:
350
            self._registry = self._lazy_registry.get_obj()
351
        return self._registry
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
352
1551.12.24 by Aaron Bentley
Add RegistryOption.from_swargs to simplify simple registry options
353
    @staticmethod
354
    def from_kwargs(name_, help=None, title=None, value_switches=False,
1551.12.43 by Aaron Bentley
Misc changes from review
355
                    enum_switch=True, **kwargs):
1551.12.24 by Aaron Bentley
Add RegistryOption.from_swargs to simplify simple registry options
356
        """Convenience method to generate string-map registry options
357
358
        name, help, value_switches and enum_switch are passed to the
359
        RegistryOption constructor.  Any other keyword arguments are treated
360
        as values for the option, and they value is treated as the help.
361
        """
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
362
        reg = _mod_registry.Registry()
2681.1.5 by Aaron Bentley
Display correct help message in from_kwargs
363
        for name, switch_help in kwargs.iteritems():
1551.12.24 by Aaron Bentley
Add RegistryOption.from_swargs to simplify simple registry options
364
            name = name.replace('_', '-')
2681.1.5 by Aaron Bentley
Display correct help message in from_kwargs
365
            reg.register(name, name, help=switch_help)
3571.2.1 by Robert Widhopf-Fenk
Add the help of values to the help of the option if there are no value switches.
366
            if not value_switches:
367
                help = help + '  "' + name + '": ' + switch_help
368
                if not help.endswith("."):
369
                    help = help + "."
1551.12.24 by Aaron Bentley
Add RegistryOption.from_swargs to simplify simple registry options
370
        return RegistryOption(name_, help, reg, title=title,
371
            value_switches=value_switches, enum_switch=enum_switch)
372
2221.4.1 by Aaron Bentley
Get registry options working
373
    def add_option(self, parser, short_name):
374
        """Add this option to an Optparse parser"""
2221.4.12 by Aaron Bentley
Add option grouping to RegistryOption and clean up format options
375
        if self.value_switches:
376
            parser = parser.add_option_group(self.title)
1551.12.18 by Aaron Bentley
Allow RegistryOption to omit the value-taking option
377
        if self.enum_switch:
378
            Option.add_option(self, parser, short_name)
2221.4.1 by Aaron Bentley
Get registry options working
379
        if self.value_switches:
380
            for key in self.registry.keys():
381
                option_strings = ['--%s' % key]
1551.18.12 by Aaron Bentley
Man page doesn't list hidden options (#131667)
382
                if self.is_hidden(key):
1551.13.2 by Aaron Bentley
Hide dirstate-with-subtree format
383
                    help = optparse.SUPPRESS_HELP
384
                else:
385
                    help = self.registry.get_help(key)
2221.4.9 by Aaron Bentley
Zap trailing whitespace
386
                parser.add_option(action='callback',
387
                              callback=self._optparse_value_callback(key),
1551.13.2 by Aaron Bentley
Hide dirstate-with-subtree format
388
                                  help=help,
2221.4.1 by Aaron Bentley
Get registry options working
389
                                  *option_strings)
390
391
    def _optparse_value_callback(self, cb_value):
392
        def cb(option, opt, value, parser):
2768.1.11 by Ian Clatworthy
Add new option tests for custom help, callbacks and verbose/quiet linkage
393
            v = self.type(cb_value)
2768.1.15 by Ian Clatworthy
Merge bzr.dev
394
            setattr(parser.values, self._param_name, v)
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
395
            if self.custom_callback is not None:
2768.1.15 by Ian Clatworthy
Merge bzr.dev
396
                self.custom_callback(option, self._param_name, v, parser)
2221.4.1 by Aaron Bentley
Get registry options working
397
        return cb
398
2221.4.4 by Aaron Bentley
Fix iter_switches behavior when value_switches is true
399
    def iter_switches(self):
400
        """Iterate through the list of switches provided by the option
2221.4.9 by Aaron Bentley
Zap trailing whitespace
401
2221.4.4 by Aaron Bentley
Fix iter_switches behavior when value_switches is true
402
        :return: an iterator of (name, short_name, argname, help)
403
        """
404
        for value in Option.iter_switches(self):
405
            yield value
406
        if self.value_switches:
407
            for key in sorted(self.registry.keys()):
408
                yield key, None, None, self.registry.get_help(key)
2221.4.1 by Aaron Bentley
Get registry options working
409
1551.18.12 by Aaron Bentley
Man page doesn't list hidden options (#131667)
410
    def is_hidden(self, name):
411
        if name == self.name:
412
            return Option.is_hidden(self, name)
413
        return getattr(self.registry.get_info(name), 'hidden', False)
414
2221.4.6 by Aaron Bentley
Improve text and naming
415
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
416
class OptionParser(optparse.OptionParser):
417
    """OptionParser that raises exceptions instead of exiting"""
418
1857.1.6 by Aaron Bentley
Make the DEFAULT_VALUE an object instance
419
    DEFAULT_VALUE = object()
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
420
421
    def error(self, message):
1996.3.28 by John Arbash Meinel
lazy import revisionspec and errors for bzrlib.options
422
        raise errors.BzrCommandError(message)
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
423
424
425
def get_optparser(options):
426
    """Generate an optparse parser for bzrlib-style options"""
427
428
    parser = OptionParser()
429
    parser.remove_option('--help')
430
    for option in options.itervalues():
2227.1.1 by mbp at sourcefrog
Back out previous incompatible change: Option.short_name is now again
431
        option.add_option(parser, option.short_name())
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
432
    return parser
433
1185.16.45 by Martin Pool
- refactor handling of short option names
434
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
435
def custom_help(name, help):
436
    """Clone a common option overriding the help."""
437
    import copy
438
    o = copy.copy(Option.OPTIONS[name])
439
    o.help = help
440
    return o
441
442
443
def _standard_option(name, **kwargs):
444
    """Register a standard option."""
445
    # All standard options are implicitly 'global' ones
446
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
447
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
448
449
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
450
def _global_option(name, **kwargs):
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
451
    """Register a global option."""
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
452
    Option.OPTIONS[name] = Option(name, **kwargs)
453
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
454
3224.5.3 by Andrew Bennetts
Avoid importing bzrlib.log unnecessarily, and always import bzrlib.registry and optparse directly in bzrlib.option because it always uses it.
455
def _global_registry_option(name, help, registry=None, **kwargs):
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
456
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
457
2221.4.17 by Aaron Bentley
PEP8-ness
458
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
459
# This is the verbosity level detected during command line parsing.
460
# Note that the final value is dependent on the order in which the
461
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
462
# The final value will be one of the following:
463
#
464
# * -ve for quiet
465
# * 0 for normal
466
# * +ve for verbose
467
_verbosity_level = 0
468
469
470
def _verbosity_level_callback(option, opt_str, value, parser):
471
    global _verbosity_level
472
    if not value:
473
        # Either --no-verbose or --no-quiet was specified
474
        _verbosity_level = 0
475
    elif opt_str == "verbose":
476
        if _verbosity_level > 0:
477
            _verbosity_level += 1
478
        else:
479
            _verbosity_level = 1
480
    else:
481
        if _verbosity_level < 0:
482
            _verbosity_level -= 1
483
        else:
484
            _verbosity_level = -1
485
486
3755.1.2 by Vincent Ladeuil
Fix conflict. Related to moved lines, nice use case
487
class MergeTypeRegistry(_mod_registry.Registry):
3755.1.1 by Vincent Ladeuil
Fix --verbose leaking into blackbox tests.
488
489
    pass
490
491
2221.4.15 by Aaron Bentley
Use RegistryOption for merge type
492
_merge_type_registry = MergeTypeRegistry()
493
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
494
                                   "Native diff3-style merge")
495
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
496
                                   "Merge using external diff3")
497
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
498
                                   "Weave-based merge")
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
499
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
500
                                   "LCA-newness merge")
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
501
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
502
# Declare the standard options
503
_standard_option('help', short_name='h',
504
                 help='Show help message.')
3984.4.6 by Ian Clatworthy
Show usage on --usage, not -h
505
_standard_option('usage',
506
                 help='Show usage message and options.')
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
507
_standard_option('verbose', short_name='v',
508
                 help='Display more information.',
509
                 custom_callback=_verbosity_level_callback)
510
_standard_option('quiet', short_name='q',
511
                 help="Only display errors and warnings.",
512
                 custom_callback=_verbosity_level_callback)
513
514
# Declare commonly used options
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
515
_global_option('all')
1185.12.92 by Aaron Bentley
Fixed pull help, renamed clobber to overwrite
516
_global_option('overwrite', help='Ignore differences between branches and '
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
517
               'overwrite unconditionally.')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
518
_global_option('basis', type=str)
519
_global_option('bound')
520
_global_option('diff-options', type=str)
521
_global_option('file', type=unicode, short_name='F')
522
_global_option('force')
523
_global_option('format', type=unicode)
524
_global_option('forward')
525
_global_option('message', type=unicode,
526
               short_name='m',
527
               help='Message string.')
528
_global_option('no-recurse')
529
_global_option('profile',
530
               help='Show performance profiling information.')
2204.2.1 by Wouter van Heyst
Fix merge conflicts.
531
_global_option('revision',
2190.2.1 by Martin Pool
remove global registration of short options
532
               type=_parse_revision_str,
2204.2.1 by Wouter van Heyst
Fix merge conflicts.
533
               short_name='r',
2745.4.4 by Lukáš Lalinsky
- Make the description of --change more general
534
               help='See "help revisionspec" for details.')
2745.4.1 by Lukáš Lalinsky
New option -C/--change for diff and status to show changes in one revision. (#56299)
535
_global_option('change',
536
               type=_parse_change_str,
2745.4.3 by Lukáš Lalinsky
Change -C to -c.
537
               short_name='c',
2745.4.2 by Lukáš Lalinsky
Allow options to be stored in attributes that differ from their 'name' and use this to let '--change' and '--revision' to override each other.
538
               param_name='revision',
2745.4.4 by Lukáš Lalinsky
- Make the description of --change more general
539
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
540
_global_option('show-ids',
541
               help='Show internal object ids.')
3755.1.1 by Vincent Ladeuil
Fix --verbose leaking into blackbox tests.
542
_global_option('timezone',
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
543
               type=str,
3755.1.1 by Vincent Ladeuil
Fix --verbose leaking into blackbox tests.
544
               help='Display timezone as local, original, or utc.')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
545
_global_option('unbound')
546
_global_option('version')
547
_global_option('email')
548
_global_option('update')
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
549
_global_registry_option('log-format', "Use specified log format.",
3224.5.3 by Andrew Bennetts
Avoid importing bzrlib.log unnecessarily, and always import bzrlib.registry and optparse directly in bzrlib.option because it always uses it.
550
                        lazy_registry=('bzrlib.log', 'log_formatter_registry'),
551
                        value_switches=True, title='Log format')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
552
_global_option('long', help='Use detailed log format. Same as --log-format long',
553
               short_name='l')
554
_global_option('short', help='Use moderately short log format. Same as --log-format short')
555
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
556
_global_option('root', type=str)
557
_global_option('no-backup')
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
558
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
2221.4.15 by Aaron Bentley
Use RegistryOption for merge type
559
                        _merge_type_registry, value_switches=True,
560
                        title='Merge algorithm')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
561
_global_option('pattern', type=str)
1185.12.92 by Aaron Bentley
Fixed pull help, renamed clobber to overwrite
562
_global_option('remember', help='Remember the specified location as a'
563
               ' default.')
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
564
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
565
_global_option('kind', type=str)
566
_global_option('dry-run',
567
               help="Show what would be done, but don't actually do anything.")
568
_global_option('name-from-revision', help='The path name in the old tree.')
0.16.108 by Aaron Bentley
Shelf supports multiple diff writers.
569
570
diff_writer_registry = _mod_registry.Registry()
571
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
572
diff_writer_registry.default_key = 'plain'