← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

merge only needs a lock_tree_write() on the working tree, not a full lock_write()

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007 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
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 optparse
21
20
import re
22
21
 
23
22
from bzrlib.lazy_import import lazy_import
24
23
lazy_import(globals(), """
 
24
import optparse
 
25
 
25
26
from bzrlib import (
26
27
    errors,
27
28
    revisionspec,
 
29
    symbol_versioning,
28
30
    )
29
31
""")
30
 
 
31
 
from bzrlib import (
32
 
    registry as _mod_registry,
33
 
    )
 
32
from bzrlib.trace import warning
34
33
 
35
34
 
36
35
def _parse_revision_str(revstr):
85
84
    [<RevisionSpec_branch branch:../../branch2>]
86
85
    >>> _parse_revision_str('branch:../../branch2..23')
87
86
    [<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>]
92
87
    """
93
88
    # TODO: Maybe move this into revisionspec.py
94
89
    revs = []
95
 
    # split on .. that is not followed by a / or \
96
 
    sep = re.compile(r'\.\.(?![\\/])')
 
90
    # split on the first .. that is not followed by a / ?
 
91
    sep = re.compile("\\.\\.(?!/)")
97
92
    for x in sep.split(revstr):
98
93
        revs.append(revisionspec.RevisionSpec.from_string(x or None))
99
94
    return revs
100
95
 
101
96
 
102
 
def _parse_change_str(revstr):
103
 
    """Parse the revision string and return a tuple with left-most
104
 
    parent of the revision.
105
 
 
106
 
    >>> _parse_change_str('123')
107
 
    (<RevisionSpec_before before:123>, <RevisionSpec_revno 123>)
108
 
    >>> _parse_change_str('123..124')
109
 
    Traceback (most recent call last):
110
 
      ...
111
 
    RangeInChangeOption: Option --change does not accept revision ranges
112
 
    """
113
 
    revs = _parse_revision_str(revstr)
114
 
    if len(revs) > 1:
115
 
        raise errors.RangeInChangeOption()
116
 
    return (revisionspec.RevisionSpec.from_string('before:' + revstr),
117
 
            revs[0])
118
 
 
119
 
 
120
97
def _parse_merge_type(typestring):
121
98
    return get_merge_type(typestring)
122
99
 
141
118
    Otherwise None.
142
119
    """
143
120
 
144
 
    # The dictionary of standard options. These are always legal.
145
 
    STD_OPTIONS = {}
 
121
    # TODO: Some way to show in help a description of the option argument
146
122
 
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.
150
123
    OPTIONS = {}
151
124
 
152
125
    def __init__(self, name, help='', type=None, argname=None,
153
 
                 short_name=None, param_name=None, custom_callback=None):
 
126
                 short_name=None):
154
127
        """Make a new command option.
155
128
 
156
 
        :param name: regular name of the command, used in the double-dash
 
129
        name -- regular name of the command, used in the double-dash
157
130
            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
            method.
 
132
 
 
133
        help -- help message displayed in command help
 
134
 
 
135
        type -- function called to parse the option argument, or 
163
136
            None (default) if this option doesn't take an argument.
164
137
 
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).
 
138
        argname -- name of option argument, if any
176
139
        """
177
140
        self.name = name
178
141
        self.help = help
179
142
        self.type = type
180
143
        self._short_name = short_name
181
144
        if type is None:
182
 
            if argname:
183
 
                raise ValueError('argname not valid for booleans')
 
145
            assert argname is None
184
146
        elif argname is None:
185
147
            argname = 'ARG'
186
148
        self.argname = argname
187
 
        if param_name is None:
188
 
            self._param_name = self.name.replace('-', '_')
189
 
        else:
190
 
            self._param_name = param_name
191
 
        self.custom_callback = custom_callback
192
149
 
193
150
    def short_name(self):
194
151
        if self._short_name:
195
152
            return self._short_name
 
153
        else:
 
154
            # remove this when SHORT_OPTIONS is removed
 
155
            # XXX: This is accessing a DeprecatedDict, so we call the super 
 
156
            # method to avoid warnings
 
157
            for (k, v) in dict.iteritems(Option.SHORT_OPTIONS):
 
158
                if v == self:
 
159
                    return k
196
160
 
197
161
    def set_short_name(self, short_name):
198
162
        self._short_name = short_name
210
174
            option_strings.append('-%s' % short_name)
211
175
        optargfn = self.type
212
176
        if optargfn is None:
