/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
# TODO: For things like --diff-prefix, we want a way to customize the display
18
18
# of the option argument.
19
19
 
 
20
import re
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
20
24
import optparse
21
 
import re
22
25
 
23
 
from . import (
 
26
from bzrlib import (
24
27
    errors,
25
 
    registry as _mod_registry,
 
28
    log,
 
29
    registry,
26
30
    revisionspec,
 
31
    symbol_versioning,
27
32
    )
28
 
 
29
 
 
30
 
class BadOptionValue(errors.BzrError):
31
 
 
32
 
    _fmt = """Bad value "%(value)s" for option "%(name)s"."""
33
 
 
34
 
    def __init__(self, name, value):
35
 
        errors.BzrError.__init__(self, name=name, value=value)
 
33
""")
 
34
from bzrlib.trace import warning
36
35
 
37
36
 
38
37
def _parse_revision_str(revstr):
42
41
    each revision specifier supplied.
43
42
 
44
43
    >>> _parse_revision_str('234')
45
 
    [<RevisionSpec_dwim 234>]
 
44
    [<RevisionSpec_revno 234>]
46
45
    >>> _parse_revision_str('234..567')
47
 
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
 
46
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
48
47
    >>> _parse_revision_str('..')
49
48
    [<RevisionSpec None>, <RevisionSpec None>]
50
49
    >>> _parse_revision_str('..234')
51
 
    [<RevisionSpec None>, <RevisionSpec_dwim 234>]
 
50
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
52
51
    >>> _parse_revision_str('234..')
53
 
    [<RevisionSpec_dwim 234>, <RevisionSpec None>]
 
52
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
54
53
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
55
 
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
 
54
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
56
55
    >>> _parse_revision_str('234....789') #Error ?
57
 
    [<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
 
56
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
58
57
    >>> _parse_revision_str('revid:test@other.com-234234')
59
58
    [<RevisionSpec_revid revid:test@other.com-234234>]
60
59
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
61
60
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
62
61
    >>> _parse_revision_str('revid:test@other.com-234234..23')
63
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
 
62
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
64
63
    >>> _parse_revision_str('date:2005-04-12')
65
64
    [<RevisionSpec_date date:2005-04-12>]
66
65
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
70
69
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
71
70
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
72
71
    >>> _parse_revision_str('-5..23')
73
 
    [<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
 
72
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
74
73
    >>> _parse_revision_str('-5')
75
 
    [<RevisionSpec_dwim -5>]
 
74
    [<RevisionSpec_revno -5>]
76
75
    >>> _parse_revision_str('123a')
77
 
    [<RevisionSpec_dwim 123a>]
 
76
    Traceback (most recent call last):
 
77
      ...
 
78
    NoSuchRevisionSpec: No namespace registered for string: '123a'
78
79
    >>> _parse_revision_str('abc')
79
 
    [<RevisionSpec_dwim abc>]
 
80
    Traceback (most recent call last):
 
81
      ...
 
82
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
80
83
    >>> _parse_revision_str('branch:../branch2')
81
84
    [<RevisionSpec_branch branch:../branch2>]
82
85
    >>> _parse_revision_str('branch:../../branch2')
83
86
    [<RevisionSpec_branch branch:../../branch2>]
84
87
    >>> _parse_revision_str('branch:../../branch2..23')
85
 
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_dwim 23>]
86
 
    >>> _parse_revision_str('branch:..\\\\branch2')
87
 
    [<RevisionSpec_branch branch:..\\branch2>]
88
 
    >>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
89
 
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
 
88
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
90
89
    """
91
90
    # TODO: Maybe move this into revisionspec.py
92
91
    revs = []
93
 
    # split on .. that is not followed by a / or \
94
 
    sep = re.compile(r'\.\.(?![\\/])')
 
92
    # split on the first .. that is not followed by a / ?
 
93
    sep = re.compile("\\.\\.(?!/)")
95
94
    for x in sep.split(revstr):
96
95
        revs.append(revisionspec.RevisionSpec.from_string(x or None))
97
96
    return revs
98
97
 
99
98
 
100
 
def _parse_change_str(revstr):
101
 
    """Parse the revision string and return a tuple with left-most
102
 
    parent of the revision.
103
 
 
104
 
    >>> _parse_change_str('123')
105
 
    (<RevisionSpec_before before:123>, <RevisionSpec_dwim 123>)
106
 
    >>> _parse_change_str('123..124')
107
 
    Traceback (most recent call last):
108
 
      ...
109
 
    breezy.errors.RangeInChangeOption: Option --change does not accept revision ranges
110
 
    """
111
 
    revs = _parse_revision_str(revstr)
112
 
    if len(revs) > 1:
113
 
        raise errors.RangeInChangeOption()
114
 
    return (revisionspec.RevisionSpec.from_string('before:' + revstr),
115
 
            revs[0])
116
 
 
117
 
 
118
99
def _parse_merge_type(typestring):
119
100
    return get_merge_type(typestring)
120
101
 
121
 
 
122
102
def get_merge_type(typestring):
123
103
    """Attempt to find the merge class/factory associated with a string."""
124
104
    from merge import merge_types
125
105
    try:
126
106
        return merge_types[typestring][0]
127
107
    except KeyError:
128
 
        templ = '%s%%7s: %%s' % (' ' * 12)
129
 
        lines = [templ % (f[0], f[1][1]) for f in merge_types.items()]
 
108
        templ = '%s%%7s: %%s' % (' '*12)
 
109
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
130
110
        type_list = '\n'.join(lines)
131
111
        msg = "No known merge type %s. Supported types are:\n%s" %\
132
112
            (typestring, type_list)
133
 
        raise errors.CommandError(msg)
 
113
        raise errors.BzrCommandError(msg)
134
114
 
135
115
 
136
116
class Option(object):
137
117
    """Description of a command line option
138
 
 
 
118
    
139
119
    :ivar _short_name: If this option has a single-letter name, this is it.
140
120
    Otherwise None.
141
121
    """
142
122
 
143
 
    # The dictionary of standard options. These are always legal.
144
 
    STD_OPTIONS = {}
 
123
    # TODO: Some way to show in help a description of the option argument
145
124
 
146
 
    # The dictionary of commonly used options. these are only legal
147
 
    # if a command explicitly references them by name in the list
148
 
    # of supported options.
149
125
    OPTIONS = {}
150
126
 
151
127
    def __init__(self, name, help='', type=None, argname=None,
152
 
                 short_name=None, param_name=None, custom_callback=None,
153
 
                 hidden=False):
 
128
                 short_name=None):
