/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/commands.py

Partially fix pull.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2008 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
 
 
18
 
# TODO: probably should say which arguments are candidates for glob
19
 
# expansion on windows and do that at the command level.
20
 
 
21
 
# TODO: Define arguments by objects, rather than just using names.
22
 
# Those objects can specify the expected type of the argument, which
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.
27
 
 
28
 
# TODO: "--profile=cum", to change sort order.  Is there any value in leaving
29
 
# the profile output behind so it can be interactively examined?
30
 
 
31
 
import os
32
 
import sys
33
 
 
34
 
from bzrlib.lazy_import import lazy_import
35
 
lazy_import(globals(), """
36
 
import codecs
37
 
import errno
38
 
from warnings import warn
39
 
 
40
 
import bzrlib
41
 
from bzrlib import (
42
 
    debug,
43
 
    errors,
44
 
    option,
45
 
    osutils,
46
 
    trace,
47
 
    win32utils,
48
 
    )
49
 
""")
50
 
 
51
 
from bzrlib import registry
52
 
# Compatibility
53
 
from bzrlib.hooks import Hooks
54
 
from bzrlib.option import Option
55
 
 
56
 
 
57
 
class CommandInfo(object):
58
 
    """Information about a command."""
59
 
 
60
 
    def __init__(self, aliases):
61
 
        """The list of aliases for the command."""
62
 
        self.aliases = aliases
63
 
 
64
 
    @classmethod
65
 
    def from_command(klass, command):
66
 
        """Factory to construct a CommandInfo from a command."""
67
 
        return klass(command.aliases)
68
 
 
69
 
 
70
 
class CommandRegistry(registry.Registry):
71
 
 
72
 
    @staticmethod
73
 
    def _get_name(command_name):
74
 
        if command_name.startswith("cmd_"):
75
 
            return _unsquish_command_name(command_name)
76
 
        else:
77
 
            return command_name
78
 
 
79
 
    def register(self, cmd, decorate=False):
80
 
        """Utility function to help register a command
81
 
 
82
 
        :param cmd: Command subclass to register
83
 
        :param decorate: If true, allow overriding an existing command
84
 
            of the same name; the old command is returned by this function.
85
 
            Otherwise it is an error to try to override an existing command.
86
 
        """
87
 
        k = cmd.__name__
88
 
        k_unsquished = self._get_name(k)
89
 
        try:
90
 
            previous = self.get(k_unsquished)
91
 
        except KeyError:
92
 
            previous = _builtin_commands().get(k_unsquished)
93
 
        info = CommandInfo.from_command(cmd)
94
 
        try:
95
 
            registry.Registry.register(self, k_unsquished, cmd,
96
 
                                       override_existing=decorate, info=info)
97
 
        except KeyError:
98
 
            trace.log_error('Two plugins defined the same command: %r' % k)
99
 
            trace.log_error('Not loading the one in %r' %
100
 
                            sys.modules[cmd.__module__])
101
 
            trace.log_error('Previously this command was registered from %r' %
102
 
                            sys.modules[previous.__module__])
103
 
        return previous
104
 
 
105
 
    def register_lazy(self, command_name, aliases, module_name):
106
 
        """Register a command without loading its module.
107
 
 
108
 
        :param command_name: The primary name of the command.
109
 
        :param aliases: A list of aliases for the command.
110
 
        :module_name: The module that the command lives in.
111
 
        """
112
 
        key = self._get_name(command_name)
113
 
        registry.Registry.register_lazy(self, key, module_name, command_name,
114
 
                                        info=CommandInfo(aliases))
115
 
 
116
 
 
117
 
plugin_cmds = CommandRegistry()
118
 
 
119
 
 
120
 
def register_command(cmd, decorate=False):
121
 
    global plugin_cmds
122
 
    return plugin_cmds.register(cmd, decorate)
123
 
 
124
 
 
125
 
def _squish_command_name(cmd):
126
 
    return 'cmd_' + cmd.replace('-', '_')
127
 
 
128
 
 
129
 
def _unsquish_command_name(cmd):
130
 
    return cmd[4:].replace('_','-')
131
 
 
132
 
 
133
 
def _builtin_commands():
134
 
    import bzrlib.builtins
135
 
    r = {}
136
 
    builtins = bzrlib.builtins.__dict__
137
 
    for name in builtins:
138
 
        if name.startswith("cmd_"):
139
 
            real_name = _unsquish_command_name(name)
140
 
            r[real_name] = builtins[name]
141
 
    return r
142
 
 
143
 
 
144
 
def builtin_command_names():
145
 
    """Return list of builtin command names."""
146
 
    return _builtin_commands().keys()
147
 
 
148
 
 
149
 
def plugin_command_names():
150
 
    return plugin_cmds.keys()
151
 
 
152
 
 
153
 
def _get_cmd_dict(plugins_override=True):
154
 
    """Return name->class mapping for all commands."""