213
 
            parser.add_option(action='callback',
214
 
                              callback=self._optparse_bool_callback,
215
 
                              callback_args=(True,),
 
177
            parser.add_option(action='store_true', dest=self.name, 
216
178
                              help=self.help,
 
179
                              default=OptionParser.DEFAULT_VALUE,
217
180
                              *option_strings)
218
181
            negation_strings = ['--%s' % self.get_negation_name()]
219
 
            parser.add_option(action='callback',
220
 
                              callback=self._optparse_bool_callback,
221
 
                              callback_args=(False,),
 
182
            parser.add_option(action='store_false', dest=self.name, 
222
183
                              help=optparse.SUPPRESS_HELP, *negation_strings)
223
184
        else:
224
 
            parser.add_option(action='callback',
225
 
                              callback=self._optparse_callback,
 
185
            parser.add_option(action='callback', 
 
186
                              callback=self._optparse_callback, 
226
187
                              type='string', metavar=self.argname.upper(),
227
188
                              help=self.help,
228
 
                              default=OptionParser.DEFAULT_VALUE,
 
189
                              default=OptionParser.DEFAULT_VALUE, 
229
190
                              *option_strings)
230
191
 
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)
235
 
 
236
192
    def _optparse_callback(self, option, opt, value, parser):
237
 
        v = self.type(value)
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)
 
193
        setattr(parser.values, self.name, self.type(value))
241
194
 
242
195
    def iter_switches(self):
243
196
        """Iterate through the list of switches provided by the option
249
202
            argname = argname.upper()
250
203
        yield self.name, self.short_name(), argname, self.help
251
204
 
252
 
    def is_hidden(self, name):
253
 
        return False
254
 
 
255
 
 
256
 
class ListOption(Option):
257
 
    """Option used to provide a list of values.
258
 
 
259
 
    On the command line, arguments are specified by a repeated use of the
260
 
    option. '-' is a special argument that resets the list. For example,
261
 
      --foo=a --foo=b
262
 
    sets the value of the 'foo' option to ['a', 'b'], and
263
 
      --foo=a --foo=b --foo=- --foo=c
264
 
    sets the value of the 'foo' option to ['c'].
265
 
    """
266
 
 
267
 
    def add_option(self, parser, short_name):
268
 
        """Add this option to an Optparse parser."""
269
 
        option_strings = ['--%s' % self.name]
270
 
        if short_name is not None:
271
 
            option_strings.append('-%s' % short_name)
272
 
        parser.add_option(action='callback',
273
 
                          callback=self._optparse_callback,
274
 
                          type='string', metavar=self.argname.upper(),
275
 
                          help=self.help, default=[],
276
 
                          *option_strings)
277
 
 
278
 
    def _optparse_callback(self, option, opt, value, parser):
279
 
        values = getattr(parser.values, self._param_name)
280
 
        if value == '-':
281
 
            del values[:]
282
 
        else:
283
 
            values.append(self.type(value))
284
 
        if self.custom_callback is not None:
285
 
            self.custom_callback(option, self._param_name, values, parser)
286
 
 
287
205
 
288
206
class RegistryOption(Option):
289
207
    """Option based on a registry
306
224
        else:
307
225
            return self.converter(value)
308
226
 
309
 
    def __init__(self, name, help, registry=None, converter=None,
310
 
        value_switches=False, title=None, enum_switch=True,
311
 
        lazy_registry=None):
 
227
    def __init__(self, name, help, registry, converter=None,
 
228
        value_switches=False):
312
229
        """
313
230
        Constructor.
314
231
 
318
235
        :param converter: Callable to invoke with the value name to produce
319
236
            the value.  If not supplied, self.registry.get is used.
320
237
        :param value_switches: If true, each possible value is assigned its
321
 
            own switch.  For example, instead of '--format knit',
322
 
            '--knit' can be used interchangeably.
323
 
        :param enum_switch: If true, a switch is provided with the option name,
324
 
            which takes a value.
325
 
        :param lazy_registry: A tuple of (module name, attribute name) for a
326
 
            registry to be lazily loaded.
 
238
            own switch.  For example, instead of '--format metaweave',
 
239
            '--metaweave' can be used interchangeably.
327
240
        """
328
241
        Option.__init__(self, name, help, type=self.convert)
329
 
        self._registry = registry
330
 
        if registry is None:
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(
335
 
                *lazy_registry)
336
 
        if registry is not None and lazy_registry is not None:
337
 
            raise AssertionError(
338
 
                'registry and lazy_registry are mutually exclusive')
 
242
        self.registry = registry
339
243
        self.name = name
340
244
        self.converter = converter
341
245
        self.value_switches = value_switches
342
 
        self.enum_switch = enum_switch
343
 
        self.title = title
344
 
        if self.title is None:
345
 
            self.title = name
346
 
 
347
 
    @property
348
 
    def registry(self):
349
 
        if self._registry is None:
350
 
            self._registry = self._lazy_registry.get_obj()
351
 
        return self._registry
352
 
    
353
 
    @staticmethod
354
 
    def from_kwargs(name_, help=None, title=None, value_switches=False,
355
 
                    enum_switch=True, **kwargs):
356
 
        """Convenience method to generate string-map registry options
357
 
 
358
 
        name, help, value_switches and enum_switch are passed to the
359
 
        RegistryOption constructor.  Any other keyword arguments are treated
360
 
        as values for the option, and they value is treated as the help.
361
 
        """
362
 
        reg = _mod_registry.Registry()
363
 
        for name, switch_help in kwargs.iteritems():
364
 
            name = name.replace('_', '-')
365
 
            reg.register(name, name, help=switch_help)
366
 
            if not value_switches:
367
 
                help = help + '  "' + name + '": ' + switch_help
368
 
                if not help.endswith("."):
369
 
                    help = help + "."
370
 
        return RegistryOption(name_, help, reg, title=title,
371
 
            value_switches=value_switches, enum_switch=enum_switch)
372
246
 
373
247
    def add_option(self, parser, short_name):
374
248
        """Add this option to an Optparse parser"""
375
 
        if self.value_switches:
376
 
            parser = parser.add_option_group(self.title)
377
 
        if self.enum_switch:
378
 
            Option.add_option(self, parser, short_name)
 
249
        Option.add_option(self, parser, short_name)
379
250
        if self.value_switches:
380
251
            for key in self.registry.keys():
381
252
                option_strings = ['--%s' % key]
382
 
                if self.is_hidden(key):
383
 
                    help = optparse.SUPPRESS_HELP
384
 
                else:
385
 
                    help = self.registry.get_help(key)
386
253
                parser.add_option(action='callback',
387
254
                              callback=self._optparse_value_callback(key),
388
 
                                  help=help,
 
255
                                  help=self.registry.get_help(key),
389
256
                                  *option_strings)
390
257
 
391
258
    def _optparse_value_callback(self, cb_value):
392
259
        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)
 