154
129
        """Make a new command option.
155
130
 
156
 
        :param name: regular name of the command, used in the double-dash
157
 
            form and also as the parameter to the command's run()
158
 
            method (unless param_name is specified).
159
 
 
160
 
        :param help: help message displayed in command help
161
 
 
162
 
        :param type: function called to parse the option argument, or
 
131
        name -- regular name of the command, used in the double-dash
 
132
            form and also as the parameter to the command's run() 
 
133
            method.
 
134
 
 
135
        help -- help message displayed in command help
 
136
 
 
137
        type -- function called to parse the option argument, or 
163
138
            None (default) if this option doesn't take an argument.
164
139
 
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
 
 
170
 
        :param param_name: name of the parameter which will be passed to
171
 
            the command's run() method.
172
 
 
173
 
        :param custom_callback: a callback routine to be called after normal
174
 
            processing. The signature of the callback routine is
175
 
            (option, name, new_value, parser).
176
 
        :param hidden: If True, the option should be hidden in help and
177
 
            documentation.
 
140
        argname -- name of option argument, if any
178
141
        """
179
142
        self.name = name
180
143
        self.help = help
181
144
        self.type = type
182
145
        self._short_name = short_name
183
146
        if type is None:
184
 
            if argname:
185
 
                raise ValueError('argname not valid for booleans')
 
147
            assert argname is None
186
148
        elif argname is None:
187
149
            argname = 'ARG'
188
150
        self.argname = argname
189
 
        if param_name is None:
