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']:
279
def _try_plugin_provider(cmd_name):
280
"""Probe for a plugin provider having cmd_name."""
282
plugin_metadata, provider = probe_for_provider(cmd_name)
283
raise errors.CommandAvailableInPlugin(cmd_name,
284
plugin_metadata, provider)
285
except errors.NoPluginAvailable:
289
def probe_for_provider(cmd_name):
290
"""Look for a provider for cmd_name.
292
:param cmd_name: The command name.
293
:return: plugin_metadata, provider for getting cmd_name.
294
:raises NoPluginAvailable: When no provider can supply the plugin.
296
# look for providers that provide this command but aren't installed
297
for provider in command_providers_registry:
299
return provider.plugin_for_command(cmd_name), provider
300
except errors.NoPluginAvailable:
302
raise errors.NoPluginAvailable(cmd_name)
305
def _get_bzr_command(cmd_or_None, cmd_name):
306
"""Get a command from bzr's core."""
308
cmd_class = builtin_command_registry.get(cmd_name)
316
def _get_external_command(cmd_or_None, cmd_name):
317
"""Lookup a command that is a shell script."""
318
# Only do external command lookups when no command is found so far.
319
if cmd_or_None is not None:
321
from bzrlib.externalcommand import ExternalCommand
322
cmd_obj = ExternalCommand.find_command(cmd_name)
327
def _get_plugin_command(cmd_or_None, cmd_name):
328
"""Get a command from bzr's plugins."""
330
return plugin_cmds.get(cmd_name)()
333
for key in plugin_cmds.keys():
334
info = plugin_cmds.get_info(key)
335
if cmd_name in info.aliases:
336
return plugin_cmds.get(key)()
340
class Command(object):
341
"""Base class for commands.
343
Commands are the heart of the command-line bzr interface.
345
The command object mostly handles the mapping of command-line
346
parameters into one or more bzrlib operations, and of the results
349
Commands normally don't have any state. All their arguments are
350
passed in to the run method. (Subclasses may take a different
351
policy if the behaviour of the instance needs to depend on e.g. a
352
shell plugin and not just its Python class.)
354
The docstring for an actual command should give a single-line
355
summary, then a complete description of the command. A grammar
356
description will be inserted.
359
Other accepted names for this command.
362
List of argument forms, marked with whether they are optional,
367
['to_location', 'from_branch?', 'file*']
369
'to_location' is required
370
'from_branch' is optional
371
'file' can be specified 0 or more times
374
List of options that may be given for this command. These can
375
be either strings, referring to globally-defined options,
376
or option objects. Retrieve through options().
379
If true, this command isn't advertised. This is typically
380
for commands intended for expert users.
383
Command objects will get a 'outf' attribute, which has been
384
setup to properly handle encoding of unicode strings.
385
encoding_type determines what will happen when characters cannot
387
strict - abort if we cannot decode
388
replace - put in a bogus character (typically '?')
389
exact - do not encode sys.stdout
391
NOTE: by default on Windows, sys.stdout is opened as a text
392
stream, therefore LF line-endings are converted to CRLF.
393
When a command uses encoding_type = 'exact', then
394
sys.stdout is forced to be a binary stream, and line-endings
397
:cvar hooks: An instance of CommandHooks.
398
:ivar __doc__: The help shown by 'bzr help command' for this command.
399
This is set by assigning explicitly to __doc__ so that -OO can
403
__doc__ = "My help goes here"
408
encoding_type = 'strict'
413
"""Construct an instance of this command."""
414
# List of standard options directly supported
415
self.supported_std_options = []
418
def add_cleanup(self, cleanup_func, *args, **kwargs):
419
"""Register a function to call after self.run returns or raises.
421
Functions will be called in LIFO order.
423
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
425
def cleanup_now(self):
426
"""Execute and empty pending cleanup functions immediately.
428
After cleanup_now all registered cleanups are forgotten. add_cleanup
429
may be called again after cleanup_now; these cleanups will be called
430
after self.run returns or raises (or when cleanup_now is next called).
432
This is useful for releasing expensive or contentious resources (such
433
as write locks) before doing further work that does not require those
434
resources (such as writing results to self.outf). Note though, that
435
as it releases all resources, this may release locks that the command
436
wants to hold, so use should be done with care.
438
self._operation.cleanup_now()
440
@deprecated_method(deprecated_in((2, 1, 0)))
441
def _maybe_expand_globs(self, file_list):
442
"""Glob expand file_list if the platform does not do that itself.
444
Not used anymore, now that the bzr command-line parser globs on
447
:return: A possibly empty list of unicode paths.
449
Introduced in bzrlib 0.18.
454
"""Return single-line grammar for this command.
456
Only describes arguments, not options.
458
s = 'bzr ' + self.name() + ' '
459
for aname in self.takes_args:
460
aname = aname.upper()
461
if aname[-1] in ['$', '+']:
462
aname = aname[:-1] + '...'
463
elif aname[-1] == '?':
464
aname = '[' + aname[:-1] + ']'
465
elif aname[-1] == '*':
466
aname = '[' + aname[:-1] + '...]'
468
s = s[:-1] # remove last space
471
def get_help_text(self, additional_see_also=None, plain=True,
472
see_also_as_links=False, verbose=True):
473
"""Return a text string with help for this command.
475
:param additional_see_also: Additional help topics to be
477
:param plain: if False, raw help (reStructuredText) is
478
returned instead of plain text.
479
:param see_also_as_links: if True, convert items in 'See also'
480
list to internal links (used by bzr_man rstx generator)
481
:param verbose: if True, display the full help, otherwise
482
leave out the descriptive sections and just display
483
usage help (e.g. Purpose, Usage, Options) with a
484
message explaining how to obtain full help.
488
doc = "No help for this command."
490
# Extract the summary (purpose) and sections out from the text
491
purpose,sections,order = self._get_help_parts(doc)
493
# If a custom usage section was provided, use it
494
if sections.has_key('Usage'):
495
usage = sections.pop('Usage')
497
usage = self._usage()
499
# The header is the purpose and usage
501
result += ':Purpose: %s\n' % purpose
502
if usage.find('\n') >= 0:
503
result += ':Usage:\n%s\n' % usage
505
result += ':Usage: %s\n' % usage
510
# XXX: optparse implicitly rewraps the help, and not always perfectly,
511
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
513
options = option.get_optparser(self.options()).format_option_help()
514
# XXX: According to the spec, ReST option lists actually don't support
515
# options like --1.9 so that causes syntax errors (in Sphinx at least).
516
# As that pattern always appears in the commands that break, we trap
517
# on that and then format that block of 'format' options as a literal
519
if not plain and options.find(' --1.9 ') != -1:
520
options = options.replace(' format:\n', ' format::\n\n', 1)
521
if options.startswith('Options:'):
522
result += ':' + options
523
elif options.startswith('options:'):
524
# Python 2.4 version of optparse
525
result += ':Options:' + options[len('options:'):]
531
# Add the description, indenting it 2 spaces
532
# to match the indentation of the options
533
if sections.has_key(None):
534
text = sections.pop(None)
535
text = '\n '.join(text.splitlines())
536
result += ':%s:\n %s\n\n' % ('Description',text)
538
# Add the custom sections (e.g. Examples). Note that there's no need
539
# to indent these as they must be indented already in the source.
542
if sections.has_key(label):
543
result += ':%s:\n%s\n' % (label,sections[label])
546
result += ("See bzr help %s for more details and examples.\n\n"
549
# Add the aliases, source (plug-in) and see also links, if any
551
result += ':Aliases: '
552
result += ', '.join(self.aliases) + '\n'
553
plugin_name = self.plugin_name()
554
if plugin_name is not None:
555
result += ':From: plugin "%s"\n' % plugin_name
556
see_also = self.get_see_also(additional_see_also)
558
if not plain and see_also_as_links:
560
for item in see_also:
562
# topics doesn't have an independent section
563
# so don't create a real link
564
see_also_links.append(item)
566
# Use a Sphinx link for this entry
567
link_text = ":doc:`%s <%s-help>`" % (item, item)
568
see_also_links.append(link_text)
569
see_also = see_also_links
570
result += ':See also: '
571
result += ', '.join(see_also) + '\n'
573
# If this will be rendered as plain text, convert it
575
import bzrlib.help_topics
576
result = bzrlib.help_topics.help_as_plain_text(result)
580
def _get_help_parts(text):
581
"""Split help text into a summary and named sections.
583
:return: (summary,sections,order) where summary is the top line and
584
sections is a dictionary of the rest indexed by section name.
585
order is the order the section appear in the text.
586
A section starts with a heading line of the form ":xxx:".
587
Indented text on following lines is the section value.
588
All text found outside a named section is assigned to the
589
default section which is given the key of None.
591
def save_section(sections, order, label, section):
593
if sections.has_key(label):
594
sections[label] += '\n' + section
597
sections[label] = section
599
lines = text.rstrip().splitlines()
600
summary = lines.pop(0)
603
label,section = None,''
605
if line.startswith(':') and line.endswith(':') and len(line) > 2:
606
save_section(sections, order, label, section)
607
label,section = line[1:-1],''
608
elif (label is not None) and len(line) > 1 and not line[0].isspace():
609
save_section(sections, order, label, section)
610
label,section = None,line
613
section += '\n' + line
616
save_section(sections, order, label, section)
617
return summary, sections, order
619
def get_help_topic(self):
620
"""Return the commands help topic - its name."""
623
def get_see_also(self, additional_terms=None):
624
"""Return a list of help topics that are related to this command.
626
The list is derived from the content of the _see_also attribute. Any
627
duplicates are removed and the result is in lexical order.
628
:param additional_terms: Additional help topics to cross-reference.
629
:return: A list of help topics.
631
see_also = set(getattr(self, '_see_also', []))
633
see_also.update(additional_terms)
634
return sorted(see_also)
637
"""Return dict of valid options for this command.
639
Maps from long option name to option object."""
640
r = Option.STD_OPTIONS.copy()
642
for o in self.takes_options:
643
if isinstance(o, basestring):
644
o = option.Option.OPTIONS[o]
646
if o.name in std_names:
647
self.supported_std_options.append(o.name)
650
def _setup_outf(self):
651
"""Return a file linked to stdout, which has proper encoding."""
652
self.outf = ui.ui_factory.make_output_stream(
653
encoding_type=self.encoding_type)
655
def run_argv_aliases(self, argv, alias_argv=None):
656
"""Parse the command line and run with extra aliases in alias_argv."""
657
args, opts = parse_args(self, argv, alias_argv)
659
# Process the standard options
660
if 'help' in opts: # e.g. bzr add --help
661
sys.stdout.write(self.get_help_text())
663
if 'usage' in opts: # e.g. bzr add --usage
664
sys.stdout.write(self.get_help_text(verbose=False))
666
trace.set_verbosity_level(option._verbosity_level)
667
if 'verbose' in self.supported_std_options:
668
opts['verbose'] = trace.is_verbose()
669
elif opts.has_key('verbose'):
671
if 'quiet' in self.supported_std_options:
672
opts['quiet'] = trace.is_quiet()
673
elif opts.has_key('quiet'):
676
# mix arguments and options into one dictionary
677
cmdargs = _match_argform(self.name(), self.takes_args, args)
679
for k, v in opts.items():
680
cmdopts[k.replace('-', '_')] = v
682
all_cmd_args = cmdargs.copy()
683
all_cmd_args.update(cmdopts)
688
return self.run(**all_cmd_args)
690
# reset it, so that other commands run in the same process won't
691
# inherit state. Before we reset it, log any activity, so that it
692
# gets properly tracked.
693
ui.ui_factory.log_transport_activity(
694
display=('bytes' in debug.debug_flags))
695
trace.set_verbosity_level(0)
697
def _setup_run(self):
698
"""Wrap the defined run method on self with a cleanup.
700
This is called by __init__ to make the Command be able to be run
701
by just calling run(), as it could be before cleanups were added.
703
If a different form of cleanups are in use by your Command subclass,
704
you can override this method.
707
def run(*args, **kwargs):
708
self._operation = cleanup.OperationWithCleanups(class_run)
710
return self._operation.run_simple(*args, **kwargs)
715
@deprecated_method(deprecated_in((2, 2, 0)))
716
def run_direct(self, *args, **kwargs):
717
"""Deprecated thunk from bzrlib 2.1."""
718
return self.run(*args, **kwargs)
721
"""Actually run the command.
723
This is invoked with the options and arguments bound to
726
Return 0 or None if the command was successful, or a non-zero
727
shell error code if not. It's OK for this method to allow
728
an exception to raise up.
730
This method is automatically wrapped by Command.__init__ with a
731
cleanup operation, stored as self._operation. This can be used
732
via self.add_cleanup to perform automatic cleanups at the end of
735
The argument for run are assembled by introspection. So for instance,
736
if your command takes an argument files, you would declare::
738
def run(self, files=None):
741
raise NotImplementedError('no implementation of command %r'
745
"""Return help message for this class."""
746
from inspect import getdoc
747
if self.__doc__ is Command.__doc__:
752
return _unsquish_command_name(self.__class__.__name__)
754
def plugin_name(self):
755
"""Get the name of the plugin that provides this command.
757
:return: The name of the plugin or None if the command is builtin.
759
mod_parts = self.__module__.split('.')
760
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
766
class CommandHooks(Hooks):
767
"""Hooks related to Command object creation/enumeration."""
770
"""Create the default hooks.
772
These are all empty initially, because by default nothing should get
775
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
776
self.add_hook('extend_command',
777
"Called after creating a command object to allow modifications "
778
"such as adding or removing options, docs etc. Called with the "
779
"new bzrlib.commands.Command object.", (1, 13))
780
self.add_hook('get_command',
781
"Called when creating a single command. Called with "
782
"(cmd_or_None, command_name). get_command should either return "
783
"the cmd_or_None parameter, or a replacement Command object that "
784
"should be used for the command. Note that the Command.hooks "
785
"hooks are core infrastructure. Many users will prefer to use "
786
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
788
self.add_hook('get_missing_command',
789
"Called when creating a single command if no command could be "
790
"found. Called with (command_name). get_missing_command should "
791
"either return None, or a Command object to be used for the "
793
self.add_hook('list_commands',
794
"Called when enumerating commands. Called with a set of "
795
"cmd_name strings for all the commands found so far. This set "
796
" is safe to mutate - e.g. to remove a command. "
797
"list_commands should return the updated set of command names.",
800
Command.hooks = CommandHooks()
803
def parse_args(command, argv, alias_argv=None):
804
"""Parse command line.
806
Arguments and options are parsed at this level before being passed
807
down to specific command handlers. This routine knows, from a
808
lookup table, something about the available options, what optargs
809
they take, and which commands will accept them.
811
# TODO: make it a method of the Command?
812
parser = option.get_optparser(command.options())
813
if alias_argv is not None:
814
args = alias_argv + argv
818
# for python 2.5 and later, optparse raises this exception if a non-ascii
819
# option name is given. See http://bugs.python.org/issue2931
821
options, args = parser.parse_args(args)
822
except UnicodeEncodeError,e:
823
raise errors.BzrCommandError('Only ASCII permitted in option names')
825
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
826
v is not option.OptionParser.DEFAULT_VALUE])
830
def _match_argform(cmd, takes_args, args):
833
# step through args and takes_args, allowing appropriate 0-many matches
834
for ap in takes_args:
838
argdict[argname] = args.pop(0)
839
elif ap[-1] == '*': # all remaining arguments
841
argdict[argname + '_list'] = args[:]
844
argdict[argname + '_list'] = None
847
raise errors.BzrCommandError("command %r needs one or more %s"
848
% (cmd, argname.upper()))
850
argdict[argname + '_list'] = args[:]
852
elif ap[-1] == '$': # all but one
854
raise errors.BzrCommandError("command %r needs one or more %s"
855
% (cmd, argname.upper()))
856
argdict[argname + '_list'] = args[:-1]
862
raise errors.BzrCommandError("command %r requires argument %s"
863
% (cmd, argname.upper()))
865
argdict[argname] = args.pop(0)
868
raise errors.BzrCommandError("extra argument to command %s: %s"
873
def apply_coveraged(dirname, the_callable, *args, **kwargs):
874
# Cannot use "import trace", as that would import bzrlib.trace instead of
875
# the standard library's trace.
876
trace = __import__('trace')
878
tracer = trace.Trace(count=1, trace=0)
879
sys.settrace(tracer.globaltrace)
880
threading.settrace(tracer.globaltrace)
883
return exception_to_return_code(the_callable, *args, **kwargs)
886
results = tracer.results()
887
results.write_results(show_missing=1, summary=False,
891
def apply_profiled(the_callable, *args, **kwargs):
895
pffileno, pfname = tempfile.mkstemp()
897
prof = hotshot.Profile(pfname)
899
ret = prof.runcall(exception_to_return_code, the_callable, *args,
903
stats = hotshot.stats.load(pfname)
905
stats.sort_stats('cum') # 'time'
906
## XXX: Might like to write to stderr or the trace file instead but
907
## print_stats seems hardcoded to stdout
908
stats.print_stats(20)
915
def exception_to_return_code(the_callable, *args, **kwargs):
916
"""UI level helper for profiling and coverage.
918
This transforms exceptions into a return value of 3. As such its only
919
relevant to the UI layer, and should never be called where catching
920
exceptions may be desirable.
923
return the_callable(*args, **kwargs)
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'
933
if sys.version_info[:2] < (2, 6):
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)
940
# Setup pdb on the traceback
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])
956
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
957
from bzrlib.lsprof import profile
958
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
964
trace.note('Profile data written to "%s".', filename)
968
@deprecated_function(deprecated_in((2, 2, 0)))
969
def shlex_split_unicode(unsplit):
970
return cmdline.split(unsplit)
973
def get_alias(cmd, config=None):
974
"""Return an expanded alias, or None if no alias exists.
977
Command to be checked for an alias.
979
Used to specify an alternative config to use,
980
which is especially useful for testing.
981
If it is unspecified, the global config will be used.
985
config = bzrlib.config.GlobalConfig()
986
alias = config.get_alias(cmd)
988
return cmdline.split(alias)
992
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
993
"""Execute a command.
995
:param argv: The command-line arguments, without the program name from
996
argv[0] These should already be decoded. All library/test code calling
997
run_bzr should be passing valid strings (don't need decoding).
998
:param load_plugins: What function to call when triggering plugin loading.
999
This function should take no arguments and cause all plugins to be
1001
:param disable_plugins: What function to call when disabling plugin
1002
loading. This function should take no arguments and cause all plugin
1003
loading to be prohibited (so that code paths in your application that
1004
know about some plugins possibly being present will fail to import
1005
those plugins even if they are installed.)
1006
:return: Returns a command exit code or raises an exception.
1008
Special master options: these must come before the command because
1009
they control how the command is interpreted.
1012
Do not load plugin modules at all
1015
Do not allow aliases
1018
Only use builtin commands. (Plugins are still allowed to change
1022
Run under the Python hotshot profiler.
1025
Run under the Python lsprof profiler.
1028
Generate line coverage report in the specified directory.
1031
Specify the number of processes that can be run concurrently (selftest).
1033
trace.mutter("bazaar version: " + bzrlib.__version__)
1035
trace.mutter("bzr arguments: %r", argv)
1037
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1038
opt_no_aliases = False
1039
opt_lsprof_file = opt_coverage_dir = None
1041
# --no-plugins is handled specially at a very early stage. We need
1042
# to load plugins before doing other command parsing so that they
1043
# can override commands, but this needs to happen first.
1047
while i < len(argv):
1049
if a == '--profile':
1051
elif a == '--lsprof':
1053
elif a == '--lsprof-file':
1055
opt_lsprof_file = argv[i + 1]
1057
elif a == '--no-plugins':
1058
opt_no_plugins = True
1059
elif a == '--no-aliases':
1060
opt_no_aliases = True
1061
elif a == '--builtin':
1063
elif a == '--concurrency':
1064
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1066
elif a == '--coverage':
1067
opt_coverage_dir = argv[i + 1]
1069
elif a == '--profile-imports':
1070
pass # already handled in startup script Bug #588277
1071
elif a.startswith('-D'):
1072
debug.debug_flags.add(a[2:])
1077
debug.set_debug_flags_from_config()
1079
if not opt_no_plugins:
1086
get_cmd_object('help').run_argv_aliases([])
1089
if argv[0] == '--version':
1090
get_cmd_object('version').run_argv_aliases([])
1095
if not opt_no_aliases:
1096
alias_argv = get_alias(argv[0])
1098
argv[0] = alias_argv.pop(0)
1101
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1102
run = cmd_obj.run_argv_aliases
1103
run_argv = [argv, alias_argv]
1106
# We can be called recursively (tests for example), but we don't want
1107
# the verbosity level to propagate.
1108
saved_verbosity_level = option._verbosity_level
1109
option._verbosity_level = 0
1111
if opt_coverage_dir:
1113
'--coverage ignored, because --lsprof is in use.')
1114
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1116
if opt_coverage_dir:
1118
'--coverage ignored, because --profile is in use.')
1119
ret = apply_profiled(run, *run_argv)
1120
elif opt_coverage_dir:
1121
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1123
ret = run(*run_argv)
1126
# reset, in case we may do other commands later within the same
1127
# process. Commands that want to execute sub-commands must propagate
1128
# --verbose in their own way.
1129
if 'memory' in debug.debug_flags:
1130
trace.debug_memory('Process status after command:', short=False)
1131
option._verbosity_level = saved_verbosity_level
1134
def display_command(func):
1135
"""Decorator that suppresses pipe/interrupt errors."""
1136
def ignore_pipe(*args, **kwargs):
1138
result = func(*args, **kwargs)
1142
if getattr(e, 'errno', None) is None:
1144
if e.errno != errno.EPIPE:
1145
# Win32 raises IOError with errno=0 on a broken pipe
1146
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1149
except KeyboardInterrupt:
1154
def install_bzr_command_hooks():
1155
"""Install the hooks to supply bzr's own commands."""
1156
if _list_bzr_commands in Command.hooks["list_commands"]:
1158
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1160
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1162
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1163
"bzr plugin commands")
1164
Command.hooks.install_named_hook("get_command", _get_external_command,
1165
"bzr external command lookup")
1166
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1167
"bzr plugin-provider-db check")
1171
def _specified_or_unicode_argv(argv):
1172
# For internal or testing use, argv can be passed. Otherwise, get it from
1173
# the process arguments in a unicode-safe way.
1175
return osutils.get_unicode_argv()
1179
# ensure all arguments are unicode strings
1181
if isinstance(a, unicode):
1184
new_argv.append(a.decode('ascii'))
1185
except UnicodeDecodeError:
1186
raise errors.BzrError("argv should be list of unicode strings.")
1190
def main(argv=None):
1191
"""Main entry point of command-line interface.
1193
Typically `bzrlib.initialize` should be called first.
1195
:param argv: list of unicode command-line arguments similar to sys.argv.
1196
argv[0] is script name usually, it will be ignored.
1197
Don't pass here sys.argv because this list contains plain strings
1198
and not unicode; pass None instead.
1200
:return: exit code of bzr command.
1202
argv = _specified_or_unicode_argv(argv)
1203
_register_builtin_commands()
1204
ret = run_bzr_catch_errors(argv)
1205
trace.mutter("return code %d", ret)
1209
def run_bzr_catch_errors(argv):
1210
"""Run a bzr command with parameters as described by argv.
1212
This function assumed that that UI layer is setup, that symbol deprecations
1213
are already applied, and that unicode decoding has already been performed on argv.
1215
# done here so that they're covered for every test run
1216
install_bzr_command_hooks()
1217
return exception_to_return_code(run_bzr, argv)
1220
def run_bzr_catch_user_errors(argv):
1221
"""Run bzr and report user errors, but let internal errors propagate.
1223
This is used for the test suite, and might be useful for other programs
1224
that want to wrap the commandline interface.
1226
# done here so that they're covered for every test run
1227
install_bzr_command_hooks()
1229
return run_bzr(argv)
1230
except Exception, e:
1231
if (isinstance(e, (OSError, IOError))
1232
or not getattr(e, 'internal_error', True)):
1233
trace.report_exception(sys.exc_info(), sys.stderr)
1239
class HelpCommandIndex(object):
1240
"""A index for bzr help that returns commands."""
1243
self.prefix = 'commands/'
1245
def get_topics(self, topic):
1246
"""Search for topic amongst commands.
1248
:param topic: A topic to search for.
1249
:return: A list which is either empty or contains a single
1252
if topic and topic.startswith(self.prefix):
1253
topic = topic[len(self.prefix):]
1255
cmd = _get_cmd_object(topic, check_missing=False)
1262
class Provider(object):
1263
'''Generic class to be overriden by plugins'''
1265
def plugin_for_command(self, cmd_name):
1266
'''Takes a command and returns the information for that plugin
1268
:return: A dictionary with all the available information
1269
for the requested plugin
1271
raise NotImplementedError
1274
class ProvidersRegistry(registry.Registry):
1275
'''This registry exists to allow other providers to exist'''
1278
for key, provider in self.iteritems():
1281
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