155
 
    d = _builtin_commands()
156
 
    if plugins_override:
157
 
        d.update(plugin_cmds.iteritems())
158
 
    return d
159
 
 
160
 
 
161
 
def get_all_cmds(plugins_override=True):
162
 
    """Return canonical name and class for all registered commands."""
163
 
    for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
164
 
        yield k,v
165
 
 
166
 
 
167
 
def get_cmd_object(cmd_name, plugins_override=True):
168
 
    """Return the canonical name and command class for a command.
169
 
 
170
 
    plugins_override
171
 
        If true, plugin commands can override builtins.
172
 
    """
173
 
    try:
174
 
        cmd = _get_cmd_object(cmd_name, plugins_override)
175
 
        # Allow plugins to extend commands
176
 
        for hook in Command.hooks['extend_command']:
177
 
            hook(cmd)
178
 
        return cmd
179
 
    except KeyError:
180
 
        raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
181
 
 
182
 
 
183
 
def _get_cmd_object(cmd_name, plugins_override=True):
184
 
    """Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
185
 
    from bzrlib.externalcommand import ExternalCommand
186
 
 
187
 
    # We want only 'ascii' command names, but the user may have typed
188
 
    # in a Unicode name. In that case, they should just get a
189
 
    # 'command not found' error later.
190
 
    # In the future, we may actually support Unicode command names.
191
 
 
192
 
    # first look up this command under the specified name
193
 
    if plugins_override:
194
 
        try:
195
 
            return plugin_cmds.get(cmd_name)()
196
 
        except KeyError:
197
 
            pass
198
 
    cmds = _get_cmd_dict(plugins_override=False)
199
 
    try:
200
 
        return cmds[cmd_name]()
201
 
    except KeyError:
202
 
        pass
203
 
    if plugins_override:
204
 
        for key in plugin_cmds.keys():
205
 
            info = plugin_cmds.get_info(key)
206
 
            if cmd_name in info.aliases:
207
 
                return plugin_cmds.get(key)()
208
 
    # look for any command which claims this as an alias
209
 
    for real_cmd_name, cmd_class in cmds.iteritems():
210
 
        if cmd_name in cmd_class.aliases:
211
 
            return cmd_class()
212
 
 
213
 
    cmd_obj = ExternalCommand.find_command(cmd_name)
214
 
    if cmd_obj:
215
 
        return cmd_obj
216
 
 
217
 
    # look for plugins that provide this command but aren't installed
218
 
    for provider in command_providers_registry:
219
 
        try:
220
 
            plugin_metadata = provider.plugin_for_command(cmd_name)
221
 
        except errors.NoPluginAvailable:
222
 
            pass
223
 
        else:
224
 
            raise errors.CommandAvailableInPlugin(cmd_name,
225
 
                                                  plugin_metadata, provider)
226
 
    raise KeyError
227
 
 
228
 
 
229
 
class Command(object):
230
 
    """Base class for commands.
231
 
 
232
 
    Commands are the heart of the command-line bzr interface.
233
 
 
234
 
    The command object mostly handles the mapping of command-line
235
 
    parameters into one or more bzrlib operations, and of the results
236
 
    into textual output.
237
 
 
238
 
    Commands normally don't have any state.  All their arguments are
239
 
    passed in to the run method.  (Subclasses may take a different
240
 
    policy if the behaviour of the instance needs to depend on e.g. a
241
 
    shell plugin and not just its Python class.)
242
 
 
243
 
    The docstring for an actual command should give a single-line
244
 
    summary, then a complete description of the command.  A grammar
245
 
    description will be inserted.
246
 
 
247
 
    aliases
248
 
        Other accepted names for this command.
249
 
 
250
 
    takes_args
251
 
        List of argument forms, marked with whether they are optional,
252
 
        repeated, etc.
253
 
 
254
 
                Examples:
255
 
 
256
 
                ['to_location', 'from_branch?', 'file*']
257
 
 
258
 
                'to_location' is required
259
 
                'from_branch' is optional
260
 
                'file' can be specified 0 or more times
261
 
 
262
 
    takes_options
263
 
        List of options that may be given for this command.  These can
264
 
        be either strings, referring to globally-defined options,
265
 
        or option objects.  Retrieve through options().
266
 
 
267
 
    hidden
268
 
        If true, this command isn't advertised.  This is typically
269
 
        for commands intended for expert users.
270
 
 
271
 
    encoding_type
272
 
        Command objects will get a 'outf' attribute, which has been
273
 
        setup to properly handle encoding of unicode strings.
274
 
        encoding_type determines what will happen when characters cannot
275
 
        be encoded
276
 
            strict - abort if we cannot decode
277
 
            replace - put in a bogus character (typically '?')
278
 
            exact - do not encode sys.stdout
279
 
 
280
 
            NOTE: by default on Windows, sys.stdout is opened as a text