190
 
            self._param_name = self.name.replace('-', '_')
191
 
        else:
192
 
            self._param_name = param_name
193
 
        self.custom_callback = custom_callback
194
 
        self.hidden = hidden
195
151
 
196
152
    def short_name(self):
197
153
        if self._short_name:
198
154
            return self._short_name
 
155
        else:
 
156
            # remove this when SHORT_OPTIONS is removed
 
157
            # XXX: This is accessing a DeprecatedDict, so we call the super 
 
158
            # method to avoid warnings
 
159
            for (k, v) in dict.iteritems(Option.SHORT_OPTIONS):
 
160
                if v == self:
 
161
                    return k
199
162
 
200
163
    def set_short_name(self, short_name):
201
164
        self._short_name = short_name
211
174
        option_strings = ['--%s' % self.name]
212
175
        if short_name is not None:
213
176
            option_strings.append('-%s' % short_name)
214
 
        if self.hidden:
215
 
            help = optparse.SUPPRESS_HELP
216
 
        else:
217
 
            help = self.help
218
177
        optargfn = self.type
219
178
        if optargfn is None:
220
 
            parser.add_option(action='callback',
221
 
                              callback=self._optparse_bool_callback,
222
 
                              callback_args=(True,),
223
 
                              help=help,
 
179
            parser.add_option(action='store_true', dest=self.name, 
 
180
                              help=self.help,
 
181
                              default=OptionParser.DEFAULT_VALUE,
224
182
                              *option_strings)
225
183
            negation_strings = ['--%s' % self.get_negation_name()]
226
 
            parser.add_option(action='callback',
227
 
                              callback=self._optparse_bool_callback,
228
 
                              callback_args=(False,),
 
184
            parser.add_option(action='store_false', dest=self.name, 
229
185
                              help=optparse.SUPPRESS_HELP, *negation_strings)
230
186
        else:
231
 
            parser.add_option(action='callback',
232
 
                              callback=self._optparse_callback,
 
187
            parser.add_option(action='callback', 
 
188
                              callback=self._optparse_callback, 
233
189
                              type='string', metavar=self.argname.upper(),
234
 
                              help=help,
235
 
                              default=OptionParser.DEFAULT_VALUE,
 
190
                              help=self.help,
 
191
                              default=OptionParser.DEFAULT_VALUE, 
236
192
                              *option_strings)
237
193
 
238
 
    def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
239
 
        setattr(parser.values, self._param_name, bool_v)
240
 
        if self.custom_callback is not None:
241
 
            self.custom_callback(option, self._param_name, bool_v, parser)
242
 
 
243
194
    def _optparse_callback(self, option, opt, value, parser):
244
 
        try:
245
 
            v = self.type(value)
246
 
        except ValueError as e:
247
 
            raise optparse.OptionValueError(
248
 
                'invalid value for option %s: %s' % (option, value))
249
 
        setattr(parser.values, self._param_name, v)
250
 
        if self.custom_callback is not None:
251
 
            self.custom_callback(option, self.name, v, parser)
 
195
        setattr(parser.values, self.name, self.type(value))
252
196
 
253
197
    def iter_switches(self):
254
198
        """Iterate through the list of switches provided by the option
255
 
 
 
199
        
256
200
        :return: an iterator of (name, short_name, argname, help)
257
201
        """
258
 
        argname = self.argname
 
202
        argname =  self.argname
259
203
        if argname is not None:
260
204
            argname = argname.upper()
261
205
        yield self.name, self.short_name(), argname, self.help
262
206
 
263
 
    def is_hidden(self, name):
264
 
        return self.hidden
265
 
 
266
 
 
267
 
class ListOption(Option):
268
 
    """Option used to provide a list of values.
269
 
 
270
 
    On the command line, arguments are specified by a repeated use of the
271
 
    option. '-' is a special argument that resets the list. For example,
272
 
      --foo=a --foo=b
273
 
    sets the value of the 'foo' option to ['a', 'b'], and
274
 
      --foo=a --foo=b --foo=- --foo=c
275
 
    sets the value of the 'foo' option to ['c'].
276
 
    """
277
 
 
278
 
    def add_option(self, parser, short_name):
279
 
        """Add this option to an Optparse parser."""
280
 
        option_strings = ['--%s' % self.name]
281
 
        if short_name is not None:
282
 
            option_strings.append('-%s' % short_name)
283
 
        parser.add_option(action='callback',
284
 
                          callback=self._optparse_callback,
285
 
                          type='string', metavar=self.argname.upper(),
286
 
                          help=self.help, dest=self._param_name, default=[],
287
 
                          *option_strings)
288
 
 
289
 
    def _optparse_callback(self, option, opt, value, parser):
290
 
        values = getattr(parser.values, self._param_name)
291
 
        if value == '-':
292
 
            del values[:]
293
 
        else:
294
 
            values.append(self.type(value))
295
 
        if self.custom_callback is not None:
296
 
            self.custom_callback(option, self._param_name, values, parser)
297
 
 
298
207
 
299
208
class RegistryOption(Option):
300
209
    """Option based on a registry
307
216
    def validate_value(self, value):
308
217
        """Validate a value name"""
309
218
        if value not in self.registry:
310
 
            raise BadOptionValue(self.name, value)
 
219
            raise errors.BadOptionValue(self.name, value)
311
220
 
312
221
    def convert(self, value):
313
222
        """Convert a value name into an output type"""
317
226
        else:
318
227
            return self.converter(value)
319
228
 
320
 
    def __init__(self, name, help, registry=None, converter=None,
321
 
                 value_switches=False, title=None, enum_switch=True,
322
 
                 lazy_registry=None, short_name=None, short_value_switches=None):
 
229
    def __init__(self, name, help, registry, converter=None,
 
230
        value_switches=False, title=None, enum_switch=True):
323
231
        """
324
232
        Constructor.
325
233
 
333
241
            '--knit' can be used interchangeably.
334
242
        :param enum_switch: If true, a switch is provided with the option name,
335
243
            which takes a value.
336
 
        :param lazy_registry: A tuple of (module name, attribute name) for a
337
 
            registry to be lazily loaded.
338
 
        :param short_name: The short name for the enum switch, if any
339
 
        :param short_value_switches: A dict mapping values to short names
340
244
        """
341
 
        Option.__init__(self, name, help, type=self.convert,
342
 
                        short_name=short_name)
343
 
        self._registry = registry
344
 
        if registry is None:
345
 
            if lazy_registry is None:
346
 
                raise AssertionError(
347
 
                    'One of registry or lazy_registry must be given.')
348
 
            self._lazy_registry = _mod_registry._LazyObjectGetter(
349
 
                *lazy_registry)
350
 
        if registry is not None and lazy_registry is not None:
351
 
            raise AssertionError(
352
 
                'registry and lazy_registry are mutually exclusive')
 
245
        Option.__init__(self, name, help, type=self.convert)
 
246
        self.registry = registry
353
247
        self.name = name
354
248
        self.converter = converter
355
249
        self.value_switches = value_switches
356
250
        self.enum_switch = enum_switch
357
 
        self.short_value_switches = short_value_switches
358
251
        self.title = title
359
252
        if self.title is None:
360
253
            self.title = name
361
254
 
362
 
    @property
363
 
    def registry(self):
364
 
        if self._registry is None:
365
 
            self._registry = self._lazy_registry.get_obj()
366
 
        return self._registry
367
 
 
368
255
    @staticmethod
369
256
    def from_kwargs(name_, help=None, title=None, value_switches=False,
370
257
                    enum_switch=True, **kwargs):
372
259
 
373
260
        name, help, value_switches and enum_switch are passed to the
374
261
        RegistryOption constructor.  Any other keyword arguments are treated
375
 
        as values for the option, and their value is treated as the help.
 
262
        as values for the option, and they value is treated as the help.
376
263
        """
377
 
        reg = _mod_registry.Registry()
378
 
        for name, switch_help in sorted(kwargs.items()):
 
264
        reg = registry.Registry()
 
265
        for name, help in kwargs.iteritems():
379
266
            name = name.replace('_', '-')
380
 
            reg.register(name, name, help=switch_help)
381
 
            if not value_switches:
382
 
                help = help + '  "' + name + '": ' + switch_help
383
 
                if not help.endswith("."):
384
 
                    help = help + "."
 
267
            reg.register(name, name, help=help)
385
268
        return RegistryOption(name_, help, reg, title=title,
386
 
                              value_switches=value_switches, enum_switch=enum_switch)
 
269
            value_switches=value_switches, enum_switch=enum_switch)
387
270
 
388
271
    def add_option(self, parser, short_name):
389
272
        """Add this option to an Optparse parser"""
392
275
        if self.enum_switch:
393
276
            Option.add_option(self, parser, short_name)
394
277
        if self.value_switches:
395
 
            alias_map = self.registry.alias_map()
396
278
            for key in self.registry.keys():
397
 
                if key in self.registry.aliases():
398
 
                    continue
399
 
                option_strings = [
400
 
                    ('--%s' % name)
401
 
                    for name in [key] +
402
 
                    [alias for alias in alias_map.get(key, [])
403
 
                        if not self.is_hidden(alias)]]
404
 
                if self.is_hidden(key):
 
279
                option_strings = ['--%s' % key]
 
280
                if getattr(self.registry.get_info(key), 'hidden', False):
405
281
                    help = optparse.SUPPRESS_HELP
406
282
                else:
407
283
                    help = self.registry.get_help(key)
408
 
                if (self.short_value_switches and
409
 
                        key in self.short_value_switches):
410
 
                    option_strings.append('-%s' %
411
 
                                          self.short_value_switches[key])
412
284
                parser.add_option(action='callback',
413
 
                                  callback=self._optparse_value_callback(key),
 
285
                              callback=self._optparse_value_callback(key),
414
286
                                  help=help,
415
287
                                  *option_strings)
416
288
 
417
289
    def _optparse_value_callback(self, cb_value):
418
290
        def cb(option, opt, value, parser):
419
 
            v = self.type(cb_value)
420
 
            setattr(parser.values, self._param_name, v)
421
 
            if self.custom_callback is not None:
422
 
                self.custom_callback(option, self._param_name, v, parser)
 
291
            setattr(parser.values, self.name, self.type(cb_value))
423
292
        return cb
424
293
 
425
294
    def iter_switches(self):
433
302
            for key in sorted(self.registry.keys()):
434
303
                yield key, None, None, self.registry.get_help(key)
435
304
 
436
 
    def is_alias(self, name):
437
 
        """Check whether a particular format is an alias."""
438
 
        if name == self.name:
439
 
            return False
440
 
        return name in self.registry.aliases()
441
 
 
442
 
    def is_hidden(self, name):
443
 
        if name == self.name:
444
 
            return Option.is_hidden(self, name)
445
 
        return getattr(self.registry.get_info(name), 'hidden', False)
446
 
 
447
305
 
448
306
class OptionParser(optparse.OptionParser):
449
307
    """OptionParser that raises exceptions instead of exiting"""
450
308
 
451
309
    DEFAULT_VALUE = object()
452
310
 
453
 
    def __init__(self):
454
 
        optparse.OptionParser.__init__(self)
455
 
        self.formatter = GettextIndentedHelpFormatter()
456
 
 
457
311
    def error(self, message):
458
 
        raise errors.CommandError(message)
459
 
 
460
 
 
461
 
class GettextIndentedHelpFormatter(optparse.IndentedHelpFormatter):
462
 
    """Adds gettext() call to format_option()"""
463
 
 
464
 
    def __init__(self):
465
 
        optparse.IndentedHelpFormatter.__init__(self)
466
 
 
467
 
    def format_option(self, option):
468
 
        """code taken from Python's optparse.py"""
469
 
        if option.help:
470
 
            from .i18n import gettext
471
 
            option.help = gettext(option.help)
472
 
        return optparse.IndentedHelpFormatter.format_option(self, option)
 
312
        raise errors.BzrCommandError(message)
473
313
 
474
314
 
475
315
def get_optparser(options):
476
 
    """Generate an optparse parser for breezy-style options"""
 
316
    """Generate an optparse parser for bzrlib-style options"""
477
317
 
478
318
    parser = OptionParser()
479
319
    parser.remove_option('--help')
480
 
    for option in options:
 
320
    for option in options.itervalues():
481
321
        option.add_option(parser, option.short_name())
482
322
    return parser
483
323
 
484
324
 
485
 
def custom_help(name, help):
486
 
    """Clone a common option overriding the help."""
487
 
    import copy
488
 
    o = copy.copy(Option.OPTIONS[name])
489
 
    o.help = help
490
 
    return o
491
 
 
492
 
 
493
 
def _standard_option(name, **kwargs):
494
 
    """Register a standard option."""
495
 
    # All standard options are implicitly 'global' ones
496
 
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
497
 
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
498
 
 
499
 
 
500
 
def _standard_list_option(name, **kwargs):
501
 
    """Register a standard option."""
502
 
    # All standard options are implicitly 'global' ones
503
 
    Option.STD_OPTIONS[name] = ListOption(name, **kwargs)
504
 
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
505
 
 
506
 
 
507
325
def _global_option(name, **kwargs):
508
 
    """Register a global option."""
 
326
    """Register o as a global option."""
509
327
    Option.OPTIONS[name] = Option(name, **kwargs)
510
328
 
511
329
 
512
 
def _global_registry_option(name, help, registry=None, **kwargs):
 
330
def _global_registry_option(name, help, registry, **kwargs):
513
331
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
514
332
 
515
333
 
516
 
# This is the verbosity level detected during command line parsing.
517
 
# Note that the final value is dependent on the order in which the
518
 
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
519
 
# The final value will be one of the following:
520
 
#
521
 
# * -ve for quiet
522
 
# * 0 for normal
523
 
# * +ve for verbose
524
 
_verbosity_level = 0
525
 
 
526
 
 
527
 
def _verbosity_level_callback(option, opt_str, value, parser):
528
 
    global _verbosity_level
529
 
    if not value:
530
 
        # Either --no-verbose or --no-quiet was specified
531
 
        _verbosity_level = 0
532
 
    elif opt_str == "verbose":
533
 
        if _verbosity_level > 0:
534
 
            _verbosity_level += 1
535
 
        else:
536
 
            _verbosity_level = 1
537
 
    else:
538
 
        if _verbosity_level < 0:
539
 
            _verbosity_level -= 1
540
 
        else:
541
 
            _verbosity_level = -1
542
 
 
543
 
 
544
 
# Declare the standard options
545
 
_standard_option('help', short_name='h',
546
 
                 help='Show help message.')
547
 
_standard_option('quiet', short_name='q',
548
 
                 help="Only display errors and warnings.",
549
 
                 custom_callback=_verbosity_level_callback)
550
 
_standard_option('usage',
551
 
                 help='Show usage message and options.')
552
 
_standard_option('verbose', short_name='v',
553
 
                 help='Display more information.',
554
 
                 custom_callback=_verbosity_level_callback)
555
 
 
556
 
# Declare commonly used options
557
 
_global_option('change',
558
 
               type=_parse_change_str,
559
 
               short_name='c',
560
 
               param_name='revision',
561
 
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
562
 
_global_option('directory', short_name='d', type=str,
563
 
               help='Branch to operate on, instead of working directory.')
564
 
_global_option('file', type=str, short_name='F')
565
 
_global_registry_option('log-format', "Use specified log format.",
566
 
                        lazy_registry=('breezy.log', 'log_formatter_registry'),
567
 
                        value_switches=True, title='Log format',
568
 
                        short_value_switches={'short': 'S'})
569
 
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
570
 
                        lazy_registry=('breezy.merge', 'merge_type_registry'),
571
 
                        value_switches=True, title='Merge algorithm')
572
 
_global_option('message', type=str,
573
 
               short_name='m',
574
 
               help='Message string.')
575
 
_global_option('null', short_name='0',
576
 
               help='Use an ASCII NUL (\\0) separator rather than '
577
 
               'a newline.')
 
334
class MergeTypeRegistry(registry.Registry):
 
335
 
 
336
    pass
 
337
 
 
338
 
 
339
_merge_type_registry = MergeTypeRegistry()
 
340
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
 
341
                                   "Native diff3-style merge")
 
342
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
 
343
                                   "Merge using external diff3")
 
