/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-03-08 04:06:06 UTC
  • mfrom: (2323.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2442.
  • Revision ID: robertc@robertcollins.net-20070308040606-84gsniv56huiyjt4
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
19
 
20
20
import re
21
21
 
22
 
import bzrlib.commands
23
 
from bzrlib.trace import warning, mutter
24
 
from bzrlib.revisionspec import RevisionSpec
25
 
from bzrlib.errors import BzrCommandError
 
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
from bzrlib.trace import warning
26
35
 
27
36
 
28
37
def _parse_revision_str(revstr):
32
41
    each revision specifier supplied.
33
42
 
34
43
    >>> _parse_revision_str('234')
35
 
    [<RevisionSpec_int 234>]
 
44
    [<RevisionSpec_revno 234>]
36
45
    >>> _parse_revision_str('234..567')
37
 
    [<RevisionSpec_int 234>, <RevisionSpec_int 567>]
 
46
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
38
47
    >>> _parse_revision_str('..')
39
48
    [<RevisionSpec None>, <RevisionSpec None>]
40
49
    >>> _parse_revision_str('..234')
41
 
    [<RevisionSpec None>, <RevisionSpec_int 234>]
 
50
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
42
51
    >>> _parse_revision_str('234..')
43
 
    [<RevisionSpec_int 234>, <RevisionSpec None>]
 
52
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
44
53
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
45
 
    [<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
 
54
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
46
55
    >>> _parse_revision_str('234....789') #Error ?
47
 
    [<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
 
56
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
48
57
    >>> _parse_revision_str('revid:test@other.com-234234')
49
58
    [<RevisionSpec_revid revid:test@other.com-234234>]
50
59
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
51
60
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
52
61
    >>> _parse_revision_str('revid:test@other.com-234234..23')
53
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
 
62
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
54
63
    >>> _parse_revision_str('date:2005-04-12')
55
64
    [<RevisionSpec_date date:2005-04-12>]
56
65
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
60
69
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
61
70
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
62
71
    >>> _parse_revision_str('-5..23')
63
 
    [<RevisionSpec_int -5>, <RevisionSpec_int 23>]
 
72
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
64
73
    >>> _parse_revision_str('-5')
65
 
    [<RevisionSpec_int -5>]
 
74
    [<RevisionSpec_revno -5>]
66
75
    >>> _parse_revision_str('123a')
67
76
    Traceback (most recent call last):
68
77
      ...
69
 
    BzrError: No namespace registered for string: '123a'
 
78
    NoSuchRevisionSpec: No namespace registered for string: '123a'
70
79
    >>> _parse_revision_str('abc')
71
80
    Traceback (most recent call last):
72
81
      ...
73
 
    BzrError: No namespace registered for string: 'abc'
 
82
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
74
83
    >>> _parse_revision_str('branch:../branch2')
75
84
    [<RevisionSpec_branch branch:../branch2>]
76
85
    >>> _parse_revision_str('branch:../../branch2')
77
86
    [<RevisionSpec_branch branch:../../branch2>]
78
87
    >>> _parse_revision_str('branch:../../branch2..23')
79
 
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_int 23>]
 
88
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
80
89
    """
81
90
    # TODO: Maybe move this into revisionspec.py
82
 
    old_format_re = re.compile('\d*:\d*')
83
 
    m = old_format_re.match(revstr)
84
91
    revs = []
85
 
    if m:
86
 
        warning('Colon separator for revision numbers is deprecated.'
87
 
                ' Use .. instead')
88
 
        for rev in revstr.split(':'):
89
 
            if rev:
90
 
                revs.append(RevisionSpec(int(rev)))
91
 
            else:
92
 
                revs.append(RevisionSpec(None))
93
 
    else:
94
 
        sep = re.compile("\\.\\.(?!/)")
95
 
        for x in sep.split(revstr):
96
 
            revs.append(RevisionSpec(x or None))
 
92
    # split on the first .. that is not followed by a / ?
 
93
    sep = re.compile("\\.\\.(?!/)")
 
94
    for x in sep.split(revstr):
 
95
        revs.append(revisionspec.RevisionSpec.from_string(x or None))
97
96
    return revs
98
97
 
99
98
 
111
110
        type_list = '\n'.join(lines)
112
111
        msg = "No known merge type %s. Supported types are:\n%s" %\
113
112
            (typestring, type_list)
114
 
        raise BzrCommandError(msg)
 
113
        raise errors.BzrCommandError(msg)
 
114
 
115
115
 
116
116
class Option(object):
117
 
    """Description of a command line option"""
 
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
 
118
123
    # TODO: Some way to show in help a description of the option argument
119
124
 
120
125
    OPTIONS = {}
121
 
    SHORT_OPTIONS = {}
122
126
 
123
 
    def __init__(self, name, help='', type=None, argname=None):
 
127
    def __init__(self, name, help='', type=None, argname=None,
 
128
                 short_name=None):
124
129
        """Make a new command option.
125
130
 
126
131
        name -- regular name of the command, used in the double-dash
134
139
 
135
140
        argname -- name of option argument, if any
136
141
        """
137
 
        # TODO: perhaps a subclass that automatically does 
138
 
        # --option, --no-option for reversable booleans
139
142
        self.name = name
140
143
        self.help = help
141
144
        self.type = type
 
145
        self._short_name = short_name
142
146
        if type is None:
143
147
            assert argname is None
144
148
        elif argname is None:
146
150
        self.argname = argname
147
151
 
148
152
    def short_name(self):
149
 
        """Return the single character option for this command, if any.
150
 
 
151
 
        Short options are globally registered.
152
 
        """
153
 
        for short, option in Option.SHORT_OPTIONS.iteritems():
154
 
            if option is self:
155
 
                return short
 
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
 
162
 
 
163
    def set_short_name(self, short_name):
 
164
        self._short_name = short_name
 
165
 
 
166
    def get_negation_name(self):
 
167
        if self.name.startswith('no-'):
 
168
            return self.name[3:]
 
169
        else:
 
170
            return 'no-' + self.name
 
171
 
 
172
    def add_option(self, parser, short_name):
 
173
        """Add this option to an Optparse parser"""
 
174
        option_strings = ['--%s' % self.name]
 
175
        if short_name is not None:
 
176
            option_strings.append('-%s' % short_name)
 
177
        optargfn = self.type
 
178
        if optargfn is None:
 
179
            parser.add_option(action='store_true', dest=self.name, 
 
180
                              help=self.help,
 
181
                              default=OptionParser.DEFAULT_VALUE,
 
182
                              *option_strings)
 
183
            negation_strings = ['--%s' % self.get_negation_name()]
 
184
            parser.add_option(action='store_false', dest=self.name, 
 
185
                              help=optparse.SUPPRESS_HELP, *negation_strings)
 
186
        else:
 
187
            parser.add_option(action='callback', 
 
188
                              callback=self._optparse_callback, 
 
189
                              type='string', metavar=self.argname.upper(),
 
190
                              help=self.help,
 
191
                              default=OptionParser.DEFAULT_VALUE, 
 
192
                              *option_strings)
 
193
 
 
194
    def _optparse_callback(self, option, opt, value, parser):
 
195
        setattr(parser.values, self.name, self.type(value))
 
196
 
 
197
    def iter_switches(self):
 
198
        """Iterate through the list of switches provided by the option
 
199
        
 
200
        :return: an iterator of (name, short_name, argname, help)
 
201
        """
 
202
        argname =  self.argname
 
203
        if argname is not None:
 
204
            argname = argname.upper()
 
205
        yield self.name, self.short_name(), argname, self.help
 
206
 
 
207
 
 
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):
 
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
        """
 
243
        Option.__init__(self, name, help, type=self.convert)
 
244
        self.registry = registry
 
245
        self.name = name
 
246
        self.converter = converter
 
247
        self.value_switches = value_switches
 
248
        self.title = title
 
249
        if self.title is None:
 
250
            self.title = name
 
251
 
 
252
    def add_option(self, parser, short_name):
 
253
        """Add this option to an Optparse parser"""
 
254
        if self.value_switches:
 
255
            parser = parser.add_option_group(self.title)
 
256
        Option.add_option(self, parser, short_name)
 
257
        if self.value_switches:
 
258
            for key in self.registry.keys():
 
259
                option_strings = ['--%s' % key]
 
260
                parser.add_option(action='callback',
 
261
                              callback=self._optparse_value_callback(key),
 
262
                                  help=self.registry.get_help(key),
 
263
                                  *option_strings)
 
264
 
 
265
    def _optparse_value_callback(self, cb_value):
 
266
        def cb(option, opt, value, parser):
 
267
            setattr(parser.values, self.name, self.type(cb_value))
 
268
        return cb
 
269
 
 
270
    def iter_switches(self):
 
271
        """Iterate through the list of switches provided by the option
 
272
 
 
273
        :return: an iterator of (name, short_name, argname, help)
 
274
        """
 
275
        for value in Option.iter_switches(self):
 
276
            yield value
 
277
        if self.value_switches:
 
278
            for key in sorted(self.registry.keys()):
 
279
                yield key, None, None, self.registry.get_help(key)
 
280
 
 
281
 
 
282
class OptionParser(optparse.OptionParser):
 
283
    """OptionParser that raises exceptions instead of exiting"""
 
284
 
 
285
    DEFAULT_VALUE = object()
 
286
 
 
287
    def error(self, message):
 
288
        raise errors.BzrCommandError(message)
 
289
 
 
290
 
 
291
def get_optparser(options):
 
292
    """Generate an optparse parser for bzrlib-style options"""
 
293
 
 
294
    parser = OptionParser()
 
295
    parser.remove_option('--help')
 
296
    for option in options.itervalues():
 
297
        option.add_option(parser, option.short_name())
 
298
    return parser
156
299
 
157
300
 
158
301
def _global_option(name, **kwargs):
159
302
    """Register o as a global option."""
160
303
    Option.OPTIONS[name] = Option(name, **kwargs)
161
304
 
 
305
 
 
306
def _global_registry_option(name, help, registry, **kwargs):
 
307
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
 
308
 
 
309
 
 
310
class MergeTypeRegistry(registry.Registry):
 
311
 
 
312
    pass
 
313
 
 
314
 
 
315
_merge_type_registry = MergeTypeRegistry()
 
316
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
 
317
                                   "Native diff3-style merge")
 
318
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
 
319
                                   "Merge using external diff3")
 
