~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: Martin Pool
  • Date: 2006-06-05 17:19:03 UTC
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: mbp@sourcefrog.net-20060605171903-f3a801c35a7db12d
Small Transport fixups

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
# TODO: For things like --diff-prefix, we want a way to customize the display
 
18
# of the option argument.
 
19
 
 
20
import re
 
21
 
 
22
import bzrlib.commands
 
23
from bzrlib.trace import warning, mutter
 
24
from bzrlib.revisionspec import RevisionSpec
 
25
from bzrlib.errors import BzrCommandError
 
26
 
 
27
 
 
28
def _parse_revision_str(revstr):
 
29
    """This handles a revision string -> revno.
 
30
 
 
31
    This always returns a list.  The list will have one element for
 
32
    each revision specifier supplied.
 
33
 
 
34
    >>> _parse_revision_str('234')
 
35
    [<RevisionSpec_int 234>]
 
36
    >>> _parse_revision_str('234..567')
 
37
    [<RevisionSpec_int 234>, <RevisionSpec_int 567>]
 
38
    >>> _parse_revision_str('..')
 
39
    [<RevisionSpec None>, <RevisionSpec None>]
 
40
    >>> _parse_revision_str('..234')
 
41
    [<RevisionSpec None>, <RevisionSpec_int 234>]
 
42
    >>> _parse_revision_str('234..')
 
43
    [<RevisionSpec_int 234>, <RevisionSpec None>]
 
44
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
 
45
    [<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
 
46
    >>> _parse_revision_str('234....789') #Error ?
 
47
    [<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
 
48
    >>> _parse_revision_str('revid:test@other.com-234234')
 
49
    [<RevisionSpec_revid revid:test@other.com-234234>]
 
50
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
 
51
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
 
52
    >>> _parse_revision_str('revid:test@other.com-234234..23')
 
53
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
 
54
    >>> _parse_revision_str('date:2005-04-12')
 
55
    [<RevisionSpec_date date:2005-04-12>]
 
56
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
 
57
    [<RevisionSpec_date date:2005-04-12 12:24:33>]
 
58
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
 
59
    [<RevisionSpec_date date:2005-04-12T12:24:33>]
 
60
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
 
61
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
 
62
    >>> _parse_revision_str('-5..23')
 
63
    [<RevisionSpec_int -5>, <RevisionSpec_int 23>]
 
64
    >>> _parse_revision_str('-5')
 
65
    [<RevisionSpec_int -5>]
 
66
    >>> _parse_revision_str('123a')
 
67
    Traceback (most recent call last):
 
68
      ...
 
69
    BzrError: No namespace registered for string: '123a'
 
70
    >>> _parse_revision_str('abc')
 
71
    Traceback (most recent call last):
 
72
      ...
 
73
    BzrError: No namespace registered for string: 'abc'
 
74
    >>> _parse_revision_str('branch:../branch2')
 
75
    [<RevisionSpec_branch branch:../branch2>]
 
76
    >>> _parse_revision_str('branch:../../branch2')
 
77
    [<RevisionSpec_branch branch:../../branch2>]
 
78
    >>> _parse_revision_str('branch:../../branch2..23')
 
79
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_int 23>]
 
80
    """
 
81
    # TODO: Maybe move this into revisionspec.py
 
82
    old_format_re = re.compile('\d*:\d*')
 
83
    m = old_format_re.match(revstr)
 
84
    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))
 
97
    return revs
 
98
 
 
99
 
 
100
def _parse_merge_type(typestring):
 
101
    return get_merge_type(typestring)
 
102
 
 
103
def get_merge_type(typestring):
 
104
    """Attempt to find the merge class/factory associated with a string."""
 
105
    from merge import merge_types
 
106
    try:
 
107
        return merge_types[typestring][0]
 
108
    except KeyError:
 
109
        templ = '%s%%7s: %%s' % (' '*12)
 
110
        lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
 
111
        type_list = '\n'.join(lines)
 
112
        msg = "No known merge type %s. Supported types are:\n%s" %\
 
113
            (typestring, type_list)
 
