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: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Define arguments by objects, rather than just using names.
22
# Those objects can specify the expected type of the argument, which
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
39
from warnings import warn
54
from bzrlib.hooks import HookPoint, Hooks
55
# Compatibility - Option used to be in commands.
56
from bzrlib.option import Option
57
from bzrlib import registry
58
from bzrlib.symbol_versioning import (
65
class CommandInfo(object):
66
"""Information about a command."""
68
def __init__(self, aliases):
69
"""The list of aliases for the command."""
70
self.aliases = aliases
73
def from_command(klass, command):
74
"""Factory to construct a CommandInfo from a command."""
75
return klass(command.aliases)
78
class CommandRegistry(registry.Registry):
81
def _get_name(command_name):
82
if command_name.startswith("cmd_"):
83
return _unsquish_command_name(command_name)
87
def register(self, cmd, decorate=False):
88
"""Utility function to help register a command
90
:param cmd: Command subclass to register
91
:param decorate: If true, allow overriding an existing command
92
of the same name; the old command is returned by this function.
93
Otherwise it is an error to try to override an existing command.
96
k_unsquished = self._get_name(k)
98
previous = self.get(k_unsquished)
100
previous = _builtin_commands().get(k_unsquished)
101
info = CommandInfo.from_command(cmd)
103
registry.Registry.register(self, k_unsquished, cmd,
104
override_existing=decorate, info=info)
106
trace.warning('Two plugins defined the same command: %r' % k)
107
trace.warning('Not loading the one in %r' %
108
sys.modules[cmd.__module__])
109
trace.warning('Previously this command was registered from %r' %
110
sys.modules[previous.__module__])
113
def register_lazy(self, command_name, aliases, module_name):
114
"""Register a command without loading its module.
116
:param command_name: The primary name of the command.
117
:param aliases: A list of aliases for the command.
118
:module_name: The module that the command lives in.
120
key = self._get_name(command_name)
121
registry.Registry.register_lazy(self, key, module_name, command_name,
122
info=CommandInfo(aliases))
125
plugin_cmds = CommandRegistry()
128
def register_command(cmd, decorate=False):
130
return plugin_cmds.register(cmd, decorate)
133
def _squish_command_name(cmd):
134
return 'cmd_' + cmd.replace('-', '_')
137
def _unsquish_command_name(cmd):
138
return cmd[4:].replace('_','-')
141
def _builtin_commands():
142
import bzrlib.builtins
143
return _scan_module_for_commands(bzrlib.builtins)
146
def _scan_module_for_commands(module):
148
for name, obj in module.__dict__.iteritems():
149
if name.startswith("cmd_"):
150
real_name = _unsquish_command_name(name)
155
def _list_bzr_commands(names):
156
"""Find commands from bzr's core and plugins."""
157
# to eliminate duplicates
158
names.update(builtin_command_names())
159
names.update(plugin_command_names())
163
def all_command_names():
164
"""Return a set of all command names."""
166
for hook in Command.hooks['list_commands']:
169
raise AssertionError(
170
'hook %s returned None' % Command.hooks.get_hook_name(hook))
174
def builtin_command_names():
175
"""Return list of builtin command names.
177
Use of all_command_names() is encouraged rather than builtin_command_names
178
and/or plugin_command_names.
180
return _builtin_commands().keys()
183
def plugin_command_names():
184
"""Returns command names from commands registered by plugins."""
185
return plugin_cmds.keys()
188
def get_cmd_object(cmd_name, plugins_override=True):
189
"""Return the command object for a command.
192
If true, plugin commands can override builtins.
195
return _get_cmd_object(cmd_name, plugins_override)
197
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
200
def _get_cmd_object(cmd_name, plugins_override=True):
201
"""Get a command object.
203
:param cmd_name: The name of the command.
204
:param plugins_override: Allow plugins to override builtins.
205
:return: A Command object instance
206
:raises KeyError: If no command is found.
208
# We want only 'ascii' command names, but the user may have typed
209
# in a Unicode name. In that case, they should just get a
210
# 'command not found' error later.
211
# In the future, we may actually support Unicode command names.
214
for hook in Command.hooks['get_command']:
215
cmd = hook(cmd, cmd_name)
216
if cmd is not None and not plugins_override and not cmd.plugin_name():
217
# We've found a non-plugin command, don't permit it to be
221
for hook in Command.hooks['get_missing_command']:
228
# Allow plugins to extend commands
229
for hook in Command.hooks['extend_command']:
234
def _try_plugin_provider(cmd_name):
235
"""Probe for a plugin provider having cmd_name."""
237
plugin_metadata, provider = probe_for_provider(cmd_name)
238
raise errors.CommandAvailableInPlugin(cmd_name,
239
plugin_metadata, provider)
240
except errors.NoPluginAvailable:
244
def probe_for_provider(cmd_name):
245
"""Look for a provider for cmd_name.
247
:param cmd_name: The command name.
248
:return: plugin_metadata, provider for getting cmd_name.
249
:raises NoPluginAvailable: When no provider can supply the plugin.
251
# look for providers that provide this command but aren't installed
252
for provider in command_providers_registry:
254
return provider.plugin_for_command(cmd_name), provider
255
except errors.NoPluginAvailable:
257
raise errors.NoPluginAvailable(cmd_name)
260
def _get_bzr_command(cmd_or_None, cmd_name):
261
"""Get a command from bzr's core."""
262
cmds = _builtin_commands()
264
return cmds[cmd_name]()
267
# look for any command which claims this as an alias
268
for real_cmd_name, cmd_class in cmds.iteritems():
269
if cmd_name in cmd_class.aliases:
274
def _get_external_command(cmd_or_None, cmd_name):
275
"""Lookup a command that is a shell script."""
276
# Only do external command lookups when no command is found so far.
277
if cmd_or_None is not None:
279
from bzrlib.externalcommand import ExternalCommand
280
cmd_obj = ExternalCommand.find_command(cmd_name)
285
def _get_plugin_command(cmd_or_None, cmd_name):
286
"""Get a command from bzr's plugins."""
288
return plugin_cmds.get(cmd_name)()
291
for key in plugin_cmds.keys():
292
info = plugin_cmds.get_info(key)
293
if cmd_name in info.aliases:
294
return plugin_cmds.get(key)()
298
class Command(object):
299
"""Base class for commands.
301
Commands are the heart of the command-line bzr interface.
303
The command object mostly handles the mapping of command-line
304
parameters into one or more bzrlib operations, and of the results
307
Commands normally don't have any state. All their arguments are
308
passed in to the run method. (Subclasses may take a different
309
policy if the behaviour of the instance needs to depend on e.g. a
310
shell plugin and not just its Python class.)
312
The docstring for an actual command should give a single-line
313
summary, then a complete description of the command. A grammar
314
description will be inserted.
317
Other accepted names for this command.
320
List of argument forms, marked with whether they are optional,
325
['to_location', 'from_branch?', 'file*']
327
'to_location' is required
328
'from_branch' is optional
329
'file' can be specified 0 or more times
332
List of options that may be given for this command. These can
333
be either strings, referring to globally-defined options,
334
or option objects. Retrieve through options().
337
If true, this command isn't advertised. This is typically
338
for commands intended for expert users.
341
Command objects will get a 'outf' attribute, which has been
342
setup to properly handle encoding of unicode strings.
343
encoding_type determines what will happen when characters cannot
345
strict - abort if we cannot decode
346
replace - put in a bogus character (typically '?')
347
exact - do not encode sys.stdout
349
NOTE: by default on Windows, sys.stdout is opened as a text
350
stream, therefore LF line-endings are converted to CRLF.
351
When a command uses encoding_type = 'exact', then
352
sys.stdout is forced to be a binary stream, and line-endings
355
:cvar hooks: An instance of CommandHooks.
360
encoding_type = 'strict'
365
"""Construct an instance of this command."""
366
if self.__doc__ == Command.__doc__:
367
warn("No help message set for %r" % self)
368
# List of standard options directly supported
369
self.supported_std_options = []
370
self._operation = cleanup.OperationWithCleanups(self.run)
372
def add_cleanup(self, cleanup_func, *args, **kwargs):
373
"""Register a function to call after self.run returns or raises.
375
Functions will be called in LIFO order.
377
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
379
def cleanup_now(self):
380
"""Execute and empty pending cleanup functions immediately.
382
After cleanup_now all registered cleanups are forgotten. add_cleanup
383
may be called again after cleanup_now; these cleanups will be called
384
after self.run returns or raises (or when cleanup_now is next called).
386
This is useful for releasing expensive or contentious resources (such
387
as write locks) before doing further work that does not require those
388
resources (such as writing results to self.outf).
390
self._operation.cleanup_now()
392
@deprecated_method(deprecated_in((2, 1, 0)))
393
def _maybe_expand_globs(self, file_list):
394
"""Glob expand file_list if the platform does not do that itself.
396
Not used anymore, now that the bzr command-line parser globs on
399
:return: A possibly empty list of unicode paths.
401
Introduced in bzrlib 0.18.
406
"""Return single-line grammar for this command.
408
Only describes arguments, not options.
410
s = 'bzr ' + self.name() + ' '
411
for aname in self.takes_args:
412
aname = aname.upper()
413
if aname[-1] in ['$', '+']:
414
aname = aname[:-1] + '...'
415
elif aname[-1] == '?':
416
aname = '[' + aname[:-1] + ']'
417
elif aname[-1] == '*':
418
aname = '[' + aname[:-1] + '...]'
420
s = s[:-1] # remove last space
423
def get_help_text(self, additional_see_also=None, plain=True,
424
see_also_as_links=False, verbose=True):
425
"""Return a text string with help for this command.
427
:param additional_see_also: Additional help topics to be
429
:param plain: if False, raw help (reStructuredText) is
430
returned instead of plain text.
431
:param see_also_as_links: if True, convert items in 'See also'
432
list to internal links (used by bzr_man rstx generator)
433
:param verbose: if True, display the full help, otherwise
434
leave out the descriptive sections and just display
435
usage help (e.g. Purpose, Usage, Options) with a
436
message explaining how to obtain full help.
440
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
442
# Extract the summary (purpose) and sections out from the text
443
purpose,sections,order = self._get_help_parts(doc)
445
# If a custom usage section was provided, use it
446
if sections.has_key('Usage'):
447
usage = sections.pop('Usage')
449
usage = self._usage()
451
# The header is the purpose and usage
453
result += ':Purpose: %s\n' % purpose
454
if usage.find('\n') >= 0:
455
result += ':Usage:\n%s\n' % usage
457
result += ':Usage: %s\n' % usage
462
# XXX: optparse implicitly rewraps the help, and not always perfectly,
463
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
465
options = option.get_optparser(self.options()).format_option_help()
466
# XXX: According to the spec, ReST option lists actually don't support
467
# options like --1.9 so that causes syntax errors (in Sphinx at least).
468
# As that pattern always appears in the commands that break, we trap
469
# on that and then format that block of 'format' options as a literal
471
if not plain and options.find(' --1.9 ') != -1:
472
options = options.replace(' format:\n', ' format::\n\n', 1)
473
if options.startswith('Options:'):
474
result += ':' + options
475
elif options.startswith('options:'):
476
# Python 2.4 version of optparse
477
result += ':Options:' + options[len('options:'):]
483
# Add the description, indenting it 2 spaces
484
# to match the indentation of the options
485
if sections.has_key(None):
486
text = sections.pop(None)
487
text = '\n '.join(text.splitlines())
488
result += ':%s:\n %s\n\n' % ('Description',text)
490
# Add the custom sections (e.g. Examples). Note that there's no need
491
# to indent these as they must be indented already in the source.
494
if sections.has_key(label):
495
result += ':%s:\n%s\n' % (label,sections[label])
498
result += ("See bzr help %s for more details and examples.\n\n"
501
# Add the aliases, source (plug-in) and see also links, if any
503
result += ':Aliases: '
504
result += ', '.join(self.aliases) + '\n'
505
plugin_name = self.plugin_name()
506
if plugin_name is not None:
507
result += ':From: plugin "%s"\n' % plugin_name
508
see_also = self.get_see_also(additional_see_also)
510
if not plain and see_also_as_links:
512
for item in see_also:
514
# topics doesn't have an independent section
515
# so don't create a real link
516
see_also_links.append(item)
518
# Use a Sphinx link for this entry
519
link_text = ":doc:`%s <%s-help>`" % (item, item)
520
see_also_links.append(link_text)
521
see_also = see_also_links
522
result += ':See also: '
523
result += ', '.join(see_also) + '\n'
525
# If this will be rendered as plain text, convert it
527
import bzrlib.help_topics
528
result = bzrlib.help_topics.help_as_plain_text(result)
532
def _get_help_parts(text):
533
"""Split help text into a summary and named sections.
535
:return: (summary,sections,order) where summary is the top line and
536
sections is a dictionary of the rest indexed by section name.
537
order is the order the section appear in the text.
538
A section starts with a heading line of the form ":xxx:".
539
Indented text on following lines is the section value.
540
All text found outside a named section is assigned to the
541
default section which is given the key of None.
543
def save_section(sections, order, label, section):
545
if sections.has_key(label):
546
sections[label] += '\n' + section
549
sections[label] = section
551
lines = text.rstrip().splitlines()
552
summary = lines.pop(0)
555
label,section = None,''
557
if line.startswith(':') and line.endswith(':') and len(line) > 2:
558
save_section(sections, order, label, section)
559
label,section = line[1:-1],''
560
elif (label is not None) and len(line) > 1 and not line[0].isspace():
561
save_section(sections, order, label, section)
562
label,section = None,line
565
section += '\n' + line
568
save_section(sections, order, label, section)
569
return summary, sections, order
571
def get_help_topic(self):
572
"""Return the commands help topic - its name."""
575
def get_see_also(self, additional_terms=None):
576
"""Return a list of help topics that are related to this command.
578
The list is derived from the content of the _see_also attribute. Any
579
duplicates are removed and the result is in lexical order.
580
:param additional_terms: Additional help topics to cross-reference.
581
:return: A list of help topics.
583
see_also = set(getattr(self, '_see_also', []))
585
see_also.update(additional_terms)
586
return sorted(see_also)
589
"""Return dict of valid options for this command.
591
Maps from long option name to option object."""
592
r = Option.STD_OPTIONS.copy()
594
for o in self.takes_options:
595
if isinstance(o, basestring):
596
o = option.Option.OPTIONS[o]
598
if o.name in std_names:
599
self.supported_std_options.append(o.name)
602
def _setup_outf(self):
603
"""Return a file linked to stdout, which has proper encoding."""
604
self.outf = ui.ui_factory.make_output_stream(
605
encoding_type=self.encoding_type)
607
def run_argv_aliases(self, argv, alias_argv=None):
608
"""Parse the command line and run with extra aliases in alias_argv."""
609
args, opts = parse_args(self, argv, alias_argv)
611
# Process the standard options
612
if 'help' in opts: # e.g. bzr add --help
613
sys.stdout.write(self.get_help_text())
615
if 'usage' in opts: # e.g. bzr add --usage
616
sys.stdout.write(self.get_help_text(verbose=False))
618
trace.set_verbosity_level(option._verbosity_level)
619
if 'verbose' in self.supported_std_options:
620
opts['verbose'] = trace.is_verbose()
621
elif opts.has_key('verbose'):
623
if 'quiet' in self.supported_std_options:
624
opts['quiet'] = trace.is_quiet()
625
elif opts.has_key('quiet'):
628
# mix arguments and options into one dictionary
629
cmdargs = _match_argform(self.name(), self.takes_args, args)
631
for k, v in opts.items():
632
cmdopts[k.replace('-', '_')] = v
634
all_cmd_args = cmdargs.copy()
635
all_cmd_args.update(cmdopts)
639
return self.run_direct(**all_cmd_args)
641
def run_direct(self, *args, **kwargs):
642
"""Call run directly with objects (without parsing an argv list)."""
643
return self._operation.run_simple(*args, **kwargs)
646
"""Actually run the command.
648
This is invoked with the options and arguments bound to
651
Return 0 or None if the command was successful, or a non-zero
652
shell error code if not. It's OK for this method to allow
653
an exception to raise up.
655
raise NotImplementedError('no implementation of command %r'
659
"""Return help message for this class."""
660
from inspect import getdoc
661
if self.__doc__ is Command.__doc__:
666
return _unsquish_command_name(self.__class__.__name__)
668
def plugin_name(self):
669
"""Get the name of the plugin that provides this command.
671
:return: The name of the plugin or None if the command is builtin.
673
mod_parts = self.__module__.split('.')
674
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
680
class CommandHooks(Hooks):
681
"""Hooks related to Command object creation/enumeration."""
684
"""Create the default hooks.
686
These are all empty initially, because by default nothing should get
690
self.create_hook(HookPoint('extend_command',
691
"Called after creating a command object to allow modifications "
692
"such as adding or removing options, docs etc. Called with the "
693
"new bzrlib.commands.Command object.", (1, 13), None))
694
self.create_hook(HookPoint('get_command',
695
"Called when creating a single command. Called with "
696
"(cmd_or_None, command_name). get_command should either return "
697
"the cmd_or_None parameter, or a replacement Command object that "
698
"should be used for the command. Note that the Command.hooks "
699
"hooks are core infrastructure. Many users will prefer to use "
700
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
702
self.create_hook(HookPoint('get_missing_command',
703
"Called when creating a single command if no command could be "
704
"found. Called with (command_name). get_missing_command should "
705
"either return None, or a Command object to be used for the "
706
"command.", (1, 17), None))
707
self.create_hook(HookPoint('list_commands',
708
"Called when enumerating commands. Called with a set of "
709
"cmd_name strings for all the commands found so far. This set "
710
" is safe to mutate - e.g. to remove a command. "
711
"list_commands should return the updated set of command names.",
714
Command.hooks = CommandHooks()
717
def parse_args(command, argv, alias_argv=None):
718
"""Parse command line.
720
Arguments and options are parsed at this level before being passed
721
down to specific command handlers. This routine knows, from a
722
lookup table, something about the available options, what optargs
723
they take, and which commands will accept them.
725
# TODO: make it a method of the Command?
726
parser = option.get_optparser(command.options())
727
if alias_argv is not None:
728
args = alias_argv + argv
732
options, args = parser.parse_args(args)
733
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
734
v is not option.OptionParser.DEFAULT_VALUE])
738
def _match_argform(cmd, takes_args, args):
741
# step through args and takes_args, allowing appropriate 0-many matches
742
for ap in takes_args:
746
argdict[argname] = args.pop(0)
747
elif ap[-1] == '*': # all remaining arguments
749
argdict[argname + '_list'] = args[:]
752
argdict[argname + '_list'] = None
755
raise errors.BzrCommandError("command %r needs one or more %s"
756
% (cmd, argname.upper()))
758
argdict[argname + '_list'] = args[:]
760
elif ap[-1] == '$': # all but one
762
raise errors.BzrCommandError("command %r needs one or more %s"
763
% (cmd, argname.upper()))
764
argdict[argname + '_list'] = args[:-1]
770
raise errors.BzrCommandError("command %r requires argument %s"
771
% (cmd, argname.upper()))
773
argdict[argname] = args.pop(0)
776
raise errors.BzrCommandError("extra argument to command %s: %s"
781
def apply_coveraged(dirname, the_callable, *args, **kwargs):
782
# Cannot use "import trace", as that would import bzrlib.trace instead of
783
# the standard library's trace.
784
trace = __import__('trace')
786
tracer = trace.Trace(count=1, trace=0)
787
sys.settrace(tracer.globaltrace)
788
threading.settrace(tracer.globaltrace)
791
return exception_to_return_code(the_callable, *args, **kwargs)
794
results = tracer.results()
795
results.write_results(show_missing=1, summary=False,
799
def apply_profiled(the_callable, *args, **kwargs):
803
pffileno, pfname = tempfile.mkstemp()
805
prof = hotshot.Profile(pfname)
807
ret = prof.runcall(exception_to_return_code, the_callable, *args,
811
stats = hotshot.stats.load(pfname)
813
stats.sort_stats('cum') # 'time'
814
## XXX: Might like to write to stderr or the trace file instead but
815
## print_stats seems hardcoded to stdout
816
stats.print_stats(20)
823
def exception_to_return_code(the_callable, *args, **kwargs):
824
"""UI level helper for profiling and coverage.
826
This transforms exceptions into a return value of 3. As such its only
827
relevant to the UI layer, and should never be called where catching
828
exceptions may be desirable.
831
return the_callable(*args, **kwargs)
832
except (KeyboardInterrupt, Exception), e:
833
# used to handle AssertionError and KeyboardInterrupt
834
# specially here, but hopefully they're handled ok by the logger now
835
exc_info = sys.exc_info()
836
exitcode = trace.report_exception(exc_info, sys.stderr)
837
if os.environ.get('BZR_PDB'):
838
print '**** entering debugger'
841
if sys.version_info[:2] < (2, 6):
843
# pdb.post_mortem(tb)
844
# but because pdb.post_mortem gives bad results for tracebacks
845
# from inside generators, we do it manually.
846
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
848
# Setup pdb on the traceback
851
p.setup(tb.tb_frame, tb)
852
# Point the debugger at the deepest frame of the stack
853
p.curindex = len(p.stack) - 1
854
p.curframe = p.stack[p.curindex][0]
855
# Start the pdb prompt.
856
p.print_stack_entry(p.stack[p.curindex])
864
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
865
from bzrlib.lsprof import profile
866
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
872
trace.note('Profile data written to "%s".', filename)
876
def shlex_split_unicode(unsplit):
878
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
881
def get_alias(cmd, config=None):
882
"""Return an expanded alias, or None if no alias exists.
885
Command to be checked for an alias.
887
Used to specify an alternative config to use,
888
which is especially useful for testing.
889
If it is unspecified, the global config will be used.
893
config = bzrlib.config.GlobalConfig()
894
alias = config.get_alias(cmd)
896
return shlex_split_unicode(alias)
901
"""Execute a command.
904
The command-line arguments, without the program name from argv[0]
905
These should already be decoded. All library/test code calling
906
run_bzr should be passing valid strings (don't need decoding).
908
Returns a command status or raises an exception.
910
Special master options: these must come before the command because
911
they control how the command is interpreted.
914
Do not load plugin modules at all
920
Only use builtin commands. (Plugins are still allowed to change
924
Run under the Python hotshot profiler.
927
Run under the Python lsprof profiler.
930
Generate line coverage report in the specified directory.
933
Specify the number of processes that can be run concurrently (selftest).
935
trace.mutter("bazaar version: " + bzrlib.__version__)
937
trace.mutter("bzr arguments: %r", argv)
939
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
940
opt_no_aliases = False
941
opt_lsprof_file = opt_coverage_dir = None
943
# --no-plugins is handled specially at a very early stage. We need
944
# to load plugins before doing other command parsing so that they
945
# can override commands, but this needs to happen first.
953
elif a == '--lsprof':
955
elif a == '--lsprof-file':
957
opt_lsprof_file = argv[i + 1]
959
elif a == '--no-plugins':
960
opt_no_plugins = True
961
elif a == '--no-aliases':
962
opt_no_aliases = True
963
elif a == '--builtin':
965
elif a == '--concurrency':
966
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
968
elif a == '--coverage':
969
opt_coverage_dir = argv[i + 1]
971
elif a.startswith('-D'):
972
debug.debug_flags.add(a[2:])
977
debug.set_debug_flags_from_config()
981
from bzrlib.builtins import cmd_help
982
cmd_help().run_argv_aliases([])
985
if argv[0] == '--version':
986
from bzrlib.builtins import cmd_version
987
cmd_version().run_argv_aliases([])
990
if not opt_no_plugins:
991
from bzrlib.plugin import load_plugins
994
from bzrlib.plugin import disable_plugins
999
if not opt_no_aliases:
1000
alias_argv = get_alias(argv[0])
1002
user_encoding = osutils.get_user_encoding()
1003
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1004
argv[0] = alias_argv.pop(0)
1007
# We want only 'ascii' command names, but the user may have typed
1008
# in a Unicode name. In that case, they should just get a
1009
# 'command not found' error later.
1011
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1012
run = cmd_obj.run_argv_aliases
1013
run_argv = [argv, alias_argv]
1016
# We can be called recursively (tests for example), but we don't want
1017
# the verbosity level to propagate.
1018
saved_verbosity_level = option._verbosity_level
1019
option._verbosity_level = 0
1021
if opt_coverage_dir:
1023
'--coverage ignored, because --lsprof is in use.')
1024
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1026
if opt_coverage_dir:
1028
'--coverage ignored, because --profile is in use.')
1029
ret = apply_profiled(run, *run_argv)
1030
elif opt_coverage_dir:
1031
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1033
ret = run(*run_argv)
1036
# reset, in case we may do other commands later within the same
1037
# process. Commands that want to execute sub-commands must propagate
1038
# --verbose in their own way.
1039
if 'memory' in debug.debug_flags:
1040
trace.debug_memory('Process status after command:', short=False)
1041
option._verbosity_level = saved_verbosity_level
1044
def display_command(func):
1045
"""Decorator that suppresses pipe/interrupt errors."""
1046
def ignore_pipe(*args, **kwargs):
1048
result = func(*args, **kwargs)
1052
if getattr(e, 'errno', None) is None:
1054
if e.errno != errno.EPIPE:
1055
# Win32 raises IOError with errno=0 on a broken pipe
1056
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1059
except KeyboardInterrupt:
1064
def install_bzr_command_hooks():
1065
"""Install the hooks to supply bzr's own commands."""
1066
if _list_bzr_commands in Command.hooks["list_commands"]:
1068
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1070
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1072
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1073
"bzr plugin commands")
1074
Command.hooks.install_named_hook("get_command", _get_external_command,
1075
"bzr external command lookup")
1076
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1077
"bzr plugin-provider-db check")
1081
def _specified_or_unicode_argv(argv):
1082
# For internal or testing use, argv can be passed. Otherwise, get it from
1083
# the process arguments in a unicode-safe way.
1085
return osutils.get_unicode_argv()
1089
# ensure all arguments are unicode strings
1091
if isinstance(a, unicode):
1094
new_argv.append(a.decode('ascii'))
1095
except UnicodeDecodeError:
1096
raise errors.BzrError("argv should be list of unicode strings.")
1100
def main(argv=None):
1101
"""Main entry point of command-line interface.
1103
Typically `bzrlib.initialize` should be called first.
1105
:param argv: list of unicode command-line arguments similar to sys.argv.
1106
argv[0] is script name usually, it will be ignored.
1107
Don't pass here sys.argv because this list contains plain strings
1108
and not unicode; pass None instead.
1110
:return: exit code of bzr command.
1112
argv = _specified_or_unicode_argv(argv)
1113
ret = run_bzr_catch_errors(argv)
1114
bzrlib.ui.ui_factory.log_transport_activity(
1115
display=('bytes' in debug.debug_flags))
1116
trace.mutter("return code %d", ret)
1120
def run_bzr_catch_errors(argv):
1121
"""Run a bzr command with parameters as described by argv.
1123
This function assumed that that UI layer is setup, that symbol deprecations
1124
are already applied, and that unicode decoding has already been performed on argv.
1126
# done here so that they're covered for every test run
1127
install_bzr_command_hooks()
1128
return exception_to_return_code(run_bzr, argv)
1131
def run_bzr_catch_user_errors(argv):
1132
"""Run bzr and report user errors, but let internal errors propagate.
1134
This is used for the test suite, and might be useful for other programs
1135
that want to wrap the commandline interface.
1137
# done here so that they're covered for every test run
1138
install_bzr_command_hooks()
1140
return run_bzr(argv)
1141
except Exception, e:
1142
if (isinstance(e, (OSError, IOError))
1143
or not getattr(e, 'internal_error', True)):
1144
trace.report_exception(sys.exc_info(), sys.stderr)
1150
class HelpCommandIndex(object):
1151
"""A index for bzr help that returns commands."""
1154
self.prefix = 'commands/'
1156
def get_topics(self, topic):
1157
"""Search for topic amongst commands.
1159
:param topic: A topic to search for.
1160
:return: A list which is either empty or contains a single
1163
if topic and topic.startswith(self.prefix):
1164
topic = topic[len(self.prefix):]
1166
cmd = _get_cmd_object(topic)
1173
class Provider(object):
1174
'''Generic class to be overriden by plugins'''
1176
def plugin_for_command(self, cmd_name):
1177
'''Takes a command and returns the information for that plugin
1179
:return: A dictionary with all the available information
1180
for the requested plugin
1182
raise NotImplementedError
1185
class ProvidersRegistry(registry.Registry):
1186
'''This registry exists to allow other providers to exist'''
1189
for key, provider in self.iteritems():
1192
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
