/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: John Arbash Meinel
  • Date: 2006-09-13 02:09:37 UTC
  • mto: This revision was merged to the branch mainline in revision 2004.
  • Revision ID: john@arbash-meinel.com-20060913020937-2df2f49f9a28ec43
Update HACKING and docstrings

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006 by 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
20
21
import re
21
22
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
import optparse
25
 
 
26
 
from bzrlib import (
27
 
    errors,
28
 
    log,
29
 
    registry,
30
 
    revisionspec,
31
 
    symbol_versioning,
32
 
    )
33
 
""")
34
23
from bzrlib.trace import warning
 
24
from bzrlib.revisionspec import RevisionSpec
 
25
from bzrlib.errors import BzrCommandError
35
26
 
36
27
 
37
28
def _parse_revision_str(revstr):
89
80
    """
90
81
    # TODO: Maybe move this into revisionspec.py
91
82
    revs = []
92
 
    # split on the first .. that is not followed by a / ?
93
83
    sep = re.compile("\\.\\.(?!/)")
94
84
    for x in sep.split(revstr):
95
 
        revs.append(revisionspec.RevisionSpec.from_string(x or None))
 
85
        revs.append(RevisionSpec.from_string(x or None))
96
86
    return revs
97
87
 
98
88
 
110
100
        type_list = '\n'.join(lines)
111
101
        msg = "No known merge type %s. Supported types are:\n%s" %\
112
102
            (typestring, type_list)
113
 
        raise errors.BzrCommandError(msg)
114
 
 
 
103
        raise BzrCommandError(msg)
115
104
 
116
105
class Option(object):
117
 
    """Description of a command line option
118
 
    
119
 
    :ivar _short_name: If this option has a single-letter name, this is it.
120
 
    Otherwise None.
121
 
    """
122
 
 
 
106
    """Description of a command line option"""
123
107
    # TODO: Some way to show in help a description of the option argument
124
108
 
125
109
    OPTIONS = {}
 
110
    SHORT_OPTIONS = {}
126
111
 
127
 
    def __init__(self, name, help='', type=None, argname=None,
128
 
                 short_name=None):
 
112
    def __init__(self, name, help='', type=None, argname=None):
129
113
        """Make a new command option.
130
114
 
131
115
        name -- regular name of the command, used in the double-dash
139
123
 
140
124
        argname -- name of option argument, if any
141
125
        """
 
126
        # TODO: perhaps a subclass that automatically does 
 
127
        # --option, --no-option for reversible booleans
142
128
        self.name = name
143
129
        self.help = help
144
130
        self.type = type
145
 
        self._short_name = short_name
146
131
        if type is None:
147
132
            assert argname is None
148
133
        elif argname is None:
150
135
        self.argname = argname
151
136
 
152
137
    def short_name(self):
153
 
        if self._short_name:
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
 
138
        """Return the single character option for this command, if any.
162
139
 
163
 
    def set_short_name(self, short_name):
164
 
        self._short_name = short_name
 
140
        Short options are globally registered.
 
141
        """
 
142
        for short, option in Option.SHORT_OPTIONS.iteritems():
 
143
            if option is self:
 
144
                return short
165
145
 
166
146
    def get_negation_name(self):
167
147
        if self.name.startswith('no-'):
205
185
        yield self.name, self.short_name(), argname, self.help
206
186
 
207
187
 
208
 
class RegistryOption(Option):
209
 
    """Option based on a registry
210
 
 
211
 
    The values for the options correspond to entries in the registry.  Input
212
 
    must be a registry key.  After validation, it is converted into an object
213
 
    using Registry.get or a caller-provided converter.
214
 
    """
215
 
 
216
 
    def validate_value(self, value):
217
 
        """Validate a value name"""
218
 
        if value not in self.registry:
219
 
            raise errors.BadOptionValue(self.name, value)
220
 
 
221
 
    def convert(self, value):
222
 
        """Convert a value name into an output type"""
223
 
        self.validate_value(value)
224
 
        if self.converter is None:
225
 
            return self.registry.get(value)
226
 
        else:
227
 
            return self.converter(value)
228
 
 
229
 
    def __init__(self, name, help, registry, converter=None,
230
 
        value_switches=False, title=None, enum_switch=True):
231
 
        """
232
 
        Constructor.
233
 
 
234
 
        :param name: The option name.
235
 
        :param help: Help for the option.
236
 
        :param registry: A Registry containing the values
237
 
        :param converter: Callable to invoke with the value name to produce
238
 
            the value.  If not supplied, self.registry.get is used.
239
 
        :param value_switches: If true, each possible value is assigned its
240
 
            own switch.  For example, instead of '--format knit',
241
 
            '--knit' can be used interchangeably.
242
 
        :param enum_switch: If true, a switch is provided with the option name,
243
 
            which takes a value.
244
 
        """
245
 
        Option.__init__(self, name, help, type=self.convert)
246
 
        self.registry = registry
247
 
        self.name = name
248
 
        self.converter = converter
249
 
        self.value_switches = value_switches
250
 
        self.enum_switch = enum_switch
251
 
        self.title = title
252
 
        if self.title is None:
253
 
            self.title = name
254
 
 
255
 
    @staticmethod
256
 
    def from_kwargs(name_, help=None, title=None, value_switches=False,
257
 
                    enum_switch=True, **kwargs):
258
 
        """Convenience method to generate string-map registry options
259
 
 
260
 
        name, help, value_switches and enum_switch are passed to the
261
 
        RegistryOption constructor.  Any other keyword arguments are treated
262
 
        as values for the option, and they value is treated as the help.
263
 
        """
