1
# Copyright (C) 2005-2011 Canonical Ltd
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: Define arguments by objects, rather than just using names.
19
# Those objects can specify the expected type of the argument, which
20
# would help with validation and shell completion. They could also provide
21
# help/explanation for that argument in a structured way.
23
# TODO: Specific "examples" property on commands for consistent formatting.
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
46
from bzrlib.hooks import Hooks
47
# Compatibility - Option used to be in commands.
48
from bzrlib.option import Option
49
from bzrlib.plugin import disable_plugins, load_plugins
50
from bzrlib import registry
51
from bzrlib.symbol_versioning import (
58
class CommandInfo(object):
59
"""Information about a command."""
61
def __init__(self, aliases):
62
"""The list of aliases for the command."""
63
self.aliases = aliases
66
def from_command(klass, command):
67
"""Factory to construct a CommandInfo from a command."""
68
return klass(command.aliases)
71
class CommandRegistry(registry.Registry):
72
"""Special registry mapping command names to command classes.
74
:ivar overridden_registry: Look in this registry for commands being
75
overridden by this registry. This can be used to tell plugin commands
76
about the builtin they're decorating.
80
registry.Registry.__init__(self)
81
self.overridden_registry = None
82
# map from aliases to the real command that implements the name
85
def get(self, command_name):
86
real_name = self._alias_dict.get(command_name, command_name)
87
return registry.Registry.get(self, real_name)
90
def _get_name(command_name):
91
if command_name.startswith("cmd_"):
92
return _unsquish_command_name(command_name)
96
def register(self, cmd, decorate=False):
97
"""Utility function to help register a command
99
:param cmd: Command subclass to register
100
:param decorate: If true, allow overriding an existing command
101
of the same name; the old command is returned by this function.
102
Otherwise it is an error to try to override an existing command.
105
k_unsquished = self._get_name(k)
107
previous = self.get(k_unsquished)
110
if self.overridden_registry:
112
previous = self.overridden_registry.get(k_unsquished)
115
info = CommandInfo.from_command(cmd)
117
registry.Registry.register(self, k_unsquished, cmd,
118
override_existing=decorate, info=info)
120
trace.warning('Two plugins defined the same command: %r' % k)
121
trace.warning('Not loading the one in %r' %
122
sys.modules[cmd.__module__])
123
trace.warning('Previously this command was registered from %r' %
124
sys.modules[previous.__module__])
125
for a in cmd.aliases:
126
self._alias_dict[a] = k_unsquished
129
def register_lazy(self, command_name, aliases, module_name):
130
"""Register a command without loading its module.
132
:param command_name: The primary name of the command.
133
:param aliases: A list of aliases for the command.
134
:module_name: The module that the command lives in.
136
key = self._get_name(command_name)
137
registry.Registry.register_lazy(self, key, module_name, command_name,
138
info=CommandInfo(aliases))
140
self._alias_dict[a] = key
143
plugin_cmds = CommandRegistry()
144
builtin_command_registry = CommandRegistry()
145
plugin_cmds.overridden_registry = builtin_command_registry
148
def register_command(cmd, decorate=False):
149
"""Register a plugin command.
151
Should generally be avoided in favor of lazy registration.
154
return plugin_cmds.register(cmd, decorate)
157
def _squish_command_name(cmd):
158
return 'cmd_' + cmd.replace('-', '_')
161
def _unsquish_command_name(cmd):
162
return cmd[4:].replace('_','-')
165
@deprecated_function(deprecated_in((2, 2, 0)))
166
def _builtin_commands():
167
"""Return a dict of {name: cmd_class} for builtin commands.
169
:deprecated: Use the builtin_command_registry registry instead
171
# return dict(name: cmd_class)
172
return dict(builtin_command_registry.items())
175
def _register_builtin_commands():
176
if builtin_command_registry.keys():
179
import bzrlib.builtins
180
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
181
builtin_command_registry.register(cmd_class)
182
bzrlib.builtins._register_lazy_builtins()
185
def _scan_module_for_commands(module):
187
for name, obj in module.__dict__.iteritems():
188
if name.startswith("cmd_"):
189
real_name = _unsquish_command_name(name)
194
def _list_bzr_commands(names):
195
"""Find commands from bzr's core and plugins.
197
This is not the public interface, just the default hook called by all_command_names.
199
# to eliminate duplicates
200
names.update(builtin_command_names())
201
names.update(plugin_command_names())
205
def all_command_names():
206
"""Return a set of all command names."""
208
for hook in Command.hooks['list_commands']:
211
raise AssertionError(
212
'hook %s returned None' % Command.hooks.get_hook_name(hook))
216
def builtin_command_names():
217
"""Return list of builtin command names.
219
Use of all_command_names() is encouraged rather than builtin_command_names
220
and/or plugin_command_names.
222
_register_builtin_commands()
223
return builtin_command_registry.keys()
226
def plugin_command_names():
227
"""Returns command names from commands registered by plugins."""
228
return plugin_cmds.keys()
231
def get_cmd_object(cmd_name, plugins_override=True):
232
"""Return the command object for a command.
235
If true, plugin commands can override builtins.
238
return _get_cmd_object(cmd_name, plugins_override)
240
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
243
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
244
"""Get a command object.
246
:param cmd_name: The name of the command.
247
:param plugins_override: Allow plugins to override builtins.
248
:param check_missing: Look up commands not found in the regular index via
249
the get_missing_command hook.
250
:return: A Command object instance
251
:raises KeyError: If no command is found.
253
# We want only 'ascii' command names, but the user may have typed
254
# in a Unicode name. In that case, they should just get a
255
# 'command not found' error later.
256
# In the future, we may actually support Unicode command names.
259
for hook in Command.hooks['get_command']:
260
cmd = hook(cmd, cmd_name)
261
if cmd is not None and not plugins_override and not cmd.plugin_name():
262
# We've found a non-plugin command, don't permit it to be
265
if cmd is None and check_missing:
266
for hook in Command.hooks['get_missing_command']:
273
# Allow plugins to extend commands
274
for hook in Command.hooks['extend_command']:
276
if getattr(cmd, 'invoked_as', None) is None:
277
cmd.invoked_as = cmd_name
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
324
cmd_obj = ExternalCommand.find_command(cmd_name)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
332
return plugin_cmds.get(cmd_name)()
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
342
class Command(object):
343
"""Base class for commands.
345
Commands are the heart of the command-line bzr interface.
347
The command object mostly handles the mapping of command-line
348
parameters into one or more bzrlib operations, and of the results
351
Commands normally don't have any state. All their arguments are
352
passed in to the run method. (Subclasses may take a different
353
policy if the behaviour of the instance needs to depend on e.g. a
354
shell plugin and not just its Python class.)
356
The docstring for an actual command should give a single-line
357
summary, then a complete description of the command. A grammar
358
description will be inserted.
361
Other accepted names for this command.
364
List of argument forms, marked with whether they are optional,
369
['to_location', 'from_branch?', 'file*']
371
'to_location' is required
372
'from_branch' is optional
373
'file' can be specified 0 or more times
376
List of options that may be given for this command. These can
377
be either strings, referring to globally-defined options,
378
or option objects. Retrieve through options().
381
If true, this command isn't advertised. This is typically
382
for commands intended for expert users.
385
Command objects will get a 'outf' attribute, which has been
386
setup to properly handle encoding of unicode strings.
387
encoding_type determines what will happen when characters cannot
389
strict - abort if we cannot decode
390
replace - put in a bogus character (typically '?')
391
exact - do not encode sys.stdout
393
NOTE: by default on Windows, sys.stdout is opened as a text
394
stream, therefore LF line-endings are converted to CRLF.
395
When a command uses encoding_type = 'exact', then
396
sys.stdout is forced to be a binary stream, and line-endings
400
A string indicating the real name under which this command was
401
invoked, before expansion of aliases.
402
(This may be None if the command was constructed and run in-process.)
404
:cvar hooks: An instance of CommandHooks.
406
:ivar __doc__: The help shown by 'bzr help command' for this command.
407
This is set by assigning explicitly to __doc__ so that -OO can
411
__doc__ = "My help goes here"
416
encoding_type = 'strict'
422
"""Construct an instance of this command."""
423
# List of standard options directly supported
424
self.supported_std_options = []
427
def add_cleanup(self, cleanup_func, *args, **kwargs):
428
"""Register a function to call after self.run returns or raises.
430
Functions will be called in LIFO order.
432
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
434
def cleanup_now(self):
435
"""Execute and empty pending cleanup functions immediately.
437
After cleanup_now all registered cleanups are forgotten. add_cleanup
438
may be called again after cleanup_now; these cleanups will be called
439
after self.run returns or raises (or when cleanup_now is next called).
441
This is useful for releasing expensive or contentious resources (such
442
as write locks) before doing further work that does not require those
443
resources (such as writing results to self.outf). Note though, that
444
as it releases all resources, this may release locks that the command
445
wants to hold, so use should be done with care.
447
self._operation.cleanup_now()
449
@deprecated_method(deprecated_in((2, 1, 0)))
450
def _maybe_expand_globs(self, file_list):
451
"""Glob expand file_list if the platform does not do that itself.
453
Not used anymore, now that the bzr command-line parser globs on
456
:return: A possibly empty list of unicode paths.
458
Introduced in bzrlib 0.18.
463
"""Return single-line grammar for this command.
465
Only describes arguments, not options.
467
s = 'bzr ' + self.name() + ' '
468
for aname in self.takes_args:
469
aname = aname.upper()
470
if aname[-1] in ['$', '+']:
471
aname = aname[:-1] + '...'
472
elif aname[-1] == '?':
473
aname = '[' + aname[:-1] + ']'
474
elif aname[-1] == '*':
475
aname = '[' + aname[:-1] + '...]'
477
s = s[:-1] # remove last space
480
def get_help_text(self, additional_see_also=None, plain=True,
481
see_also_as_links=False, verbose=True):
482
"""Return a text string with help for this command.
484
:param additional_see_also: Additional help topics to be
486
:param plain: if False, raw help (reStructuredText) is
487
returned instead of plain text.
488
:param see_also_as_links: if True, convert items in 'See also'
489
list to internal links (used by bzr_man rstx generator)
490
:param verbose: if True, display the full help, otherwise
491
leave out the descriptive sections and just display
492
usage help (e.g. Purpose, Usage, Options) with a
493
message explaining how to obtain full help.
497
doc = "No help for this command."
499
# Extract the summary (purpose) and sections out from the text
500
purpose,sections,order = self._get_help_parts(doc)
502
# If a custom usage section was provided, use it
503
if sections.has_key('Usage'):
504
usage = sections.pop('Usage')
506
usage = self._usage()
508
# The header is the purpose and usage
510
result += ':Purpose: %s\n' % purpose
511
if usage.find('\n') >= 0:
512
result += ':Usage:\n%s\n' % usage
514
result += ':Usage: %s\n' % usage
519
# XXX: optparse implicitly rewraps the help, and not always perfectly,
520
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
522
options = option.get_optparser(self.options()).format_option_help()
523
# XXX: According to the spec, ReST option lists actually don't support
524
# options like --1.9 so that causes syntax errors (in Sphinx at least).
525
# As that pattern always appears in the commands that break, we trap
526
# on that and then format that block of 'format' options as a literal
528
if not plain and options.find(' --1.9 ') != -1:
529
options = options.replace(' format:\n', ' format::\n\n', 1)
530
if options.startswith('Options:'):
531
result += ':' + options
532
elif options.startswith('options:'):
533
# Python 2.4 version of optparse
534
result += ':Options:' + options[len('options:'):]
540
# Add the description, indenting it 2 spaces
541
# to match the indentation of the options
542
if sections.has_key(None):
543
text = sections.pop(None)
544
text = '\n '.join(text.splitlines())
545
result += ':%s:\n %s\n\n' % ('Description',text)
547
# Add the custom sections (e.g. Examples). Note that there's no need
548
# to indent these as they must be indented already in the source.
551
if sections.has_key(label):
552
result += ':%s:\n%s\n' % (label,sections[label])
555
result += ("See bzr help %s for more details and examples.\n\n"
558
# Add the aliases, source (plug-in) and see also links, if any
560
result += ':Aliases: '
561
result += ', '.join(self.aliases) + '\n'
562
plugin_name = self.plugin_name()
563
if plugin_name is not None:
564
result += ':From: plugin "%s"\n' % plugin_name
565
see_also = self.get_see_also(additional_see_also)
567
if not plain and see_also_as_links:
569
for item in see_also:
571
# topics doesn't have an independent section
572
# so don't create a real link
573
see_also_links.append(item)
575
# Use a Sphinx link for this entry
576
link_text = ":doc:`%s <%s-help>`" % (item, item)
577
see_also_links.append(link_text)
578
see_also = see_also_links
579
result += ':See also: '
580
result += ', '.join(see_also) + '\n'
582
# If this will be rendered as plain text, convert it
584
import bzrlib.help_topics
585
result = bzrlib.help_topics.help_as_plain_text(result)
589
def _get_help_parts(text):
590
"""Split help text into a summary and named sections.
592
:return: (summary,sections,order) where summary is the top line and
593
sections is a dictionary of the rest indexed by section name.
594
order is the order the section appear in the text.
595
A section starts with a heading line of the form ":xxx:".
596
Indented text on following lines is the section value.
597
All text found outside a named section is assigned to the
598
default section which is given the key of None.
600
def save_section(sections, order, label, section):
602
if sections.has_key(label):
603
sections[label] += '\n' + section
606
sections[label] = section
608
lines = text.rstrip().splitlines()
609
summary = lines.pop(0)
612
label,section = None,''
614
if line.startswith(':') and line.endswith(':') and len(line) > 2:
615
save_section(sections, order, label, section)
616
label,section = line[1:-1],''
617
elif (label is not None) and len(line) > 1 and not line[0].isspace():
618
save_section(sections, order, label, section)
619
label,section = None,line
622
section += '\n' + line
625
save_section(sections, order, label, section)
626
return summary, sections, order
628
def get_help_topic(self):
629
"""Return the commands help topic - its name."""
632
def get_see_also(self, additional_terms=None):
633
"""Return a list of help topics that are related to this command.
635
The list is derived from the content of the _see_also attribute. Any
636
duplicates are removed and the result is in lexical order.
637
:param additional_terms: Additional help topics to cross-reference.
638
:return: A list of help topics.
640
see_also = set(getattr(self, '_see_also', []))
642
see_also.update(additional_terms)
643
return sorted(see_also)
646
"""Return dict of valid options for this command.
648
Maps from long option name to option object."""
649
r = Option.STD_OPTIONS.copy()
651
for o in self.takes_options:
652
if isinstance(o, basestring):
653
o = option.Option.OPTIONS[o]
655
if o.name in std_names:
656
self.supported_std_options.append(o.name)
659
def _setup_outf(self):
660
"""Return a file linked to stdout, which has proper encoding."""
661
self.outf = ui.ui_factory.make_output_stream(
662
encoding_type=self.encoding_type)
664
def run_argv_aliases(self, argv, alias_argv=None):
665
"""Parse the command line and run with extra aliases in alias_argv."""
666
args, opts = parse_args(self, argv, alias_argv)
668
# Process the standard options
669
if 'help' in opts: # e.g. bzr add --help
670
sys.stdout.write(self.get_help_text())
672
if 'usage' in opts: # e.g. bzr add --usage
673
sys.stdout.write(self.get_help_text(verbose=False))
675
trace.set_verbosity_level(option._verbosity_level)
676
if 'verbose' in self.supported_std_options:
677
opts['verbose'] = trace.is_verbose()
678
elif opts.has_key('verbose'):
680
if 'quiet' in self.supported_std_options:
681
opts['quiet'] = trace.is_quiet()
682
elif opts.has_key('quiet'):
685
# mix arguments and options into one dictionary
686
cmdargs = _match_argform(self.name(), self.takes_args, args)
688
for k, v in opts.items():
689
cmdopts[k.replace('-', '_')] = v
691
all_cmd_args = cmdargs.copy()
692
all_cmd_args.update(cmdopts)
697
return self.run(**all_cmd_args)
699
# reset it, so that other commands run in the same process won't
700
# inherit state. Before we reset it, log any activity, so that it
701
# gets properly tracked.
702
ui.ui_factory.log_transport_activity(
703
display=('bytes' in debug.debug_flags))
704
trace.set_verbosity_level(0)
706
def _setup_run(self):
707
"""Wrap the defined run method on self with a cleanup.
709
This is called by __init__ to make the Command be able to be run
710
by just calling run(), as it could be before cleanups were added.
712
If a different form of cleanups are in use by your Command subclass,
713
you can override this method.
716
def run(*args, **kwargs):
717
self._operation = cleanup.OperationWithCleanups(class_run)
719
return self._operation.run_simple(*args, **kwargs)
724
@deprecated_method(deprecated_in((2, 2, 0)))
725
def run_direct(self, *args, **kwargs):
726
"""Deprecated thunk from bzrlib 2.1."""
727
return self.run(*args, **kwargs)
730
"""Actually run the command.
732
This is invoked with the options and arguments bound to
735
Return 0 or None if the command was successful, or a non-zero
736
shell error code if not. It's OK for this method to allow
737
an exception to raise up.
739
This method is automatically wrapped by Command.__init__ with a
740
cleanup operation, stored as self._operation. This can be used
741
via self.add_cleanup to perform automatic cleanups at the end of
744
The argument for run are assembled by introspection. So for instance,
745
if your command takes an argument files, you would declare::
747
def run(self, files=None):
750
raise NotImplementedError('no implementation of command %r'
754
"""Return help message for this class."""
755
from inspect import getdoc
756
if self.__doc__ is Command.__doc__:
761
"""Return the canonical name for this command.
763
The name under which it was actually invoked is available in invoked_as.
765
return _unsquish_command_name(self.__class__.__name__)
767
def plugin_name(self):
768
"""Get the name of the plugin that provides this command.
770
:return: The name of the plugin or None if the command is builtin.
772
mod_parts = self.__module__.split('.')
773
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
779
class CommandHooks(Hooks):
780
"""Hooks related to Command object creation/enumeration."""
783
"""Create the default hooks.
785
These are all empty initially, because by default nothing should get
788
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
789
self.add_hook('extend_command',
790
"Called after creating a command object to allow modifications "
791
"such as adding or removing options, docs etc. Called with the "
792
"new bzrlib.commands.Command object.", (1, 13))
793
self.add_hook('get_command',
794
"Called when creating a single command. Called with "
795
"(cmd_or_None, command_name). get_command should either return "
796
"the cmd_or_None parameter, or a replacement Command object that "
797
"should be used for the command. Note that the Command.hooks "
798
"hooks are core infrastructure. Many users will prefer to use "
799
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
801
self.add_hook('get_missing_command',
802
"Called when creating a single command if no command could be "
803
"found. Called with (command_name). get_missing_command should "
804
"either return None, or a Command object to be used for the "
806
self.add_hook('list_commands',
807
"Called when enumerating commands. Called with a set of "
808
"cmd_name strings for all the commands found so far. This set "
809
" is safe to mutate - e.g. to remove a command. "
810
"list_commands should return the updated set of command names.",
813
Command.hooks = CommandHooks()
816
def parse_args(command, argv, alias_argv=None):
817
"""Parse command line.
819
Arguments and options are parsed at this level before being passed
820
down to specific command handlers. This routine knows, from a
821
lookup table, something about the available options, what optargs
822
they take, and which commands will accept them.
824
# TODO: make it a method of the Command?
825
parser = option.get_optparser(command.options())
826
if alias_argv is not None:
827
args = alias_argv + argv
831
# for python 2.5 and later, optparse raises this exception if a non-ascii
832
# option name is given. See http://bugs.python.org/issue2931
834
options, args = parser.parse_args(args)
835
except UnicodeEncodeError,e:
836
raise errors.BzrCommandError('Only ASCII permitted in option names')
838
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
839
v is not option.OptionParser.DEFAULT_VALUE])
843
def _match_argform(cmd, takes_args, args):
846
# step through args and takes_args, allowing appropriate 0-many matches
847
for ap in takes_args:
851
argdict[argname] = args.pop(0)
852
elif ap[-1] == '*': # all remaining arguments
854
argdict[argname + '_list'] = args[:]
857
argdict[argname + '_list'] = None
860
raise errors.BzrCommandError("command %r needs one or more %s"
861
% (cmd, argname.upper()))
863
argdict[argname + '_list'] = args[:]
865
elif ap[-1] == '$': # all but one
867
raise errors.BzrCommandError("command %r needs one or more %s"
868
% (cmd, argname.upper()))
869
argdict[argname + '_list'] = args[:-1]
875
raise errors.BzrCommandError("command %r requires argument %s"
876
% (cmd, argname.upper()))
878
argdict[argname] = args.pop(0)
881
raise errors.BzrCommandError("extra argument to command %s: %s"
886
def apply_coveraged(dirname, the_callable, *args, **kwargs):
887
# Cannot use "import trace", as that would import bzrlib.trace instead of
888
# the standard library's trace.
889
trace = __import__('trace')
891
tracer = trace.Trace(count=1, trace=0)
892
sys.settrace(tracer.globaltrace)
893
threading.settrace(tracer.globaltrace)
896
return exception_to_return_code(the_callable, *args, **kwargs)
899
results = tracer.results()
900
results.write_results(show_missing=1, summary=False,
904
def apply_profiled(the_callable, *args, **kwargs):
908
pffileno, pfname = tempfile.mkstemp()
910
prof = hotshot.Profile(pfname)
912
ret = prof.runcall(exception_to_return_code, the_callable, *args,
916
stats = hotshot.stats.load(pfname)
918
stats.sort_stats('cum') # 'time'
919
## XXX: Might like to write to stderr or the trace file instead but
920
## print_stats seems hardcoded to stdout
921
stats.print_stats(20)
928
def exception_to_return_code(the_callable, *args, **kwargs):
929
"""UI level helper for profiling and coverage.
931
This transforms exceptions into a return value of 3. As such its only
932
relevant to the UI layer, and should never be called where catching
933
exceptions may be desirable.
936
return the_callable(*args, **kwargs)
937
except (KeyboardInterrupt, Exception), e:
938
# used to handle AssertionError and KeyboardInterrupt
939
# specially here, but hopefully they're handled ok by the logger now
940
exc_info = sys.exc_info()
941
exitcode = trace.report_exception(exc_info, sys.stderr)
942
if os.environ.get('BZR_PDB'):
943
print '**** entering debugger'
946
if sys.version_info[:2] < (2, 6):
948
# pdb.post_mortem(tb)
949
# but because pdb.post_mortem gives bad results for tracebacks
950
# from inside generators, we do it manually.
951
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
953
# Setup pdb on the traceback
956
p.setup(tb.tb_frame, tb)
957
# Point the debugger at the deepest frame of the stack
958
p.curindex = len(p.stack) - 1
959
p.curframe = p.stack[p.curindex][0]
960
# Start the pdb prompt.
961
p.print_stack_entry(p.stack[p.curindex])
969
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
970
from bzrlib.lsprof import profile
971
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
977
trace.note('Profile data written to "%s".', filename)
981
@deprecated_function(deprecated_in((2, 2, 0)))
982
def shlex_split_unicode(unsplit):
983
return cmdline.split(unsplit)
986
def get_alias(cmd, config=None):
987
"""Return an expanded alias, or None if no alias exists.
990
Command to be checked for an alias.
992
Used to specify an alternative config to use,
993
which is especially useful for testing.
994
If it is unspecified, the global config will be used.
998
config = bzrlib.config.GlobalConfig()
999
alias = config.get_alias(cmd)
1001
return cmdline.split(alias)
1005
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1006
"""Execute a command.
1008
:param argv: The command-line arguments, without the program name from
1009
argv[0] These should already be decoded. All library/test code calling
1010
run_bzr should be passing valid strings (don't need decoding).
1011
:param load_plugins: What function to call when triggering plugin loading.
1012
This function should take no arguments and cause all plugins to be
1014
:param disable_plugins: What function to call when disabling plugin
1015
loading. This function should take no arguments and cause all plugin
1016
loading to be prohibited (so that code paths in your application that
1017
know about some plugins possibly being present will fail to import
1018
those plugins even if they are installed.)
1019
:return: Returns a command exit code or raises an exception.
1021
Special master options: these must come before the command because
1022
they control how the command is interpreted.
1025
Do not load plugin modules at all
1028
Do not allow aliases
1031
Only use builtin commands. (Plugins are still allowed to change
1035
Run under the Python hotshot profiler.
1038
Run under the Python lsprof profiler.
1041
Generate line coverage report in the specified directory.
1044
Specify the number of processes that can be run concurrently (selftest).
1046
trace.mutter("bazaar version: " + bzrlib.__version__)
1047
argv = _specified_or_unicode_argv(argv)
1048
trace.mutter("bzr arguments: %r", argv)
1050
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1051
opt_no_aliases = False
1052
opt_lsprof_file = opt_coverage_dir = None
1054
# --no-plugins is handled specially at a very early stage. We need
1055
# to load plugins before doing other command parsing so that they
1056
# can override commands, but this needs to happen first.
1060
while i < len(argv):
1062
if a == '--profile':
1064
elif a == '--lsprof':
1066
elif a == '--lsprof-file':
1068
opt_lsprof_file = argv[i + 1]
1070
elif a == '--no-plugins':
1071
opt_no_plugins = True
1072
elif a == '--no-aliases':
1073
opt_no_aliases = True
1074
elif a == '--builtin':
1076
elif a == '--concurrency':
1077
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1079
elif a == '--coverage':
1080
opt_coverage_dir = argv[i + 1]
1082
elif a == '--profile-imports':
1083
pass # already handled in startup script Bug #588277
1084
elif a.startswith('-D'):
1085
debug.debug_flags.add(a[2:])
1090
debug.set_debug_flags_from_config()
1092
if not opt_no_plugins:
1099
get_cmd_object('help').run_argv_aliases([])
1102
if argv[0] == '--version':
1103
get_cmd_object('version').run_argv_aliases([])
1108
if not opt_no_aliases:
1109
alias_argv = get_alias(argv[0])
1111
argv[0] = alias_argv.pop(0)
1114
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1115
run = cmd_obj.run_argv_aliases
1116
run_argv = [argv, alias_argv]
1119
# We can be called recursively (tests for example), but we don't want
1120
# the verbosity level to propagate.
1121
saved_verbosity_level = option._verbosity_level
1122
option._verbosity_level = 0
1124
if opt_coverage_dir:
1126
'--coverage ignored, because --lsprof is in use.')
1127
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1129
if opt_coverage_dir:
1131
'--coverage ignored, because --profile is in use.')
1132
ret = apply_profiled(run, *run_argv)
1133
elif opt_coverage_dir:
1134
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1136
ret = run(*run_argv)
1139
# reset, in case we may do other commands later within the same
1140
# process. Commands that want to execute sub-commands must propagate
1141
# --verbose in their own way.
1142
if 'memory' in debug.debug_flags:
1143
trace.debug_memory('Process status after command:', short=False)
1144
option._verbosity_level = saved_verbosity_level
1147
def display_command(func):
1148
"""Decorator that suppresses pipe/interrupt errors."""
1149
def ignore_pipe(*args, **kwargs):
1151
result = func(*args, **kwargs)
1155
if getattr(e, 'errno', None) is None:
1157
if e.errno != errno.EPIPE:
1158
# Win32 raises IOError with errno=0 on a broken pipe
1159
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1162
except KeyboardInterrupt:
1167
def install_bzr_command_hooks():
1168
"""Install the hooks to supply bzr's own commands."""
1169
if _list_bzr_commands in Command.hooks["list_commands"]:
1171
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1173
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1175
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1176
"bzr plugin commands")
1177
Command.hooks.install_named_hook("get_command", _get_external_command,
1178
"bzr external command lookup")
1179
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1180
"bzr plugin-provider-db check")
1184
def _specified_or_unicode_argv(argv):
1185
# For internal or testing use, argv can be passed. Otherwise, get it from
1186
# the process arguments in a unicode-safe way.
1188
return osutils.get_unicode_argv()
1192
# ensure all arguments are unicode strings
1194
if isinstance(a, unicode):
1197
new_argv.append(a.decode('ascii'))
1198
except UnicodeDecodeError:
1199
raise errors.BzrError("argv should be list of unicode strings.")
1203
def main(argv=None):
1204
"""Main entry point of command-line interface.
1206
Typically `bzrlib.initialize` should be called first.
1208
:param argv: list of unicode command-line arguments similar to sys.argv.
1209
argv[0] is script name usually, it will be ignored.
1210
Don't pass here sys.argv because this list contains plain strings
1211
and not unicode; pass None instead.
1213
:return: exit code of bzr command.
1215
if argv is not None:
1217
_register_builtin_commands()
1218
ret = run_bzr_catch_errors(argv)
1219
trace.mutter("return code %d", ret)
1223
def run_bzr_catch_errors(argv):
1224
"""Run a bzr command with parameters as described by argv.
1226
This function assumed that that UI layer is setup, that symbol deprecations
1227
are already applied, and that unicode decoding has already been performed on argv.
1229
# done here so that they're covered for every test run
1230
install_bzr_command_hooks()
1231
return exception_to_return_code(run_bzr, argv)
1234
def run_bzr_catch_user_errors(argv):
1235
"""Run bzr and report user errors, but let internal errors propagate.
1237
This is used for the test suite, and might be useful for other programs
1238
that want to wrap the commandline interface.
1240
# done here so that they're covered for every test run
1241
install_bzr_command_hooks()
1243
return run_bzr(argv)
1244
except Exception, e:
1245
if (isinstance(e, (OSError, IOError))
1246
or not getattr(e, 'internal_error', True)):
1247
trace.report_exception(sys.exc_info(), sys.stderr)
1253
class HelpCommandIndex(object):
1254
"""A index for bzr help that returns commands."""
1257
self.prefix = 'commands/'
1259
def get_topics(self, topic):
1260
"""Search for topic amongst commands.
1262
:param topic: A topic to search for.
1263
:return: A list which is either empty or contains a single
1266
if topic and topic.startswith(self.prefix):
1267
topic = topic[len(self.prefix):]
1269
cmd = _get_cmd_object(topic, check_missing=False)
1276
class Provider(object):
1277
'''Generic class to be overriden by plugins'''
1279
def plugin_for_command(self, cmd_name):
1280
'''Takes a command and returns the information for that plugin
1282
:return: A dictionary with all the available information
1283
for the requested plugin
1285
raise NotImplementedError
1288
class ProvidersRegistry(registry.Registry):
1289
'''This registry exists to allow other providers to exist'''
1292
for key, provider in self.iteritems():
1295
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