320
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
 
321
                                   "Weave-based merge")
 
322
 
162
323
_global_option('all')
163
324
_global_option('overwrite', help='Ignore differences between branches and '
164
325
               'overwrite unconditionally')
166
327
_global_option('bound')
167
328
_global_option('diff-options', type=str)
168
329
_global_option('help',
169
 
               help='show help message')
170
 
_global_option('file', type=unicode)
 
330
               help='show help message',
 
331
               short_name='h')
 
332
_global_option('file', type=unicode, short_name='F')
171
333
_global_option('force')
172
334
_global_option('format', type=unicode)
173
335
_global_option('forward')
174
 
_global_option('message', type=unicode)
 
336
_global_option('message', type=unicode,
 
337
               short_name='m')
175
338
_global_option('no-recurse')
176
 
_global_option('prefix', type=str, 
177
 
               help='Set prefixes to added to old and new filenames, as '
178
 
                    'two values separated by a colon.')
179
339
_global_option('profile',
180
340
               help='show performance profiling information')
181
 
_global_option('revision', type=_parse_revision_str)
 
341
_global_option('revision',
 
342
               type=_parse_revision_str,
 
343
               short_name='r',
 
344
               help='See \'help revisionspec\' for details')
182
345
_global_option('show-ids', 
183
346
               help='show internal object ids')