281
 
            stream, therefore LF line-endings are converted to CRLF.
282
 
            When a command uses encoding_type = 'exact', then
283
 
            sys.stdout is forced to be a binary stream, and line-endings
284
 
            will not mangled.
285
 
 
286
 
    :cvar hooks: An instance of CommandHooks.
287
 
    """
288
 
    aliases = []
289
 
    takes_args = []
290
 
    takes_options = []
291
 
    encoding_type = 'strict'
292
 
 
293
 
    hidden = False
294
 
 
295
 
    def __init__(self):
296
 
        """Construct an instance of this command."""
297
 
        if self.__doc__ == Command.__doc__:
298
 
            warn("No help message set for %r" % self)
299
 
        # List of standard options directly supported
300
 
        self.supported_std_options = []
301
 
 
302
 
    def _maybe_expand_globs(self, file_list):
303
 
        """Glob expand file_list if the platform does not do that itself.
304
 
 
305
 
        :return: A possibly empty list of unicode paths.
306
 
 
307
 
        Introduced in bzrlib 0.18.
308
 
        """
309
 
        if not file_list:
310
 
            file_list = []
311
 
        if sys.platform == 'win32':
312
 
            file_list = win32utils.glob_expand(file_list)
313
 
        return list(file_list)
314
 
 
315
 
    def _usage(self):
316
 
        """Return single-line grammar for this command.
317
 
 
318
 
        Only describes arguments, not options.
319
 
        """
320
 
        s = 'bzr ' + self.name() + ' '
321
 
        for aname in self.takes_args:
322
 
            aname = aname.upper()
323
 
            if aname[-1] in ['$', '+']:
324
 
                aname = aname[:-1] + '...'
325
 
            elif aname[-1] == '?':
326
 
                aname = '[' + aname[:-1] + ']'
327
 
            elif aname[-1] == '*':
328
 
                aname = '[' + aname[:-1] + '...]'
329
 
            s += aname + ' '
330
 
        s = s[:-1]      # remove last space
331
 
        return s
332
 
 
333
 
    def get_help_text(self, additional_see_also=None, plain=True,
334
 
                      see_also_as_links=False):
335
 
        """Return a text string with help for this command.
336
 
 
337
 
        :param additional_see_also: Additional help topics to be
338
 
            cross-referenced.
339
 
        :param plain: if False, raw help (reStructuredText) is
340
 
            returned instead of plain text.
341
 
        :param see_also_as_links: if True, convert items in 'See also'
342
 
            list to internal links (used by bzr_man rstx generator)
343
 
        """
344
 
        doc = self.help()
345
 
        if doc is None:
346
 
            raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
347
 
 
348
 
        # Extract the summary (purpose) and sections out from the text
349
 
        purpose,sections,order = self._get_help_parts(doc)
350
 
 
351
 
        # If a custom usage section was provided, use it
352
 
        if sections.has_key('Usage'):
353
 
            usage = sections.pop('Usage')
354
 
        else:
355
 
            usage = self._usage()
356
 
 
357
 
        # The header is the purpose and usage
358
 
        result = ""
359
 
        result += ':Purpose: %s\n' % purpose
360
 
        if usage.find('\n') >= 0:
361
 
            result += ':Usage:\n%s\n' % usage
362
 
        else:
363
 
            result += ':Usage:   %s\n' % usage
364
 
        result += '\n'
365
 
 
366
 
        # Add the options
367
 
        options = option.get_optparser(self.options()).format_option_help()
368
 
        if options.startswith('Options:'):
369
 
            result += ':' + options
370
 
        elif options.startswith('options:'):
371
 
            # Python 2.4 version of optparse
372
 
            result += ':Options:' + options[len('options:'):]
373
 
        else:
374
 
            result += options
375
 
        result += '\n'
376
 
 
377
 
        # Add the description, indenting it 2 spaces
378
 
        # to match the indentation of the options
379
 
        if sections.has_key(None):
380
 
            text = sections.pop(None)
381
 
            text = '\n  '.join(text.splitlines())
382
 
            result += ':%s:\n  %s\n\n' % ('Description',text)
383
 
 
384
 
        # Add the custom sections (e.g. Examples). Note that there's no need
385
 
        # to indent these as they must be indented already in the source.
386
 
        if sections:
387
 
            for label in order:
388
 
                if sections.has_key(label):
389
 
                    result += ':%s:\n%s\n\n' % (label,sections[label])
390
 
 
391
 
        # Add the aliases, source (plug-in) and see also links, if any
392
 
        if self.aliases:
393
 
            result += ':Aliases:  '
394
 
            result += ', '.join(self.aliases) + '\n'
395
 
        plugin_name = self.plugin_name()
396
 
        if plugin_name is not None:
397
 
            result += ':From:     plugin "%s"\n' % plugin_name
398
 
        see_also = self.get_see_also(additional_see_also)
399
 
        if see_also:
400
 
            if not plain and see_also_as_links:
401
 
                see_also_links = []
402
 
                for item in see_also:
403
 
                    if item == 'topics':
404
 
                        # topics doesn't have an independent section
405
 
                        # so don't create a real link
406
 
                        see_also_links.append(item)
407
 
                    else:
408
 
                        # Use a reST link for this entry
409
 
                        see_also_links.append("`%s`_" % (item,))
410
 
                see_also = see_also_links
411
 
            result += ':See also: '
412
 
            result += ', '.join(see_also) + '\n'
413
 
 
414
 
        # If this will be rendered as plain text, convert it
415
 
        if plain:
416
 
            import bzrlib.help_topics
417
 
            result = bzrlib.help_topics.help_as_plain_text(result)
418
 
        return result
419
 
 
420
 
    @staticmethod
421
 
    def _get_help_parts(text):
422
 
        """Split help text into a summary and named sections.
