~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-04-07 07:52:50 UTC
  • mfrom: (3340.1.1 208418-1.4)
  • Revision ID: pqm@pqm.ubuntu.com-20080407075250-phs53xnslo8boaeo
Return the correct knit serialisation method in _StreamAccess.
        (Andrew Bennetts, Martin Pool, Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 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
18
18
# TODO: probably should say which arguments are candidates for glob
19
19
# expansion on windows and do that at the command level.
20
20
 
21
 
# TODO: Help messages for options.
22
 
 
23
21
# TODO: Define arguments by objects, rather than just using names.
24
22
# Those objects can specify the expected type of the argument, which
25
 
# would help with validation and shell completion.
 
23
# would help with validation and shell completion.  They could also provide
 
24
# help/explanation for that argument in a structured way.
 
25
 
 
26
# TODO: Specific "examples" property on commands for consistent formatting.
26
27
 
27
28
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
28
29
# the profile output behind so it can be interactively examined?
29
30
 
 
31
import os
30
32
import sys
31
 
import os
 
33
 
 
34
from bzrlib.lazy_import import lazy_import
 
35
lazy_import(globals(), """
 
36
import codecs
 
37
import errno
32
38
from warnings import warn
33
 
from inspect import getdoc
34
39
 
35
40
import bzrlib
36
 
import bzrlib.trace
37
 
from bzrlib.trace import mutter, note, log_error, warning
38
 
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
39
 
from bzrlib.revisionspec import RevisionSpec
40
 
from bzrlib import BZRDIR
 
41
from bzrlib import (
 
42
    debug,
 
43
    errors,
 
44
    option,
 
45
    osutils,
 
46
    trace,
 
47
    win32utils,
 
48
    )
 
49
""")
 
50
 
 
51
from bzrlib.symbol_versioning import (
 
52
    deprecated_function,
 
53
    deprecated_method,
 
54
    )
 
55
# Compatibility
 
56
from bzrlib.option import Option
 
57
 
41
58
 
42
59
plugin_cmds = {}
43
60
 
44
61
 
45
 
def register_command(cmd):
46
 
    "Utility function to help register a command"
 
62
def register_command(cmd, decorate=False):
 
63
    """Utility function to help register a command
 
64
 
 
65
    :param cmd: Command subclass to register
 
66
    :param decorate: If true, allow overriding an existing command
 
67
        of the same name; the old command is returned by this function.
 
68
        Otherwise it is an error to try to override an existing command.
 
69
    """
47
70
    global plugin_cmds
48
71
    k = cmd.__name__
49
72
    if k.startswith("cmd_"):
50
73
        k_unsquished = _unsquish_command_name(k)
51
74
    else:
52
75
        k_unsquished = k
53
 
    if not plugin_cmds.has_key(k_unsquished):
54
 
        plugin_cmds[k_unsquished] = cmd
55
 
        mutter('registered plugin command %s', k_unsquished)      
 
76
    if k_unsquished not in plugin_cmds:
 
77
        plugin_cmds[k_unsquished] = cmd
 
78
        ## trace.mutter('registered plugin command %s', k_unsquished)
 
79
        if decorate and k_unsquished in builtin_command_names():
 
80
            return _builtin_commands()[k_unsquished]
 
81
    elif decorate:
 
82
        result = plugin_cmds[k_unsquished]
 
83
        plugin_cmds[k_unsquished] = cmd
 
84
        return result
56
85
    else:
57
 
        log_error('Two plugins defined the same command: %r' % k)
58
 
        log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
 
86
        trace.log_error('Two plugins defined the same command: %r' % k)
 
87
        trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
 
88
        trace.log_error('Previously this command was registered from %r' %
 
89
                        sys.modules[plugin_cmds[k_unsquished].__module__])
59
90
 
60
91
 
61
92
def _squish_command_name(cmd):
67
98
    return cmd[4:].replace('_','-')
68
99
 
69
100
 
70
 
def _parse_revision_str(revstr):
71
 
    """This handles a revision string -> revno.
72
 
 
73
 
    This always returns a list.  The list will have one element for
74
 
    each revision.
75
 
 
76
 
    >>> _parse_revision_str('234')
77
 
    [<RevisionSpec_int 234>]
78
 
    >>> _parse_revision_str('234..567')
79
 
    [<RevisionSpec_int 234>, <RevisionSpec_int 567>]
80
 
    >>> _parse_revision_str('..')
81
 
    [<RevisionSpec None>, <RevisionSpec None>]
82
 
    >>> _parse_revision_str('..234')
83
 
    [<RevisionSpec None>, <RevisionSpec_int 234>]
84
 
    >>> _parse_revision_str('234..')
85
 
    [<RevisionSpec_int 234>, <RevisionSpec None>]
86
 
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
87
 
    [<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
88
 
    >>> _parse_revision_str('234....789') # Error?
89
 
    [<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
90
 
    >>> _parse_revision_str('revid:test@other.com-234234')
91
 
    [<RevisionSpec_revid revid:test@other.com-234234>]
92
 
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
93
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
94
 
    >>> _parse_revision_str('revid:test@other.com-234234..23')
95
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
96
 
    >>> _parse_revision_str('date:2005-04-12')
97
 
    [<RevisionSpec_date date:2005-04-12>]
98
 
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
99
 
    [<RevisionSpec_date date:2005-04-12 12:24:33>]
100
 
    >>> _parse_revision_str('date:2005-04-12T12:24:33')
101
 
    [<RevisionSpec_date date:2005-04-12T12:24:33>]
102
 
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
103
 
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
104
 
    >>> _parse_revision_str('-5..23')
105
 
    [<RevisionSpec_int -5>, <RevisionSpec_int 23>]
106
 
    >>> _parse_revision_str('-5')
107
 
    [<RevisionSpec_int -5>]
108
 
    >>> _parse_revision_str('123a')
109
 
    Traceback (most recent call last):
110
 
      ...
111
 
    BzrError: No namespace registered for string: '123a'
112
 
    >>> _parse_revision_str('abc')
113
 
    Traceback (most recent call last):
114
 
      ...
115
 
    BzrError: No namespace registered for string: 'abc'
116
 
    """
117
 
    import re
118
 
    old_format_re = re.compile('\d*:\d*')
119
 
    m = old_format_re.match(revstr)
120
 
    revs = []
121
 
    if m:
122
 
        warning('Colon separator for revision numbers is deprecated.'
123
 
                ' Use .. instead')
124
 
        for rev in revstr.split(':'):
125
 
            if rev:
126
 
                revs.append(RevisionSpec(int(rev)))
127
 
            else:
128
 
                revs.append(RevisionSpec(None))
129
 
    else:
130
 
        for x in revstr.split('..'):
131
 
            if not x:
132
 
                revs.append(RevisionSpec(None))
133
 
            else:
134
 
                revs.append(RevisionSpec(x))
135
 
    return revs
136
 
 
137
 
 
138
101
def _builtin_commands():
139
102
    import bzrlib.builtins
140
103
    r = {}
141
104
    builtins = bzrlib.builtins.__dict__
142
105
    for name in builtins:
143
106
        if name.startswith("cmd_"):
144
 
            real_name = _unsquish_command_name(name)        
 
107
            real_name = _unsquish_command_name(name)
145
108
            r[real_name] = builtins[name]
146
109
    return r
147
 
 
148
110
            
149
111
 
150
112
def builtin_command_names():
176
138
    plugins_override
177
139
        If true, plugin commands can override builtins.
178
140
    """
 
141
    try:
 
142
        return _get_cmd_object(cmd_name, plugins_override)
 
143
    except KeyError:
 
144
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
 
145
 
 
146
 
 
147
def _get_cmd_object(cmd_name, plugins_override=True):
 
148
    """Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
179
149
    from bzrlib.externalcommand import ExternalCommand
180
150
 
181
 
    cmd_name = str(cmd_name)            # not unicode
 
151
    # We want only 'ascii' command names, but the user may have typed
 
152
    # in a Unicode name. In that case, they should just get a
 
153
    # 'command not found' error later.
 
154
    # In the future, we may actually support Unicode command names.
182
155
 
183
156
    # first look up this command under the specified name
184
157
    cmds = _get_cmd_dict(plugins_override=plugins_override)
195
168
    cmd_obj = ExternalCommand.find_command(cmd_name)
196
169
    if cmd_obj:
197
170
        return cmd_obj
198
 
 
199
 
    raise BzrCommandError("unknown command %r" % cmd_name)
 
171
    raise KeyError
200
172
 
201
173
 
202
174
class Command(object):
224
196
        List of argument forms, marked with whether they are optional,
225
197
        repeated, etc.
226
198
 
 
199
                Examples:
 
200
 
 
201
                ['to_location', 'from_branch?', 'file*']
 
202
 
 
203
                'to_location' is required
 
204
                'from_branch' is optional
 
205
                'file' can be specified 0 or more times
 
206
 
227
207
    takes_options
228
 
        List of options that may be given for this command.
 
208
        List of options that may be given for this command.  These can
 
209
        be either strings, referring to globally-defined options,
 
210
        or option objects.  Retrieve through options().
229
211
 
230
212
    hidden
231
213
        If true, this command isn't advertised.  This is typically
232
214
        for commands intended for expert users.
 
215
 
 
216
    encoding_type
 
217
        Command objects will get a 'outf' attribute, which has been
 
218
        setup to properly handle encoding of unicode strings.
 
219
        encoding_type determines what will happen when characters cannot
 
220
        be encoded
 
221
            strict - abort if we cannot decode
 
222
            replace - put in a bogus character (typically '?')
 
223
            exact - do not encode sys.stdout
 
224
 
 
225
            NOTE: by default on Windows, sys.stdout is opened as a text
 
226
            stream, therefore LF line-endings are converted to CRLF.
 
227
            When a command uses encoding_type = 'exact', then
 
228
            sys.stdout is forced to be a binary stream, and line-endings
 
229
            will not mangled.
 
230
 
233
231
    """
234
232
    aliases = []
235
 
    
236
233
    takes_args = []
237
234
    takes_options = []
 
235
    encoding_type = 'strict'
238
236
 
239
237
    hidden = False
240
238
    
242
240
        """Construct an instance of this command."""
243
241
        if self.__doc__ == Command.__doc__:
244
242
            warn("No help message set for %r" % self)
245
 
 
246
 
 
247
 
    def run_argv(self, argv):
248
 
        """Parse command line and run."""
249
 
        args, opts = parse_args(argv)
250
 
 
 
243
        # List of standard options directly supported
 
244
        self.supported_std_options = []
 
245
 
 
246
    def _maybe_expand_globs(self, file_list):
 
247
        """Glob expand file_list if the platform does not do that itself.
 
248
        
 
249
        :return: A possibly empty list of unicode paths.
 
250
 
 
251
        Introduced in bzrlib 0.18.
 
252
        """
 
253
        if not file_list:
 
254
            file_list = []
 
255
        if sys.platform == 'win32':
 
256
            file_list = win32utils.glob_expand(file_list)
 
257
        return list(file_list)
 
258
 
 
259
    def _usage(self):
 
260
        """Return single-line grammar for this command.
 
261
 
 
262
        Only describes arguments, not options.
 
263
        """
 
264
        s = 'bzr ' + self.name() + ' '
 
265
        for aname in self.takes_args:
 
266
            aname = aname.upper()
 
267
            if aname[-1] in ['$', '+']:
 
268
                aname = aname[:-1] + '...'
 
269
            elif aname[-1] == '?':
 
270
                aname = '[' + aname[:-1] + ']'
 
271
            elif aname[-1] == '*':
 
272
                aname = '[' + aname[:-1] + '...]'
 
273
            s += aname + ' '
 
274
                
 
275
        assert s[-1] == ' '
 
276
        s = s[:-1]
 
277
        return s
 
278
 
 
279
    def get_help_text(self, additional_see_also=None, plain=True,
 
280
                      see_also_as_links=False):
 
281
        """Return a text string with help for this command.
 
282
        
 
283
        :param additional_see_also: Additional help topics to be
 
284
            cross-referenced.
 
285
        :param plain: if False, raw help (reStructuredText) is
 
286
            returned instead of plain text.
 
287
        :param see_also_as_links: if True, convert items in 'See also'
 
288
            list to internal links (used by bzr_man rstx generator)
 
289
        """
 
290
        doc = self.help()
 
291
        if doc is None:
 
292
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
 
293
 
 
294
        # Extract the summary (purpose) and sections out from the text
 
295
        purpose,sections = self._get_help_parts(doc)
 
296
 
 
297
        # If a custom usage section was provided, use it
 
298
        if sections.has_key('Usage'):
 
299
            usage = sections.pop('Usage')
 
300
        else:
 
301
            usage = self._usage()
 
302
 
 
303
        # The header is the purpose and usage
 
304
        result = ""
 
305
        result += ':Purpose: %s\n' % purpose
 
306
        if usage.find('\n') >= 0:
 
307
            result += ':Usage:\n%s\n' % usage
 
308
        else:
 
309
            result += ':Usage:   %s\n' % usage
 
310
        result += '\n'
 
311
 
 
312
        # Add the options
 
313
        options = option.get_optparser(self.options()).format_option_help()
 
314
        if options.startswith('Options:'):
 
315
            result += ':' + options
 
316
        elif options.startswith('options:'):
 
317
            # Python 2.4 version of optparse
 
318
            result += ':Options:' + options[len('options:'):]
 
319
        else:
 
320
            result += options
 
321
        result += '\n'
 
322
 
 
323
        # Add the description, indenting it 2 spaces
 
324
        # to match the indentation of the options
 
325
        if sections.has_key(None):
 
326
            text = sections.pop(None)
 
327
            text = '\n  '.join(text.splitlines())
 
328
            result += ':%s:\n  %s\n\n' % ('Description',text)
 
329
 
 
330
        # Add the custom sections (e.g. Examples). Note that there's no need
 
331
        # to indent these as they must be indented already in the source.
 
332
        if sections:
 
333
            labels = sorted(sections.keys())
 
334
            for label in labels:
 
335
                result += ':%s:\n%s\n\n' % (label,sections[label])
 
336
 
 
337
        # Add the aliases, source (plug-in) and see also links, if any
 
338
        if self.aliases:
 
339
            result += ':Aliases:  '
 
340
            result += ', '.join(self.aliases) + '\n'
 
341
        plugin_name = self.plugin_name()
 
342
        if plugin_name is not None:
 
343
            result += ':From:     plugin "%s"\n' % plugin_name
 
344
        see_also = self.get_see_also(additional_see_also)
 
345
        if see_also:
 
346
            if not plain and see_also_as_links:
 
347
                see_also_links = []
 
348
                for item in see_also:
 
349
                    if item == 'topics':
 
350
                        # topics doesn't have an independent section
 
351
                        # so don't create a real link
 
352
                        see_also_links.append(item)
 
353
                    else:
 
354
                        # Use a reST link for this entry
 
355
                        see_also_links.append("`%s`_" % (item,))
 
356
                see_also = see_also_links
 
357
            result += ':See also: '
 
358
            result += ', '.join(see_also) + '\n'
 
359
 
 
360
        # If this will be rendered as plan text, convert it
 
361
        if plain:
 
362
            import bzrlib.help_topics
 
363
            result = bzrlib.help_topics.help_as_plain_text(result)
 
364
        return result
 
365
 
 
366
    @staticmethod
 
367
    def _get_help_parts(text):
 
368
        """Split help text into a summary and named sections.
 
369
 
 
370
        :return: (summary,sections) where summary is the top line and
 
371
            sections is a dictionary of the rest indexed by section name.
 
372
            A section starts with a heading line of the form ":xxx:".
 
373
            Indented text on following lines is the section value.
 
374
            All text found outside a named section is assigned to the
 
375
            default section which is given the key of None.
 
376
        """
 
377
        def save_section(sections, label, section):
 
378
            if len(section) > 0:
 
379
                if sections.has_key(label):
 
380
                    sections[label] += '\n' + section
 
381
                else:
 
382
                    sections[label] = section
 
383
            
 
384
        lines = text.rstrip().splitlines()
 
385
        summary = lines.pop(0)
 
386
        sections = {}
 
387
        label,section = None,''
 
388
        for line in lines:
 
389
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
 
390
                save_section(sections, label, section)
 
391
                label,section = line[1:-1],''
 
392
            elif label != None and len(line) > 1 and not line[0].isspace():
 
393
                save_section(sections, label, section)
 
394
                label,section = None,line
 
395
            else:
 
396
                if len(section) > 0:
 
397
                    section += '\n' + line
 
398
                else:
 
399
                    section = line
 
400
        save_section(sections, label, section)
 
401
        return summary, sections
 
402
 
 
403
    def get_help_topic(self):
 
404
        """Return the commands help topic - its name."""
 
405
        return self.name()
 
406
 
 
407
    def get_see_also(self, additional_terms=None):
 
408
        """Return a list of help topics that are related to this command.
 
409
        
 
410
        The list is derived from the content of the _see_also attribute. Any
 
411
        duplicates are removed and the result is in lexical order.
 
412
        :param additional_terms: Additional help topics to cross-reference.
 
413
        :return: A list of help topics.
 
414
        """
 
415
        see_also = set(getattr(self, '_see_also', []))
 
416
        if additional_terms:
 
417
            see_also.update(additional_terms)
 
418
        return sorted(see_also)
 
419
 
 
420
    def options(self):
 
421
        """Return dict of valid options for this command.
 
422
 
 
423
        Maps from long option name to option object."""
 
424
        r = Option.STD_OPTIONS.copy()
 
425
        std_names = r.keys()
 
426
        for o in self.takes_options:
 
427
            if isinstance(o, basestring):
 
428
                o = option.Option.OPTIONS[o]
 
429
            r[o.name] = o
 
430
            if o.name in std_names:
 
431
                self.supported_std_options.append(o.name)
 
432
        return r
 
433
 
 
434
    def _setup_outf(self):
 
435
        """Return a file linked to stdout, which has proper encoding."""
 
436
        assert self.encoding_type in ['strict', 'exact', 'replace']
 
437
 
 
438
        # Originally I was using self.stdout, but that looks
 
439
        # *way* too much like sys.stdout
 
440
        if self.encoding_type == 'exact':
 
441
            # force sys.stdout to be binary stream on win32
 
442
            if sys.platform == 'win32':
 
443
                fileno = getattr(sys.stdout, 'fileno', None)
 
444
                if fileno:
 
445
                    import msvcrt
 
446
                    msvcrt.setmode(fileno(), os.O_BINARY)
 
447
            self.outf = sys.stdout
 
448
            return
 
449
 
 
450
        output_encoding = osutils.get_terminal_encoding()
 
451
 
 
452
        self.outf = codecs.getwriter(output_encoding)(sys.stdout,
 
453
                        errors=self.encoding_type)
 
454
        # For whatever reason codecs.getwriter() does not advertise its encoding
 
455
        # it just returns the encoding of the wrapped file, which is completely
 
456
        # bogus. So set the attribute, so we can find the correct encoding later.
 
457
        self.outf.encoding = output_encoding
 
458
 
 
459
    def run_argv_aliases(self, argv, alias_argv=None):
 
460
        """Parse the command line and run with extra aliases in alias_argv."""
 
461
        if argv is None:
 
462
            warn("Passing None for [] is deprecated from bzrlib 0.10",
 
463
                 DeprecationWarning, stacklevel=2)
 
464
            argv = []
 
465
        args, opts = parse_args(self, argv, alias_argv)
 
466
 
 
467
        # Process the standard options
251
468
        if 'help' in opts:  # e.g. bzr add --help
252
 
            from bzrlib.help import help_on_command
253
 
            help_on_command(self.name())
 
469
            sys.stdout.write(self.get_help_text())
254
470
            return 0
255
 
 
256
 
        # check options are reasonable
257
 
        allowed = self.takes_options
258
 
        for oname in opts:
259
 
            if oname not in allowed:
260
 
                raise BzrCommandError("option '--%s' is not allowed for command %r"
261
 
                                      % (oname, self.name()))
 
471
        trace.set_verbosity_level(option._verbosity_level)
 
472
        if 'verbose' in self.supported_std_options:
 
473
            opts['verbose'] = trace.is_verbose()
 
474
        elif opts.has_key('verbose'):
 
475
            del opts['verbose']
 
476
        if 'quiet' in self.supported_std_options:
 
477
            opts['quiet'] = trace.is_quiet()
 
478
        elif opts.has_key('quiet'):
 
479
            del opts['quiet']
262
480
 
263
481
        # mix arguments and options into one dictionary
264
482
        cmdargs = _match_argform(self.name(), self.takes_args, args)
269
487
        all_cmd_args = cmdargs.copy()
270
488
        all_cmd_args.update(cmdopts)
271
489
 
 
490
        self._setup_outf()
 
491
 
272
492
        return self.run(**all_cmd_args)
273
 
 
274
493
    
275
494
    def run(self):
276
495
        """Actually run the command.
282
501
        shell error code if not.  It's OK for this method to allow
283
502
        an exception to raise up.
284
503
        """
285
 
        raise NotImplementedError()
286
 
 
 
504
        raise NotImplementedError('no implementation of command %r'
 
505
                                  % self.name())
287
506
 
288
507
    def help(self):
289
508
        """Return help message for this class."""
 
509
        from inspect import getdoc
290
510
        if self.__doc__ is Command.__doc__:
291
511
            return None
292
512
        return getdoc(self)
294
514
    def name(self):
295
515
        return _unsquish_command_name(self.__class__.__name__)
296
516
 
 
517
    def plugin_name(self):
 
518
        """Get the name of the plugin that provides this command.
297
519
 
298
 
def parse_spec(spec):
299
 
    """
300
 
    >>> parse_spec(None)
301
 
    [None, None]
302
 
    >>> parse_spec("./")
303
 
    ['./', None]
304
 
    >>> parse_spec("../@")
305
 
    ['..', -1]
306
 
    >>> parse_spec("../f/@35")
307
 
    ['../f', 35]
308
 
    >>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
309
 
    ['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
310
 
    """
311
 
    if spec is None:
312
 
        return [None, None]
313
 
    if '/@' in spec:
314
 
        parsed = spec.split('/@')
315
 
        assert len(parsed) == 2
316
 
        if parsed[1] == "":
317
 
            parsed[1] = -1
 
520
        :return: The name of the plugin or None if the command is builtin.
 
521
        """
 
522
        mod_parts = self.__module__.split('.')
 
523
        if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
 
524
            return mod_parts[2]
318
525
        else:
319
 
            try:
320
 
                parsed[1] = int(parsed[1])
321
 
            except ValueError:
322
 
                pass # We can allow stuff like ./@revid:blahblahblah
323
 
            else:
324
 
                assert parsed[1] >=0
325
 
    else:
326
 
        parsed = [spec, None]
327
 
    return parsed
328
 
 
329
 
 
330
 
# list of all available options; the rhs can be either None for an
331
 
# option that takes no argument, or a constructor function that checks
332
 
# the type.
333
 
OPTIONS = {
334
 
    'all':                    None,
335
 
    'basis':                  str,
336
 
    'diff-options':           str,
337
 
    'help':                   None,
338
 
    'file':                   unicode,
339
 
    'force':                  None,
340
 
    'format':                 unicode,
341
 
    'forward':                None,
342
 
    'message':                unicode,
343
 
    'no-recurse':             None,
344
 
    'profile':                None,
345
 
    'revision':               _parse_revision_str,
346
 
    'short':                  None,
347
 
    'show-ids':               None,
348
 
    'timezone':               str,
349
 
    'verbose':                None,
350
 
    'version':                None,
351
 
    'email':                  None,
352
 
    'unchanged':              None,
353
 
    'update':                 None,
354
 
    'long':                   None,
355
 
    'root':                   str,
356
 
    'no-backup':              None,
357
 
    'pattern':                str,
358
 
    }
359
 
 
360
 
SHORT_OPTIONS = {
361
 
    'F':                      'file', 
362
 
    'h':                      'help',
363
 
    'm':                      'message',
364
 
    'r':                      'revision',
365
 
    'v':                      'verbose',
366
 
    'l':                      'long',
367
 
}
368
 
 
369
 
 
370
 
def parse_args(argv):
 
526
            return None
 
527
 
 
528
 
 
529
def parse_args(command, argv, alias_argv=None):
371
530
    """Parse command line.
372
531
    
373
532
    Arguments and options are parsed at this level before being passed
374
533
    down to specific command handlers.  This routine knows, from a
375
534
    lookup table, something about the available options, what optargs
376
535
    they take, and which commands will accept them.
377
 
 
378
 
    >>> parse_args('--help'.split())
379
 
    ([], {'help': True})
380
 
    >>> parse_args('help -- --invalidcmd'.split())
381
 
    (['help', '--invalidcmd'], {})
382
 
    >>> parse_args('--version'.split())
383
 
    ([], {'version': True})
384
 
    >>> parse_args('status --all'.split())
385
 
    (['status'], {'all': True})
386
 
    >>> parse_args('commit --message=biter'.split())
387
 
    (['commit'], {'message': u'biter'})
388
 
    >>> parse_args('log -r 500'.split())
389
 
    (['log'], {'revision': [<RevisionSpec_int 500>]})
390
 
    >>> parse_args('log -r500..600'.split())
391
 
    (['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
392
 
    >>> parse_args('log -vr500..600'.split())
393
 
    (['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
394
 
    >>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
395
 
    (['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
396
536
    """
397
 
    args = []
398
 
    opts = {}
399
 
 
400
 
    argsover = False
401
 
    while argv:
402
 
        a = argv.pop(0)
403
 
        if not argsover and a[0] == '-':
404
 
            # option names must not be unicode
405
 
            a = str(a)
406
 
            optarg = None
407
 
            if a[1] == '-':
408
 
                if a == '--':
409
 
                    # We've received a standalone -- No more flags
410
 
                    argsover = True
411
 
                    continue
412
 
                mutter("  got option %r" % a)
413
 
                if '=' in a:
414
 
                    optname, optarg = a[2:].split('=', 1)
415
 
                else:
416
 
                    optname = a[2:]
417
 
                if optname not in OPTIONS:
418
 
                    raise BzrError('unknown long option %r' % a)
419
 
            else:
420
 
                shortopt = a[1:]
421
 
                if shortopt in SHORT_OPTIONS:
422
 
                    # Multi-character options must have a space to delimit
423
 
                    # their value
424
 
                    optname = SHORT_OPTIONS[shortopt]
425
 
                else:
426
 
                    # Single character short options, can be chained,
427
 
                    # and have their value appended to their name
428
 
                    shortopt = a[1:2]
429
 
                    if shortopt not in SHORT_OPTIONS:
430
 
                        # We didn't find the multi-character name, and we
431
 
                        # didn't find the single char name
432
 
                        raise BzrError('unknown short option %r' % a)
433
 
                    optname = SHORT_OPTIONS[shortopt]
434
 
 
435
 
                    if a[2:]:
436
 
                        # There are extra things on this option
437
 
                        # see if it is the value, or if it is another
438
 
                        # short option
439
 
                        optargfn = OPTIONS[optname]
440
 
                        if optargfn is None:
441
 
                            # This option does not take an argument, so the
442
 
                            # next entry is another short option, pack it back
443
 
                            # into the list
444
 
                            argv.insert(0, '-' + a[2:])
445
 
                        else:
446
 
                            # This option takes an argument, so pack it
447
 
                            # into the array
448
 
                            optarg = a[2:]
449
 
            
450
 
            if optname in opts:
451
 
                # XXX: Do we ever want to support this, e.g. for -r?
452
 
                raise BzrError('repeated option %r' % a)
453
 
                
454
 
            optargfn = OPTIONS[optname]
455
 
            if optargfn:
456
 
                if optarg == None:
457
 
                    if not argv:
458
 
                        raise BzrError('option %r needs an argument' % a)
459
 
                    else:
460
 
                        optarg = argv.pop(0)
461
 
                opts[optname] = optargfn(optarg)
462
 
            else:
463
 
                if optarg != None:
464
 
                    raise BzrError('option %r takes no argument' % optname)
465
 
                opts[optname] = True
466
 
        else:
467
 
            args.append(a)
468
 
 
 
537
    # TODO: make it a method of the Command?
 
538
    parser = option.get_optparser(command.options())
 
539
    if alias_argv is not None:
 
540
        args = alias_argv + argv
 
541
    else:
 
542
        args = argv
 
543
 
 
544
    options, args = parser.parse_args(args)
 
545
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
 
546
                 v is not option.OptionParser.DEFAULT_VALUE])
469
547
    return args, opts
470
548
 
471
549
 
472
 
 
473
 
 
474
550
def _match_argform(cmd, takes_args, args):
475
551
    argdict = {}
476
552
 
488
564
                argdict[argname + '_list'] = None
489
565
        elif ap[-1] == '+':
490
566
            if not args:
491
 
                raise BzrCommandError("command %r needs one or more %s"
492
 
                        % (cmd, argname.upper()))
 
567
                raise errors.BzrCommandError("command %r needs one or more %s"
 
568
                                             % (cmd, argname.upper()))
493
569
            else:
494
570
                argdict[argname + '_list'] = args[:]
495
571
                args = []
496
572
        elif ap[-1] == '$': # all but one
497
573
            if len(args) < 2:
498
 
                raise BzrCommandError("command %r needs one or more %s"
499
 
                        % (cmd, argname.upper()))
 
574
                raise errors.BzrCommandError("command %r needs one or more %s"
 
575
                                             % (cmd, argname.upper()))
500
576
            argdict[argname + '_list'] = args[:-1]
501
 
            args[:-1] = []                
 
577
            args[:-1] = []
502
578
        else:
503
579
            # just a plain arg
504
580
            argname = ap
505
581
            if not args:
506
 
                raise BzrCommandError("command %r requires argument %s"
507
 
                        % (cmd, argname.upper()))
 
582
                raise errors.BzrCommandError("command %r requires argument %s"
 
583
                               % (cmd, argname.upper()))
508
584
            else:
509
585
                argdict[argname] = args.pop(0)
510
586
            
511
587
    if args:
512
 
        raise BzrCommandError("extra argument to command %s: %s"
513
 
                              % (cmd, args[0]))
 
588
        raise errors.BzrCommandError("extra argument to command %s: %s"
 
589
                                     % (cmd, args[0]))
514
590
 
515
591
    return argdict
516
592
 
 
593
def apply_coveraged(dirname, the_callable, *args, **kwargs):
 
594
    # Cannot use "import trace", as that would import bzrlib.trace instead of
 
595
    # the standard library's trace.
 
596
    trace = __import__('trace')
 
597
 
 
598
    tracer = trace.Trace(count=1, trace=0)
 
599
    sys.settrace(tracer.globaltrace)
 
600
 
 
601
    ret = the_callable(*args, **kwargs)
 
602
 
 
603
    sys.settrace(None)
 
604
    results = tracer.results()
 
605
    results.write_results(show_missing=1, summary=False,
 
606
                          coverdir=dirname)
517
607
 
518
608
 
519
609
def apply_profiled(the_callable, *args, **kwargs):
539
629
        os.remove(pfname)
540
630
 
541
631
 
 
632
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
 
633
    from bzrlib.lsprof import profile
 
634
    ret, stats = profile(the_callable, *args, **kwargs)
 
635
    stats.sort()
 
636
    if filename is None:
 
637
        stats.pprint()
 
638
    else:
 
639
        stats.save(filename)
 
640
        trace.note('Profile data written to "%s".', filename)
 
641
    return ret
 
642
 
 
643
 
 
644
def shlex_split_unicode(unsplit):
 
645
    import shlex
 
646
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
 
647
 
 
648
 
 
649
def get_alias(cmd, config=None):
 
650
    """Return an expanded alias, or None if no alias exists.
 
651
 
 
652
    cmd
 
653
        Command to be checked for an alias.
 
654
    config
 
655
        Used to specify an alternative config to use,
 
656
        which is especially useful for testing.
 
657
        If it is unspecified, the global config will be used.
 
658
    """
 
659
    if config is None:
 
660
        import bzrlib.config
 
661
        config = bzrlib.config.GlobalConfig()
 
662
    alias = config.get_alias(cmd)
 
663
    if (alias):
 
664
        return shlex_split_unicode(alias)
 
665
    return None
 
666
 
 
667
 
542
668
def run_bzr(argv):
543
669
    """Execute a command.
544
670
 
547
673
    
548
674
    argv
549
675
       The command-line arguments, without the program name from argv[0]
 
676
       These should already be decoded. All library/test code calling
 
677
       run_bzr should be passing valid strings (don't need decoding).
550
678
    
551
679
    Returns a command status or raises an exception.
552
680
 
556
684
    --no-plugins
557
685
        Do not load plugin modules at all
558
686
 
 
687
    --no-aliases
 
688
        Do not allow aliases
 
689
 
559
690
    --builtin
560
691
        Only use builtin commands.  (Plugins are still allowed to change
561
692
        other behaviour.)
562
693
 
563
694
    --profile
564
 
        Run under the Python profiler.
 
695
        Run under the Python hotshot profiler.
 
696
 
 
697
    --lsprof
 
698
        Run under the Python lsprof profiler.
 
699
 
 
700
    --coverage
 
701
        Generate line coverage report in the specified directory.
565
702
    """
566
 
    # Load all of the transport methods
567
 
    import bzrlib.transport.local, bzrlib.transport.http
568
 
    
569
 
    argv = [a.decode(bzrlib.user_encoding) for a in argv]
 
703
    argv = list(argv)
 
704
    trace.mutter("bzr arguments: %r", argv)
570
705
 
571
 
    opt_profile = opt_no_plugins = opt_builtin = False
 
706
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
707
                opt_no_aliases = False
 
708
    opt_lsprof_file = opt_coverage_dir = None
572
709
 
573
710
    # --no-plugins is handled specially at a very early stage. We need
574
711
    # to load plugins before doing other command parsing so that they
575
712
    # can override commands, but this needs to happen first.
576
713
 
577
 
    for a in argv:
 
714
    argv_copy = []
 
715
    i = 0
 
716
    while i < len(argv):
 
717
        a = argv[i]
578
718
        if a == '--profile':
579
719
            opt_profile = True
 
720
        elif a == '--lsprof':
 
721
            opt_lsprof = True
 
722
        elif a == '--lsprof-file':
 
723
            opt_lsprof = True
 
724
            opt_lsprof_file = argv[i + 1]
 
725
            i += 1
580
726
        elif a == '--no-plugins':
581
727
            opt_no_plugins = True
 
728
        elif a == '--no-aliases':
 
729
            opt_no_aliases = True
582
730
        elif a == '--builtin':
583
731
            opt_builtin = True
 
732
        elif a == '--coverage':
 
733
            opt_coverage_dir = argv[i + 1]
 
734
            i += 1
 
735
        elif a.startswith('-D'):
 
736
            debug.debug_flags.add(a[2:])
584
737
        else:
585
 
            break
586
 
        argv.remove(a)
 
738
            argv_copy.append(a)
 
739
        i += 1
587
740
 
588
 
    if (not argv) or (argv[0] == '--help'):
589
 
        from bzrlib.help import help
590
 
        if len(argv) > 1:
591
 
            help(argv[1])
592
 
        else:
593
 
            help()
 
741
    argv = argv_copy
 
742
    if (not argv):
 
743
        from bzrlib.builtins import cmd_help
 
744
        cmd_help().run_argv_aliases([])
594
745
        return 0
595
746
 
596
747
    if argv[0] == '--version':
597
 
        from bzrlib.builtins import show_version
598
 
        show_version()
 
748
        from bzrlib.builtins import cmd_version
 
749
        cmd_version().run_argv_aliases([])
599
750
        return 0
600
751
        
601
752
    if not opt_no_plugins:
602
753
        from bzrlib.plugin import load_plugins
603
754
        load_plugins()
604
 
 
605
 
    cmd = str(argv.pop(0))
 
755
    else:
 
756
        from bzrlib.plugin import disable_plugins
 
757
        disable_plugins()
 
758
 
 
759
    alias_argv = None
 
760
 
 
761
    if not opt_no_aliases:
 
762
        alias_argv = get_alias(argv[0])
 
763
        if alias_argv:
 
764
            alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
 
765
            argv[0] = alias_argv.pop(0)
 
766
 
 
767
    cmd = argv.pop(0)
 
768
    # We want only 'ascii' command names, but the user may have typed
 
769
    # in a Unicode name. In that case, they should just get a
 
770
    # 'command not found' error later.
606
771
 
607
772
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
608
 
 
609
 
    if opt_profile:
610
 
        ret = apply_profiled(cmd_obj.run_argv, argv)
611
 
    else:
612
 
        ret = cmd_obj.run_argv(argv)
613
 
    return ret or 0
 
773
    run = cmd_obj.run_argv_aliases
 
774
    run_argv = [argv, alias_argv]
 
775
 
 
776
    try:
 
777
        if opt_lsprof:
 
778
            if opt_coverage_dir:
 
779
                trace.warning(
 
780
                    '--coverage ignored, because --lsprof is in use.')
 
781
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
 
782
        elif opt_profile:
 
783
            if opt_coverage_dir:
 
784
                trace.warning(
 
785
                    '--coverage ignored, because --profile is in use.')
 
786
            ret = apply_profiled(run, *run_argv)
 
787
        elif opt_coverage_dir:
 
788
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
 
789
        else:
 
790
            ret = run(*run_argv)
 
791
        return ret or 0
 
792
    finally:
 
793
        # reset, in case we may do other commands later within the same process
 
794
        option._verbosity_level = 0
 
795
 
 
796
def display_command(func):
 
797
    """Decorator that suppresses pipe/interrupt errors."""
 
798
    def ignore_pipe(*args, **kwargs):
 
799
        try:
 
800
            result = func(*args, **kwargs)
 
801
            sys.stdout.flush()
 
802
            return result
 
803
        except IOError, e:
 
804
            if getattr(e, 'errno', None) is None:
 
805
                raise
 
806
            if e.errno != errno.EPIPE:
 
807
                # Win32 raises IOError with errno=0 on a broken pipe
 
808
                if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
 
809
                    raise
 
810
            pass
 
811
        except KeyboardInterrupt:
 
812
            pass
 
813
    return ignore_pipe
614
814
 
615
815
 
616
816
def main(argv):
617
817
    import bzrlib.ui
618
 
    bzrlib.trace.log_startup(argv)
619
 
    bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
620
 
 
621
 
    return run_bzr_catch_errors(argv[1:])
 
818
    from bzrlib.ui.text import TextUIFactory
 
819
    bzrlib.ui.ui_factory = TextUIFactory()
 
820
    try:
 
821
        argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
 
822
    except UnicodeDecodeError:
 
823
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
824
                                                            "encoding." % a))
 
825
    ret = run_bzr_catch_errors(argv)
 
826
    trace.mutter("return code %d", ret)
 
827
    return ret
622
828
 
623
829
 
624
830
def run_bzr_catch_errors(argv):
625
 
    try:
626
 
        try:
627
 
            try:
628
 
                return run_bzr(argv)
629
 
            finally:
630
 
                # do this here inside the exception wrappers to catch EPIPE
631
 
                sys.stdout.flush()
632
 
        #wrap common errors as CommandErrors.
633
 
        except (NotBranchError,), e:
634
 
            raise BzrCommandError(str(e))
635
 
    except BzrCommandError, e:
636
 
        # command line syntax error, etc
637
 
        log_error(str(e))
638
 
        return 1
639
 
    except BzrError, e:
640
 
        bzrlib.trace.log_exception()
641
 
        return 1
642
 
    except AssertionError, e:
643
 
        bzrlib.trace.log_exception('assertion failed: ' + str(e))
644
 
        return 3
645
 
    except KeyboardInterrupt, e:
646
 
        bzrlib.trace.log_exception('interrupted')
647
 
        return 2
 
831
    # Note: The except clause logic below should be kept in sync with the
 
832
    # profile() routine in lsprof.py.
 
833
    try:
 
834
        return run_bzr(argv)
 
835
    except (KeyboardInterrupt, Exception), e:
 
836
        # used to handle AssertionError and KeyboardInterrupt
 
837
        # specially here, but hopefully they're handled ok by the logger now
 
838
        exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
 
839
        if os.environ.get('BZR_PDB'):
 
840
            print '**** entering debugger'
 
841
            import pdb
 
842
            pdb.post_mortem(sys.exc_traceback)
 
843
        return exitcode
 
844
 
 
845
 
 
846
def run_bzr_catch_user_errors(argv):
 
847
    """Run bzr and report user errors, but let internal errors propagate.
 
848
 
 
849
    This is used for the test suite, and might be useful for other programs
 
850
    that want to wrap the commandline interface.
 
851
    """
 
852
    try:
 
853
        return run_bzr(argv)
648
854
    except Exception, e:
649
 
        import errno
650
 
        if (isinstance(e, IOError) 
651
 
            and hasattr(e, 'errno')
652
 
            and e.errno == errno.EPIPE):
653
 
            bzrlib.trace.note('broken pipe')
654
 
            return 2
655
 
        else:
656
 
            bzrlib.trace.log_exception()
657
 
            return 2
 
855
        if (isinstance(e, (OSError, IOError))
 
856
            or not getattr(e, 'internal_error', True)):
 
857
            trace.report_exception(sys.exc_info(), sys.stderr)
 
858
            return 3
 
859
        else:
 
860
            raise
 
861
 
 
862
 
 
863
class HelpCommandIndex(object):
 
864
    """A index for bzr help that returns commands."""
 
865
 
 
866
    def __init__(self):
 
867
        self.prefix = 'commands/'
 
868
 
 
869
    def get_topics(self, topic):
 
870
        """Search for topic amongst commands.
 
871
 
 
872
        :param topic: A topic to search for.
 
873
        :return: A list which is either empty or contains a single
 
874
            Command entry.
 
875
        """
 
876
        if topic and topic.startswith(self.prefix):
 
877
            topic = topic[len(self.prefix):]
 
878
        try:
 
879
            cmd = _get_cmd_object(topic)
 
880
        except KeyError:
 
881
            return []
 
882
        else:
 
883
            return [cmd]
 
884
 
658
885
 
659
886
if __name__ == '__main__':
660
887
    sys.exit(main(sys.argv))