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
# FIXME: According to the spec, ReST option lists actually don't
524
# support options like --1.14 so that causes syntax errors (in Sphinx
525
# at least). As that pattern always appears in the commands that
526
# break, we trap on that and then format that block of 'format' options
527
# as a literal block. We use the most recent format still listed so we
528
# don't have to do that too often -- vila 20110514
529
if not plain and options.find(' --1.14 ') != -1:
530
options = options.replace(' format:\n', ' format::\n\n', 1)
531
if options.startswith('Options:'):
532
result += ':' + options
533
elif options.startswith('options:'):
534
# Python 2.4 version of optparse
535
result += ':Options:' + options[len('options:'):]
541
# Add the description, indenting it 2 spaces
542
# to match the indentation of the options
543
if sections.has_key(None):
544
text = sections.pop(None)
545
text = '\n '.join(text.splitlines())
546
result += ':%s:\n %s\n\n' % ('Description',text)
548
# Add the custom sections (e.g. Examples). Note that there's no need
549
# to indent these as they must be indented already in the source.
552
if sections.has_key(label):
553
result += ':%s:\n%s\n' % (label,sections[label])
556
result += ("See bzr help %s for more details and examples.\n\n"
559
# Add the aliases, source (plug-in) and see also links, if any
561
result += ':Aliases: '
562
result += ', '.join(self.aliases) + '\n'
563
plugin_name = self.plugin_name()
564
if plugin_name is not None:
565
result += ':From: plugin "%s"\n' % plugin_name
566
see_also = self.get_see_also(additional_see_also)
568
if not plain and see_also_as_links:
570
for item in see_also:
572
# topics doesn't have an independent section
573
# so don't create a real link
574
see_also_links.append(item)
576
# Use a Sphinx link for this entry
577
link_text = ":doc:`%s <%s-help>`" % (item, item)
578
see_also_links.append(link_text)
579
see_also = see_also_links
580
result += ':See also: '
581
result += ', '.join(see_also) + '\n'
583
# If this will be rendered as plain text, convert it
585
import bzrlib.help_topics
586
result = bzrlib.help_topics.help_as_plain_text(result)
590
def _get_help_parts(text):
591
"""Split help text into a summary and named sections.
593
:return: (summary,sections,order) where summary is the top line and
594
sections is a dictionary of the rest indexed by section name.
595
order is the order the section appear in the text.
596
A section starts with a heading line of the form ":xxx:".
597
Indented text on following lines is the section value.
598
All text found outside a named section is assigned to the
599
default section which is given the key of None.
601
def save_section(sections, order, label, section):
603
if sections.has_key(label):
604
sections[label] += '\n' + section
607
sections[label] = section
609
lines = text.rstrip().splitlines()
610
summary = lines.pop(0)
613
label,section = None,''
615
if line.startswith(':') and line.endswith(':') and len(line) > 2:
616
save_section(sections, order, label, section)
617
label,section = line[1:-1],''
618
elif (label is not None) and len(line) > 1 and not line[0].isspace():
619
save_section(sections, order, label, section)
620
label,section = None,line
623
section += '\n' + line
626
save_section(sections, order, label, section)
627
return summary, sections, order
629
def get_help_topic(self):
630
"""Return the commands help topic - its name."""
633
def get_see_also(self, additional_terms=None):
634
"""Return a list of help topics that are related to this command.
636
The list is derived from the content of the _see_also attribute. Any
637
duplicates are removed and the result is in lexical order.
638
:param additional_terms: Additional help topics to cross-reference.
639
:return: A list of help topics.
641
see_also = set(getattr(self, '_see_also', []))
643
see_also.update(additional_terms)
644
return sorted(see_also)
647
"""Return dict of valid options for this command.
649
Maps from long option name to option object."""
650
r = Option.STD_OPTIONS.copy()
652
for o in self.takes_options:
653
if isinstance(o, basestring):
654
o = option.Option.OPTIONS[o]
656
if o.name in std_names:
657
self.supported_std_options.append(o.name)
660
def _setup_outf(self):
661
"""Return a file linked to stdout, which has proper encoding."""
662
self.outf = ui.ui_factory.make_output_stream(
663
encoding_type=self.encoding_type)
665
def run_argv_aliases(self, argv, alias_argv=None):
666
"""Parse the command line and run with extra aliases in alias_argv."""
667
args, opts = parse_args(self, argv, alias_argv)
669
# Process the standard options
670
if 'help' in opts: # e.g. bzr add --help
671
sys.stdout.write(self.get_help_text())
673
if 'usage' in opts: # e.g. bzr add --usage
674
sys.stdout.write(self.get_help_text(verbose=False))
676
trace.set_verbosity_level(option._verbosity_level)
677
if 'verbose' in self.supported_std_options:
678
opts['verbose'] = trace.is_verbose()
679
elif opts.has_key('verbose'):
681
if 'quiet' in self.supported_std_options:
682
opts['quiet'] = trace.is_quiet()
683
elif opts.has_key('quiet'):
686
# mix arguments and options into one dictionary
687
cmdargs = _match_argform(self.name(), self.takes_args, args)
689
for k, v in opts.items():
690
cmdopts[k.replace('-', '_')] = v
692
all_cmd_args = cmdargs.copy()
693
all_cmd_args.update(cmdopts)
698
return self.run(**all_cmd_args)
700
# reset it, so that other commands run in the same process won't
701
# inherit state. Before we reset it, log any activity, so that it
702
# gets properly tracked.
703
ui.ui_factory.log_transport_activity(
704
display=('bytes' in debug.debug_flags))
705
trace.set_verbosity_level(0)
707
def _setup_run(self):
708
"""Wrap the defined run method on self with a cleanup.
710
This is called by __init__ to make the Command be able to be run
711
by just calling run(), as it could be before cleanups were added.
713
If a different form of cleanups are in use by your Command subclass,
714
you can override this method.
717
def run(*args, **kwargs):
718
self._operation = cleanup.OperationWithCleanups(class_run)
720
return self._operation.run_simple(*args, **kwargs)
725
@deprecated_method(deprecated_in((2, 2, 0)))
726
def run_direct(self, *args, **kwargs):
727
"""Deprecated thunk from bzrlib 2.1."""
728
return self.run(*args, **kwargs)
731
"""Actually run the command.
733
This is invoked with the options and arguments bound to
736
Return 0 or None if the command was successful, or a non-zero
737
shell error code if not. It's OK for this method to allow
738
an exception to raise up.
740
This method is automatically wrapped by Command.__init__ with a
741
cleanup operation, stored as self._operation. This can be used
742
via self.add_cleanup to perform automatic cleanups at the end of
745
The argument for run are assembled by introspection. So for instance,
746
if your command takes an argument files, you would declare::
748
def run(self, files=None):
751
raise NotImplementedError('no implementation of command %r'
755
"""Return help message for this class."""
756
from inspect import getdoc
757
if self.__doc__ is Command.__doc__:
762
"""Return the canonical name for this command.
764
The name under which it was actually invoked is available in invoked_as.
766
return _unsquish_command_name(self.__class__.__name__)
768
def plugin_name(self):
769
"""Get the name of the plugin that provides this command.
771
:return: The name of the plugin or None if the command is builtin.
773
mod_parts = self.__module__.split('.')
774
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
780
class CommandHooks(Hooks):
781
"""Hooks related to Command object creation/enumeration."""
784
"""Create the default hooks.
786
These are all empty initially, because by default nothing should get
789
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
790
self.add_hook('extend_command',
791
"Called after creating a command object to allow modifications "
792
"such as adding or removing options, docs etc. Called with the "
793
"new bzrlib.commands.Command object.", (1, 13))
794
self.add_hook('get_command',
795
"Called when creating a single command. Called with "
796
"(cmd_or_None, command_name). get_command should either return "
797
"the cmd_or_None parameter, or a replacement Command object that "
798
"should be used for the command. Note that the Command.hooks "
799
"hooks are core infrastructure. Many users will prefer to use "
800
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
802
self.add_hook('get_missing_command',
803
"Called when creating a single command if no command could be "
804
"found. Called with (command_name). get_missing_command should "
805
"either return None, or a Command object to be used for the "
807
self.add_hook('list_commands',
808
"Called when enumerating commands. Called with a set of "
809
"cmd_name strings for all the commands found so far. This set "
810
" is safe to mutate - e.g. to remove a command. "
811
"list_commands should return the updated set of command names.",
814
Command.hooks = CommandHooks()
817
def parse_args(command, argv, alias_argv=None):
818
"""Parse command line.
820
Arguments and options are parsed at this level before being passed
821
down to specific command handlers. This routine knows, from a
822
lookup table, something about the available options, what optargs
823
they take, and which commands will accept them.
825
# TODO: make it a method of the Command?
826
parser = option.get_optparser(command.options())
827
if alias_argv is not None:
828
args = alias_argv + argv
832
# for python 2.5 and later, optparse raises this exception if a non-ascii
833
# option name is given. See http://bugs.python.org/issue2931
835
options, args = parser.parse_args(args)
836
except UnicodeEncodeError,e:
837
raise errors.BzrCommandError('Only ASCII permitted in option names')
839
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
840
v is not option.OptionParser.DEFAULT_VALUE])
844
def _match_argform(cmd, takes_args, args):
847
# step through args and takes_args, allowing appropriate 0-many matches
848
for ap in takes_args:
852
argdict[argname] = args.pop(0)
853
elif ap[-1] == '*': # all remaining arguments
855
argdict[argname + '_list'] = args[:]
858
argdict[argname + '_list'] = None
861
raise errors.BzrCommandError("command %r needs one or more %s"
862
% (cmd, argname.upper()))
864
argdict[argname + '_list'] = args[:]
866
elif ap[-1] == '$': # all but one
868
raise errors.BzrCommandError("command %r needs one or more %s"
869
% (cmd, argname.upper()))
870
argdict[argname + '_list'] = args[:-1]
876
raise errors.BzrCommandError("command %r requires argument %s"
877
% (cmd, argname.upper()))
879
argdict[argname] = args.pop(0)
882
raise errors.BzrCommandError("extra argument to command %s: %s"
887
def apply_coveraged(dirname, the_callable, *args, **kwargs):
888
# Cannot use "import trace", as that would import bzrlib.trace instead of
889
# the standard library's trace.
890
trace = __import__('trace')
892
tracer = trace.Trace(count=1, trace=0)
893
sys.settrace(tracer.globaltrace)
894
threading.settrace(tracer.globaltrace)
897
return exception_to_return_code(the_callable, *args, **kwargs)
900
results = tracer.results()
901
results.write_results(show_missing=1, summary=False,
905
def apply_profiled(the_callable, *args, **kwargs):
909
pffileno, pfname = tempfile.mkstemp()
911
prof = hotshot.Profile(pfname)
913
ret = prof.runcall(exception_to_return_code, the_callable, *args,
917
stats = hotshot.stats.load(pfname)
919
stats.sort_stats('cum') # 'time'
920
## XXX: Might like to write to stderr or the trace file instead but
921
## print_stats seems hardcoded to stdout
922
stats.print_stats(20)
929
def exception_to_return_code(the_callable, *args, **kwargs):
930
"""UI level helper for profiling and coverage.
932
This transforms exceptions into a return value of 3. As such its only
933
relevant to the UI layer, and should never be called where catching
934
exceptions may be desirable.
937
return the_callable(*args, **kwargs)
938
except (KeyboardInterrupt, Exception), e:
939
# used to handle AssertionError and KeyboardInterrupt
940
# specially here, but hopefully they're handled ok by the logger now
941
exc_info = sys.exc_info()
942
exitcode = trace.report_exception(exc_info, sys.stderr)
943
if os.environ.get('BZR_PDB'):
944
print '**** entering debugger'
947
if sys.version_info[:2] < (2, 6):
949
# pdb.post_mortem(tb)
950
# but because pdb.post_mortem gives bad results for tracebacks
951
# from inside generators, we do it manually.
952
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
954
# Setup pdb on the traceback
957
p.setup(tb.tb_frame, tb)
958
# Point the debugger at the deepest frame of the stack
959
p.curindex = len(p.stack) - 1
960
p.curframe = p.stack[p.curindex][0]
961
# Start the pdb prompt.
962
p.print_stack_entry(p.stack[p.curindex])
970
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
971
from bzrlib.lsprof import profile
972
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
978
trace.note('Profile data written to "%s".', filename)
982
@deprecated_function(deprecated_in((2, 2, 0)))
983
def shlex_split_unicode(unsplit):
984
return cmdline.split(unsplit)
987
def get_alias(cmd, config=None):
988
"""Return an expanded alias, or None if no alias exists.
991
Command to be checked for an alias.
993
Used to specify an alternative config to use,
994
which is especially useful for testing.
995
If it is unspecified, the global config will be used.
999
config = bzrlib.config.GlobalConfig()
1000
alias = config.get_alias(cmd)
1002
return cmdline.split(alias)
1006
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1007
"""Execute a command.
1009
:param argv: The command-line arguments, without the program name from
1010
argv[0] These should already be decoded. All library/test code calling
1011
run_bzr should be passing valid strings (don't need decoding).
1012
:param load_plugins: What function to call when triggering plugin loading.
1013
This function should take no arguments and cause all plugins to be
1015
:param disable_plugins: What function to call when disabling plugin
1016
loading. This function should take no arguments and cause all plugin
1017
loading to be prohibited (so that code paths in your application that
1018
know about some plugins possibly being present will fail to import
1019
those plugins even if they are installed.)
1020
:return: Returns a command exit code or raises an exception.
1022
Special master options: these must come before the command because
1023
they control how the command is interpreted.
1026
Do not load plugin modules at all
1029
Do not allow aliases
1032
Only use builtin commands. (Plugins are still allowed to change
1036
Run under the Python hotshot profiler.
1039
Run under the Python lsprof profiler.
1042
Generate line coverage report in the specified directory.
1045
Specify the number of processes that can be run concurrently (selftest).
1047
trace.mutter("bazaar version: " + bzrlib.__version__)
1048
argv = _specified_or_unicode_argv(argv)
1049
trace.mutter("bzr arguments: %r", argv)
1051
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1052
opt_no_aliases = False
1053
opt_lsprof_file = opt_coverage_dir = None
1055
# --no-plugins is handled specially at a very early stage. We need
1056
# to load plugins before doing other command parsing so that they
1057
# can override commands, but this needs to happen first.
1061
while i < len(argv):
1063
if a == '--profile':
1065
elif a == '--lsprof':
1067
elif a == '--lsprof-file':
1069
opt_lsprof_file = argv[i + 1]
1071
elif a == '--no-plugins':
1072
opt_no_plugins = True
1073
elif a == '--no-aliases':
1074
opt_no_aliases = True
1075
elif a == '--builtin':
1077
elif a == '--concurrency':
1078
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1080
elif a == '--coverage':
1081
opt_coverage_dir = argv[i + 1]
1083
elif a == '--profile-imports':
1084
pass # already handled in startup script Bug #588277
1085
elif a.startswith('-D'):
1086
debug.debug_flags.add(a[2:])
1091
debug.set_debug_flags_from_config()
1093
if not opt_no_plugins:
1100
get_cmd_object('help').run_argv_aliases([])
1103
if argv[0] == '--version':
1104
get_cmd_object('version').run_argv_aliases([])
1109
if not opt_no_aliases:
1110
alias_argv = get_alias(argv[0])
1112
argv[0] = alias_argv.pop(0)
1115
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1116
run = cmd_obj.run_argv_aliases
1117
run_argv = [argv, alias_argv]
1120
# We can be called recursively (tests for example), but we don't want
1121
# the verbosity level to propagate.
1122
saved_verbosity_level = option._verbosity_level
1123
option._verbosity_level = 0
1125
if opt_coverage_dir:
1127
'--coverage ignored, because --lsprof is in use.')
1128
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1130
if opt_coverage_dir:
1132
'--coverage ignored, because --profile is in use.')
1133
ret = apply_profiled(run, *run_argv)
1134
elif opt_coverage_dir:
1135
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1137
ret = run(*run_argv)
1140
# reset, in case we may do other commands later within the same
1141
# process. Commands that want to execute sub-commands must propagate
1142
# --verbose in their own way.
1143
if 'memory' in debug.debug_flags:
1144
trace.debug_memory('Process status after command:', short=False)
1145
option._verbosity_level = saved_verbosity_level
1148
def display_command(func):
1149
"""Decorator that suppresses pipe/interrupt errors."""
1150
def ignore_pipe(*args, **kwargs):
1152
result = func(*args, **kwargs)
1156
if getattr(e, 'errno', None) is None:
1158
if e.errno != errno.EPIPE:
1159
# Win32 raises IOError with errno=0 on a broken pipe
1160
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1163
except KeyboardInterrupt:
1168
def install_bzr_command_hooks():
1169
"""Install the hooks to supply bzr's own commands."""
1170
if _list_bzr_commands in Command.hooks["list_commands"]:
1172
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1174
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1176
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1177
"bzr plugin commands")
1178
Command.hooks.install_named_hook("get_command", _get_external_command,
1179
"bzr external command lookup")
1180
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1181
"bzr plugin-provider-db check")
1185
def _specified_or_unicode_argv(argv):
1186
# For internal or testing use, argv can be passed. Otherwise, get it from
1187
# the process arguments in a unicode-safe way.
1189
return osutils.get_unicode_argv()
1193
# ensure all arguments are unicode strings
1195
if isinstance(a, unicode):
1198
new_argv.append(a.decode('ascii'))
1199
except UnicodeDecodeError:
1200
raise errors.BzrError("argv should be list of unicode strings.")
1204
def main(argv=None):
1205
"""Main entry point of command-line interface.
1207
Typically `bzrlib.initialize` should be called first.
1209
:param argv: list of unicode command-line arguments similar to sys.argv.
1210
argv[0] is script name usually, it will be ignored.
1211
Don't pass here sys.argv because this list contains plain strings
1212
and not unicode; pass None instead.
1214
:return: exit code of bzr command.
1216
if argv is not None:
1218
_register_builtin_commands()
1219
ret = run_bzr_catch_errors(argv)
1220
trace.mutter("return code %d", ret)
1224
def run_bzr_catch_errors(argv):
1225
"""Run a bzr command with parameters as described by argv.
1227
This function assumed that that UI layer is setup, that symbol deprecations
1228
are already applied, and that unicode decoding has already been performed on argv.
1230
# done here so that they're covered for every test run
1231
install_bzr_command_hooks()
1232
return exception_to_return_code(run_bzr, argv)
1235
def run_bzr_catch_user_errors(argv):
1236
"""Run bzr and report user errors, but let internal errors propagate.
1238
This is used for the test suite, and might be useful for other programs
1239
that want to wrap the commandline interface.
1241
# done here so that they're covered for every test run
1242
install_bzr_command_hooks()
1244
return run_bzr(argv)
1245
except Exception, e:
1246
if (isinstance(e, (OSError, IOError))
1247
or not getattr(e, 'internal_error', True)):
1248
trace.report_exception(sys.exc_info(), sys.stderr)
1254
class HelpCommandIndex(object):
1255
"""A index for bzr help that returns commands."""
1258
self.prefix = 'commands/'
1260
def get_topics(self, topic):
1261
"""Search for topic amongst commands.
1263
:param topic: A topic to search for.
1264
:return: A list which is either empty or contains a single
1267
if topic and topic.startswith(self.prefix):
1268
topic = topic[len(self.prefix):]
1270
cmd = _get_cmd_object(topic, check_missing=False)
1277
class Provider(object):
1278
'''Generic class to be overriden by plugins'''
1280
def plugin_for_command(self, cmd_name):
1281
'''Takes a command and returns the information for that plugin
1283
:return: A dictionary with all the available information
1284
for the requested plugin
1286
raise NotImplementedError
1289
class ProvidersRegistry(registry.Registry):
1290
'''This registry exists to allow other providers to exist'''
1293
for key, provider in self.iteritems():
1296
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