260
            setattr(parser.values, self.name, self.type(cb_value))
397
261
        return cb
398
262
 
399
263
    def iter_switches(self):
407
271
            for key in sorted(self.registry.keys()):
408
272
                yield key, None, None, self.registry.get_help(key)
409
273
 
410
 
    def is_hidden(self, name):
411
 
        if name == self.name:
412
 
            return Option.is_hidden(self, name)
413
 
        return getattr(self.registry.get_info(name), 'hidden', False)
414
 
 
415
274
 
416
275
class OptionParser(optparse.OptionParser):
417
276
    """OptionParser that raises exceptions instead of exiting"""
432
291
    return parser
433
292
 
434
293
 
435
 
def custom_help(name, help):
436
 
    """Clone a common option overriding the help."""
437
 
    import copy
438
 
    o = copy.copy(Option.OPTIONS[name])
439
 
    o.help = help
440
 
    return o
441
 
 
442
 
 
443
 
def _standard_option(name, **kwargs):
444
 
    """Register a standard option."""
445
 
    # All standard options are implicitly 'global' ones
446
 
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
447
 
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
448
 
 
449
 
 
450
294
def _global_option(name, **kwargs):
451
 
    """Register a global option."""
 
295
    """Register o as a global option."""
452
296
    Option.OPTIONS[name] = Option(name, **kwargs)
453
297
 
454
 
 
455
 
def _global_registry_option(name, help, registry=None, **kwargs):
456
 
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
457
 
 
458
 
 
459
 
# This is the verbosity level detected during command line parsing.
460
 
# Note that the final value is dependent on the order in which the
461
 
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
462
 
# The final value will be one of the following:
463
 
#
464
 
# * -ve for quiet
465
 
# * 0 for normal
466
 
# * +ve for verbose
467
 
_verbosity_level = 0
468
 
 
469
 
 
470
 
def _verbosity_level_callback(option, opt_str, value, parser):
471
 
    global _verbosity_level
472
 
    if not value:
473
 
        # Either --no-verbose or --no-quiet was specified
474
 
        _verbosity_level = 0
475
 
    elif opt_str == "verbose":
476
 
        if _verbosity_level > 0:
477
 
            _verbosity_level += 1
478
 
        else:
479
 
            _verbosity_level = 1
480
 
    else:
481
 
        if _verbosity_level < 0:
482
 
            _verbosity_level -= 1
483
 
        else:
484
 
            _verbosity_level = -1
485
 
 
486
 
 
487
 
class MergeTypeRegistry(_mod_registry.Registry):
488
 
 
489
 
    pass
490
 
 
491
 
 
492
 
_merge_type_registry = MergeTypeRegistry()
493
 
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
494
 
                                   "Native diff3-style merge")
495
 
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
496
 
                                   "Merge using external diff3")
