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
17
17
# TODO: For things like --diff-prefix, we want a way to customize the display
18
18
# of the option argument.
23
22
from bzrlib.lazy_import import lazy_import
24
23
lazy_import(globals(), """
25
26
from bzrlib import (
32
registry as _mod_registry,
34
from bzrlib.trace import warning
36
37
def _parse_revision_str(revstr):
85
86
[<RevisionSpec_branch branch:../../branch2>]
86
87
>>> _parse_revision_str('branch:../../branch2..23')
87
88
[<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
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>]
93
90
# TODO: Maybe move this into revisionspec.py
95
# split on .. that is not followed by a / or \
96
sep = re.compile(r'\.\.(?![\\/])')
92
# split on the first .. that is not followed by a / ?
93
sep = re.compile("\\.\\.(?!/)")
97
94
for x in sep.split(revstr):
98
95
revs.append(revisionspec.RevisionSpec.from_string(x or None))
102
def _parse_change_str(revstr):
103
"""Parse the revision string and return a tuple with left-most
104
parent of the revision.
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):
111
RangeInChangeOption: Option --change does not accept revision ranges
113
revs = _parse_revision_str(revstr)
115
raise errors.RangeInChangeOption()
116
return (revisionspec.RevisionSpec.from_string('before:' + revstr),
120
99
def _parse_merge_type(typestring):
121
100
return get_merge_type(typestring)
137
116
class Option(object):
138
117
"""Description of a command line option
140
119
:ivar _short_name: If this option has a single-letter name, this is it.
144
# The dictionary of standard options. These are always legal.
123
# TODO: Some way to show in help a description of the option argument
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.
152
127
def __init__(self, name, help='', type=None, argname=None,
153
short_name=None, param_name=None, custom_callback=None):
154
129
"""Make a new command option.
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).
160
:param help: help message displayed in command help
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()
135
help -- help message displayed in command help
137
type -- function called to parse the option argument, or
163
138
None (default) if this option doesn't take an argument.
165
:param argname: name of option argument, if any
167
:param short_name: short option code for use with a single -, e.g.
168
short_name="v" to enable parsing of -v.
170
:param param_name: name of the parameter which will be passed to
171
the command's run() method.
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).
140
argname -- name of option argument, if any
180
145
self._short_name = short_name
183
raise ValueError('argname not valid for booleans')
147
assert argname is None
184
148
elif argname is None:
186
150
self.argname = argname
187
if param_name is None:
188
self._param_name = self.name.replace('-', '_')
190
self._param_name = param_name
191
self.custom_callback = custom_callback
193
152
def short_name(self):
194
153
if self._short_name:
210
169
option_strings.append('-%s' % short_name)
211
170
optargfn = self.type
212
171
if optargfn is None:
213
parser.add_option(action='callback',
214
callback=self._optparse_bool_callback,
215
callback_args=(True,),
172
parser.add_option(action='store_true', dest=self.name,
174
default=OptionParser.DEFAULT_VALUE,
218
176
negation_strings = ['--%s' % self.get_negation_name()]
219
parser.add_option(action='callback',
220
callback=self._optparse_bool_callback,
221
callback_args=(False,),
177
parser.add_option(action='store_false', dest=self.name,
222
178
help=optparse.SUPPRESS_HELP, *negation_strings)
224
parser.add_option(action='callback',
225
callback=self._optparse_callback,
180
parser.add_option(action='callback',
181
callback=self._optparse_callback,
226
182
type='string', metavar=self.argname.upper(),
228
default=OptionParser.DEFAULT_VALUE,
184
default=OptionParser.DEFAULT_VALUE,
231
def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
232
setattr(parser.values, self._param_name, bool_v)
233
if self.custom_callback is not None:
234
self.custom_callback(option, self._param_name, bool_v, parser)
236
187
def _optparse_callback(self, option, opt, value, parser):
238
setattr(parser.values, self._param_name, v)
239
if self.custom_callback is not None:
240
self.custom_callback(option, self.name, v, parser)
188
setattr(parser.values, self.name, self.type(value))
242
190
def iter_switches(self):
243
191
"""Iterate through the list of switches provided by the option
245
193
:return: an iterator of (name, short_name, argname, help)
247
195
argname = self.argname
249
197
argname = argname.upper()
250
198
yield self.name, self.short_name(), argname, self.help
252
def is_hidden(self, name):
256
201
class ListOption(Option):
257
202
"""Option used to provide a list of values.
278
223
def _optparse_callback(self, option, opt, value, parser):
279
values = getattr(parser.values, self._param_name)
224
values = getattr(parser.values, self.name)
283
228
values.append(self.type(value))
284
if self.custom_callback is not None:
285
self.custom_callback(option, self._param_name, values, parser)
288
231
class RegistryOption(Option):
307
250
return self.converter(value)
309
def __init__(self, name, help, registry=None, converter=None,
310
value_switches=False, title=None, enum_switch=True,
252
def __init__(self, name, help, registry, converter=None,
253
value_switches=False, title=None, enum_switch=True):
322
264
'--knit' can be used interchangeably.
323
265
:param enum_switch: If true, a switch is provided with the option name,
324
266
which takes a value.
325
:param lazy_registry: A tuple of (module name, attribute name) for a
326
registry to be lazily loaded.
328
268
Option.__init__(self, name, help, type=self.convert)
329
self._registry = registry
331
if lazy_registry is None:
332
raise AssertionError(
333
'One of registry or lazy_registry must be given.')
334
self._lazy_registry = _mod_registry._LazyObjectGetter(
336
if registry is not None and lazy_registry is not None:
337
raise AssertionError(
338
'registry and lazy_registry are mutually exclusive')
269
self.registry = registry
340
271
self.converter = converter
341
272
self.value_switches = value_switches
344
275
if self.title is None:
345
276
self.title = name
349
if self._registry is None:
350
self._registry = self._lazy_registry.get_obj()
351
return self._registry
354
279
def from_kwargs(name_, help=None, title=None, value_switches=False,
355
280
enum_switch=True, **kwargs):
359
284
RegistryOption constructor. Any other keyword arguments are treated
360
285
as values for the option, and they value is treated as the help.
362
reg = _mod_registry.Registry()
287
reg = registry.Registry()
363
288
for name, switch_help in kwargs.iteritems():
364
289
name = name.replace('_', '-')
365
290
reg.register(name, name, help=switch_help)
366
if not value_switches:
367
help = help + ' "' + name + '": ' + switch_help
368
if not help.endswith("."):
370
291
return RegistryOption(name_, help, reg, title=title,
371
292
value_switches=value_switches, enum_switch=enum_switch)
391
312
def _optparse_value_callback(self, cb_value):
392
313
def cb(option, opt, value, parser):
393
v = self.type(cb_value)
394
setattr(parser.values, self._param_name, v)
395
if self.custom_callback is not None:
396
self.custom_callback(option, self._param_name, v, parser)
314
setattr(parser.values, self.name, self.type(cb_value))
399
317
def iter_switches(self):
407
325
for key in sorted(self.registry.keys()):
408
326
yield key, None, None, self.registry.get_help(key)
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)
416
329
class OptionParser(optparse.OptionParser):
417
330
"""OptionParser that raises exceptions instead of exiting"""
435
def custom_help(name, help):
436
"""Clone a common option overriding the help."""
438
o = copy.copy(Option.OPTIONS[name])
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]
450
348
def _global_option(name, **kwargs):
451
"""Register a global option."""
349
"""Register o as a global option."""
452
350
Option.OPTIONS[name] = Option(name, **kwargs)
455
def _global_registry_option(name, help, registry=None, **kwargs):
353
def _global_registry_option(name, help, registry, **kwargs):
456
354
Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
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:
470
def _verbosity_level_callback(option, opt_str, value, parser):
471
global _verbosity_level
473
# Either --no-verbose or --no-quiet was specified
475
elif opt_str == "verbose":
476
if _verbosity_level > 0:
477
_verbosity_level += 1
481
if _verbosity_level < 0:
482
_verbosity_level -= 1
484
_verbosity_level = -1
487
class MergeTypeRegistry(_mod_registry.Registry):
357
class MergeTypeRegistry(registry.Registry):
496
366
"Merge using external diff3")
497
367
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
498
368
"Weave-based merge")
499
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
502
# Declare the standard options
503
_standard_option('help', short_name='h',
504
help='Show help message.')
505
_standard_option('usage',
506
help='Show usage message and options.')
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)
514
# Declare commonly used options
515
370
_global_option('all')
516
371
_global_option('overwrite', help='Ignore differences between branches and '
517
372
'overwrite unconditionally.')
531
386
_global_option('revision',
532
387
type=_parse_revision_str,
534
help='See "help revisionspec" for details.')
535
_global_option('change',
536
type=_parse_change_str,
538
param_name='revision',
539
help='Select changes introduced by the specified revision. See also "help revisionspec".')
389
help='See \'help revisionspec\' for details.')
540
390
_global_option('show-ids',
541
391
help='Show internal object ids.')
542
_global_option('timezone',
392
_global_option('timezone',
544
help='Display timezone as local, original, or utc.')
394
help='display timezone as local, original, or utc')
545
395
_global_option('unbound')
396
_global_option('verbose',
397
help='Display more information.',
546
399
_global_option('version')
547
400
_global_option('email')
548
401
_global_option('update')
549
402
_global_registry_option('log-format', "Use specified log format.",
550
lazy_registry=('bzrlib.log', 'log_formatter_registry'),
551
value_switches=True, title='Log format')
403
log.log_formatter_registry, value_switches=True,
552
405
_global_option('long', help='Use detailed log format. Same as --log-format long',
554
407
_global_option('short', help='Use moderately short log format. Same as --log-format short')
559
412
_merge_type_registry, value_switches=True,
560
413
title='Merge algorithm')
561
414
_global_option('pattern', type=str)
415
_global_option('quiet', short_name='q')
562
416
_global_option('remember', help='Remember the specified location as a'
564
418
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
567
421
help="Show what would be done, but don't actually do anything.")
568
422
_global_option('name-from-revision', help='The path name in the old tree.')
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'
424
_help_option = Option('help',
425
help='Show help message.',
added
removed
bzrlib/option.py