423
 
 
424
 
        :return: (summary,sections,order) where summary is the top line and
425
 
            sections is a dictionary of the rest indexed by section name.
426
 
            order is the order the section appear in the text.
427
 
            A section starts with a heading line of the form ":xxx:".
428
 
            Indented text on following lines is the section value.
429
 
            All text found outside a named section is assigned to the
430
 
            default section which is given the key of None.
431
 
        """
432
 
        def save_section(sections, order, label, section):
433
 
            if len(section) > 0:
434
 
                if sections.has_key(label):
435
 
                    sections[label] += '\n' + section
436
 
                else:
437
 
                    order.append(label)
438
 
                    sections[label] = section
439
 
 
440
 
        lines = text.rstrip().splitlines()
441
 
        summary = lines.pop(0)
442
 
        sections = {}
443
 
        order = []
444
 
        label,section = None,''
445
 
        for line in lines:
446
 
            if line.startswith(':') and line.endswith(':') and len(line) > 2:
447
 
                save_section(sections, order, label, section)
448
 
                label,section = line[1:-1],''
449
 
            elif (label is not None) and len(line) > 1 and not line[0].isspace():
450
 
                save_section(sections, order, label, section)
451
 
                label,section = None,line
452
 
            else:
453
 
                if len(section) > 0:
454
 
                    section += '\n' + line
455
 
                else:
456
 
                    section = line
457
 
        save_section(sections, order, label, section)
458
 
        return summary, sections, order
459
 
 
460
 
    def get_help_topic(self):
461
 
        """Return the commands help topic - its name."""
462
 
        return self.name()
463
 
 
464
 
    def get_see_also(self, additional_terms=None):
465
 
        """Return a list of help topics that are related to this command.
466
 
 
467
 
        The list is derived from the content of the _see_also attribute. Any
468
 
        duplicates are removed and the result is in lexical order.
469
 
        :param additional_terms: Additional help topics to cross-reference.
470
 
        :return: A list of help topics.
471
 
        """
472
 
        see_also = set(getattr(self, '_see_also', []))
473
 
        if additional_terms:
474
 
            see_also.update(additional_terms)
475
 
        return sorted(see_also)
476
 
 
477
 
    def options(self):
478
 
        """Return dict of valid options for this command.
479
 
 
480
 
        Maps from long option name to option object."""
481
 
        r = Option.STD_OPTIONS.copy()
482
 
        std_names = r.keys()
483
 
        for o in self.takes_options:
484
 
            if isinstance(o, basestring):
485
 
                o = option.Option.OPTIONS[o]
486
 
            r[o.name] = o
487
 
            if o.name in std_names:
488
 
                self.supported_std_options.append(o.name)
489
 
        return r
490
 
 
491
 
    def _setup_outf(self):
492
 
        """Return a file linked to stdout, which has proper encoding."""
493
 
        # Originally I was using self.stdout, but that looks
494
 
        # *way* too much like sys.stdout
495
 
        if self.encoding_type == 'exact':
496
 
            # force sys.stdout to be binary stream on win32
497
 
            if sys.platform == 'win32':
498
 
                fileno = getattr(sys.stdout, 'fileno', None)
499
 
                if fileno:
500
 
                    import msvcrt
501
 
                    msvcrt.setmode(fileno(), os.O_BINARY)
502
 
            self.outf = sys.stdout
503
 
            return
504
 
 
505
 
        output_encoding = osutils.get_terminal_encoding()
506
 
 
507
 
        self.outf = codecs.getwriter(output_encoding)(sys.stdout,
508
 
                        errors=self.encoding_type)
509
 
        # For whatever reason codecs.getwriter() does not advertise its encoding
510
 
        # it just returns the encoding of the wrapped file, which is completely
511
 
        # bogus. So set the attribute, so we can find the correct encoding later.
512
 
        self.outf.encoding = output_encoding
513
 
 
514
 
    def run_argv_aliases(self, argv, alias_argv=None):
515
 
        """Parse the command line and run with extra aliases in alias_argv."""
516
 
        if argv is None:
517
 
            warn("Passing None for [] is deprecated from bzrlib 0.10",
518
 
                 DeprecationWarning, stacklevel=2)
519
 
            argv = []
520
 
        args, opts = parse_args(self, argv, alias_argv)
521
 
 
522
 
        # Process the standard options
523
 
        if 'help' in opts:  # e.g. bzr add --help
524
 
            sys.stdout.write(self.get_help_text())
525
 
            return 0
526
 
        trace.set_verbosity_level(option._verbosity_level)
527
 
        if 'verbose' in self.supported_std_options:
528
 
            opts['verbose'] = trace.is_verbose()
529
 
        elif opts.has_key('verbose'):
530
 
            del opts['verbose']
531
 
        if 'quiet' in self.supported_std_options:
532
 
            opts['quiet'] = trace.is_quiet()
533
 
        elif opts.has_key('quiet'):
534
 
            del opts['quiet']
535
 
 
536
 
        # mix arguments and options into one dictionary
537
 
        cmdargs = _match_argform(self.name(), self.takes_args, args)
538
 
        cmdopts = {}
539
 
        for k, v in opts.items():
540
 
            cmdopts[k.replace('-', '_')] = v
541
 
 
542
 
        all_cmd_args = cmdargs.copy()
543
 
        all_cmd_args.update(cmdopts)
544
 
 
545
 
        self._setup_outf()
546
 
 
547
 
        return self.run(**all_cmd_args)
548
 
 
549
 
    def run(self):
550
 
        """Actually run the command.
