1
# Copyright (C) 2006, 2008, 2009 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 (
62
suppress_deprecation_warnings,
66
class CommandInfo(object):
67
"""Information about a command."""
69
def __init__(self, aliases):
70
"""The list of aliases for the command."""
71
self.aliases = aliases
74
def from_command(klass, command):
75
"""Factory to construct a CommandInfo from a command."""
76
return klass(command.aliases)
79
class CommandRegistry(registry.Registry):
82
def _get_name(command_name):
83
if command_name.startswith("cmd_"):
84
return _unsquish_command_name(command_name)
88
def register(self, cmd, decorate=False):
89
"""Utility function to help register a command
91
:param cmd: Command subclass to register
92
:param decorate: If true, allow overriding an existing command
93
of the same name; the old command is returned by this function.
94
Otherwise it is an error to try to override an existing command.
97
k_unsquished = self._get_name(k)
99
previous = self.get(k_unsquished)
101
previous = _builtin_commands().get(k_unsquished)
102
info = CommandInfo.from_command(cmd)
104
registry.Registry.register(self, k_unsquished, cmd,
105
override_existing=decorate, info=info)
107
trace.warning('Two plugins defined the same command: %r' % k)
108
trace.warning('Not loading the one in %r' %
109
sys.modules[cmd.__module__])
110
trace.warning('Previously this command was registered from %r' %
111
sys.modules[previous.__module__])
114
def register_lazy(self, command_name, aliases, module_name):
115
"""Register a command without loading its module.
117
:param command_name: The primary name of the command.
118
:param aliases: A list of aliases for the command.
119
:module_name: The module that the command lives in.
121
key = self._get_name(command_name)
122
registry.Registry.register_lazy(self, key, module_name, command_name,
123
info=CommandInfo(aliases))
126
plugin_cmds = CommandRegistry()
129
def register_command(cmd, decorate=False):
131
return plugin_cmds.register(cmd, decorate)
134
def _squish_command_name(cmd):
135
return 'cmd_' + cmd.replace('-', '_')
138
def _unsquish_command_name(cmd):
139
return cmd[4:].replace('_','-')
142
def _builtin_commands():
143
import bzrlib.builtins
144
return _scan_module_for_commands(bzrlib.builtins)
147
def _scan_module_for_commands(module):
149
for name, obj in module.__dict__.iteritems():
150
if name.startswith("cmd_"):
151
real_name = _unsquish_command_name(name)
156
def _list_bzr_commands(names):
157
"""Find commands from bzr's core and plugins."""
158
# to eliminate duplicates
159
names.update(builtin_command_names())
160
names.update(plugin_command_names())
164
def all_command_names():
165
"""Return a set of all command names."""
167
for hook in Command.hooks['list_commands']:
170
raise AssertionError(
171
'hook %s returned None' % Command.hooks.get_hook_name(hook))
175
def builtin_command_names():
176
"""Return list of builtin command names.
178
Use of all_command_names() is encouraged rather than builtin_command_names
179
and/or plugin_command_names.
181
return _builtin_commands().keys()
184
def plugin_command_names():
185
"""Returns command names from commands registered by plugins."""
186
return plugin_cmds.keys()
189
@deprecated_function(deprecated_in((1, 17, 0)))
190
def get_all_cmds(plugins_override=False):
191
"""Return canonical name and class for most commands.
193
NB: This does not return all commands since the introduction of
194
command hooks, and returning the class is not sufficient to
195
get correctly setup commands, which is why it is deprecated.
197
Use 'all_command_names' + 'get_cmd_object' instead.
199
d = _builtin_commands()
201
d.update(plugin_cmds.iteritems())
202
for k, v in d.iteritems():
206
def get_cmd_object(cmd_name, plugins_override=True):
207
"""Return the command object for a command.
210
If true, plugin commands can override builtins.
213
return _get_cmd_object(cmd_name, plugins_override)
215
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
218
def _get_cmd_object(cmd_name, plugins_override=True):
219
"""Get a command object.
221
:param cmd_name: The name of the command.
222
:param plugins_override: Allow plugins to override builtins.
223
:return: A Command object instance
224
:raises KeyError: If no command is found.
226
# We want only 'ascii' command names, but the user may have typed
227
# in a Unicode name. In that case, they should just get a
228
# 'command not found' error later.
229
# In the future, we may actually support Unicode command names.
232
for hook in Command.hooks['get_command']:
233
cmd = hook(cmd, cmd_name)
234
if cmd is not None and not plugins_override and not cmd.plugin_name():
235
# We've found a non-plugin command, don't permit it to be
239
for hook in Command.hooks['get_missing_command']:
246
# Allow plugins to extend commands
247
for hook in Command.hooks['extend_command']:
252
def _try_plugin_provider(cmd_name):
253
"""Probe for a plugin provider having cmd_name."""
255
plugin_metadata, provider = probe_for_provider(cmd_name)
256
raise errors.CommandAvailableInPlugin(cmd_name,
257
plugin_metadata, provider)
258
except errors.NoPluginAvailable:
262
def probe_for_provider(cmd_name):
263
"""Look for a provider for cmd_name.
265
:param cmd_name: The command name.
266
:return: plugin_metadata, provider for getting cmd_name.
267
:raises NoPluginAvailable: When no provider can supply the plugin.
269
# look for providers that provide this command but aren't installed
270
for provider in command_providers_registry:
272
return provider.plugin_for_command(cmd_name), provider
273
except errors.NoPluginAvailable:
275
raise errors.NoPluginAvailable(cmd_name)
278
def _get_bzr_command(cmd_or_None, cmd_name):
279
"""Get a command from bzr's core."""
280
cmds = _builtin_commands()
282
return cmds[cmd_name]()
285
# look for any command which claims this as an alias
286
for real_cmd_name, cmd_class in cmds.iteritems():
287
if cmd_name in cmd_class.aliases:
292
def _get_external_command(cmd_or_None, cmd_name):
293
"""Lookup a command that is a shell script."""
294
# Only do external command lookups when no command is found so far.
295
if cmd_or_None is not None:
297
from bzrlib.externalcommand import ExternalCommand
298
cmd_obj = ExternalCommand.find_command(cmd_name)
303
def _get_plugin_command(cmd_or_None, cmd_name):
304
"""Get a command from bzr's plugins."""
306
return plugin_cmds.get(cmd_name)()
309
for key in plugin_cmds.keys():
310
info = plugin_cmds.get_info(key)
311
if cmd_name in info.aliases:
312
return plugin_cmds.get(key)()
316
class Command(object):
317
"""Base class for commands.
319
Commands are the heart of the command-line bzr interface.
321
The command object mostly handles the mapping of command-line
322
parameters into one or more bzrlib operations, and of the results
325
Commands normally don't have any state. All their arguments are
326
passed in to the run method. (Subclasses may take a different
327
policy if the behaviour of the instance needs to depend on e.g. a
328
shell plugin and not just its Python class.)
330
The docstring for an actual command should give a single-line
331
summary, then a complete description of the command. A grammar
332
description will be inserted.
335
Other accepted names for this command.
338
List of argument forms, marked with whether they are optional,
343
['to_location', 'from_branch?', 'file*']
345
'to_location' is required
346
'from_branch' is optional
347
'file' can be specified 0 or more times
350
List of options that may be given for this command. These can
351
be either strings, referring to globally-defined options,
352
or option objects. Retrieve through options().
355
If true, this command isn't advertised. This is typically
356
for commands intended for expert users.
359
Command objects will get a 'outf' attribute, which has been
360
setup to properly handle encoding of unicode strings.
361
encoding_type determines what will happen when characters cannot
363
strict - abort if we cannot decode
364
replace - put in a bogus character (typically '?')
365
exact - do not encode sys.stdout
367
NOTE: by default on Windows, sys.stdout is opened as a text
368
stream, therefore LF line-endings are converted to CRLF.
369
When a command uses encoding_type = 'exact', then
370
sys.stdout is forced to be a binary stream, and line-endings
373
:cvar hooks: An instance of CommandHooks.
378
encoding_type = 'strict'
383
"""Construct an instance of this command."""
384
if self.__doc__ == Command.__doc__:
385
warn("No help message set for %r" % self)
386
# List of standard options directly supported
387
self.supported_std_options = []
388
self._operation = cleanup.OperationWithCleanups(self.run)
390
def add_cleanup(self, cleanup_func, *args, **kwargs):
391
"""Register a function to call after self.run returns or raises.
393
Functions will be called in LIFO order.
395
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
397
def cleanup_now(self):
398
"""Execute and empty pending cleanup functions immediately.
400
After cleanup_now all registered cleanups are forgotten. add_cleanup
401
may be called again after cleanup_now; these cleanups will be called
402
after self.run returns or raises (or when cleanup_now is next called).
404
This is useful for releasing expensive or contentious resources (such
405
as write locks) before doing further work that does not require those
406
resources (such as writing results to self.outf).
408
self._operation.cleanup_now()
410
@deprecated_method(deprecated_in((2, 1, 0)))
411
def _maybe_expand_globs(self, file_list):
412
"""Glob expand file_list if the platform does not do that itself.
414
Not used anymore, now that the bzr command-line parser globs on
417
:return: A possibly empty list of unicode paths.
419
Introduced in bzrlib 0.18.
424
"""Return single-line grammar for this command.
426
Only describes arguments, not options.
428
s = 'bzr ' + self.name() + ' '
429
for aname in self.takes_args:
430
aname = aname.upper()
431
if aname[-1] in ['$', '+']:
432
aname = aname[:-1] + '...'
433
elif aname[-1] == '?':
434
aname = '[' + aname[:-1] + ']'
435
elif aname[-1] == '*':
436
aname = '[' + aname[:-1] + '...]'
438
s = s[:-1] # remove last space
441
def get_help_text(self, additional_see_also=None, plain=True,
442
see_also_as_links=False, verbose=True):
443
"""Return a text string with help for this command.
445
:param additional_see_also: Additional help topics to be
447
:param plain: if False, raw help (reStructuredText) is
448
returned instead of plain text.
449
:param see_also_as_links: if True, convert items in 'See also'
450
list to internal links (used by bzr_man rstx generator)
451
:param verbose: if True, display the full help, otherwise
452
leave out the descriptive sections and just display
453
usage help (e.g. Purpose, Usage, Options) with a
454
message explaining how to obtain full help.
458
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
460
# Extract the summary (purpose) and sections out from the text
461
purpose,sections,order = self._get_help_parts(doc)
463
# If a custom usage section was provided, use it
464
if sections.has_key('Usage'):
465
usage = sections.pop('Usage')
467
usage = self._usage()
469
# The header is the purpose and usage
471
result += ':Purpose: %s\n' % purpose
472
if usage.find('\n') >= 0:
473
result += ':Usage:\n%s\n' % usage
475
result += ':Usage: %s\n' % usage
480
# XXX: optparse implicitly rewraps the help, and not always perfectly,
481
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
483
options = option.get_optparser(self.options()).format_option_help()
484
# XXX: According to the spec, ReST option lists actually don't support
485
# options like --1.9 so that causes syntax errors (in Sphinx at least).
486
# As that pattern always appears in the commands that break, we trap
487
# on that and then format that block of 'format' options as a literal
489
if not plain and options.find(' --1.9 ') != -1:
490
options = options.replace(' format:\n', ' format::\n\n', 1)
491
if options.startswith('Options:'):
492
result += ':' + options
493
elif options.startswith('options:'):
494
# Python 2.4 version of optparse
495
result += ':Options:' + options[len('options:'):]
501
# Add the description, indenting it 2 spaces
502
# to match the indentation of the options
503
if sections.has_key(None):
504
text = sections.pop(None)
505
text = '\n '.join(text.splitlines())
506
result += ':%s:\n %s\n\n' % ('Description',text)
508
# Add the custom sections (e.g. Examples). Note that there's no need
509
# to indent these as they must be indented already in the source.
512
if sections.has_key(label):
513
result += ':%s:\n%s\n' % (label,sections[label])
516
result += ("See bzr help %s for more details and examples.\n\n"
519
# Add the aliases, source (plug-in) and see also links, if any
521
result += ':Aliases: '
522
result += ', '.join(self.aliases) + '\n'
523
plugin_name = self.plugin_name()
524
if plugin_name is not None:
525
result += ':From: plugin "%s"\n' % plugin_name
526
see_also = self.get_see_also(additional_see_also)
528
if not plain and see_also_as_links:
530
for item in see_also:
532
# topics doesn't have an independent section
533
# so don't create a real link
534
see_also_links.append(item)
536
# Use a reST link for this entry
537
see_also_links.append("`%s`_" % (item,))
538
see_also = see_also_links
539
result += ':See also: '
540
result += ', '.join(see_also) + '\n'
542
# If this will be rendered as plain text, convert it
544
import bzrlib.help_topics
545
result = bzrlib.help_topics.help_as_plain_text(result)
549
def _get_help_parts(text):
550
"""Split help text into a summary and named sections.
552
:return: (summary,sections,order) where summary is the top line and
553
sections is a dictionary of the rest indexed by section name.
554
order is the order the section appear in the text.
555
A section starts with a heading line of the form ":xxx:".
556
Indented text on following lines is the section value.
557
All text found outside a named section is assigned to the
558
default section which is given the key of None.
560
def save_section(sections, order, label, section):
562
if sections.has_key(label):
563
sections[label] += '\n' + section
566
sections[label] = section
568
lines = text.rstrip().splitlines()
569
summary = lines.pop(0)
572
label,section = None,''
574
if line.startswith(':') and line.endswith(':') and len(line) > 2:
575
save_section(sections, order, label, section)
576
label,section = line[1:-1],''
577
elif (label is not None) and len(line) > 1 and not line[0].isspace():
578
save_section(sections, order, label, section)
579
label,section = None,line
582
section += '\n' + line
585
save_section(sections, order, label, section)
586
return summary, sections, order
588
def get_help_topic(self):
589
"""Return the commands help topic - its name."""
592
def get_see_also(self, additional_terms=None):
593
"""Return a list of help topics that are related to this command.
595
The list is derived from the content of the _see_also attribute. Any
596
duplicates are removed and the result is in lexical order.
597
:param additional_terms: Additional help topics to cross-reference.
598
:return: A list of help topics.
600
see_also = set(getattr(self, '_see_also', []))
602
see_also.update(additional_terms)
603
return sorted(see_also)
606
"""Return dict of valid options for this command.
608
Maps from long option name to option object."""
609
r = Option.STD_OPTIONS.copy()
611
for o in self.takes_options:
612
if isinstance(o, basestring):
613
o = option.Option.OPTIONS[o]
615
if o.name in std_names:
616
self.supported_std_options.append(o.name)
619
def _setup_outf(self):
620
"""Return a file linked to stdout, which has proper encoding."""
621
self.outf = ui.ui_factory.make_output_stream(
622
encoding_type=self.encoding_type)
624
def run_argv_aliases(self, argv, alias_argv=None):
625
"""Parse the command line and run with extra aliases in alias_argv."""
627
warn("Passing None for [] is deprecated from bzrlib 0.10",
628
DeprecationWarning, stacklevel=2)
630
args, opts = parse_args(self, argv, alias_argv)
632
# Process the standard options
633
if 'help' in opts: # e.g. bzr add --help
634
sys.stdout.write(self.get_help_text())
636
if 'usage' in opts: # e.g. bzr add --usage
637
sys.stdout.write(self.get_help_text(verbose=False))
639
trace.set_verbosity_level(option._verbosity_level)
640
if 'verbose' in self.supported_std_options:
641
opts['verbose'] = trace.is_verbose()
642
elif opts.has_key('verbose'):
644
if 'quiet' in self.supported_std_options:
645
opts['quiet'] = trace.is_quiet()
646
elif opts.has_key('quiet'):
649
# mix arguments and options into one dictionary
650
cmdargs = _match_argform(self.name(), self.takes_args, args)
652
for k, v in opts.items():
653
cmdopts[k.replace('-', '_')] = v
655
all_cmd_args = cmdargs.copy()
656
all_cmd_args.update(cmdopts)
660
return self._operation.run_simple(**all_cmd_args)
663
"""Actually run the command.
665
This is invoked with the options and arguments bound to
668
Return 0 or None if the command was successful, or a non-zero
669
shell error code if not. It's OK for this method to allow
670
an exception to raise up.
672
raise NotImplementedError('no implementation of command %r'
676
"""Return help message for this class."""
677
from inspect import getdoc
678
if self.__doc__ is Command.__doc__:
683
return _unsquish_command_name(self.__class__.__name__)
685
def plugin_name(self):
686
"""Get the name of the plugin that provides this command.
688
:return: The name of the plugin or None if the command is builtin.
690
mod_parts = self.__module__.split('.')
691
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
697
class CommandHooks(Hooks):
698
"""Hooks related to Command object creation/enumeration."""
701
"""Create the default hooks.
703
These are all empty initially, because by default nothing should get
707
self.create_hook(HookPoint('extend_command',
708
"Called after creating a command object to allow modifications "
709
"such as adding or removing options, docs etc. Called with the "
710
"new bzrlib.commands.Command object.", (1, 13), None))
711
self.create_hook(HookPoint('get_command',
712
"Called when creating a single command. Called with "
713
"(cmd_or_None, command_name). get_command should either return "
714
"the cmd_or_None parameter, or a replacement Command object that "
715
"should be used for the command. Note that the Command.hooks "
716
"hooks are core infrastructure. Many users will prefer to use "
717
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
719
self.create_hook(HookPoint('get_missing_command',
720
"Called when creating a single command if no command could be "
721
"found. Called with (command_name). get_missing_command should "
722
"either return None, or a Command object to be used for the "
723
"command.", (1, 17), None))
724
self.create_hook(HookPoint('list_commands',
725
"Called when enumerating commands. Called with a set of "
726
"cmd_name strings for all the commands found so far. This set "
727
" is safe to mutate - e.g. to remove a command. "
728
"list_commands should return the updated set of command names.",
731
Command.hooks = CommandHooks()
734
def parse_args(command, argv, alias_argv=None):
735
"""Parse command line.
737
Arguments and options are parsed at this level before being passed
738
down to specific command handlers. This routine knows, from a
739
lookup table, something about the available options, what optargs
740
they take, and which commands will accept them.
742
# TODO: make it a method of the Command?
743
parser = option.get_optparser(command.options())
744
if alias_argv is not None:
745
args = alias_argv + argv
749
options, args = parser.parse_args(args)
750
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
751
v is not option.OptionParser.DEFAULT_VALUE])
755
def _match_argform(cmd, takes_args, args):
758
# step through args and takes_args, allowing appropriate 0-many matches
759
for ap in takes_args:
763
argdict[argname] = args.pop(0)
764
elif ap[-1] == '*': # all remaining arguments
766
argdict[argname + '_list'] = args[:]
769
argdict[argname + '_list'] = None
772
raise errors.BzrCommandError("command %r needs one or more %s"
773
% (cmd, argname.upper()))
775
argdict[argname + '_list'] = args[:]
777
elif ap[-1] == '$': # all but one
779
raise errors.BzrCommandError("command %r needs one or more %s"
780
% (cmd, argname.upper()))
781
argdict[argname + '_list'] = args[:-1]
787
raise errors.BzrCommandError("command %r requires argument %s"
788
% (cmd, argname.upper()))
790
argdict[argname] = args.pop(0)
793
raise errors.BzrCommandError("extra argument to command %s: %s"
798
def apply_coveraged(dirname, the_callable, *args, **kwargs):
799
# Cannot use "import trace", as that would import bzrlib.trace instead of
800
# the standard library's trace.
801
trace = __import__('trace')
803
tracer = trace.Trace(count=1, trace=0)
804
sys.settrace(tracer.globaltrace)
805
threading.settrace(tracer.globaltrace)
808
return exception_to_return_code(the_callable, *args, **kwargs)
811
results = tracer.results()
812
results.write_results(show_missing=1, summary=False,
816
def apply_profiled(the_callable, *args, **kwargs):
820
pffileno, pfname = tempfile.mkstemp()
822
prof = hotshot.Profile(pfname)
824
ret = prof.runcall(exception_to_return_code, the_callable, *args,
828
stats = hotshot.stats.load(pfname)
830
stats.sort_stats('cum') # 'time'
831
## XXX: Might like to write to stderr or the trace file instead but
832
## print_stats seems hardcoded to stdout
833
stats.print_stats(20)
840
def exception_to_return_code(the_callable, *args, **kwargs):
841
"""UI level helper for profiling and coverage.
843
This transforms exceptions into a return value of 3. As such its only
844
relevant to the UI layer, and should never be called where catching
845
exceptions may be desirable.
848
return the_callable(*args, **kwargs)
849
except (KeyboardInterrupt, Exception), e:
850
# used to handle AssertionError and KeyboardInterrupt
851
# specially here, but hopefully they're handled ok by the logger now
852
exc_info = sys.exc_info()
853
exitcode = trace.report_exception(exc_info, sys.stderr)
854
if os.environ.get('BZR_PDB'):
855
print '**** entering debugger'
858
if sys.version_info[:2] < (2, 6):
860
# pdb.post_mortem(tb)
861
# but because pdb.post_mortem gives bad results for tracebacks
862
# from inside generators, we do it manually.
863
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
865
# Setup pdb on the traceback
868
p.setup(tb.tb_frame, tb)
869
# Point the debugger at the deepest frame of the stack
870
p.curindex = len(p.stack) - 1
871
p.curframe = p.stack[p.curindex][0]
872
# Start the pdb prompt.
873
p.print_stack_entry(p.stack[p.curindex])
881
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
882
from bzrlib.lsprof import profile
883
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
889
trace.note('Profile data written to "%s".', filename)
893
def shlex_split_unicode(unsplit):
895
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
898
def get_alias(cmd, config=None):
899
"""Return an expanded alias, or None if no alias exists.
902
Command to be checked for an alias.
904
Used to specify an alternative config to use,
905
which is especially useful for testing.
906
If it is unspecified, the global config will be used.
910
config = bzrlib.config.GlobalConfig()
911
alias = config.get_alias(cmd)
913
return shlex_split_unicode(alias)
918
"""Execute a command.
921
The command-line arguments, without the program name from argv[0]
922
These should already be decoded. All library/test code calling
923
run_bzr should be passing valid strings (don't need decoding).
925
Returns a command status or raises an exception.
927
Special master options: these must come before the command because
928
they control how the command is interpreted.
931
Do not load plugin modules at all
937
Only use builtin commands. (Plugins are still allowed to change
941
Run under the Python hotshot profiler.
944
Run under the Python lsprof profiler.
947
Generate line coverage report in the specified directory.
950
Specify the number of processes that can be run concurrently (selftest).
953
trace.mutter("bzr arguments: %r", argv)
955
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
956
opt_no_aliases = False
957
opt_lsprof_file = opt_coverage_dir = None
959
# --no-plugins is handled specially at a very early stage. We need
960
# to load plugins before doing other command parsing so that they
961
# can override commands, but this needs to happen first.
969
elif a == '--lsprof':
971
elif a == '--lsprof-file':
973
opt_lsprof_file = argv[i + 1]
975
elif a == '--no-plugins':
976
opt_no_plugins = True
977
elif a == '--no-aliases':
978
opt_no_aliases = True
979
elif a == '--builtin':
981
elif a == '--concurrency':
982
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
984
elif a == '--coverage':
985
opt_coverage_dir = argv[i + 1]
987
elif a.startswith('-D'):
988
debug.debug_flags.add(a[2:])
993
debug.set_debug_flags_from_config()
997
from bzrlib.builtins import cmd_help
998
cmd_help().run_argv_aliases([])
1001
if argv[0] == '--version':
1002
from bzrlib.builtins import cmd_version
1003
cmd_version().run_argv_aliases([])
1006
if not opt_no_plugins:
1007
from bzrlib.plugin import load_plugins
1010
from bzrlib.plugin import disable_plugins
1015
if not opt_no_aliases:
1016
alias_argv = get_alias(argv[0])
1018
user_encoding = osutils.get_user_encoding()
1019
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1020
argv[0] = alias_argv.pop(0)
1023
# We want only 'ascii' command names, but the user may have typed
1024
# in a Unicode name. In that case, they should just get a
1025
# 'command not found' error later.
1027
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1028
run = cmd_obj.run_argv_aliases
1029
run_argv = [argv, alias_argv]
1032
# We can be called recursively (tests for example), but we don't want
1033
# the verbosity level to propagate.
1034
saved_verbosity_level = option._verbosity_level
1035
option._verbosity_level = 0
1037
if opt_coverage_dir:
1039
'--coverage ignored, because --lsprof is in use.')
1040
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1042
if opt_coverage_dir:
1044
'--coverage ignored, because --profile is in use.')
1045
ret = apply_profiled(run, *run_argv)
1046
elif opt_coverage_dir:
1047
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1049
ret = run(*run_argv)
1052
# reset, in case we may do other commands later within the same
1053
# process. Commands that want to execute sub-commands must propagate
1054
# --verbose in their own way.
1055
if 'memory' in debug.debug_flags:
1056
trace.debug_memory('Process status after command:', short=False)
1057
option._verbosity_level = saved_verbosity_level
1060
def display_command(func):
1061
"""Decorator that suppresses pipe/interrupt errors."""
1062
def ignore_pipe(*args, **kwargs):
1064
result = func(*args, **kwargs)
1068
if getattr(e, 'errno', None) is None:
1070
if e.errno != errno.EPIPE:
1071
# Win32 raises IOError with errno=0 on a broken pipe
1072
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1075
except KeyboardInterrupt:
1080
def install_bzr_command_hooks():
1081
"""Install the hooks to supply bzr's own commands."""
1082
if _list_bzr_commands in Command.hooks["list_commands"]:
1084
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1086
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1088
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1089
"bzr plugin commands")
1090
Command.hooks.install_named_hook("get_command", _get_external_command,
1091
"bzr external command lookup")
1092
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1093
"bzr plugin-provider-db check")
1096
def main(argv=None):
1097
"""Main entry point of command-line interface.
1099
:param argv: list of unicode command-line arguments similar to sys.argv.
1100
argv[0] is script name usually, it will be ignored.
1101
Don't pass here sys.argv because this list contains plain strings
1102
and not unicode; pass None instead.
1104
:return: exit code of bzr command.
1107
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1108
sys.stdin, sys.stdout, sys.stderr)
1110
# Is this a final release version? If so, we should suppress warnings
1111
if bzrlib.version_info[3] == 'final':
1112
suppress_deprecation_warnings(override=True)
1114
argv = osutils.get_unicode_argv()
1118
# ensure all arguments are unicode strings
1120
if isinstance(a, unicode):
1123
new_argv.append(a.decode('ascii'))
1124
except UnicodeDecodeError:
1125
raise errors.BzrError("argv should be list of unicode strings.")
1127
ret = run_bzr_catch_errors(argv)
1128
bzrlib.ui.ui_factory.log_transport_activity(
1129
display=('bytes' in debug.debug_flags))
1130
trace.mutter("return code %d", ret)
1131
osutils.report_extension_load_failures()
1135
def run_bzr_catch_errors(argv):
1136
"""Run a bzr command with parameters as described by argv.
1138
This function assumed that that UI layer is setup, that symbol deprecations
1139
are already applied, and that unicode decoding has already been performed on argv.
1141
install_bzr_command_hooks()
1142
return exception_to_return_code(run_bzr, argv)
1145
def run_bzr_catch_user_errors(argv):
1146
"""Run bzr and report user errors, but let internal errors propagate.
1148
This is used for the test suite, and might be useful for other programs
1149
that want to wrap the commandline interface.
1151
install_bzr_command_hooks()
1153
return run_bzr(argv)
1154
except Exception, e:
1155
if (isinstance(e, (OSError, IOError))
1156
or not getattr(e, 'internal_error', True)):
1157
trace.report_exception(sys.exc_info(), sys.stderr)
1163
class HelpCommandIndex(object):
1164
"""A index for bzr help that returns commands."""
1167
self.prefix = 'commands/'
1169
def get_topics(self, topic):
1170
"""Search for topic amongst commands.
1172
:param topic: A topic to search for.
1173
:return: A list which is either empty or contains a single
1176
if topic and topic.startswith(self.prefix):
1177
topic = topic[len(self.prefix):]
1179
cmd = _get_cmd_object(topic)
1186
class Provider(object):
1187
'''Generic class to be overriden by plugins'''
1189
def plugin_for_command(self, cmd_name):
1190
'''Takes a command and returns the information for that plugin
1192
:return: A dictionary with all the available information
1193
for the requested plugin
1195
raise NotImplementedError
1198
class ProvidersRegistry(registry.Registry):
1199
'''This registry exists to allow other providers to exist'''
1202
for key, provider in self.iteritems():
1205
command_providers_registry = ProvidersRegistry()
1208
if __name__ == '__main__':
1209
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