344
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
 
345
                                   "Weave-based merge")
 
346
 
 
347
_global_option('all')
578
348
_global_option('overwrite', help='Ignore differences between branches and '
579
 
               'overwrite unconditionally.')
580
 
_global_option('remember', help='Remember the specified location as a'
581
 
               ' default.')
582
 
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
 
349
               'overwrite unconditionally')
 
350
_global_option('basis', type=str)
 
351
_global_option('bound')
 
352
_global_option('diff-options', type=str)
 
353
_global_option('help',
 
354
               help='show help message',
 
355
               short_name='h')
 
356
_global_option('file', type=unicode, short_name='F')
 
357
_global_option('force')
 
358
_global_option('format', type=unicode)
 
359
_global_option('forward')
 
360
_global_option('message', type=unicode,
 
361
               short_name='m')
 
362
_global_option('no-recurse')
 
363
_global_option('profile',
 
364
               help='show performance profiling information')
583
365
_global_option('revision',
584
366
               type=_parse_revision_str,
585
367
               short_name='r',
586
 
               help='See "help revisionspec" for details.')
587
 
_global_option('show-ids',
588
 
               help='Show internal object ids.')
589
 
_global_option('timezone',
 
368
               help='See \'help revisionspec\' for details')
 
369
_global_option('show-ids', 
 
370
               help='show internal object ids')
 
