1
# Copyright (C) 2005-2010 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(), """
33
from warnings import warn
49
from bzrlib.hooks import HookPoint, Hooks
50
# Compatibility - Option used to be in commands.
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
61
class CommandInfo(object):
62
"""Information about a command."""
64
def __init__(self, aliases):
65
"""The list of aliases for the command."""
66
self.aliases = aliases
69
def from_command(klass, command):
70
"""Factory to construct a CommandInfo from a command."""
71
return klass(command.aliases)
74
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
def _get_name(command_name):
94
if command_name.startswith("cmd_"):
95
return _unsquish_command_name(command_name)
99
def register(self, cmd, decorate=False):
100
"""Utility function to help register a command
102
:param cmd: Command subclass to register
103
:param decorate: If true, allow overriding an existing command
104
of the same name; the old command is returned by this function.
105
Otherwise it is an error to try to override an existing command.
108
k_unsquished = self._get_name(k)
110
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
118
info = CommandInfo.from_command(cmd)
120
registry.Registry.register(self, k_unsquished, cmd,
121
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
132
def register_lazy(self, command_name, aliases, module_name):
133
"""Register a command without loading its module.
135
:param command_name: The primary name of the command.
136
:param aliases: A list of aliases for the command.
137
:module_name: The module that the command lives in.
139
key = self._get_name(command_name)
140
registry.Registry.register_lazy(self, key, module_name, command_name,
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
151
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
154
Should generally be avoided in favor of lazy registration.
157
return plugin_cmds.register(cmd, decorate)
160
def _squish_command_name(cmd):
161
return 'cmd_' + cmd.replace('-', '_')
164
def _unsquish_command_name(cmd):
165
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
191
if name.startswith("cmd_"):
192
real_name = _unsquish_command_name(name)
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
def builtin_command_names():
220
"""Return list of builtin command names.
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
return builtin_command_registry.keys()
228
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
return plugin_cmds.keys()
233
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
237
If true, plugin commands can override builtins.
240
return _get_cmd_object(cmd_name, plugins_override)
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
# We want only 'ascii' command names, but the user may have typed
256
# in a Unicode name. In that case, they should just get a
257
# 'command not found' error later.
258
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
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
399
:cvar hooks: An instance of CommandHooks.
400
:ivar __doc__: The help shown by 'bzr help command' for this command.
401
This is set by assigning explicitly to __doc__ so that -OO can
405
__doc__ = "My help goes here"
410
encoding_type = 'strict'
415
"""Construct an instance of this command."""
416
# List of standard options directly supported
417
self.supported_std_options = []
420
def add_cleanup(self, cleanup_func, *args, **kwargs):
421
"""Register a function to call after self.run returns or raises.
423
Functions will be called in LIFO order.
425
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
427
def cleanup_now(self):
428
"""Execute and empty pending cleanup functions immediately.
430
After cleanup_now all registered cleanups are forgotten. add_cleanup
431
may be called again after cleanup_now; these cleanups will be called
432
after self.run returns or raises (or when cleanup_now is next called).
434
This is useful for releasing expensive or contentious resources (such
435
as write locks) before doing further work that does not require those
436
resources (such as writing results to self.outf). Note though, that
437
as it releases all resources, this may release locks that the command
438
wants to hold, so use should be done with care.
440
self._operation.cleanup_now()
442
@deprecated_method(deprecated_in((2, 1, 0)))
443
def _maybe_expand_globs(self, file_list):
444
"""Glob expand file_list if the platform does not do that itself.
446
Not used anymore, now that the bzr command-line parser globs on
449
:return: A possibly empty list of unicode paths.
451
Introduced in bzrlib 0.18.
456
"""Return single-line grammar for this command.
458
Only describes arguments, not options.
460
s = 'bzr ' + self.name() + ' '
461
for aname in self.takes_args:
462
aname = aname.upper()
463
if aname[-1] in ['$', '+']:
464
aname = aname[:-1] + '...'
465
elif aname[-1] == '?':
466
aname = '[' + aname[:-1] + ']'
467
elif aname[-1] == '*':
468
aname = '[' + aname[:-1] + '...]'
470
s = s[:-1] # remove last space
473
def get_help_text(self, additional_see_also=None, plain=True,
474
see_also_as_links=False, verbose=True):
475
"""Return a text string with help for this command.
477
:param additional_see_also: Additional help topics to be
479
:param plain: if False, raw help (reStructuredText) is
480
returned instead of plain text.
481
:param see_also_as_links: if True, convert items in 'See also'
482
list to internal links (used by bzr_man rstx generator)
483
:param verbose: if True, display the full help, otherwise
484
leave out the descriptive sections and just display
485
usage help (e.g. Purpose, Usage, Options) with a
486
message explaining how to obtain full help.
490
doc = "No help for this command."
492
# Extract the summary (purpose) and sections out from the text
493
purpose,sections,order = self._get_help_parts(doc)
495
# If a custom usage section was provided, use it
496
if sections.has_key('Usage'):
497
usage = sections.pop('Usage')
499
usage = self._usage()
501
# The header is the purpose and usage
503
result += ':Purpose: %s\n' % purpose
504
if usage.find('\n') >= 0:
505
result += ':Usage:\n%s\n' % usage
507
result += ':Usage: %s\n' % usage
512
# XXX: optparse implicitly rewraps the help, and not always perfectly,
513
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
515
options = option.get_optparser(self.options()).format_option_help()
516
# XXX: According to the spec, ReST option lists actually don't support
517
# options like --1.9 so that causes syntax errors (in Sphinx at least).
518
# As that pattern always appears in the commands that break, we trap
519
# on that and then format that block of 'format' options as a literal
521
if not plain and options.find(' --1.9 ') != -1:
522
options = options.replace(' format:\n', ' format::\n\n', 1)
523
if options.startswith('Options:'):
524
result += ':' + options
525
elif options.startswith('options:'):
526
# Python 2.4 version of optparse
527
result += ':Options:' + options[len('options:'):]
533
# Add the description, indenting it 2 spaces
534
# to match the indentation of the options
535
if sections.has_key(None):
536
text = sections.pop(None)
537
text = '\n '.join(text.splitlines())
538
result += ':%s:\n %s\n\n' % ('Description',text)
540
# Add the custom sections (e.g. Examples). Note that there's no need
541
# to indent these as they must be indented already in the source.
544
if sections.has_key(label):
545
result += ':%s:\n%s\n' % (label,sections[label])
548
result += ("See bzr help %s for more details and examples.\n\n"
551
# Add the aliases, source (plug-in) and see also links, if any
553
result += ':Aliases: '
554
result += ', '.join(self.aliases) + '\n'
555
plugin_name = self.plugin_name()
556
if plugin_name is not None:
557
result += ':From: plugin "%s"\n' % plugin_name
558
see_also = self.get_see_also(additional_see_also)
560
if not plain and see_also_as_links:
562
for item in see_also:
564
# topics doesn't have an independent section
565
# so don't create a real link
566
see_also_links.append(item)
568
# Use a Sphinx link for this entry
569
link_text = ":doc:`%s <%s-help>`" % (item, item)
570
see_also_links.append(link_text)
571
see_also = see_also_links
572
result += ':See also: '
573
result += ', '.join(see_also) + '\n'
575
# If this will be rendered as plain text, convert it
577
import bzrlib.help_topics
578
result = bzrlib.help_topics.help_as_plain_text(result)
582
def _get_help_parts(text):
583
"""Split help text into a summary and named sections.
585
:return: (summary,sections,order) where summary is the top line and
586
sections is a dictionary of the rest indexed by section name.
587
order is the order the section appear in the text.
588
A section starts with a heading line of the form ":xxx:".
589
Indented text on following lines is the section value.
590
All text found outside a named section is assigned to the
591
default section which is given the key of None.
593
def save_section(sections, order, label, section):
595
if sections.has_key(label):
596
sections[label] += '\n' + section
599
sections[label] = section
601
lines = text.rstrip().splitlines()
602
summary = lines.pop(0)
605
label,section = None,''
607
if line.startswith(':') and line.endswith(':') and len(line) > 2:
608
save_section(sections, order, label, section)
609
label,section = line[1:-1],''
610
elif (label is not None) and len(line) > 1 and not line[0].isspace():
611
save_section(sections, order, label, section)
612
label,section = None,line
615
section += '\n' + line
618
save_section(sections, order, label, section)
619
return summary, sections, order
621
def get_help_topic(self):
622
"""Return the commands help topic - its name."""
625
def get_see_also(self, additional_terms=None):
626
"""Return a list of help topics that are related to this command.
628
The list is derived from the content of the _see_also attribute. Any
629
duplicates are removed and the result is in lexical order.
630
:param additional_terms: Additional help topics to cross-reference.
631
:return: A list of help topics.
633
see_also = set(getattr(self, '_see_also', []))
635
see_also.update(additional_terms)
636
return sorted(see_also)
639
"""Return dict of valid options for this command.
641
Maps from long option name to option object."""
642
r = Option.STD_OPTIONS.copy()
644
for o in self.takes_options:
645
if isinstance(o, basestring):
646
o = option.Option.OPTIONS[o]
648
if o.name in std_names:
649
self.supported_std_options.append(o.name)
652
def _setup_outf(self):
653
"""Return a file linked to stdout, which has proper encoding."""
654
self.outf = ui.ui_factory.make_output_stream(
655
encoding_type=self.encoding_type)
657
def run_argv_aliases(self, argv, alias_argv=None):
658
"""Parse the command line and run with extra aliases in alias_argv."""
659
args, opts = parse_args(self, argv, alias_argv)
661
# Process the standard options
662
if 'help' in opts: # e.g. bzr add --help
663
sys.stdout.write(self.get_help_text())
665
if 'usage' in opts: # e.g. bzr add --usage
666
sys.stdout.write(self.get_help_text(verbose=False))
668
trace.set_verbosity_level(option._verbosity_level)
669
if 'verbose' in self.supported_std_options:
670
opts['verbose'] = trace.is_verbose()
671
elif opts.has_key('verbose'):
673
if 'quiet' in self.supported_std_options:
674
opts['quiet'] = trace.is_quiet()
675
elif opts.has_key('quiet'):
678
# mix arguments and options into one dictionary
679
cmdargs = _match_argform(self.name(), self.takes_args, args)
681
for k, v in opts.items():
682
cmdopts[k.replace('-', '_')] = v
684
all_cmd_args = cmdargs.copy()
685
all_cmd_args.update(cmdopts)
689
return self.run(**all_cmd_args)
691
def _setup_run(self):
692
"""Wrap the defined run method on self with a cleanup.
694
This is called by __init__ to make the Command be able to be run
695
by just calling run(), as it could be before cleanups were added.
697
If a different form of cleanups are in use by your Command subclass,
698
you can override this method.
701
def run(*args, **kwargs):
702
self._operation = cleanup.OperationWithCleanups(class_run)
704
return self._operation.run_simple(*args, **kwargs)
709
@deprecated_method(deprecated_in((2, 2, 0)))
710
def run_direct(self, *args, **kwargs):
711
"""Deprecated thunk from bzrlib 2.1."""
712
return self.run(*args, **kwargs)
715
"""Actually run the command.
717
This is invoked with the options and arguments bound to
720
Return 0 or None if the command was successful, or a non-zero
721
shell error code if not. It's OK for this method to allow
722
an exception to raise up.
724
This method is automatically wrapped by Command.__init__ with a
725
cleanup operation, stored as self._operation. This can be used
726
via self.add_cleanup to perform automatic cleanups at the end of
729
The argument for run are assembled by introspection. So for instance,
730
if your command takes an argument files, you would declare::
732
def run(self, files=None):
735
raise NotImplementedError('no implementation of command %r'
739
"""Return help message for this class."""
740
from inspect import getdoc
741
if self.__doc__ is Command.__doc__:
746
return _unsquish_command_name(self.__class__.__name__)
748
def plugin_name(self):
749
"""Get the name of the plugin that provides this command.
751
:return: The name of the plugin or None if the command is builtin.
753
mod_parts = self.__module__.split('.')
754
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
760
class CommandHooks(Hooks):
761
"""Hooks related to Command object creation/enumeration."""
764
"""Create the default hooks.
766
These are all empty initially, because by default nothing should get
770
self.create_hook(HookPoint('extend_command',
771
"Called after creating a command object to allow modifications "
772
"such as adding or removing options, docs etc. Called with the "
773
"new bzrlib.commands.Command object.", (1, 13), None))
774
self.create_hook(HookPoint('get_command',
775
"Called when creating a single command. Called with "
776
"(cmd_or_None, command_name). get_command should either return "
777
"the cmd_or_None parameter, or a replacement Command object that "
778
"should be used for the command. Note that the Command.hooks "
779
"hooks are core infrastructure. Many users will prefer to use "
780
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
782
self.create_hook(HookPoint('get_missing_command',
783
"Called when creating a single command if no command could be "
784
"found. Called with (command_name). get_missing_command should "
785
"either return None, or a Command object to be used for the "
786
"command.", (1, 17), None))
787
self.create_hook(HookPoint('list_commands',
788
"Called when enumerating commands. Called with a set of "
789
"cmd_name strings for all the commands found so far. This set "
790
" is safe to mutate - e.g. to remove a command. "
791
"list_commands should return the updated set of command names.",
794
Command.hooks = CommandHooks()
797
def parse_args(command, argv, alias_argv=None):
798
"""Parse command line.
800
Arguments and options are parsed at this level before being passed
801
down to specific command handlers. This routine knows, from a
802
lookup table, something about the available options, what optargs
803
they take, and which commands will accept them.
805
# TODO: make it a method of the Command?
806
parser = option.get_optparser(command.options())
807
if alias_argv is not None:
808
args = alias_argv + argv
812
options, args = parser.parse_args(args)
813
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
814
v is not option.OptionParser.DEFAULT_VALUE])
818
def _match_argform(cmd, takes_args, args):
821
# step through args and takes_args, allowing appropriate 0-many matches
822
for ap in takes_args:
826
argdict[argname] = args.pop(0)
827
elif ap[-1] == '*': # all remaining arguments
829
argdict[argname + '_list'] = args[:]
832
argdict[argname + '_list'] = None
835
raise errors.BzrCommandError("command %r needs one or more %s"
836
% (cmd, argname.upper()))
838
argdict[argname + '_list'] = args[:]
840
elif ap[-1] == '$': # all but one
842
raise errors.BzrCommandError("command %r needs one or more %s"
843
% (cmd, argname.upper()))
844
argdict[argname + '_list'] = args[:-1]
850
raise errors.BzrCommandError("command %r requires argument %s"
851
% (cmd, argname.upper()))
853
argdict[argname] = args.pop(0)
856
raise errors.BzrCommandError("extra argument to command %s: %s"
861
def apply_coveraged(dirname, the_callable, *args, **kwargs):
862
# Cannot use "import trace", as that would import bzrlib.trace instead of
863
# the standard library's trace.
864
trace = __import__('trace')
866
tracer = trace.Trace(count=1, trace=0)
867
sys.settrace(tracer.globaltrace)
868
threading.settrace(tracer.globaltrace)
871
return exception_to_return_code(the_callable, *args, **kwargs)
874
results = tracer.results()
875
results.write_results(show_missing=1, summary=False,
879
def apply_profiled(the_callable, *args, **kwargs):
883
pffileno, pfname = tempfile.mkstemp()
885
prof = hotshot.Profile(pfname)
887
ret = prof.runcall(exception_to_return_code, the_callable, *args,
891
stats = hotshot.stats.load(pfname)
893
stats.sort_stats('cum') # 'time'
894
## XXX: Might like to write to stderr or the trace file instead but
895
## print_stats seems hardcoded to stdout
896
stats.print_stats(20)
903
def exception_to_return_code(the_callable, *args, **kwargs):
904
"""UI level helper for profiling and coverage.
906
This transforms exceptions into a return value of 3. As such its only
907
relevant to the UI layer, and should never be called where catching
908
exceptions may be desirable.
911
return the_callable(*args, **kwargs)
912
except (KeyboardInterrupt, Exception), e:
913
# used to handle AssertionError and KeyboardInterrupt
914
# specially here, but hopefully they're handled ok by the logger now
915
exc_info = sys.exc_info()
916
exitcode = trace.report_exception(exc_info, sys.stderr)
917
if os.environ.get('BZR_PDB'):
918
print '**** entering debugger'
921
if sys.version_info[:2] < (2, 6):
923
# pdb.post_mortem(tb)
924
# but because pdb.post_mortem gives bad results for tracebacks
925
# from inside generators, we do it manually.
926
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
928
# Setup pdb on the traceback
931
p.setup(tb.tb_frame, tb)
932
# Point the debugger at the deepest frame of the stack
933
p.curindex = len(p.stack) - 1
934
p.curframe = p.stack[p.curindex][0]
935
# Start the pdb prompt.
936
p.print_stack_entry(p.stack[p.curindex])
944
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
945
from bzrlib.lsprof import profile
946
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
952
trace.note('Profile data written to "%s".', filename)
956
@deprecated_function(deprecated_in((2, 2, 0)))
957
def shlex_split_unicode(unsplit):
958
return cmdline.split(unsplit)
961
def get_alias(cmd, config=None):
962
"""Return an expanded alias, or None if no alias exists.
965
Command to be checked for an alias.
967
Used to specify an alternative config to use,
968
which is especially useful for testing.
969
If it is unspecified, the global config will be used.
973
config = bzrlib.config.GlobalConfig()
974
alias = config.get_alias(cmd)
976
return cmdline.split(alias)
980
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
981
"""Execute a command.
983
:param argv: The command-line arguments, without the program name from
984
argv[0] These should already be decoded. All library/test code calling
985
run_bzr should be passing valid strings (don't need decoding).
986
:param load_plugins: What function to call when triggering plugin loading.
987
This function should take no arguments and cause all plugins to be
989
:param disable_plugins: What function to call when disabling plugin
990
loading. This function should take no arguments and cause all plugin
991
loading to be prohibited (so that code paths in your application that
992
know about some plugins possibly being present will fail to import
993
those plugins even if they are installed.)
994
:return: Returns a command exit code or raises an exception.
996
Special master options: these must come before the command because
997
they control how the command is interpreted.
1000
Do not load plugin modules at all
1003
Do not allow aliases
1006
Only use builtin commands. (Plugins are still allowed to change
1010
Run under the Python hotshot profiler.
1013
Run under the Python lsprof profiler.
1016
Generate line coverage report in the specified directory.
1019
Specify the number of processes that can be run concurrently (selftest).
1021
trace.mutter("bazaar version: " + bzrlib.__version__)
1023
trace.mutter("bzr arguments: %r", argv)
1025
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1026
opt_no_aliases = False
1027
opt_lsprof_file = opt_coverage_dir = None
1029
# --no-plugins is handled specially at a very early stage. We need
1030
# to load plugins before doing other command parsing so that they
1031
# can override commands, but this needs to happen first.
1035
while i < len(argv):
1037
if a == '--profile':
1039
elif a == '--lsprof':
1041
elif a == '--lsprof-file':
1043
opt_lsprof_file = argv[i + 1]
1045
elif a == '--no-plugins':
1046
opt_no_plugins = True
1047
elif a == '--no-aliases':
1048
opt_no_aliases = True
1049
elif a == '--builtin':
1051
elif a == '--concurrency':
1052
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1054
elif a == '--coverage':
1055
opt_coverage_dir = argv[i + 1]
1057
elif a == '--profile-imports':
1058
pass # already handled in startup script Bug #588277
1059
elif a.startswith('-D'):
1060
debug.debug_flags.add(a[2:])
1065
debug.set_debug_flags_from_config()
1067
if not opt_no_plugins:
1074
get_cmd_object('help').run_argv_aliases([])
1077
if argv[0] == '--version':
1078
get_cmd_object('version').run_argv_aliases([])
1083
if not opt_no_aliases:
1084
alias_argv = get_alias(argv[0])
1086
argv[0] = alias_argv.pop(0)
1089
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1090
run = cmd_obj.run_argv_aliases
1091
run_argv = [argv, alias_argv]
1094
# We can be called recursively (tests for example), but we don't want
1095
# the verbosity level to propagate.
1096
saved_verbosity_level = option._verbosity_level
1097
option._verbosity_level = 0
1099
if opt_coverage_dir:
1101
'--coverage ignored, because --lsprof is in use.')
1102
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1104
if opt_coverage_dir:
1106
'--coverage ignored, because --profile is in use.')
1107
ret = apply_profiled(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1111
ret = run(*run_argv)
1114
# reset, in case we may do other commands later within the same
1115
# process. Commands that want to execute sub-commands must propagate
1116
# --verbose in their own way.
1117
if 'memory' in debug.debug_flags:
1118
trace.debug_memory('Process status after command:', short=False)
1119
option._verbosity_level = saved_verbosity_level
1122
def display_command(func):
1123
"""Decorator that suppresses pipe/interrupt errors."""
1124
def ignore_pipe(*args, **kwargs):
1126
result = func(*args, **kwargs)
1130
if getattr(e, 'errno', None) is None:
1132
if e.errno != errno.EPIPE:
1133
# Win32 raises IOError with errno=0 on a broken pipe
1134
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1137
except KeyboardInterrupt:
1142
def install_bzr_command_hooks():
1143
"""Install the hooks to supply bzr's own commands."""
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
"bzr plugin commands")
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1153
"bzr external command lookup")
1154
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
"bzr plugin-provider-db check")
1159
def _specified_or_unicode_argv(argv):
1160
# For internal or testing use, argv can be passed. Otherwise, get it from
1161
# the process arguments in a unicode-safe way.
1163
return osutils.get_unicode_argv()
1167
# ensure all arguments are unicode strings
1169
if isinstance(a, unicode):
1172
new_argv.append(a.decode('ascii'))
1173
except UnicodeDecodeError:
1174
raise errors.BzrError("argv should be list of unicode strings.")
1178
def main(argv=None):
1179
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
argv[0] is script name usually, it will be ignored.
1185
Don't pass here sys.argv because this list contains plain strings
1186
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1190
argv = _specified_or_unicode_argv(argv)
1191
_register_builtin_commands()
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
trace.mutter("return code %d", ret)
1199
def run_bzr_catch_errors(argv):
1200
"""Run a bzr command with parameters as described by argv.
1202
This function assumed that that UI layer is setup, that symbol deprecations
1203
are already applied, and that unicode decoding has already been performed on argv.
1205
# done here so that they're covered for every test run
1206
install_bzr_command_hooks()
1207
return exception_to_return_code(run_bzr, argv)
1210
def run_bzr_catch_user_errors(argv):
1211
"""Run bzr and report user errors, but let internal errors propagate.
1213
This is used for the test suite, and might be useful for other programs
1214
that want to wrap the commandline interface.
1216
# done here so that they're covered for every test run
1217
install_bzr_command_hooks()
1219
return run_bzr(argv)
1220
except Exception, e:
1221
if (isinstance(e, (OSError, IOError))
1222
or not getattr(e, 'internal_error', True)):
1223
trace.report_exception(sys.exc_info(), sys.stderr)
1229
class HelpCommandIndex(object):
1230
"""A index for bzr help that returns commands."""
1233
self.prefix = 'commands/'
1235
def get_topics(self, topic):
1236
"""Search for topic amongst commands.
1238
:param topic: A topic to search for.
1239
:return: A list which is either empty or contains a single
1242
if topic and topic.startswith(self.prefix):
1243
topic = topic[len(self.prefix):]
1245
cmd = _get_cmd_object(topic, check_missing=False)
1252
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1255
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1258
:return: A dictionary with all the available information
1259
for the requested plugin
1261
raise NotImplementedError
1264
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1268
for key, provider in self.iteritems():
1271
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