114
        raise BzrCommandError(msg)
 
115
 
 
116
class Option(object):
 
117
    """Description of a command line option"""
 
118
    # TODO: Some way to show in help a description of the option argument
 
119
 
 
120
    OPTIONS = {}
 
121
    SHORT_OPTIONS = {}
 
122
 
 
123
    def __init__(self, name, help='', type=None, argname=None):
 
124
        """Make a new command option.
 
125
 
 
126
        name -- regular name of the command, used in the double-dash
 
127
            form and also as the parameter to the command's run() 
 
128
            method.
 
129
 
 
130
        help -- help message displayed in command help
 
131
 
 
132
        type -- function called to parse the option argument, or 
 
133
            None (default) if this option doesn't take an argument.
 
134
 
 
135
        argname -- name of option argument, if any
 
136
        """
 
137
        # TODO: perhaps a subclass that automatically does 
 
138
        # --option, --no-option for reversable booleans
 
139
        self.name = name
 
140
        self.help = help
 
141
        self.type = type
 
142
        if type is None:
 
143
            assert argname is None
 
144
        elif argname is None:
 
145
            argname = 'ARG'
 
146
        self.argname = argname
 
147
 
 
148
    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
 
156
 
 
157
 
 
158
def _global_option(name, **kwargs):
 
159
    """Register o as a global option."""
 
160
    Option.OPTIONS[name] = Option(name, **kwargs)
 
161
 
 
162
_global_option('all')
 
163
_global_option('overwrite', help='Ignore differences between branches and '
 
164
               'overwrite unconditionally')
 
165
_global_option('basis', type=str)
 
166
_global_option('bound')
 
167
_global_option('diff-options', type=str)
 
168
_global_option('help',
 
169
               help='show help message')
 
170
_global_option('file', type=unicode)
 
171
_global_option('force')
 
172
_global_option('format', type=unicode)
 
173
_global_option('forward')
 
174
_global_option('message', type=unicode)
 
175
_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
_global_option('profile',
 
180
               help='show performance profiling information')
 
181
_global_option('revision', type=_parse_revision_str)
 
182
_global_option('show-ids', 
 
183
               help='show internal object ids')
 
184
_global_option('timezone', 
 
185
               type=str,
 
186
               help='display timezone as local, original, or utc')
 
187
_global_option('unbound')
 
188
_global_option('verbose',
 
189
               help='display more information')
 
190
_global_option('version')
 
191
_global_option('email')
 
192
_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')
 
195
_global_option('short', help='Use moderately short log format. Same as --log-format short')
 
196
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
 
197
_global_option('root', type=str)
 
198
_global_option('no-backup')
 
199
_global_option('merge-type', type=_parse_merge_type)
 
200
_global_option('pattern', type=str)
 
201
_global_option('quiet')
 
202
_global_option('remember', help='Remember the specified location as a'
 
203
               ' default.')
 
204
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
 
205
_global_option('kind', type=str)
 
206
_global_option('dry-run',
 
207
               help="show what would be done, but don't actually do anything")
 
208
 
 
209
 
 
210
def _global_short(short_name, long_name):
 
211
    assert short_name not in Option.SHORT_OPTIONS
 
212
    Option.SHORT_OPTIONS[short_name] = Option.OPTIONS[long_name]
 
213
    
 
214
 
 
215
Option.SHORT_OPTIONS['F'] = Option.OPTIONS['file']
 
216
Option.SHORT_OPTIONS['h'] = Option.OPTIONS['help']
 
217
Option.SHORT_OPTIONS['m'] = Option.OPTIONS['message']
 
218
Option.SHORT_OPTIONS['r'] = Option.OPTIONS['revision']
 
219
Option.SHORT_OPTIONS['v'] = Option.OPTIONS['verbose']
 
220
Option.SHORT_OPTIONS['l'] = Option.OPTIONS['long']
 
221
Option.SHORT_OPTIONS['q'] = Option.OPTIONS['quiet']
 
222
Option.SHORT_OPTIONS['p'] = Option.OPTIONS['prefix']