264
 
        reg = registry.Registry()
265
 
        for name, help in kwargs.iteritems():
266
 
            name = name.replace('_', '-')
267
 
            reg.register(name, name, help=help)
268
 
        return RegistryOption(name_, help, reg, title=title,
269
 
            value_switches=value_switches, enum_switch=enum_switch)
270
 
 
271
 
    def add_option(self, parser, short_name):
272
 
        """Add this option to an Optparse parser"""
273
 
        if self.value_switches:
274
 
            parser = parser.add_option_group(self.title)
275
 
        if self.enum_switch:
276
 
            Option.add_option(self, parser, short_name)
277
 
        if self.value_switches:
278
 
            for key in self.registry.keys():
279
 
                option_strings = ['--%s' % key]
280
 
                if getattr(self.registry.get_info(key), 'hidden', False):
281
 
                    help = optparse.SUPPRESS_HELP
282
 
                else:
283
 
                    help = self.registry.get_help(key)
284
 
                parser.add_option(action='callback',
285
 
                              callback=self._optparse_value_callback(key),
286
 
                                  help=help,
287
 
                                  *option_strings)
288
 
 
289
 
    def _optparse_value_callback(self, cb_value):
290
 
        def cb(option, opt, value, parser):
291
 
            setattr(parser.values, self.name, self.type(cb_value))
292
 
        return cb
293
 
 
294
 
    def iter_switches(self):
295
 
        """Iterate through the list of switches provided by the option
296
 
 
297
 
        :return: an iterator of (name, short_name, argname, help)
298
 
        """
299
 
        for value in Option.iter_switches(self):
300
 
            yield value
301
 
        if self.value_switches:
302
 
            for key in sorted(self.registry.keys()):
303
 
                yield key, None, None, self.registry.get_help(key)
304
 
 
305
 
 
306
188
class OptionParser(optparse.OptionParser):
307
189
    """OptionParser that raises exceptions instead of exiting"""
308
190
 
309
191
    DEFAULT_VALUE = object()
310
192
 
311
193
    def error(self, message):
312
 
        raise errors.BzrCommandError(message)
 
194
        raise BzrCommandError(message)
313
195
 
314
196
 
315
197
def get_optparser(options):
317
199
 
318
200
    parser = OptionParser()
319
201
    parser.remove_option('--help')
 
202
    short_options = dict((k.name, v) for v, k in 
 
203
                         Option.SHORT_OPTIONS.iteritems())
320
204
    for option in options.itervalues():
321
 
        option.add_option(parser, option.short_name())
 
205
        option.add_option(parser, short_options.get(option.name))
322
206
    return parser
323
207
 
324
208
 
326
210
    """Register o as a global option."""
327
211
    Option.OPTIONS[name] = Option(name, **kwargs)
328
212
 
329
 
 
330
 
def _global_registry_option(name, help, registry, **kwargs):
331
 
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
332
 
 
333
 
 
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
213
_global_option('all')
348
214
_global_option('overwrite', help='Ignore differences between branches and '
349
215
               'overwrite unconditionally')
351
217
_global_option('bound')
352
218
_global_option('diff-options', type=str)
353
219
_global_option('help',
354
 
               help='show help message',
355
 
               short_name='h')
356
 
_global_option('file', type=unicode, short_name='F')
 
220
               help='show help message')
 
221
_global_option('file', type=unicode)
357
222
_global_option('force')
358
223
_global_option('format', type=unicode)
359
224
_global_option('forward')
360
 
_global_option('message', type=unicode,
361
 
               short_name='m')
 
225
_global_option('message', type=unicode)
362
226
_global_option('no-recurse')
 
227
_global_option('prefix', type=str, 
 
228
               help='Set prefixes to added to old and new filenames, as '
 
229
                    'two values separated by a colon.')
363
230
_global_option('profile',
364
231
               help='show performance profiling information')
365
 
_global_option('revision',
366
 
               type=_parse_revision_str,
367
 
               short_name='r',
368
 
               help='See \'help revisionspec\' for details')
 
232
_global_option('revision', type=_parse_revision_str)
369
233
_global_option('show-ids', 
370
234
               help='show internal object ids')
371
235
_global_option('timezone', 
373
237
               help='display timezone as local, original, or utc')
374
238
_global_option('unbound')
375
239
_global_option('verbose',
376
 
               help='display more information',
377
 
               short_name='v')
 
240
               help='display more information')
378
241
_global_option('version')
379
242
_global_option('email')
380
243
_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')
 
244
_global_option('log-format', type=str, help="Use this log format")
 
245
_global_option('long', help='Use detailed log format. Same as --log-format long')
386
246
_global_option('short', help='Use moderately short log format. Same as --log-format short')
387
247
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
388
248
_global_option('root', type=str)
389
249
_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')
 
250
_global_option('merge-type', type=_parse_merge_type, 
 
251
               help='Select a particular merge algorithm')
393
252
_global_option('pattern', type=str)
394
 
_global_option('quiet', short_name='q')
 
253
_global_option('quiet')
395
254
_global_option('remember', help='Remember the specified location as a'
396
255
               ' default.')
397
256
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
398
257
_global_option('kind', type=str)
399
258
_global_option('dry-run',
400
259
               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
 
    )
 
260
 
 
261
 
 
262
def _global_short(short_name, long_name):
 
263
    assert short_name not in Option.SHORT_OPTIONS
 
264
    Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
 
265
    
 
266
 
 
267
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
 
268
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
 
269
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
 
270
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
 
271
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
 
272
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
 
273
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']
 
274
Option.SHORT_OPTIONS['p'] = Option.OPTIONS['prefix']