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)
186
builtin_command_registry.register_lazy('cmd_bundle_info',
188
'bzrlib.bundle.commands')
191
def _scan_module_for_commands(module):
193
for name, obj in module.__dict__.iteritems():
194
if name.startswith("cmd_"):
195
real_name = _unsquish_command_name(name)
200
def _list_bzr_commands(names):
201
"""Find commands from bzr's core and plugins.
203
This is not the public interface, just the default hook called by all_command_names.
205
# to eliminate duplicates
206
names.update(builtin_command_names())
207
names.update(plugin_command_names())
211
def all_command_names():
212
"""Return a set of all command names."""
214
for hook in Command.hooks['list_commands']:
217
raise AssertionError(
218
'hook %s returned None' % Command.hooks.get_hook_name(hook))
222
def builtin_command_names():
223
"""Return list of builtin command names.
225
Use of all_command_names() is encouraged rather than builtin_command_names
226
and/or plugin_command_names.
228
return builtin_command_registry.keys()
231
def plugin_command_names():
232
"""Returns command names from commands registered by plugins."""
233
return plugin_cmds.keys()
236
def get_cmd_object(cmd_name, plugins_override=True):
237
"""Return the command object for a command.
240
If true, plugin commands can override builtins.
243
return _get_cmd_object(cmd_name, plugins_override)
245
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
248
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
249
"""Get a command object.
251
:param cmd_name: The name of the command.
252
:param plugins_override: Allow plugins to override builtins.
253
:param check_missing: Look up commands not found in the regular index via
254
the get_missing_command hook.
255
:return: A Command object instance
256
:raises KeyError: If no command is found.
258
# We want only 'ascii' command names, but the user may have typed
259
# in a Unicode name. In that case, they should just get a
260
# 'command not found' error later.
261
# In the future, we may actually support Unicode command names.
264
for hook in Command.hooks['get_command']:
265
cmd = hook(cmd, cmd_name)
266
if cmd is not None and not plugins_override and not cmd.plugin_name():
267
# We've found a non-plugin command, don't permit it to be
270
if cmd is None and check_missing:
271
for hook in Command.hooks['get_missing_command']:
278
# Allow plugins to extend commands
279
for hook in Command.hooks['extend_command']:
284
def _try_plugin_provider(cmd_name):
285
"""Probe for a plugin provider having cmd_name."""
287
plugin_metadata, provider = probe_for_provider(cmd_name)
288
raise errors.CommandAvailableInPlugin(cmd_name,
289
plugin_metadata, provider)
290
except errors.NoPluginAvailable:
294
def probe_for_provider(cmd_name):
295
"""Look for a provider for cmd_name.
297
:param cmd_name: The command name.
298
:return: plugin_metadata, provider for getting cmd_name.
299
:raises NoPluginAvailable: When no provider can supply the plugin.
301
# look for providers that provide this command but aren't installed
302
for provider in command_providers_registry:
304
return provider.plugin_for_command(cmd_name), provider
305
except errors.NoPluginAvailable:
307
raise errors.NoPluginAvailable(cmd_name)
310
def _get_bzr_command(cmd_or_None, cmd_name):
311
"""Get a command from bzr's core."""
313
cmd_class = builtin_command_registry.get(cmd_name)
321
def _get_external_command(cmd_or_None, cmd_name):
322
"""Lookup a command that is a shell script."""
323
# Only do external command lookups when no command is found so far.
324
if cmd_or_None is not None:
326
from bzrlib.externalcommand import ExternalCommand
327
cmd_obj = ExternalCommand.find_command(cmd_name)
332
def _get_plugin_command(cmd_or_None, cmd_name):
333
"""Get a command from bzr's plugins."""
335
return plugin_cmds.get(cmd_name)()
338
for key in plugin_cmds.keys():
339
info = plugin_cmds.get_info(key)
340
if cmd_name in info.aliases:
341
return plugin_cmds.get(key)()
345
class Command(object):
346
"""Base class for commands.
348
Commands are the heart of the command-line bzr interface.
350
The command object mostly handles the mapping of command-line
351
parameters into one or more bzrlib operations, and of the results
354
Commands normally don't have any state. All their arguments are
355
passed in to the run method. (Subclasses may take a different
356
policy if the behaviour of the instance needs to depend on e.g. a
357
shell plugin and not just its Python class.)
359
The docstring for an actual command should give a single-line
360
summary, then a complete description of the command. A grammar
361
description will be inserted.
364
Other accepted names for this command.
367
List of argument forms, marked with whether they are optional,
372
['to_location', 'from_branch?', 'file*']
374
'to_location' is required
375
'from_branch' is optional
376
'file' can be specified 0 or more times
379
List of options that may be given for this command. These can
380
be either strings, referring to globally-defined options,
381
or option objects. Retrieve through options().
384
If true, this command isn't advertised. This is typically
385
for commands intended for expert users.
388
Command objects will get a 'outf' attribute, which has been
389
setup to properly handle encoding of unicode strings.
390
encoding_type determines what will happen when characters cannot
392
strict - abort if we cannot decode
393
replace - put in a bogus character (typically '?')
394
exact - do not encode sys.stdout
396
NOTE: by default on Windows, sys.stdout is opened as a text
397
stream, therefore LF line-endings are converted to CRLF.
398
When a command uses encoding_type = 'exact', then
399
sys.stdout is forced to be a binary stream, and line-endings
402
:cvar hooks: An instance of CommandHooks.
407
encoding_type = 'strict'
412
"""Construct an instance of this command."""
413
if self.__doc__ == Command.__doc__:
414
warn("No help message set for %r" % self)
415
# List of standard options directly supported
416
self.supported_std_options = []
417
self._operation = cleanup.OperationWithCleanups(self.run)
419
def add_cleanup(self, cleanup_func, *args, **kwargs):
420
"""Register a function to call after self.run returns or raises.
422
Functions will be called in LIFO order.
424
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
426
def cleanup_now(self):
427
"""Execute and empty pending cleanup functions immediately.
429
After cleanup_now all registered cleanups are forgotten. add_cleanup
430
may be called again after cleanup_now; these cleanups will be called
431
after self.run returns or raises (or when cleanup_now is next called).
433
This is useful for releasing expensive or contentious resources (such
434
as write locks) before doing further work that does not require those
435
resources (such as writing results to self.outf).
437
self._operation.cleanup_now()
439
@deprecated_method(deprecated_in((2, 1, 0)))
440
def _maybe_expand_globs(self, file_list):
441
"""Glob expand file_list if the platform does not do that itself.
443
Not used anymore, now that the bzr command-line parser globs on
446
:return: A possibly empty list of unicode paths.
448
Introduced in bzrlib 0.18.
453
"""Return single-line grammar for this command.
455
Only describes arguments, not options.
457
s = 'bzr ' + self.name() + ' '
458
for aname in self.takes_args:
459
aname = aname.upper()
460
if aname[-1] in ['$', '+']:
461
aname = aname[:-1] + '...'
462
elif aname[-1] == '?':
463
aname = '[' + aname[:-1] + ']'
464
elif aname[-1] == '*':
465
aname = '[' + aname[:-1] + '...]'
467
s = s[:-1] # remove last space
470
def get_help_text(self, additional_see_also=None, plain=True,
471
see_also_as_links=False, verbose=True):
472
"""Return a text string with help for this command.
474
:param additional_see_also: Additional help topics to be
476
:param plain: if False, raw help (reStructuredText) is
477
returned instead of plain text.
478
:param see_also_as_links: if True, convert items in 'See also'
479
list to internal links (used by bzr_man rstx generator)
480
:param verbose: if True, display the full help, otherwise
481
leave out the descriptive sections and just display
482
usage help (e.g. Purpose, Usage, Options) with a
483
message explaining how to obtain full help.
487
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
489
# Extract the summary (purpose) and sections out from the text
490
purpose,sections,order = self._get_help_parts(doc)
492
# If a custom usage section was provided, use it
493
if sections.has_key('Usage'):
494
usage = sections.pop('Usage')
496
usage = self._usage()
498
# The header is the purpose and usage
500
result += ':Purpose: %s\n' % purpose
501
if usage.find('\n') >= 0:
502
result += ':Usage:\n%s\n' % usage
504
result += ':Usage: %s\n' % usage
509
# XXX: optparse implicitly rewraps the help, and not always perfectly,
510
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
512
options = option.get_optparser(self.options()).format_option_help()
513
# XXX: According to the spec, ReST option lists actually don't support
514
# options like --1.9 so that causes syntax errors (in Sphinx at least).
515
# As that pattern always appears in the commands that break, we trap
516
# on that and then format that block of 'format' options as a literal
518
if not plain and options.find(' --1.9 ') != -1:
519
options = options.replace(' format:\n', ' format::\n\n', 1)
520
if options.startswith('Options:'):
521
result += ':' + options
522
elif options.startswith('options:'):
523
# Python 2.4 version of optparse
524
result += ':Options:' + options[len('options:'):]
530
# Add the description, indenting it 2 spaces
531
# to match the indentation of the options
532
if sections.has_key(None):
533
text = sections.pop(None)
534
text = '\n '.join(text.splitlines())
535
result += ':%s:\n %s\n\n' % ('Description',text)
537
# Add the custom sections (e.g. Examples). Note that there's no need
538
# to indent these as they must be indented already in the source.
541
if sections.has_key(label):
542
result += ':%s:\n%s\n' % (label,sections[label])
545
result += ("See bzr help %s for more details and examples.\n\n"
548
# Add the aliases, source (plug-in) and see also links, if any
550
result += ':Aliases: '
551
result += ', '.join(self.aliases) + '\n'
552
plugin_name = self.plugin_name()
553
if plugin_name is not None:
554
result += ':From: plugin "%s"\n' % plugin_name
555
see_also = self.get_see_also(additional_see_also)
557
if not plain and see_also_as_links:
559
for item in see_also:
561
# topics doesn't have an independent section
562
# so don't create a real link
563
see_also_links.append(item)
565
# Use a Sphinx link for this entry
566
link_text = ":doc:`%s <%s-help>`" % (item, item)
567
see_also_links.append(link_text)
568
see_also = see_also_links
569
result += ':See also: '
570
result += ', '.join(see_also) + '\n'
572
# If this will be rendered as plain text, convert it
574
import bzrlib.help_topics
575
result = bzrlib.help_topics.help_as_plain_text(result)
579
def _get_help_parts(text):
580
"""Split help text into a summary and named sections.
582
:return: (summary,sections,order) where summary is the top line and
583
sections is a dictionary of the rest indexed by section name.
584
order is the order the section appear in the text.
585
A section starts with a heading line of the form ":xxx:".
586
Indented text on following lines is the section value.
587
All text found outside a named section is assigned to the
588
default section which is given the key of None.
590
def save_section(sections, order, label, section):
592
if sections.has_key(label):
593
sections[label] += '\n' + section
596
sections[label] = section
598
lines = text.rstrip().splitlines()
599
summary = lines.pop(0)
602
label,section = None,''
604
if line.startswith(':') and line.endswith(':') and len(line) > 2:
605
save_section(sections, order, label, section)
606
label,section = line[1:-1],''
607
elif (label is not None) and len(line) > 1 and not line[0].isspace():
608
save_section(sections, order, label, section)
609
label,section = None,line
612
section += '\n' + line
615
save_section(sections, order, label, section)
616
return summary, sections, order
618
def get_help_topic(self):
619
"""Return the commands help topic - its name."""
622
def get_see_also(self, additional_terms=None):
623
"""Return a list of help topics that are related to this command.
625
The list is derived from the content of the _see_also attribute. Any
626
duplicates are removed and the result is in lexical order.
627
:param additional_terms: Additional help topics to cross-reference.
628
:return: A list of help topics.
630
see_also = set(getattr(self, '_see_also', []))
632
see_also.update(additional_terms)
633
return sorted(see_also)
636
"""Return dict of valid options for this command.
638
Maps from long option name to option object."""
639
r = Option.STD_OPTIONS.copy()
641
for o in self.takes_options:
642
if isinstance(o, basestring):
643
o = option.Option.OPTIONS[o]
645
if o.name in std_names:
646
self.supported_std_options.append(o.name)
649
def _setup_outf(self):
650
"""Return a file linked to stdout, which has proper encoding."""
651
self.outf = ui.ui_factory.make_output_stream(
652
encoding_type=self.encoding_type)
654
def run_argv_aliases(self, argv, alias_argv=None):
655
"""Parse the command line and run with extra aliases in alias_argv."""
656
args, opts = parse_args(self, argv, alias_argv)
658
# Process the standard options
659
if 'help' in opts: # e.g. bzr add --help
660
sys.stdout.write(self.get_help_text())
662
if 'usage' in opts: # e.g. bzr add --usage
663
sys.stdout.write(self.get_help_text(verbose=False))
665
trace.set_verbosity_level(option._verbosity_level)
666
if 'verbose' in self.supported_std_options:
667
opts['verbose'] = trace.is_verbose()
668
elif opts.has_key('verbose'):
670
if 'quiet' in self.supported_std_options:
671
opts['quiet'] = trace.is_quiet()
672
elif opts.has_key('quiet'):
675
# mix arguments and options into one dictionary
676
cmdargs = _match_argform(self.name(), self.takes_args, args)
678
for k, v in opts.items():
679
cmdopts[k.replace('-', '_')] = v
681
all_cmd_args = cmdargs.copy()
682
all_cmd_args.update(cmdopts)
686
return self.run_direct(**all_cmd_args)
688
def run_direct(self, *args, **kwargs):
689
"""Call run directly with objects (without parsing an argv list)."""
690
return self._operation.run_simple(*args, **kwargs)
693
"""Actually run the command.
695
This is invoked with the options and arguments bound to
698
Return 0 or None if the command was successful, or a non-zero
699
shell error code if not. It's OK for this method to allow
700
an exception to raise up.
702
raise NotImplementedError('no implementation of command %r'
706
"""Return help message for this class."""
707
from inspect import getdoc
708
if self.__doc__ is Command.__doc__:
713
return _unsquish_command_name(self.__class__.__name__)
715
def plugin_name(self):
716
"""Get the name of the plugin that provides this command.
718
:return: The name of the plugin or None if the command is builtin.
720
mod_parts = self.__module__.split('.')
721
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
727
class CommandHooks(Hooks):
728
"""Hooks related to Command object creation/enumeration."""
731
"""Create the default hooks.
733
These are all empty initially, because by default nothing should get
737
self.create_hook(HookPoint('extend_command',
738
"Called after creating a command object to allow modifications "
739
"such as adding or removing options, docs etc. Called with the "
740
"new bzrlib.commands.Command object.", (1, 13), None))
741
self.create_hook(HookPoint('get_command',
742
"Called when creating a single command. Called with "
743
"(cmd_or_None, command_name). get_command should either return "
744
"the cmd_or_None parameter, or a replacement Command object that "
745
"should be used for the command. Note that the Command.hooks "
746
"hooks are core infrastructure. Many users will prefer to use "
747
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
749
self.create_hook(HookPoint('get_missing_command',
750
"Called when creating a single command if no command could be "
751
"found. Called with (command_name). get_missing_command should "
752
"either return None, or a Command object to be used for the "
753
"command.", (1, 17), None))
754
self.create_hook(HookPoint('list_commands',
755
"Called when enumerating commands. Called with a set of "
756
"cmd_name strings for all the commands found so far. This set "
757
" is safe to mutate - e.g. to remove a command. "
758
"list_commands should return the updated set of command names.",
761
Command.hooks = CommandHooks()
764
def parse_args(command, argv, alias_argv=None):
765
"""Parse command line.
767
Arguments and options are parsed at this level before being passed
768
down to specific command handlers. This routine knows, from a
769
lookup table, something about the available options, what optargs
770
they take, and which commands will accept them.
772
# TODO: make it a method of the Command?
773
parser = option.get_optparser(command.options())
774
if alias_argv is not None:
775
args = alias_argv + argv
779
options, args = parser.parse_args(args)
780
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
781
v is not option.OptionParser.DEFAULT_VALUE])
785
def _match_argform(cmd, takes_args, args):
788
# step through args and takes_args, allowing appropriate 0-many matches
789
for ap in takes_args:
793
argdict[argname] = args.pop(0)
794
elif ap[-1] == '*': # all remaining arguments
796
argdict[argname + '_list'] = args[:]
799
argdict[argname + '_list'] = None
802
raise errors.BzrCommandError("command %r needs one or more %s"
803
% (cmd, argname.upper()))
805
argdict[argname + '_list'] = args[:]
807
elif ap[-1] == '$': # all but one
809
raise errors.BzrCommandError("command %r needs one or more %s"
810
% (cmd, argname.upper()))
811
argdict[argname + '_list'] = args[:-1]
817
raise errors.BzrCommandError("command %r requires argument %s"
818
% (cmd, argname.upper()))
820
argdict[argname] = args.pop(0)
823
raise errors.BzrCommandError("extra argument to command %s: %s"
828
def apply_coveraged(dirname, the_callable, *args, **kwargs):
829
# Cannot use "import trace", as that would import bzrlib.trace instead of
830
# the standard library's trace.
831
trace = __import__('trace')
833
tracer = trace.Trace(count=1, trace=0)
834
sys.settrace(tracer.globaltrace)
835
threading.settrace(tracer.globaltrace)
838
return exception_to_return_code(the_callable, *args, **kwargs)
841
results = tracer.results()
842
results.write_results(show_missing=1, summary=False,
846
def apply_profiled(the_callable, *args, **kwargs):
850
pffileno, pfname = tempfile.mkstemp()
852
prof = hotshot.Profile(pfname)
854
ret = prof.runcall(exception_to_return_code, the_callable, *args,
858
stats = hotshot.stats.load(pfname)
860
stats.sort_stats('cum') # 'time'
861
## XXX: Might like to write to stderr or the trace file instead but
862
## print_stats seems hardcoded to stdout
863
stats.print_stats(20)
870
def exception_to_return_code(the_callable, *args, **kwargs):
871
"""UI level helper for profiling and coverage.
873
This transforms exceptions into a return value of 3. As such its only
874
relevant to the UI layer, and should never be called where catching
875
exceptions may be desirable.
878
return the_callable(*args, **kwargs)
879
except (KeyboardInterrupt, Exception), e:
880
# used to handle AssertionError and KeyboardInterrupt
881
# specially here, but hopefully they're handled ok by the logger now
882
exc_info = sys.exc_info()
883
exitcode = trace.report_exception(exc_info, sys.stderr)
884
if os.environ.get('BZR_PDB'):
885
print '**** entering debugger'
888
if sys.version_info[:2] < (2, 6):
890
# pdb.post_mortem(tb)
891
# but because pdb.post_mortem gives bad results for tracebacks
892
# from inside generators, we do it manually.
893
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
895
# Setup pdb on the traceback
898
p.setup(tb.tb_frame, tb)
899
# Point the debugger at the deepest frame of the stack
900
p.curindex = len(p.stack) - 1
901
p.curframe = p.stack[p.curindex][0]
902
# Start the pdb prompt.
903
p.print_stack_entry(p.stack[p.curindex])
911
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
912
from bzrlib.lsprof import profile
913
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
919
trace.note('Profile data written to "%s".', filename)
923
@deprecated_function(deprecated_in((2, 2, 0)))
924
def shlex_split_unicode(unsplit):
925
return cmdline.split(unsplit)
928
def get_alias(cmd, config=None):
929
"""Return an expanded alias, or None if no alias exists.
932
Command to be checked for an alias.
934
Used to specify an alternative config to use,
935
which is especially useful for testing.
936
If it is unspecified, the global config will be used.
940
config = bzrlib.config.GlobalConfig()
941
alias = config.get_alias(cmd)
943
return cmdline.split(alias)
947
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
948
"""Execute a command.
950
:param argv: The command-line arguments, without the program name from
951
argv[0] These should already be decoded. All library/test code calling
952
run_bzr should be passing valid strings (don't need decoding).
953
:param load_plugins: What function to call when triggering plugin loading.
954
This function should take no arguments and cause all plugins to be
956
:param disable_plugins: What function to call when disabling plugin
957
loading. This function should take no arguments and cause all plugin
958
loading to be prohibited (so that code paths in your application that
959
know about some plugins possibly being present will fail to import
960
those plugins even if they are installed.)
961
:return: Returns a command exit code or raises an exception.
963
Special master options: these must come before the command because
964
they control how the command is interpreted.
967
Do not load plugin modules at all
973
Only use builtin commands. (Plugins are still allowed to change
977
Run under the Python hotshot profiler.
980
Run under the Python lsprof profiler.
983
Generate line coverage report in the specified directory.
986
Specify the number of processes that can be run concurrently (selftest).
988
trace.mutter("bazaar version: " + bzrlib.__version__)
990
trace.mutter("bzr arguments: %r", argv)
992
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
993
opt_no_aliases = False
994
opt_lsprof_file = opt_coverage_dir = None
996
# --no-plugins is handled specially at a very early stage. We need
997
# to load plugins before doing other command parsing so that they
998
# can override commands, but this needs to happen first.
1002
while i < len(argv):
1004
if a == '--profile':
1006
elif a == '--lsprof':
1008
elif a == '--lsprof-file':
1010
opt_lsprof_file = argv[i + 1]
1012
elif a == '--no-plugins':
1013
opt_no_plugins = True
1014
elif a == '--no-aliases':
1015
opt_no_aliases = True
1016
elif a == '--builtin':
1018
elif a == '--concurrency':
1019
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1021
elif a == '--coverage':
1022
opt_coverage_dir = argv[i + 1]
1024
elif a.startswith('-D'):
1025
debug.debug_flags.add(a[2:])
1030
debug.set_debug_flags_from_config()
1032
if not opt_no_plugins:
1039
get_cmd_object('help').run_argv_aliases([])
1042
if argv[0] == '--version':
1043
get_cmd_object('version').run_argv_aliases([])
1048
if not opt_no_aliases:
1049
alias_argv = get_alias(argv[0])
1051
user_encoding = osutils.get_user_encoding()
1052
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1053
argv[0] = alias_argv.pop(0)
1056
# We want only 'ascii' command names, but the user may have typed
1057
# in a Unicode name. In that case, they should just get a
1058
# 'command not found' error later.
1060
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1061
run = cmd_obj.run_argv_aliases
1062
run_argv = [argv, alias_argv]
1065
# We can be called recursively (tests for example), but we don't want
1066
# the verbosity level to propagate.
1067
saved_verbosity_level = option._verbosity_level
1068
option._verbosity_level = 0
1070
if opt_coverage_dir:
1072
'--coverage ignored, because --lsprof is in use.')
1073
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1075
if opt_coverage_dir:
1077
'--coverage ignored, because --profile is in use.')
1078
ret = apply_profiled(run, *run_argv)
1079
elif opt_coverage_dir:
1080
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1082
ret = run(*run_argv)
1085
# reset, in case we may do other commands later within the same
1086
# process. Commands that want to execute sub-commands must propagate
1087
# --verbose in their own way.
1088
if 'memory' in debug.debug_flags:
1089
trace.debug_memory('Process status after command:', short=False)
1090
option._verbosity_level = saved_verbosity_level
1093
def display_command(func):
1094
"""Decorator that suppresses pipe/interrupt errors."""
1095
def ignore_pipe(*args, **kwargs):
1097
result = func(*args, **kwargs)
1101
if getattr(e, 'errno', None) is None:
1103
if e.errno != errno.EPIPE:
1104
# Win32 raises IOError with errno=0 on a broken pipe
1105
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1108
except KeyboardInterrupt:
1113
def install_bzr_command_hooks():
1114
"""Install the hooks to supply bzr's own commands."""
1115
if _list_bzr_commands in Command.hooks["list_commands"]:
1117
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1119
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1121
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1122
"bzr plugin commands")
1123
Command.hooks.install_named_hook("get_command", _get_external_command,
1124
"bzr external command lookup")
1125
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1126
"bzr plugin-provider-db check")
1130
def _specified_or_unicode_argv(argv):
1131
# For internal or testing use, argv can be passed. Otherwise, get it from
1132
# the process arguments in a unicode-safe way.
1134
return osutils.get_unicode_argv()
1138
# ensure all arguments are unicode strings
1140
if isinstance(a, unicode):
1143
new_argv.append(a.decode('ascii'))
1144
except UnicodeDecodeError:
1145
raise errors.BzrError("argv should be list of unicode strings.")
1149
def main(argv=None):
1150
"""Main entry point of command-line interface.
1152
Typically `bzrlib.initialize` should be called first.
1154
:param argv: list of unicode command-line arguments similar to sys.argv.
1155
argv[0] is script name usually, it will be ignored.
1156
Don't pass here sys.argv because this list contains plain strings
1157
and not unicode; pass None instead.
1159
:return: exit code of bzr command.
1161
argv = _specified_or_unicode_argv(argv)
1162
_register_builtin_commands()
1163
ret = run_bzr_catch_errors(argv)
1164
bzrlib.ui.ui_factory.log_transport_activity(
1165
display=('bytes' in debug.debug_flags))
1166
trace.mutter("return code %d", ret)
1170
def run_bzr_catch_errors(argv):
1171
"""Run a bzr command with parameters as described by argv.
1173
This function assumed that that UI layer is setup, that symbol deprecations
1174
are already applied, and that unicode decoding has already been performed on argv.
1176
# done here so that they're covered for every test run
1177
install_bzr_command_hooks()
1178
return exception_to_return_code(run_bzr, argv)
1181
def run_bzr_catch_user_errors(argv):
1182
"""Run bzr and report user errors, but let internal errors propagate.
1184
This is used for the test suite, and might be useful for other programs
1185
that want to wrap the commandline interface.
1187
# done here so that they're covered for every test run
1188
install_bzr_command_hooks()
1190
return run_bzr(argv)
1191
except Exception, e:
1192
if (isinstance(e, (OSError, IOError))
1193
or not getattr(e, 'internal_error', True)):
1194
trace.report_exception(sys.exc_info(), sys.stderr)
1200
class HelpCommandIndex(object):
1201
"""A index for bzr help that returns commands."""
1204
self.prefix = 'commands/'
1206
def get_topics(self, topic):
1207
"""Search for topic amongst commands.
1209
:param topic: A topic to search for.
1210
:return: A list which is either empty or contains a single
1213
if topic and topic.startswith(self.prefix):
1214
topic = topic[len(self.prefix):]
1216
cmd = _get_cmd_object(topic, check_missing=False)
1223
class Provider(object):
1224
'''Generic class to be overriden by plugins'''
1226
def plugin_for_command(self, cmd_name):
1227
'''Takes a command and returns the information for that plugin
1229
:return: A dictionary with all the available information
1230
for the requested plugin
1232
raise NotImplementedError
1235
class ProvidersRegistry(registry.Registry):
1236
'''This registry exists to allow other providers to exist'''
1239
for key, provider in self.iteritems():
1242
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