551
 
 
552
 
        This is invoked with the options and arguments bound to
553
 
        keyword parameters.
554
 
 
555
 
        Return 0 or None if the command was successful, or a non-zero
556
 
        shell error code if not.  It's OK for this method to allow
557
 
        an exception to raise up.
558
 
        """
559
 
        raise NotImplementedError('no implementation of command %r'
560
 
                                  % self.name())
561
 
 
562
 
    def help(self):
563
 
        """Return help message for this class."""
564
 
        from inspect import getdoc
565
 
        if self.__doc__ is Command.__doc__:
566
 
            return None
567
 
        return getdoc(self)
568
 
 
569
 
    def name(self):
570
 
        return _unsquish_command_name(self.__class__.__name__)
571
 
 
572
 
    def plugin_name(self):
573
 
        """Get the name of the plugin that provides this command.
574
 
 
575
 
        :return: The name of the plugin or None if the command is builtin.
576
 
        """
577
 
        mod_parts = self.__module__.split('.')
578
 
        if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
579
 
            return mod_parts[2]
580
 
        else:
581
 
            return None
582
 
 
583
 
 
584
 
class CommandHooks(Hooks):
585
 
    """Hooks related to Command object creation/enumeration."""
586
 
 
587
 
    def __init__(self):
588
 
        """Create the default hooks.
589
 
 
590
 
        These are all empty initially, because by default nothing should get
591
 
        notified.
592
 
        """
593
 
        Hooks.__init__(self)
594
 
        # Introduced in 1.13:
595
 
        # invoked after creating a command object to allow modifications such
596
 
        # as adding or removing options, docs etc. Invoked with the command
597
 
        # object.
598
 
        self['extend_command'] = []
599
 
 
600
 
Command.hooks = CommandHooks()
601
 
 
602
 
 
603
 
def parse_args(command, argv, alias_argv=None):
604
 
    """Parse command line.
605
 
 
606
 
    Arguments and options are parsed at this level before being passed
607
 
    down to specific command handlers.  This routine knows, from a
608
 
    lookup table, something about the available options, what optargs
609
 
    they take, and which commands will accept them.