371
_global_option('timezone', 
590
372
               type=str,
591
 
               help='Display timezone as local, original, or utc.')
592
 
 
593
 
diff_writer_registry = _mod_registry.Registry()
594
 
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
595
 
diff_writer_registry.default_key = 'plain'
 
373
               help='display timezone as local, original, or utc')
 
374
_global_option('unbound')
 
375
_global_option('verbose',
 
376
               help='display more information',
 
377
               short_name='v')
 
378
_global_option('version')
 
379
_global_option('email')
 
380
_global_option('update')
 
381
_global_registry_option('log-format', "Use this log format",
 
382
                        log.log_formatter_registry, value_switches=True,
 
383
                        title='Log format')
 
384
_global_option('long', help='Use detailed log format. Same as --log-format long',
 
385
               short_name='l')
 
386
_global_option('short', help='Use moderately short log format. Same as --log-format short')
 
387
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
 
388
_global_option('root', type=str)
 
389
_global_option('no-backup')
 
390
_global_registry_option('merge-type', 'Select a particular merge algorithm',
 
391
                        _merge_type_registry, value_switches=True,
 
392
                        title='Merge algorithm')
 
393
_global_option('pattern', type=str)
 
394
_global_option('quiet', short_name='q')
 
395
_global_option('remember', help='Remember the specified location as a'
 
396
               ' default.')
 
397
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
 
398
_global_option('kind', type=str)
 
399
_global_option('dry-run',
 
400
               help="show what would be done, but don't actually do anything")
 
401
_global_option('name-from-revision', help='The path name in the old tree.')
 
402
 
 
403
 
 
404
# prior to 0.14 these were always globally registered; the old dict is
 
405
# available for plugins that use it but it should not be used.
 
406
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
 
407
    symbol_versioning.zero_fourteen,
 
408
    'SHORT_OPTIONS',
 
409
    {
 
410
        'F': Option.OPTIONS['file'],
 
411
        'h': Option.OPTIONS['help'],
 
412
        'm': Option.OPTIONS['message'],
 
413
        'r': Option.OPTIONS['revision'],
 
414
        'v': Option.OPTIONS['verbose'],
 
415
        'l': Option.OPTIONS['long'],
 
416
        'q': Option.OPTIONS['quiet'],
 
417
    },
 
418
    'Set the short option name when constructing the Option.',
 
419
    )