~bzr-pqm/bzr/bzr.dev

4988.10.5 by John Arbash Meinel
Merge bzr.dev 5021 to resolve NEWS
1
# Copyright (C) 2005-2010 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')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
43
    [<RevisionSpec_dwim 234>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
44
    >>> _parse_revision_str('234..567')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
45
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 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')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
49
    [<RevisionSpec None>, <RevisionSpec_dwim 234>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
50
    >>> _parse_revision_str('234..')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
51
    [<RevisionSpec_dwim 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
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
53
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
54
    >>> _parse_revision_str('234....789') #Error ?
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
55
    [<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 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')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
61
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 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')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
71
    [<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
72
    >>> _parse_revision_str('-5')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
73
    [<RevisionSpec_dwim -5>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
74
    >>> _parse_revision_str('123a')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
75
    [<RevisionSpec_dwim 123a>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
76
    >>> _parse_revision_str('abc')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
77
    [<RevisionSpec_dwim abc>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
78
    >>> _parse_revision_str('branch:../branch2')
79
    [<RevisionSpec_branch branch:../branch2>]
1545.1.1 by Denys Duchier
distinguish ../ as path to branch and .. as revspec separator
80
    >>> _parse_revision_str('branch:../../branch2')
81
    [<RevisionSpec_branch branch:../../branch2>]
82
    >>> _parse_revision_str('branch:../../branch2..23')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
83
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_dwim 23>]
2747.1.1 by Lukáš Lalinský
Accept ..\ as a path in revision specifiers
84
    >>> _parse_revision_str('branch:..\\\\branch2')
85
    [<RevisionSpec_branch branch:..\\branch2>]
86
    >>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
87
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
88
    """
89
    # TODO: Maybe move this into revisionspec.py
90
    revs = []
2747.1.1 by Lukáš Lalinský
Accept ..\ as a path in revision specifiers
91
    # split on .. that is not followed by a / or \
92
    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
93
    for x in sep.split(revstr):
1996.3.28 by John Arbash Meinel
lazy import revisionspec and errors for bzrlib.options
94
        revs.append(revisionspec.RevisionSpec.from_string(x or None))
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
95
    return revs
96
97
2745.4.1 by Lukáš Lalinsky
New option -C/--change for diff and status to show changes in one revision. (#56299)
98
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
99
    """Parse the revision string and return a tuple with left-most
100
    parent of the revision.
101
102
    >>> _parse_change_str('123')
4569.2.12 by Matthew Fuller
Fix up some doctests to handle things ending up as RevisionSpec_dwim's
103
    (<RevisionSpec_before before:123>, <RevisionSpec_dwim 123>)
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
104
    >>> _parse_change_str('123..124')
105
    Traceback (most recent call last):
106
      ...
107
    RangeInChangeOption: Option --change does not accept revision ranges
108
    """
109
    revs = _parse_revision_str(revstr)
110
    if len(revs) > 1:
2745.4.4 by Lukáš Lalinsky
- Make the description of --change more general
111
        raise errors.RangeInChangeOption()
2745.4.1 by Lukáš Lalinsky
New option -C/--change for diff and status to show changes in one revision. (#56299)
112
    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
113
            revs[0])
2745.4.1 by Lukáš Lalinsky
New option -C/--change for diff and status to show changes in one revision. (#56299)
114
115
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
116
def _parse_merge_type(typestring):
1185.12.62 by Aaron Bentley
Restored merge-type selection
117
    return get_merge_type(typestring)
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
118
1185.12.62 by Aaron Bentley
Restored merge-type selection
119
def get_merge_type(typestring):
120
    """Attempt to find the merge class/factory associated with a string."""
121
    from merge import merge_types
122
    try:
123
        return merge_types[typestring][0]
124
    except KeyError:
125
        templ = '%s%%7s: %%s' % (' '*12)
126
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
127
        type_list = '\n'.join(lines)
128
        msg = "No known merge type %s. Supported types are:\n%s" %\
129
            (typestring, type_list)
1996.3.28 by John Arbash Meinel
lazy import revisionspec and errors for bzrlib.options
130
        raise errors.BzrCommandError(msg)
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
131
2227.1.2 by mbp at sourcefrog
Add a simple DeprecatedDict class
132
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
133
class Option(object):
2190.2.1 by Martin Pool
remove global registration of short options
134
    """Description of a command line option
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
135
2227.1.1 by mbp at sourcefrog
Back out previous incompatible change: Option.short_name is now again
136
    :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
137
    Otherwise None.
138
    """
139
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
140
    # The dictionary of standard options. These are always legal.
141
    STD_OPTIONS = {}
1185.16.45 by Martin Pool
- refactor handling of short option names
142
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
143
    # The dictionary of commonly used options. these are only legal
144
    # if a command explicitly references them by name in the list
145
    # of supported options.
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
146
    OPTIONS = {}
147
2190.2.1 by Martin Pool
remove global registration of short options
148
    def __init__(self, name, help='', type=None, argname=None,
4251.1.1 by Aaron Bentley
Support hidden options.
149
                 short_name=None, param_name=None, custom_callback=None,
150
                 hidden=False):
1185.16.45 by Martin Pool
- refactor handling of short option names
151
        """Make a new command option.
152
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
153
        :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
154
            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.
155
            method (unless param_name is specified).
1185.16.45 by Martin Pool
- refactor handling of short option names
156
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
157
        :param help: help message displayed in command help
1185.16.45 by Martin Pool
- refactor handling of short option names
158
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
159
        :param type: function called to parse the option argument, or
1185.16.45 by Martin Pool
- refactor handling of short option names
160
            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
161
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
162
        :param argname: name of option argument, if any
163
164
        :param short_name: short option code for use with a single -, e.g.
165
            short_name="v" to enable parsing of -v.
166
2768.1.15 by Ian Clatworthy
Merge bzr.dev
167
        :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.
168
            the command's run() method.
2768.1.15 by Ian Clatworthy
Merge bzr.dev
169
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
170
        :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
171
            processing. The signature of the callback routine is
172
            (option, name, new_value, parser).
4251.1.1 by Aaron Bentley
Support hidden options.
173
        :param hidden: If True, the option should be hidden in help and
174
            documentation.
1185.16.45 by Martin Pool
- refactor handling of short option names
175
        """
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
176
        self.name = name
177
        self.help = help
178
        self.type = type
2227.1.1 by mbp at sourcefrog
Back out previous incompatible change: Option.short_name is now again
179
        self._short_name = short_name
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
180
        if type is None:
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
181
            if argname:
182
                raise ValueError('argname not valid for booleans')
1185.16.48 by mbp at sourcefrog
- more refactoring of and tests for option parsing
183
        elif argname is None:
184
            argname = 'ARG'
185
        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.
186
        if param_name is None:
3668.2.1 by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name.
187
            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.
188
        else:
189
            self._param_name = param_name
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
190
        self.custom_callback = custom_callback
4251.1.1 by Aaron Bentley
Support hidden options.
191
        self.hidden = hidden
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)
4251.1.1 by Aaron Bentley
Support hidden options.
211
        if self.hidden:
212
            help = optparse.SUPPRESS_HELP
213
        else:
214
            help = self.help
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
215
        optargfn = self.type
216
        if optargfn is None:
3668.2.1 by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name.
217
            parser.add_option(action='callback',
218
                              callback=self._optparse_bool_callback,
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
219
                              callback_args=(True,),
4251.1.1 by Aaron Bentley
Support hidden options.
220
                              help=help,
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
221
                              *option_strings)
1857.1.9 by Aaron Bentley
Add hidden negation options
222
            negation_strings = ['--%s' % self.get_negation_name()]
3668.2.1 by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name.
223
            parser.add_option(action='callback',
224
                              callback=self._optparse_bool_callback,
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
225
                              callback_args=(False,),
1857.1.22 by Aaron Bentley
Negations set value to False, instead of Optparser.DEFAULT_VALUE
226
                              help=optparse.SUPPRESS_HELP, *negation_strings)
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
227
        else:
3668.2.1 by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name.
228
            parser.add_option(action='callback',
229
                              callback=self._optparse_callback,
1857.1.12 by Aaron Bentley
Fix a bunch of test cases that assumed --merge-type or log-format
230
                              type='string', metavar=self.argname.upper(),
4251.1.1 by Aaron Bentley
Support hidden options.
231
                              help=help,
3668.2.1 by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name.
232
                              default=OptionParser.DEFAULT_VALUE,
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
233
                              *option_strings)
234
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
235
    def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
2768.1.15 by Ian Clatworthy
Merge bzr.dev
236
        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
237
        if self.custom_callback is not None:
2768.1.15 by Ian Clatworthy
Merge bzr.dev
238
            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
239
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
240
    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
241
        v = self.type(value)
2768.1.15 by Ian Clatworthy
Merge bzr.dev
242
        setattr(parser.values, self._param_name, v)
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
243
        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
244
            self.custom_callback(option, self.name, v, parser)
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
245
1857.1.14 by Aaron Bentley
Fix man page generation
246
    def iter_switches(self):
247
        """Iterate through the list of switches provided by the option
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
248
1857.1.14 by Aaron Bentley
Fix man page generation
249
        :return: an iterator of (name, short_name, argname, help)
250
        """
251
        argname =  self.argname
252
        if argname is not None:
253
            argname = argname.upper()
2227.1.1 by mbp at sourcefrog
Back out previous incompatible change: Option.short_name is now again
254
        yield self.name, self.short_name(), argname, self.help
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
255
1551.18.12 by Aaron Bentley
Man page doesn't list hidden options (#131667)
256
    def is_hidden(self, name):
4251.1.1 by Aaron Bentley
Support hidden options.
257
        return self.hidden
1551.18.12 by Aaron Bentley
Man page doesn't list hidden options (#131667)
258
1857.1.15 by Aaron Bentley
Add tests for generating an option parser
259
2376.4.1 by jml at canonical
Blackbox-driven --fixes option to commit.
260
class ListOption(Option):
2376.4.22 by Jonathan Lange
Variety of whitespace cleanups, tightening of tests and docstring changes in
261
    """Option used to provide a list of values.
262
263
    On the command line, arguments are specified by a repeated use of the
264
    option. '-' is a special argument that resets the list. For example,
265
      --foo=a --foo=b
266
    sets the value of the 'foo' option to ['a', 'b'], and
267
      --foo=a --foo=b --foo=- --foo=c
268
    sets the value of the 'foo' option to ['c'].
269
    """
270
2376.4.1 by jml at canonical
Blackbox-driven --fixes option to commit.
271
    def add_option(self, parser, short_name):
272
        """Add this option to an Optparse parser."""
273
        option_strings = ['--%s' % self.name]
274
        if short_name is not None:
275
            option_strings.append('-%s' % short_name)
276
        parser.add_option(action='callback',
277
                          callback=self._optparse_callback,
278
                          type='string', metavar=self.argname.upper(),
3751.1.1 by Martin von Gagern
Handle param_name for ListOption.
279
                          help=self.help, dest=self._param_name, default=[],
2376.4.1 by jml at canonical
Blackbox-driven --fixes option to commit.
280
                          *option_strings)
281
282
    def _optparse_callback(self, option, opt, value, parser):
2768.1.15 by Ian Clatworthy
Merge bzr.dev
283
        values = getattr(parser.values, self._param_name)
2376.4.11 by Jonathan Lange
Provide a way of resetting list options (specifying '-' as the argument)
284
        if value == '-':
285
            del values[:]
286
        else:
287
            values.append(self.type(value))
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
288
        if self.custom_callback is not None:
2768.1.15 by Ian Clatworthy
Merge bzr.dev
289
            self.custom_callback(option, self._param_name, values, parser)
2376.4.1 by jml at canonical
Blackbox-driven --fixes option to commit.
290
291
2221.4.1 by Aaron Bentley
Get registry options working
292
class RegistryOption(Option):
2221.4.6 by Aaron Bentley
Improve text and naming
293
    """Option based on a registry
2221.4.9 by Aaron Bentley
Zap trailing whitespace
294
2221.4.6 by Aaron Bentley
Improve text and naming
295
    The values for the options correspond to entries in the registry.  Input
296
    must be a registry key.  After validation, it is converted into an object
297
    using Registry.get or a caller-provided converter.
298
    """
2221.4.1 by Aaron Bentley
Get registry options working
299
300
    def validate_value(self, value):
2221.4.3 by Aaron Bentley
Add docstrings
301
        """Validate a value name"""
2221.4.1 by Aaron Bentley
Get registry options working
302
        if value not in self.registry:
2221.4.6 by Aaron Bentley
Improve text and naming
303
            raise errors.BadOptionValue(self.name, value)
2221.4.1 by Aaron Bentley
Get registry options working
304
2221.4.2 by Aaron Bentley
Implement RegistryOption on init
305
    def convert(self, value):
2221.4.3 by Aaron Bentley
Add docstrings
306
        """Convert a value name into an output type"""
307
        self.validate_value(value)
2221.4.1 by Aaron Bentley
Get registry options working
308
        if self.converter is None:
2221.4.2 by Aaron Bentley
Implement RegistryOption on init
309
            return self.registry.get(value)
2221.4.1 by Aaron Bentley
Get registry options working
310
        else:
2221.4.2 by Aaron Bentley
Implement RegistryOption on init
311
            return self.converter(value)
2221.4.1 by Aaron Bentley
Get registry options working
312
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.
313
    def __init__(self, name, help, registry=None, converter=None,
314
        value_switches=False, title=None, enum_switch=True,
5574.9.3 by Jelmer Vernooij
Add -F as alias for 'bzr diff -F format'
315
        lazy_registry=None, short_name=None):
2221.4.3 by Aaron Bentley
Add docstrings
316
        """
317
        Constructor.
318
319
        :param name: The option name.
320
        :param help: Help for the option.
321
        :param registry: A Registry containing the values
322
        :param converter: Callable to invoke with the value name to produce
2221.4.6 by Aaron Bentley
Improve text and naming
323
            the value.  If not supplied, self.registry.get is used.
2221.4.3 by Aaron Bentley
Add docstrings
324
        :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.
325
            own switch.  For example, instead of '--format knit',
326
            '--knit' can be used interchangeably.
1551.12.18 by Aaron Bentley
Allow RegistryOption to omit the value-taking option
327
        :param enum_switch: If true, a switch is provided with the option name,
328
            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.
329
        :param lazy_registry: A tuple of (module name, attribute name) for a
330
            registry to be lazily loaded.
2221.4.3 by Aaron Bentley
Add docstrings
331
        """
5574.9.3 by Jelmer Vernooij
Add -F as alias for 'bzr diff -F format'
332
        Option.__init__(self, name, help, type=self.convert, short_name=short_name)
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.
333
        self._registry = registry
334
        if registry is None:
3224.5.34 by Andrew Bennetts
Polish lazy_registry feature a little.
335
            if lazy_registry is None:
336
                raise AssertionError(
337
                    '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.
338
            self._lazy_registry = _mod_registry._LazyObjectGetter(
339
                *lazy_registry)
3224.5.34 by Andrew Bennetts
Polish lazy_registry feature a little.
340
        if registry is not None and lazy_registry is not None:
341
            raise AssertionError(
342
                'registry and lazy_registry are mutually exclusive')
2221.4.1 by Aaron Bentley
Get registry options working
343
        self.name = name
344
        self.converter = converter
2221.4.2 by Aaron Bentley
Implement RegistryOption on init
345
        self.value_switches = value_switches
1551.12.18 by Aaron Bentley
Allow RegistryOption to omit the value-taking option
346
        self.enum_switch = enum_switch
2221.4.12 by Aaron Bentley
Add option grouping to RegistryOption and clean up format options
347
        self.title = title
348
        if self.title is None:
349
            self.title = name
2221.4.1 by Aaron Bentley
Get registry options working
350
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.
351
    @property
352
    def registry(self):
3224.5.34 by Andrew Bennetts
Polish lazy_registry feature a little.
353
        if self._registry is None:
354
            self._registry = self._lazy_registry.get_obj()
355
        return self._registry
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
356
1551.12.24 by Aaron Bentley
Add RegistryOption.from_swargs to simplify simple registry options
357
    @staticmethod
358
    def from_kwargs(name_, help=None, title=None, value_switches=False,
1551.12.43 by Aaron Bentley
Misc changes from review
359
                    enum_switch=True, **kwargs):
1551.12.24 by Aaron Bentley
Add RegistryOption.from_swargs to simplify simple registry options
360
        """Convenience method to generate string-map registry options
361
362
        name, help, value_switches and enum_switch are passed to the
363
        RegistryOption constructor.  Any other keyword arguments are treated
4597.3.51 by Vincent Ladeuil
Implement conflicts.ResolveActionOption.
364
        as values for the option, and their value is treated as the help.
1551.12.24 by Aaron Bentley
Add RegistryOption.from_swargs to simplify simple registry options
365
        """
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.
366
        reg = _mod_registry.Registry()
3756.1.1 by Martin von Gagern
List arguments of RegistryOption.from_kwargs in alphabetical order.
367
        for name, switch_help in sorted(kwargs.items()):
1551.12.24 by Aaron Bentley
Add RegistryOption.from_swargs to simplify simple registry options
368
            name = name.replace('_', '-')
2681.1.5 by Aaron Bentley
Display correct help message in from_kwargs
369
            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.
370
            if not value_switches:
371
                help = help + '  "' + name + '": ' + switch_help
372
                if not help.endswith("."):
373
                    help = help + "."
1551.12.24 by Aaron Bentley
Add RegistryOption.from_swargs to simplify simple registry options
374
        return RegistryOption(name_, help, reg, title=title,
375
            value_switches=value_switches, enum_switch=enum_switch)
376
2221.4.1 by Aaron Bentley
Get registry options working
377
    def add_option(self, parser, short_name):
378
        """Add this option to an Optparse parser"""
2221.4.12 by Aaron Bentley
Add option grouping to RegistryOption and clean up format options
379
        if self.value_switches:
380
            parser = parser.add_option_group(self.title)
1551.12.18 by Aaron Bentley
Allow RegistryOption to omit the value-taking option
381
        if self.enum_switch:
382
            Option.add_option(self, parser, short_name)
2221.4.1 by Aaron Bentley
Get registry options working
383
        if self.value_switches:
384
            for key in self.registry.keys():
385
                option_strings = ['--%s' % key]
1551.18.12 by Aaron Bentley
Man page doesn't list hidden options (#131667)
386
                if self.is_hidden(key):
1551.13.2 by Aaron Bentley
Hide dirstate-with-subtree format
387
                    help = optparse.SUPPRESS_HELP
388
                else:
389
                    help = self.registry.get_help(key)
2221.4.9 by Aaron Bentley
Zap trailing whitespace
390
                parser.add_option(action='callback',
391
                              callback=self._optparse_value_callback(key),
1551.13.2 by Aaron Bentley
Hide dirstate-with-subtree format
392
                                  help=help,
2221.4.1 by Aaron Bentley
Get registry options working
393
                                  *option_strings)
394
395
    def _optparse_value_callback(self, cb_value):
396
        def cb(option, opt, value, parser):
2768.1.11 by Ian Clatworthy
Add new option tests for custom help, callbacks and verbose/quiet linkage
397
            v = self.type(cb_value)
2768.1.15 by Ian Clatworthy
Merge bzr.dev
398
            setattr(parser.values, self._param_name, v)
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
399
            if self.custom_callback is not None:
2768.1.15 by Ian Clatworthy
Merge bzr.dev
400
                self.custom_callback(option, self._param_name, v, parser)
2221.4.1 by Aaron Bentley
Get registry options working
401
        return cb
402
2221.4.4 by Aaron Bentley
Fix iter_switches behavior when value_switches is true
403
    def iter_switches(self):
404
        """Iterate through the list of switches provided by the option
2221.4.9 by Aaron Bentley
Zap trailing whitespace
405
2221.4.4 by Aaron Bentley
Fix iter_switches behavior when value_switches is true
406
        :return: an iterator of (name, short_name, argname, help)
407
        """
408
        for value in Option.iter_switches(self):
409
            yield value
410
        if self.value_switches:
411
            for key in sorted(self.registry.keys()):
412
                yield key, None, None, self.registry.get_help(key)
2221.4.1 by Aaron Bentley
Get registry options working
413
1551.18.12 by Aaron Bentley
Man page doesn't list hidden options (#131667)
414
    def is_hidden(self, name):
415
        if name == self.name:
416
            return Option.is_hidden(self, name)
417
        return getattr(self.registry.get_info(name), 'hidden', False)
418
2221.4.6 by Aaron Bentley
Improve text and naming
419
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
420
class OptionParser(optparse.OptionParser):
421
    """OptionParser that raises exceptions instead of exiting"""
422
1857.1.6 by Aaron Bentley
Make the DEFAULT_VALUE an object instance
423
    DEFAULT_VALUE = object()
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
424
425
    def error(self, message):
1996.3.28 by John Arbash Meinel
lazy import revisionspec and errors for bzrlib.options
426
        raise errors.BzrCommandError(message)
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
427
428
429
def get_optparser(options):
430
    """Generate an optparse parser for bzrlib-style options"""
431
432
    parser = OptionParser()
433
    parser.remove_option('--help')
434
    for option in options.itervalues():
2227.1.1 by mbp at sourcefrog
Back out previous incompatible change: Option.short_name is now again
435
        option.add_option(parser, option.short_name())
1857.1.3 by Aaron Bentley
Make option adding depend on Option type
436
    return parser
437
1185.16.45 by Martin Pool
- refactor handling of short option names
438
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
439
def custom_help(name, help):
440
    """Clone a common option overriding the help."""
441
    import copy
442
    o = copy.copy(Option.OPTIONS[name])
443
    o.help = help
444
    return o
445
446
447
def _standard_option(name, **kwargs):
448
    """Register a standard option."""
449
    # All standard options are implicitly 'global' ones
450
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
451
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
452
453
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
454
def _global_option(name, **kwargs):
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
455
    """Register a global option."""
1185.16.41 by Martin Pool
[patch] define cli options as objects, not strings
456
    Option.OPTIONS[name] = Option(name, **kwargs)
457
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
458
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.
459
def _global_registry_option(name, help, registry=None, **kwargs):
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
460
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
461
2221.4.17 by Aaron Bentley
PEP8-ness
462
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
463
# This is the verbosity level detected during command line parsing.
464
# Note that the final value is dependent on the order in which the
465
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
466
# The final value will be one of the following:
467
#
468
# * -ve for quiet
469
# * 0 for normal
470
# * +ve for verbose
471
_verbosity_level = 0
472
473
474
def _verbosity_level_callback(option, opt_str, value, parser):
475
    global _verbosity_level
476
    if not value:
477
        # Either --no-verbose or --no-quiet was specified
478
        _verbosity_level = 0
479
    elif opt_str == "verbose":
480
        if _verbosity_level > 0:
481
            _verbosity_level += 1
482
        else:
483
            _verbosity_level = 1
484
    else:
485
        if _verbosity_level < 0:
486
            _verbosity_level -= 1
487
        else:
488
            _verbosity_level = -1
489
490
3755.1.2 by Vincent Ladeuil
Fix conflict. Related to moved lines, nice use case
491
class MergeTypeRegistry(_mod_registry.Registry):
3755.1.1 by Vincent Ladeuil
Fix --verbose leaking into blackbox tests.
492
493
    pass
494
495
2221.4.15 by Aaron Bentley
Use RegistryOption for merge type
496
_merge_type_registry = MergeTypeRegistry()
497
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
498
                                   "Native diff3-style merge")
499
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
500
                                   "Merge using external diff3")
501
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
502
                                   "Weave-based merge")
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
503
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
504
                                   "LCA-newness merge")
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
505
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
506
# Declare the standard options
507
_standard_option('help', short_name='h',
508
                 help='Show help message.')
3984.4.6 by Ian Clatworthy
Show usage on --usage, not -h
509
_standard_option('usage',
510
                 help='Show usage message and options.')
2768.1.3 by Ian Clatworthy
Support custom help for commonly used options and standard option definition
511
_standard_option('verbose', short_name='v',
512
                 help='Display more information.',
513
                 custom_callback=_verbosity_level_callback)
514
_standard_option('quiet', short_name='q',
515
                 help="Only display errors and warnings.",
516
                 custom_callback=_verbosity_level_callback)
517
518
# Declare commonly used options
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
519
_global_option('all')
1185.12.92 by Aaron Bentley
Fixed pull help, renamed clobber to overwrite
520
_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
521
               'overwrite unconditionally.')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
522
_global_option('basis', type=str)
523
_global_option('bound')
524
_global_option('diff-options', type=str)
525
_global_option('file', type=unicode, short_name='F')
526
_global_option('force')
527
_global_option('format', type=unicode)
528
_global_option('forward')
529
_global_option('message', type=unicode,
530
               short_name='m',
531
               help='Message string.')
532
_global_option('no-recurse')
5250.1.1 by Parth Malwankar
-0/--null should be a global option and not standard option.
533
_global_option('null', short_name='0',
534
                 help='Use an ASCII NUL (\\0) separator rather than '
535
                      'a newline.')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
536
_global_option('profile',
537
               help='Show performance profiling information.')
2204.2.1 by Wouter van Heyst
Fix merge conflicts.
538
_global_option('revision',
2190.2.1 by Martin Pool
remove global registration of short options
539
               type=_parse_revision_str,
2204.2.1 by Wouter van Heyst
Fix merge conflicts.
540
               short_name='r',
2745.4.4 by Lukáš Lalinsky
- Make the description of --change more general
541
               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)
542
_global_option('change',
543
               type=_parse_change_str,
2745.4.3 by Lukáš Lalinsky
Change -C to -c.
544
               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.
545
               param_name='revision',
2745.4.4 by Lukáš Lalinsky
- Make the description of --change more general
546
               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
547
_global_option('show-ids',
548
               help='Show internal object ids.')
3755.1.1 by Vincent Ladeuil
Fix --verbose leaking into blackbox tests.
549
_global_option('timezone',
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
550
               type=str,
3755.1.1 by Vincent Ladeuil
Fix --verbose leaking into blackbox tests.
551
               help='Display timezone as local, original, or utc.')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
552
_global_option('unbound')
553
_global_option('version')
554
_global_option('email')
555
_global_option('update')
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
556
_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.
557
                        lazy_registry=('bzrlib.log', 'log_formatter_registry'),
558
                        value_switches=True, title='Log format')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
559
_global_option('long', help='Use detailed log format. Same as --log-format long',
560
               short_name='l')
561
_global_option('short', help='Use moderately short log format. Same as --log-format short')
562
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
563
_global_option('root', type=str)
564
_global_option('no-backup')
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
565
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
2221.4.15 by Aaron Bentley
Use RegistryOption for merge type
566
                        _merge_type_registry, value_switches=True,
567
                        title='Merge algorithm')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
568
_global_option('pattern', type=str)
1185.12.92 by Aaron Bentley
Fixed pull help, renamed clobber to overwrite
569
_global_option('remember', help='Remember the specified location as a'
570
               ' default.')
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
571
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
2598.1.14 by Martin Pool
Revert tightening of options api - breaks too many plugins
572
_global_option('kind', type=str)
573
_global_option('dry-run',
574
               help="Show what would be done, but don't actually do anything.")
575
_global_option('name-from-revision', help='The path name in the old tree.')
5171.3.1 by Martin von Gagern
Turn --directory and -d into a global option.
576
_global_option('directory', short_name='d', type=unicode,
577
               help='Branch to operate on, instead of working directory')
0.16.108 by Aaron Bentley
Shelf supports multiple diff writers.
578
579
diff_writer_registry = _mod_registry.Registry()
580
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
581
diff_writer_registry.default_key = 'plain'