610
 
    """
611
 
    # TODO: make it a method of the Command?
612
 
    parser = option.get_optparser(command.options())
613
 
    if alias_argv is not None:
614
 
        args = alias_argv + argv
615
 
    else:
616
 
        args = argv
617
 
 
618
 
    options, args = parser.parse_args(args)
619
 
    opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
620
 
                 v is not option.OptionParser.DEFAULT_VALUE])
621
 
    return args, opts
622
 
 
623
 
 
624
 
def _match_argform(cmd, takes_args, args):
625
 
    argdict = {}
626
 
 
627
 
    # step through args and takes_args, allowing appropriate 0-many matches
628
 
    for ap in takes_args:
629
 
        argname = ap[:-1]
630
 
        if ap[-1] == '?':
631
 
            if args:
632
 
                argdict[argname] = args.pop(0)
633
 
        elif ap[-1] == '*': # all remaining arguments
634
 
            if args:
635
 
                argdict[argname + '_list'] = args[:]
636
 
                args = []
637
 
            else:
638
 
                argdict[argname + '_list'] = None
639
 
        elif ap[-1] == '+':
640
 
            if not args:
641
 
                raise errors.BzrCommandError("command %r needs one or more %s"
642
 
                                             % (cmd, argname.upper()))
643
 
            else:
644
 
                argdict[argname + '_list'] = args[:]
645
 
                args = []
646
 
        elif ap[-1] == '$': # all but one
647
 
            if len(args) < 2:
648
 
                raise errors.BzrCommandError("command %r needs one or more %s"
649
 
                                             % (cmd, argname.upper()))
650
 
            argdict[argname + '_list'] = args[:-1]
651
 
            args[:-1] = []
652
 
        else:
653
 
            # just a plain arg
654
 
            argname = ap
655
 
            if not args:
656
 
                raise errors.BzrCommandError("command %r requires argument %s"
657
 
                               % (cmd, argname.upper()))
658
 
            else:
659
 
                argdict[argname] = args.pop(0)
660
 
 
661
 
    if args:
662
 
        raise errors.BzrCommandError("extra argument to command %s: %s"
663
 
                                     % (cmd, args[0]))
664
 
 
665
 
    return argdict
666
 
 
667
 
def apply_coveraged(dirname, the_callable, *args, **kwargs):
668
 
    # Cannot use "import trace", as that would import bzrlib.trace instead of
669
 
    # the standard library's trace.
670
 
    trace = __import__('trace')
671
 
 
672
 
    tracer = trace.Trace(count=1, trace=0)
673
 
    sys.settrace(tracer.globaltrace)
674
 
 
675
 
    ret = the_callable(*args, **kwargs)
676
 
 
677
 
    sys.settrace(None)
678
 
    results = tracer.results()
679
 
    results.write_results(show_missing=1, summary=False,
680
 
                          coverdir=dirname)
681
 
 
682
 
 
683
 
def apply_profiled(the_callable, *args, **kwargs):
684
 
    import hotshot
685
 
    import tempfile
686
 
    import hotshot.stats
687
 
    pffileno, pfname = tempfile.mkstemp()
688
 
    try:
689
 
        prof = hotshot.Profile(pfname)
690
 
        try:
691
 
            ret = prof.runcall(the_callable, *args, **kwargs) or 0
692
 
        finally:
693
 
            prof.close()
694
 
        stats = hotshot.stats.load(pfname)
695
 
        stats.strip_dirs()
696
 
        stats.sort_stats('cum')   # 'time'
697
 
        ## XXX: Might like to write to stderr or the trace file instead but
698
 
        ## print_stats seems hardcoded to stdout
699
 
        stats.print_stats(20)
700
 
        return ret
701
 
    finally:
702
 
        os.close(pffileno)
703
 
        os.remove(pfname)
704
 
 
705
 
 
706
 
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
707
 
    from bzrlib.lsprof import profile
708
 
    ret, stats = profile(the_callable, *args, **kwargs)
709
 
    stats.sort()
710
 
    if filename is None:
711
 
        stats.pprint()
712
 
    else:
713
 
        stats.save(filename)
714
 
        trace.note('Profile data written to "%s".', filename)
715
 
    return ret
716
 
 
717
 
 
718
 
def shlex_split_unicode(unsplit):
719
 
    import shlex
720
 
    return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
721
 
 
722
 
 
723
 
def get_alias(cmd, config=None):
724
 
    """Return an expanded alias, or None if no alias exists.
725
 
 
726
 
    cmd
727
 
        Command to be checked for an alias.
728
 
    config
729
 
        Used to specify an alternative config to use,
730
 
        which is especially useful for testing.
731
 
        If it is unspecified, the global config will be used.
732
 
    """
733
 
    if config is None:
734
 
        import bzrlib.config
735
 
        config = bzrlib.config.GlobalConfig()
736
 
    alias = config.get_alias(cmd)
737
 
    if (alias):
738
 
        return shlex_split_unicode(alias)
739
 
    return None
740
 
 
741
 
 
742
 
def run_bzr(argv):
743
 
    """Execute a command.
744
 
 
745
 
    argv
746
 
       The command-line arguments, without the program name from argv[0]
747
 
       These should already be decoded. All library/test code calling