184
347
_global_option('timezone', 
186
349
               help='display timezone as local, original, or utc')
187
350
_global_option('unbound')
188
351
_global_option('verbose',
189
 
               help='display more information')
 
352
               help='display more information',
 
353
               short_name='v')
190
354
_global_option('version')
191
355
_global_option('email')
192
356
_global_option('update')
193
 
_global_option('log-format', type=str, help="Use this log format")
194
 
_global_option('long', help='Use detailed log format. Same as --log-format long')
 
357
_global_registry_option('log-format', "Use this log format",
 
358
                        log.log_formatter_registry, value_switches=True,
 
359
                        title='Log format')
 
360
_global_option('long', help='Use detailed log format. Same as --log-format long',
 
361
               short_name='l')
195
362
_global_option('short', help='Use moderately short log format. Same as --log-format short')
196
363
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
197
364
_global_option('root', type=str)
198
365
_global_option('no-backup')
199
 
_global_option('merge-type', type=_parse_merge_type, 
200
 
               help='Select a particular merge algorithm')
 
366
_global_registry_option('merge-type', 'Select a particular merge algorithm',
 
367
                        _merge_type_registry, value_switches=True,
 
368
                        title='Merge algorithm')
201
369
_global_option('pattern', type=str)
202
 
_global_option('quiet')
 
370
_global_option('quiet', short_name='q')
203
371
_global_option('remember', help='Remember the specified location as a'
204
372
               ' default.')
205
373
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
206
374
_global_option('kind', type=str)
207
375
_global_option('dry-run',
208
376
               help="show what would be done, but don't actually do anything")
209
 
 
210
 
 
211
 
def _global_short(short_name, long_name):
212
 
    assert short_name not in Option.SHORT_OPTIONS
213
 
    Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
214
 
    
215
 
 
216
 
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
217
 
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
218
 
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
219
 
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
220
 
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
221
 
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
222
 
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']
223
 
Option.SHORT_OPTIONS['p'] = Option.OPTIONS['prefix']
 
377
_global_option('name-from-revision', help='The path name in the old tree.')
 
378
 
 
379
 
 
380
# prior to 0.14 these were always globally registered; the old dict is
 
381
# available for plugins that use it but it should not be used.
 
382
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
 
383
    symbol_versioning.zero_fourteen,
 
384
    'SHORT_OPTIONS',
 
385
    {
 
386
        'F': Option.OPTIONS['file'],
 
387
        'h': Option.OPTIONS['help'],
 
388
        'm': Option.OPTIONS['message'],
 
389
        'r': Option.OPTIONS['revision'],
 
390
        'v': Option.OPTIONS['verbose'],
 
391
        'l': Option.OPTIONS['long'],
 
392
        'q': Option.OPTIONS['quiet'],
 
393
    },
 
394
    'Set the short option name when constructing the Option.',
 
395
    )