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.
404
encoding_type = 'strict'
409
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__ or not self.__doc__:
411
raise ValueError("No help message set for %r" % self)
412
# List of standard options directly supported
413
self.supported_std_options = []
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
417
"""Register a function to call after self.run returns or raises.
419
Functions will be called in LIFO order.
421
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
423
def cleanup_now(self):
424
"""Execute and empty pending cleanup functions immediately.
426
After cleanup_now all registered cleanups are forgotten. add_cleanup
427
may be called again after cleanup_now; these cleanups will be called
428
after self.run returns or raises (or when cleanup_now is next called).
430
This is useful for releasing expensive or contentious resources (such
431
as write locks) before doing further work that does not require those
432
resources (such as writing results to self.outf). Note though, that
433
as it releases all resources, this may release locks that the command
434
wants to hold, so use should be done with care.
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def _maybe_expand_globs(self, file_list):
440
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
:return: A possibly empty list of unicode paths.
447
Introduced in bzrlib 0.18.
452
"""Return single-line grammar for this command.
454
Only describes arguments, not options.
456
s = 'bzr ' + self.name() + ' '
457
for aname in self.takes_args:
458
aname = aname.upper()
459
if aname[-1] in ['$', '+']:
460
aname = aname[:-1] + '...'
461
elif aname[-1] == '?':
462
aname = '[' + aname[:-1] + ']'
463
elif aname[-1] == '*':
464
aname = '[' + aname[:-1] + '...]'
466
s = s[:-1] # remove last space
469
def get_help_text(self, additional_see_also=None, plain=True,
470
see_also_as_links=False, verbose=True):
471
"""Return a text string with help for this command.
473
:param additional_see_also: Additional help topics to be
475
:param plain: if False, raw help (reStructuredText) is
476
returned instead of plain text.
477
:param see_also_as_links: if True, convert items in 'See also'
478
list to internal links (used by bzr_man rstx generator)
479
:param verbose: if True, display the full help, otherwise
480
leave out the descriptive sections and just display
481
usage help (e.g. Purpose, Usage, Options) with a
482
message explaining how to obtain full help.
486
raise NotImplementedError(
487
"self.help() returned None - no detailed help yet for %r" %
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)
687
return self.run(**all_cmd_args)
689
def _setup_run(self):
690
"""Wrap the defined run method on self with a cleanup.
692
This is called by __init__ to make the Command be able to be run
693
by just calling run(), as it could be before cleanups were added.
695
If a different form of cleanups are in use by your Command subclass,
696
you can override this method.
699
def run(*args, **kwargs):
700
self._operation = cleanup.OperationWithCleanups(class_run)
702
return self._operation.run_simple(*args, **kwargs)
707
@deprecated_method(deprecated_in((2, 2, 0)))
708
def run_direct(self, *args, **kwargs):
709
"""Deprecated thunk from bzrlib 2.1."""
710
return self.run(*args, **kwargs)
713
"""Actually run the command.
715
This is invoked with the options and arguments bound to
718
Return 0 or None if the command was successful, or a non-zero
719
shell error code if not. It's OK for this method to allow
720
an exception to raise up.
722
This method is automatically wrapped by Command.__init__ with a
723
cleanup operation, stored as self._operation. This can be used
724
via self.add_cleanup to perform automatic cleanups at the end of
727
The argument for run are assembled by introspection. So for instance,
728
if your command takes an argument files, you would declare::
730
def run(self, files=None):
733
raise NotImplementedError('no implementation of command %r'
737
"""Return help message for this class."""
738
from inspect import getdoc
739
if self.__doc__ is Command.__doc__:
744
return _unsquish_command_name(self.__class__.__name__)
746
def plugin_name(self):
747
"""Get the name of the plugin that provides this command.
749
:return: The name of the plugin or None if the command is builtin.
751
mod_parts = self.__module__.split('.')
752
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
758
class CommandHooks(Hooks):
759
"""Hooks related to Command object creation/enumeration."""
762
"""Create the default hooks.
764
These are all empty initially, because by default nothing should get
768
self.create_hook(HookPoint('extend_command',
769
"Called after creating a command object to allow modifications "
770
"such as adding or removing options, docs etc. Called with the "
771
"new bzrlib.commands.Command object.", (1, 13), None))
772
self.create_hook(HookPoint('get_command',
773
"Called when creating a single command. Called with "
774
"(cmd_or_None, command_name). get_command should either return "
775
"the cmd_or_None parameter, or a replacement Command object that "
776
"should be used for the command. Note that the Command.hooks "
777
"hooks are core infrastructure. Many users will prefer to use "
778
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
780
self.create_hook(HookPoint('get_missing_command',
781
"Called when creating a single command if no command could be "
782
"found. Called with (command_name). get_missing_command should "
783
"either return None, or a Command object to be used for the "
784
"command.", (1, 17), None))
785
self.create_hook(HookPoint('list_commands',
786
"Called when enumerating commands. Called with a set of "
787
"cmd_name strings for all the commands found so far. This set "
788
" is safe to mutate - e.g. to remove a command. "
789
"list_commands should return the updated set of command names.",
792
Command.hooks = CommandHooks()
795
def parse_args(command, argv, alias_argv=None):
796
"""Parse command line.
798
Arguments and options are parsed at this level before being passed
799
down to specific command handlers. This routine knows, from a
800
lookup table, something about the available options, what optargs
801
they take, and which commands will accept them.
803
# TODO: make it a method of the Command?
804
parser = option.get_optparser(command.options())
805
if alias_argv is not None:
806
args = alias_argv + argv
810
options, args = parser.parse_args(args)
811
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
812
v is not option.OptionParser.DEFAULT_VALUE])
816
def _match_argform(cmd, takes_args, args):
819
# step through args and takes_args, allowing appropriate 0-many matches
820
for ap in takes_args:
824
argdict[argname] = args.pop(0)
825
elif ap[-1] == '*': # all remaining arguments
827
argdict[argname + '_list'] = args[:]
830
argdict[argname + '_list'] = None
833
raise errors.BzrCommandError("command %r needs one or more %s"
834
% (cmd, argname.upper()))
836
argdict[argname + '_list'] = args[:]
838
elif ap[-1] == '$': # all but one
840
raise errors.BzrCommandError("command %r needs one or more %s"
841
% (cmd, argname.upper()))
842
argdict[argname + '_list'] = args[:-1]
848
raise errors.BzrCommandError("command %r requires argument %s"
849
% (cmd, argname.upper()))
851
argdict[argname] = args.pop(0)
854
raise errors.BzrCommandError("extra argument to command %s: %s"
859
def apply_coveraged(dirname, the_callable, *args, **kwargs):
860
# Cannot use "import trace", as that would import bzrlib.trace instead of
861
# the standard library's trace.
862
trace = __import__('trace')
864
tracer = trace.Trace(count=1, trace=0)
865
sys.settrace(tracer.globaltrace)
866
threading.settrace(tracer.globaltrace)
869
return exception_to_return_code(the_callable, *args, **kwargs)
872
results = tracer.results()
873
results.write_results(show_missing=1, summary=False,
877
def apply_profiled(the_callable, *args, **kwargs):
881
pffileno, pfname = tempfile.mkstemp()
883
prof = hotshot.Profile(pfname)
885
ret = prof.runcall(exception_to_return_code, the_callable, *args,
889
stats = hotshot.stats.load(pfname)
891
stats.sort_stats('cum') # 'time'
892
## XXX: Might like to write to stderr or the trace file instead but
893
## print_stats seems hardcoded to stdout
894
stats.print_stats(20)
901
def exception_to_return_code(the_callable, *args, **kwargs):
902
"""UI level helper for profiling and coverage.
904
This transforms exceptions into a return value of 3. As such its only
905
relevant to the UI layer, and should never be called where catching
906
exceptions may be desirable.
909
return the_callable(*args, **kwargs)
910
except (KeyboardInterrupt, Exception), e:
911
# used to handle AssertionError and KeyboardInterrupt
912
# specially here, but hopefully they're handled ok by the logger now
913
exc_info = sys.exc_info()
914
exitcode = trace.report_exception(exc_info, sys.stderr)
915
if os.environ.get('BZR_PDB'):
916
print '**** entering debugger'
919
if sys.version_info[:2] < (2, 6):
921
# pdb.post_mortem(tb)
922
# but because pdb.post_mortem gives bad results for tracebacks
923
# from inside generators, we do it manually.
924
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
926
# Setup pdb on the traceback
929
p.setup(tb.tb_frame, tb)
930
# Point the debugger at the deepest frame of the stack
931
p.curindex = len(p.stack) - 1
932
p.curframe = p.stack[p.curindex][0]
933
# Start the pdb prompt.
934
p.print_stack_entry(p.stack[p.curindex])
942
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
943
from bzrlib.lsprof import profile
944
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
950
trace.note('Profile data written to "%s".', filename)
954
@deprecated_function(deprecated_in((2, 2, 0)))
955
def shlex_split_unicode(unsplit):
956
return cmdline.split(unsplit)
959
def get_alias(cmd, config=None):
960
"""Return an expanded alias, or None if no alias exists.
963
Command to be checked for an alias.
965
Used to specify an alternative config to use,
966
which is especially useful for testing.
967
If it is unspecified, the global config will be used.
971
config = bzrlib.config.GlobalConfig()
972
alias = config.get_alias(cmd)
974
return cmdline.split(alias)
978
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
979
"""Execute a command.
981
:param argv: The command-line arguments, without the program name from
982
argv[0] These should already be decoded. All library/test code calling
983
run_bzr should be passing valid strings (don't need decoding).
984
:param load_plugins: What function to call when triggering plugin loading.
985
This function should take no arguments and cause all plugins to be
987
:param disable_plugins: What function to call when disabling plugin
988
loading. This function should take no arguments and cause all plugin
989
loading to be prohibited (so that code paths in your application that
990
know about some plugins possibly being present will fail to import
991
those plugins even if they are installed.)
992
:return: Returns a command exit code or raises an exception.
994
Special master options: these must come before the command because
995
they control how the command is interpreted.
998
Do not load plugin modules at all
1001
Do not allow aliases
1004
Only use builtin commands. (Plugins are still allowed to change
1008
Run under the Python hotshot profiler.
1011
Run under the Python lsprof profiler.
1014
Generate line coverage report in the specified directory.
1017
Specify the number of processes that can be run concurrently (selftest).
1019
trace.mutter("bazaar version: " + bzrlib.__version__)
1021
trace.mutter("bzr arguments: %r", argv)
1023
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1024
opt_no_aliases = False
1025
opt_lsprof_file = opt_coverage_dir = None
1027
# --no-plugins is handled specially at a very early stage. We need
1028
# to load plugins before doing other command parsing so that they
1029
# can override commands, but this needs to happen first.
1033
while i < len(argv):
1035
if a == '--profile':
1037
elif a == '--lsprof':
1039
elif a == '--lsprof-file':
1041
opt_lsprof_file = argv[i + 1]
1043
elif a == '--no-plugins':
1044
opt_no_plugins = True
1045
elif a == '--no-aliases':
1046
opt_no_aliases = True
1047
elif a == '--builtin':
1049
elif a == '--concurrency':
1050
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1052
elif a == '--coverage':
1053
opt_coverage_dir = argv[i + 1]
1055
elif a.startswith('-D'):
1056
debug.debug_flags.add(a[2:])
1061
debug.set_debug_flags_from_config()
1063
if not opt_no_plugins:
1070
get_cmd_object('help').run_argv_aliases([])
1073
if argv[0] == '--version':
1074
get_cmd_object('version').run_argv_aliases([])
1079
if not opt_no_aliases:
1080
alias_argv = get_alias(argv[0])
1082
argv[0] = alias_argv.pop(0)
1085
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1086
run = cmd_obj.run_argv_aliases
1087
run_argv = [argv, alias_argv]
1090
# We can be called recursively (tests for example), but we don't want
1091
# the verbosity level to propagate.
1092
saved_verbosity_level = option._verbosity_level
1093
option._verbosity_level = 0
1095
if opt_coverage_dir:
1097
'--coverage ignored, because --lsprof is in use.')
1098
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1100
if opt_coverage_dir:
1102
'--coverage ignored, because --profile is in use.')
1103
ret = apply_profiled(run, *run_argv)
1104
elif opt_coverage_dir:
1105
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1107
ret = run(*run_argv)
1110
# reset, in case we may do other commands later within the same
1111
# process. Commands that want to execute sub-commands must propagate
1112
# --verbose in their own way.
1113
if 'memory' in debug.debug_flags:
1114
trace.debug_memory('Process status after command:', short=False)
1115
option._verbosity_level = saved_verbosity_level
1118
def display_command(func):
1119
"""Decorator that suppresses pipe/interrupt errors."""
1120
def ignore_pipe(*args, **kwargs):
1122
result = func(*args, **kwargs)
1126
if getattr(e, 'errno', None) is None:
1128
if e.errno != errno.EPIPE:
1129
# Win32 raises IOError with errno=0 on a broken pipe
1130
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1133
except KeyboardInterrupt:
1138
def install_bzr_command_hooks():
1139
"""Install the hooks to supply bzr's own commands."""
1140
if _list_bzr_commands in Command.hooks["list_commands"]:
1142
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1144
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1146
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1147
"bzr plugin commands")
1148
Command.hooks.install_named_hook("get_command", _get_external_command,
1149
"bzr external command lookup")
1150
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1151
"bzr plugin-provider-db check")
1155
def _specified_or_unicode_argv(argv):
1156
# For internal or testing use, argv can be passed. Otherwise, get it from
1157
# the process arguments in a unicode-safe way.
1159
return osutils.get_unicode_argv()
1163
# ensure all arguments are unicode strings
1165
if isinstance(a, unicode):
1168
new_argv.append(a.decode('ascii'))
1169
except UnicodeDecodeError:
1170
raise errors.BzrError("argv should be list of unicode strings.")
1174
def main(argv=None):
1175
"""Main entry point of command-line interface.
1177
Typically `bzrlib.initialize` should be called first.
1179
:param argv: list of unicode command-line arguments similar to sys.argv.
1180
argv[0] is script name usually, it will be ignored.
1181
Don't pass here sys.argv because this list contains plain strings
1182
and not unicode; pass None instead.
1184
:return: exit code of bzr command.
1186
argv = _specified_or_unicode_argv(argv)
1187
_register_builtin_commands()
1188
ret = run_bzr_catch_errors(argv)
1189
bzrlib.ui.ui_factory.log_transport_activity(
1190
display=('bytes' in debug.debug_flags))
1191
trace.mutter("return code %d", ret)
1195
def run_bzr_catch_errors(argv):
1196
"""Run a bzr command with parameters as described by argv.
1198
This function assumed that that UI layer is setup, that symbol deprecations
1199
are already applied, and that unicode decoding has already been performed on argv.
1201
# done here so that they're covered for every test run
1202
install_bzr_command_hooks()
1203
return exception_to_return_code(run_bzr, argv)
1206
def run_bzr_catch_user_errors(argv):
1207
"""Run bzr and report user errors, but let internal errors propagate.
1209
This is used for the test suite, and might be useful for other programs
1210
that want to wrap the commandline interface.
1212
# done here so that they're covered for every test run
1213
install_bzr_command_hooks()
1215
return run_bzr(argv)
1216
except Exception, e:
1217
if (isinstance(e, (OSError, IOError))
1218
or not getattr(e, 'internal_error', True)):
1219
trace.report_exception(sys.exc_info(), sys.stderr)
1225
class HelpCommandIndex(object):
1226
"""A index for bzr help that returns commands."""
1229
self.prefix = 'commands/'
1231
def get_topics(self, topic):
1232
"""Search for topic amongst commands.
1234
:param topic: A topic to search for.
1235
:return: A list which is either empty or contains a single
1238
if topic and topic.startswith(self.prefix):
1239
topic = topic[len(self.prefix):]
1241
cmd = _get_cmd_object(topic, check_missing=False)
1248
class Provider(object):
1249
'''Generic class to be overriden by plugins'''
1251
def plugin_for_command(self, cmd_name):
1252
'''Takes a command and returns the information for that plugin
1254
:return: A dictionary with all the available information
1255
for the requested plugin
1257
raise NotImplementedError
1260
class ProvidersRegistry(registry.Registry):
1261
'''This registry exists to allow other providers to exist'''
1264
for key, provider in self.iteritems():
1267
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