748
 
       run_bzr should be passing valid strings (don't need decoding).
749
 
 
750
 
    Returns a command status or raises an exception.
751
 
 
752
 
    Special master options: these must come before the command because
753
 
    they control how the command is interpreted.
754
 
 
755
 
    --no-plugins
756
 
        Do not load plugin modules at all
757
 
 
758
 
    --no-aliases
759
 
        Do not allow aliases
760
 
 
761
 
    --builtin
762
 
        Only use builtin commands.  (Plugins are still allowed to change
763
 
        other behaviour.)
764
 
 
765
 
    --profile
766
 
        Run under the Python hotshot profiler.
767
 
 
768
 
    --lsprof
769
 
        Run under the Python lsprof profiler.
770
 
 
771
 
    --coverage
772
 
        Generate line coverage report in the specified directory.
773
 
    """
774
 
    argv = list(argv)
775
 
    trace.mutter("bzr arguments: %r", argv)
776
 
 
777
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
778
 
                opt_no_aliases = False
779
 
    opt_lsprof_file = opt_coverage_dir = None
780
 
 
781
 
    # --no-plugins is handled specially at a very early stage. We need
782
 
    # to load plugins before doing other command parsing so that they
783
 
    # can override commands, but this needs to happen first.
784
 
 
785
 
    argv_copy = []
786
 
    i = 0
787
 
    while i < len(argv):
788
 
        a = argv[i]
789
 
        if a == '--profile':
790
 
            opt_profile = True
791
 
        elif a == '--lsprof':
792
 
            opt_lsprof = True
793
 
        elif a == '--lsprof-file':
794
 
            opt_lsprof = True
795
 
            opt_lsprof_file = argv[i + 1]
796
 
            i += 1
797
 
        elif a == '--no-plugins':
798
 
            opt_no_plugins = True
799
 
        elif a == '--no-aliases':
800
 
            opt_no_aliases = True
801
 
        elif a == '--builtin':
802
 
            opt_builtin = True
803
 
        elif a == '--coverage':
804
 
            opt_coverage_dir = argv[i + 1]
805
 
            i += 1
806
 
        elif a.startswith('-D'):
807
 
            debug.debug_flags.add(a[2:])
808
 
        else:
809
 
            argv_copy.append(a)
810
 
        i += 1
811
 
 
812
 
    debug.set_debug_flags_from_config()
813
 
 
814
 
    argv = argv_copy
815
 
    if (not argv):
816
 
        from bzrlib.builtins import cmd_help
817
 
        cmd_help().run_argv_aliases([])
818
 
        return 0
819
 
 
820
 
    if argv[0] == '--version':
821
 
        from bzrlib.builtins import cmd_version
822
 
        cmd_version().run_argv_aliases([])
823
 
        return 0
824
 
 
825
 
    if not opt_no_plugins:
826
 
        from bzrlib.plugin import load_plugins
827
 
        load_plugins()
828
 
    else:
829
 
        from bzrlib.plugin import disable_plugins
830
 
        disable_plugins()
831
 
 
832
 
    alias_argv = None
833
 
 
834
 
    if not opt_no_aliases:
835
 
        alias_argv = get_alias(argv[0])
836
 
        if alias_argv:
837
 
            user_encoding = osutils.get_user_encoding()
838
 
            alias_argv = [a.decode(user_encoding) for a in alias_argv]
839
 
            argv[0] = alias_argv.pop(0)
840
 
 
841
 
    cmd = argv.pop(0)
842
 
    # We want only 'ascii' command names, but the user may have typed
843
 
    # in a Unicode name. In that case, they should just get a
844
 
    # 'command not found' error later.
845
 
 
846
 
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
847
 
    run = cmd_obj.run_argv_aliases
848
 
    run_argv = [argv, alias_argv]
849
 
 
850
 
    try:
851
 
        # We can be called recursively (tests for example), but we don't want
852
 
        # the verbosity level to propagate.
853
 
        saved_verbosity_level = option._verbosity_level
854
 
        option._verbosity_level = 0
855
 
        if opt_lsprof:
856
 
            if opt_coverage_dir:
857
 
                trace.warning(
858
 
                    '--coverage ignored, because --lsprof is in use.')
859
 
            ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
860
 
        elif opt_profile:
861
 
            if opt_coverage_dir:
862
 
                trace.warning(
863
 
                    '--coverage ignored, because --profile is in use.')
864
 
            ret = apply_profiled(run, *run_argv)
865
 
        elif opt_coverage_dir:
866
 
            ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
867
 
        else:
868
 
            ret = run(*run_argv)
869
 
        if 'memory' in debug.debug_flags:
870
 
            trace.debug_memory('Process status after command:', short=False)
871
 
        return ret or 0
872
 
    finally:
873
 
        # reset, in case we may do other commands later within the same
874
 
        # process. Commands that want to execute sub-commands must propagate
875
 
        # --verbose in their own way.
876
 
        option._verbosity_level = saved_verbosity_level
877
 
 
878
 
 
879
 
def display_command(func):
880
 
    """Decorator that suppresses pipe/interrupt errors."""
881
 
    def ignore_pipe(*args, **kwargs):
882
 
        try:
883
 
            result = func(*args, **kwargs)
884
 
            sys.stdout.flush()
885
 
            return result
886
 
        except IOError, e:
887
 
            if getattr(e, 'errno', None) is None:
888
 
                raise
889
 
            if e.errno != errno.EPIPE:
890
 
                # Win32 raises IOError with errno=0 on a broken pipe
891
 
                if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
892
 
                    raise
893
 
            pass
894
 
        except KeyboardInterrupt:
895
 
            pass
896
 
    return ignore_pipe
897
 
 
898
 
 
899
 
def main(argv):
900
 
    import bzrlib.ui
901
 
    bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
902
 
        sys.stdin, sys.stdout, sys.stderr)
903
 
 
904
 
    # Is this a final release version? If so, we should suppress warnings
905
 
    if bzrlib.version_info[3] == 'final':
906
 
        from bzrlib import symbol_versioning
907
 
        symbol_versioning.suppress_deprecation_warnings(override=False)
908
 
    try:
909
 
        user_encoding = osutils.get_user_encoding()
910
 
        argv = [a.decode(user_encoding) for a in argv[1:]]
911
 
    except UnicodeDecodeError:
912
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
913
 
                                                            "encoding." % a))
914
 
    ret = run_bzr_catch_errors(argv)
915
 
    trace.mutter("return code %d", ret)
916
 
    return ret
917
 
 
918
 
 
919
 
def run_bzr_catch_errors(argv):
920
 
    # Note: The except clause logic below should be kept in sync with the
921
 
    # profile() routine in lsprof.py.
922
 
    try:
923
 
        return run_bzr(argv)
924
 
    except (KeyboardInterrupt, Exception), e:
925
 
        # used to handle AssertionError and KeyboardInterrupt
926
 
        # specially here, but hopefully they're handled ok by the logger now
927
 
        exc_info = sys.exc_info()
928
 
        exitcode = trace.report_exception(exc_info, sys.stderr)
929
 
        if os.environ.get('BZR_PDB'):
930
 
            print '**** entering debugger'
931
 
            tb = exc_info[2]
932
 
            import pdb
933
 
            if sys.version_info[:2] < (2, 6):
934
 
                # XXX: we want to do
935
 
                #    pdb.post_mortem(tb)
936
 
                # but because pdb.post_mortem gives bad results for tracebacks
937
 
                # from inside generators, we do it manually.
938
 
                # (http://bugs.python.org/issue4150, fixed in Python 2.6)
939
 
 
940
 
                # Setup pdb on the traceback
941
 
                p = pdb.Pdb()
942
 
                p.reset()
943
 
                p.setup(tb.tb_frame, tb)
944
 
                # Point the debugger at the deepest frame of the stack
945
 
                p.curindex = len(p.stack) - 1
946
 
                p.curframe = p.stack[p.curindex][0]
947
 
                # Start the pdb prompt.
948
 
                p.print_stack_entry(p.stack[p.curindex])
949
 
                p.execRcLines()
950
 
                p.cmdloop()
951
 
            else:
952
 
                pdb.post_mortem(tb)
953
 
        return exitcode
954
 
 
955
 
 
956
 
def run_bzr_catch_user_errors(argv):
957
 
    """Run bzr and report user errors, but let internal errors propagate.
958
 
 
959
 
    This is used for the test suite, and might be useful for other programs
960
 
    that want to wrap the commandline interface.
961
 
    """
962
 
    try:
963
 
        return run_bzr(argv)
964
 
    except Exception, e:
965
 
        if (isinstance(e, (OSError, IOError))
966
 
            or not getattr(e, 'internal_error', True)):
967
 
            trace.report_exception(sys.exc_info(), sys.stderr)
968
 
            return 3
969
 
        else:
970
 
            raise
971
 
 
972
 
 
973
 
class HelpCommandIndex(object):
974
 
    """A index for bzr help that returns commands."""
975
 
 
976
 
    def __init__(self):
977
 
        self.prefix = 'commands/'
978
 
 
979
 
    def get_topics(self, topic):
980
 
        """Search for topic amongst commands.
981
 
 
982
 
        :param topic: A topic to search for.
983
 
        :return: A list which is either empty or contains a single
984
 
            Command entry.
985
 
        """
986
 
        if topic and topic.startswith(self.prefix):
987
 
            topic = topic[len(self.prefix):]
988
 
        try:
989
 
            cmd = _get_cmd_object(topic)
990
 
        except KeyError:
991
 
            return []
992
 
        else:
993
 
            return [cmd]
994
 
 
995
 
 
996
 
class Provider(object):
997
 
    '''Generic class to be overriden by plugins'''
998
 
 
999
 
    def plugin_for_command(self, cmd_name):
1000
 
        '''Takes a command and returns the information for that plugin
1001
 
 
1002
 
        :return: A dictionary with all the available information
1003
 
        for the requested plugin
1004
 
        '''
1005
 
        raise NotImplementedError
1006
 
 
1007
 
 
1008
 
class ProvidersRegistry(registry.Registry):
1009
 
    '''This registry exists to allow other providers to exist'''
1010
 
 
1011
 
    def __iter__(self):
1012
 
        for key, provider in self.iteritems():
1013
 
            yield provider
1014
 
 
1015
 
command_providers_registry = ProvidersRegistry()
1016
 
 
1017
 
 
1018
 
if __name__ == '__main__':
1019
 
    sys.exit(main(sys.argv))