497
 
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
498
 
                                   "Weave-based merge")
499
 
_merge_type_registry.register_lazy('lca', 'bzrlib.merge', 'LCAMerger',
500
 
                                   "LCA-newness merge")
501
 
 
502
 
# Declare the standard options
503
 
_standard_option('help', short_name='h',
504
 
                 help='Show help message.')
505
 
_standard_option('verbose', short_name='v',
506
 
                 help='Display more information.',
507
 
                 custom_callback=_verbosity_level_callback)
508
 
_standard_option('quiet', short_name='q',
509
 
                 help="Only display errors and warnings.",
510
 
                 custom_callback=_verbosity_level_callback)
511
 
 
512
 
# Declare commonly used options
513
298
_global_option('all')
514
299
_global_option('overwrite', help='Ignore differences between branches and '
515
 
               'overwrite unconditionally.')
 
300
               'overwrite unconditionally')
516
301
_global_option('basis', type=str)
517
302
_global_option('bound')
518
303
_global_option('diff-options', type=str)
 
304
_global_option('help',
 
305
               help='show help message',
 
306
               short_name='h')
519
307
_global_option('file', type=unicode, short_name='F')
520
308
_global_option('force')
521
309
_global_option('format', type=unicode)
522
310
_global_option('forward')
523
311
_global_option('message', type=unicode,
524
 
               short_name='m',
525
 
               help='Message string.')
 
312
               short_name='m')
526
313
_global_option('no-recurse')
527
314
_global_option('profile',
528
 
               help='Show performance profiling information.')
 
315
               help='show performance profiling information')
529
316
_global_option('revision',
530
317
               type=_parse_revision_str,
531
318
               short_name='r',
532
 
               help='See "help revisionspec" for details.')
533
 
_global_option('change',
534
 
               type=_parse_change_str,
535
 
               short_name='c',
536
 
               param_name='revision',
537
 
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
538
 
_global_option('show-ids',
539
 
               help='Show internal object ids.')
540
 
_global_option('timezone',
 
319
               help='See \'help revisionspec\' for details')
 
320
_global_option('show-ids', 
 
321
               help='show internal object ids')
 
322
_global_option('timezone', 
541
323
               type=str,
542
 
               help='Display timezone as local, original, or utc.')
 
324
               help='display timezone as local, original, or utc')
543
325
_global_option('unbound')
 
326
_global_option('verbose',
 
327
               help='display more information',
 
328
               short_name='v')
544
329
_global_option('version')
545
330
_global_option('email')
546
331
_global_option('update')
547
 
_global_registry_option('log-format', "Use specified log format.",
548
 
                        lazy_registry=('bzrlib.log', 'log_formatter_registry'),
549
 
                        value_switches=True, title='Log format')
 
332
_global_option('log-format', type=str, help="Use this log format")
550
333
_global_option('long', help='Use detailed log format. Same as --log-format long',
551
334
               short_name='l')
552
335
_global_option('short', help='Use moderately short log format. Same as --log-format short')
553
336
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
554
337
_global_option('root', type=str)
555
338
_global_option('no-backup')
556
 
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
557
 
                        _merge_type_registry, value_switches=True,
558
 
                        title='Merge algorithm')
 
339
_global_option('merge-type', type=_parse_merge_type, 
 
340
               help='Select a particular merge algorithm')
559
341
_global_option('pattern', type=str)
 
342
_global_option('quiet', short_name='q')
560
343
_global_option('remember', help='Remember the specified location as a'
561
344
               ' default.')
562
 
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
 
345
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
563
346
_global_option('kind', type=str)
564
347
_global_option('dry-run',
565
 
               help="Show what would be done, but don't actually do anything.")
 
348
               help="show what would be done, but don't actually do anything")
566
349
_global_option('name-from-revision', help='The path name in the old tree.')
567
350
 
568
 
diff_writer_registry = _mod_registry.Registry()
569
 
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
570
 
diff_writer_registry.default_key = 'plain'
 
351
 
 
352
# prior to 0.14 these were always globally registered; the old dict is
 
353
# available for plugins that use it but it should not be used.
 
354
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
 
355
    symbol_versioning.zero_fourteen,
 
356
    'SHORT_OPTIONS',
 
357
    {
 
358
        'F': Option.OPTIONS['file'],
 
359
        'h': Option.OPTIONS['help'],
 
360
        'm': Option.OPTIONS['message'],
 
361
        'r': Option.OPTIONS['revision'],
 
362
        'v': Option.OPTIONS['verbose'],
 
363
        'l': Option.OPTIONS['long'],
 
364
        'q': Option.OPTIONS['quiet'],
 
365
    },
 
366
    'Set the short option name when constructing the Option.',
 
367
    )