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
53
from bzrlib.hooks import HookPoint, Hooks
54
# Compatibility - Option used to be in commands.
55
from bzrlib.option import Option
56
from bzrlib import registry
57
from bzrlib.symbol_versioning import (
61
suppress_deprecation_warnings,
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
@deprecated_function(deprecated_in((1, 17, 0)))
189
def get_all_cmds(plugins_override=False):
190
"""Return canonical name and class for most commands.
192
NB: This does not return all commands since the introduction of
193
command hooks, and returning the class is not sufficient to
194
get correctly setup commands, which is why it is deprecated.
196
Use 'all_command_names' + 'get_cmd_object' instead.
198
d = _builtin_commands()
200
d.update(plugin_cmds.iteritems())
201
for k, v in d.iteritems():
205
def get_cmd_object(cmd_name, plugins_override=True):
206
"""Return the command object for a command.
209
If true, plugin commands can override builtins.
212
return _get_cmd_object(cmd_name, plugins_override)
214
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
217
def _get_cmd_object(cmd_name, plugins_override=True):
218
"""Get a command object.
220
:param cmd_name: The name of the command.
221
:param plugins_override: Allow plugins to override builtins.
222
:return: A Command object instance
223
:raises KeyError: If no command is found.
225
# We want only 'ascii' command names, but the user may have typed
226
# in a Unicode name. In that case, they should just get a
227
# 'command not found' error later.
228
# In the future, we may actually support Unicode command names.
231
for hook in Command.hooks['get_command']:
232
cmd = hook(cmd, cmd_name)
233
if cmd is not None and not plugins_override and not cmd.plugin_name():
234
# We've found a non-plugin command, don't permit it to be
238
for hook in Command.hooks['get_missing_command']:
245
# Allow plugins to extend commands
246
for hook in Command.hooks['extend_command']:
251
def _try_plugin_provider(cmd_name):
252
"""Probe for a plugin provider having cmd_name."""
254
plugin_metadata, provider = probe_for_provider(cmd_name)
255
raise errors.CommandAvailableInPlugin(cmd_name,
256
plugin_metadata, provider)
257
except errors.NoPluginAvailable:
261
def probe_for_provider(cmd_name):
262
"""Look for a provider for cmd_name.
264
:param cmd_name: The command name.
265
:return: plugin_metadata, provider for getting cmd_name.
266
:raises NoPluginAvailable: When no provider can supply the plugin.
268
# look for providers that provide this command but aren't installed
269
for provider in command_providers_registry:
271
return provider.plugin_for_command(cmd_name), provider
272
except errors.NoPluginAvailable:
274
raise errors.NoPluginAvailable(cmd_name)
277
def _get_bzr_command(cmd_or_None, cmd_name):
278
"""Get a command from bzr's core."""
279
cmds = _builtin_commands()
281
return cmds[cmd_name]()
284
# look for any command which claims this as an alias
285
for real_cmd_name, cmd_class in cmds.iteritems():
286
if cmd_name in cmd_class.aliases:
291
def _get_external_command(cmd_or_None, cmd_name):
292
"""Lookup a command that is a shell script."""
293
# Only do external command lookups when no command is found so far.
294
if cmd_or_None is not None:
296
from bzrlib.externalcommand import ExternalCommand
297
cmd_obj = ExternalCommand.find_command(cmd_name)
302
def _get_plugin_command(cmd_or_None, cmd_name):
303
"""Get a command from bzr's plugins."""
305
return plugin_cmds.get(cmd_name)()
308
for key in plugin_cmds.keys():
309
info = plugin_cmds.get_info(key)
310
if cmd_name in info.aliases:
311
return plugin_cmds.get(key)()
315
class Command(object):
316
"""Base class for commands.
318
Commands are the heart of the command-line bzr interface.
320
The command object mostly handles the mapping of command-line
321
parameters into one or more bzrlib operations, and of the results
324
Commands normally don't have any state. All their arguments are
325
passed in to the run method. (Subclasses may take a different
326
policy if the behaviour of the instance needs to depend on e.g. a
327
shell plugin and not just its Python class.)
329
The docstring for an actual command should give a single-line
330
summary, then a complete description of the command. A grammar
331
description will be inserted.
334
Other accepted names for this command.
337
List of argument forms, marked with whether they are optional,
342
['to_location', 'from_branch?', 'file*']
344
'to_location' is required
345
'from_branch' is optional
346
'file' can be specified 0 or more times
349
List of options that may be given for this command. These can
350
be either strings, referring to globally-defined options,
351
or option objects. Retrieve through options().
354
If true, this command isn't advertised. This is typically
355
for commands intended for expert users.
358
Command objects will get a 'outf' attribute, which has been
359
setup to properly handle encoding of unicode strings.
360
encoding_type determines what will happen when characters cannot
362
strict - abort if we cannot decode
363
replace - put in a bogus character (typically '?')
364
exact - do not encode sys.stdout
366
NOTE: by default on Windows, sys.stdout is opened as a text
367
stream, therefore LF line-endings are converted to CRLF.
368
When a command uses encoding_type = 'exact', then
369
sys.stdout is forced to be a binary stream, and line-endings
372
:cvar hooks: An instance of CommandHooks.
377
encoding_type = 'strict'
382
"""Construct an instance of this command."""
383
if self.__doc__ == Command.__doc__:
384
warn("No help message set for %r" % self)
385
# List of standard options directly supported
386
self.supported_std_options = []
388
@deprecated_method(deprecated_in((2, 1, 0)))
389
def _maybe_expand_globs(self, file_list):
390
"""Glob expand file_list if the platform does not do that itself.
392
Not used anymore, now that the bzr command-line parser globs on
395
:return: A possibly empty list of unicode paths.
397
Introduced in bzrlib 0.18.
402
"""Return single-line grammar for this command.
404
Only describes arguments, not options.
406
s = 'bzr ' + self.name() + ' '
407
for aname in self.takes_args:
408
aname = aname.upper()
409
if aname[-1] in ['$', '+']:
410
aname = aname[:-1] + '...'
411
elif aname[-1] == '?':
412
aname = '[' + aname[:-1] + ']'
413
elif aname[-1] == '*':
414
aname = '[' + aname[:-1] + '...]'
416
s = s[:-1] # remove last space
419
def get_help_text(self, additional_see_also=None, plain=True,
420
see_also_as_links=False, verbose=True):
421
"""Return a text string with help for this command.
423
:param additional_see_also: Additional help topics to be
425
:param plain: if False, raw help (reStructuredText) is
426
returned instead of plain text.
427
:param see_also_as_links: if True, convert items in 'See also'
428
list to internal links (used by bzr_man rstx generator)
429
:param verbose: if True, display the full help, otherwise
430
leave out the descriptive sections and just display
431
usage help (e.g. Purpose, Usage, Options) with a
432
message explaining how to obtain full help.
436
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
438
# Extract the summary (purpose) and sections out from the text
439
purpose,sections,order = self._get_help_parts(doc)
441
# If a custom usage section was provided, use it
442
if sections.has_key('Usage'):
443
usage = sections.pop('Usage')
445
usage = self._usage()
447
# The header is the purpose and usage
449
result += ':Purpose: %s\n' % purpose
450
if usage.find('\n') >= 0:
451
result += ':Usage:\n%s\n' % usage
453
result += ':Usage: %s\n' % usage
458
# XXX: optparse implicitly rewraps the help, and not always perfectly,
459
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
461
options = option.get_optparser(self.options()).format_option_help()
462
# XXX: According to the spec, ReST option lists actually don't support
463
# options like --1.9 so that causes syntax errors (in Sphinx at least).
464
# As that pattern always appears in the commands that break, we trap
465
# on that and then format that block of 'format' options as a literal
467
if not plain and options.find(' --1.9 ') != -1:
468
options = options.replace(' format:\n', ' format::\n\n', 1)
469
if options.startswith('Options:'):
470
result += ':' + options
471
elif options.startswith('options:'):
472
# Python 2.4 version of optparse
473
result += ':Options:' + options[len('options:'):]
479
# Add the description, indenting it 2 spaces
480
# to match the indentation of the options
481
if sections.has_key(None):
482
text = sections.pop(None)
483
text = '\n '.join(text.splitlines())
484
result += ':%s:\n %s\n\n' % ('Description',text)
486
# Add the custom sections (e.g. Examples). Note that there's no need
487
# to indent these as they must be indented already in the source.
490
if sections.has_key(label):
491
result += ':%s:\n%s\n' % (label,sections[label])
494
result += ("See bzr help %s for more details and examples.\n\n"
497
# Add the aliases, source (plug-in) and see also links, if any
499
result += ':Aliases: '
500
result += ', '.join(self.aliases) + '\n'
501
plugin_name = self.plugin_name()
502
if plugin_name is not None:
503
result += ':From: plugin "%s"\n' % plugin_name
504
see_also = self.get_see_also(additional_see_also)
506
if not plain and see_also_as_links:
508
for item in see_also:
510
# topics doesn't have an independent section
511
# so don't create a real link
512
see_also_links.append(item)
514
# Use a reST link for this entry
515
see_also_links.append("`%s`_" % (item,))
516
see_also = see_also_links
517
result += ':See also: '
518
result += ', '.join(see_also) + '\n'
520
# If this will be rendered as plain text, convert it
522
import bzrlib.help_topics
523
result = bzrlib.help_topics.help_as_plain_text(result)
527
def _get_help_parts(text):
528
"""Split help text into a summary and named sections.
530
:return: (summary,sections,order) where summary is the top line and
531
sections is a dictionary of the rest indexed by section name.
532
order is the order the section appear in the text.
533
A section starts with a heading line of the form ":xxx:".
534
Indented text on following lines is the section value.
535
All text found outside a named section is assigned to the
536
default section which is given the key of None.
538
def save_section(sections, order, label, section):
540
if sections.has_key(label):
541
sections[label] += '\n' + section
544
sections[label] = section
546
lines = text.rstrip().splitlines()
547
summary = lines.pop(0)
550
label,section = None,''
552
if line.startswith(':') and line.endswith(':') and len(line) > 2:
553
save_section(sections, order, label, section)
554
label,section = line[1:-1],''
555
elif (label is not None) and len(line) > 1 and not line[0].isspace():
556
save_section(sections, order, label, section)
557
label,section = None,line
560
section += '\n' + line
563
save_section(sections, order, label, section)
564
return summary, sections, order
566
def get_help_topic(self):
567
"""Return the commands help topic - its name."""
570
def get_see_also(self, additional_terms=None):
571
"""Return a list of help topics that are related to this command.
573
The list is derived from the content of the _see_also attribute. Any
574
duplicates are removed and the result is in lexical order.
575
:param additional_terms: Additional help topics to cross-reference.
576
:return: A list of help topics.
578
see_also = set(getattr(self, '_see_also', []))
580
see_also.update(additional_terms)
581
return sorted(see_also)
584
"""Return dict of valid options for this command.
586
Maps from long option name to option object."""
587
r = Option.STD_OPTIONS.copy()
589
for o in self.takes_options:
590
if isinstance(o, basestring):
591
o = option.Option.OPTIONS[o]
593
if o.name in std_names:
594
self.supported_std_options.append(o.name)
597
def _setup_outf(self):
598
"""Return a file linked to stdout, which has proper encoding."""
599
self.outf = ui.ui_factory.make_output_stream(
600
encoding_type=self.encoding_type)
602
def run_argv_aliases(self, argv, alias_argv=None):
603
"""Parse the command line and run with extra aliases in alias_argv."""
605
warn("Passing None for [] is deprecated from bzrlib 0.10",
606
DeprecationWarning, stacklevel=2)
608
args, opts = parse_args(self, argv, alias_argv)
610
# Process the standard options
611
if 'help' in opts: # e.g. bzr add --help
612
sys.stdout.write(self.get_help_text())
614
if 'usage' in opts: # e.g. bzr add --usage
615
sys.stdout.write(self.get_help_text(verbose=False))
617
trace.set_verbosity_level(option._verbosity_level)
618
if 'verbose' in self.supported_std_options:
619
opts['verbose'] = trace.is_verbose()
620
elif opts.has_key('verbose'):
622
if 'quiet' in self.supported_std_options:
623
opts['quiet'] = trace.is_quiet()
624
elif opts.has_key('quiet'):
627
# mix arguments and options into one dictionary
628
cmdargs = _match_argform(self.name(), self.takes_args, args)
630
for k, v in opts.items():
631
cmdopts[k.replace('-', '_')] = v
633
all_cmd_args = cmdargs.copy()
634
all_cmd_args.update(cmdopts)
638
return self.run(**all_cmd_args)
641
"""Actually run the command.
643
This is invoked with the options and arguments bound to
646
Return 0 or None if the command was successful, or a non-zero
647
shell error code if not. It's OK for this method to allow
648
an exception to raise up.
650
raise NotImplementedError('no implementation of command %r'
654
"""Return help message for this class."""
655
from inspect import getdoc
656
if self.__doc__ is Command.__doc__:
661
return _unsquish_command_name(self.__class__.__name__)
663
def plugin_name(self):
664
"""Get the name of the plugin that provides this command.
666
:return: The name of the plugin or None if the command is builtin.
668
mod_parts = self.__module__.split('.')
669
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
675
class CommandHooks(Hooks):
676
"""Hooks related to Command object creation/enumeration."""
679
"""Create the default hooks.
681
These are all empty initially, because by default nothing should get
685
self.create_hook(HookPoint('extend_command',
686
"Called after creating a command object to allow modifications "
687
"such as adding or removing options, docs etc. Called with the "
688
"new bzrlib.commands.Command object.", (1, 13), None))
689
self.create_hook(HookPoint('get_command',
690
"Called when creating a single command. Called with "
691
"(cmd_or_None, command_name). get_command should either return "
692
"the cmd_or_None parameter, or a replacement Command object that "
693
"should be used for the command. Note that the Command.hooks "
694
"hooks are core infrastructure. Many users will prefer to use "
695
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
697
self.create_hook(HookPoint('get_missing_command',
698
"Called when creating a single command if no command could be "
699
"found. Called with (command_name). get_missing_command should "
700
"either return None, or a Command object to be used for the "
701
"command.", (1, 17), None))
702
self.create_hook(HookPoint('list_commands',
703
"Called when enumerating commands. Called with a set of "
704
"cmd_name strings for all the commands found so far. This set "
705
" is safe to mutate - e.g. to remove a command. "
706
"list_commands should return the updated set of command names.",
709
Command.hooks = CommandHooks()
712
def parse_args(command, argv, alias_argv=None):
713
"""Parse command line.
715
Arguments and options are parsed at this level before being passed
716
down to specific command handlers. This routine knows, from a
717
lookup table, something about the available options, what optargs
718
they take, and which commands will accept them.
720
# TODO: make it a method of the Command?
721
parser = option.get_optparser(command.options())
722
if alias_argv is not None:
723
args = alias_argv + argv
727
options, args = parser.parse_args(args)
728
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
729
v is not option.OptionParser.DEFAULT_VALUE])
733
def _match_argform(cmd, takes_args, args):
736
# step through args and takes_args, allowing appropriate 0-many matches
737
for ap in takes_args:
741
argdict[argname] = args.pop(0)
742
elif ap[-1] == '*': # all remaining arguments
744
argdict[argname + '_list'] = args[:]
747
argdict[argname + '_list'] = None
750
raise errors.BzrCommandError("command %r needs one or more %s"
751
% (cmd, argname.upper()))
753
argdict[argname + '_list'] = args[:]
755
elif ap[-1] == '$': # all but one
757
raise errors.BzrCommandError("command %r needs one or more %s"
758
% (cmd, argname.upper()))
759
argdict[argname + '_list'] = args[:-1]
765
raise errors.BzrCommandError("command %r requires argument %s"
766
% (cmd, argname.upper()))
768
argdict[argname] = args.pop(0)
771
raise errors.BzrCommandError("extra argument to command %s: %s"
776
def apply_coveraged(dirname, the_callable, *args, **kwargs):
777
# Cannot use "import trace", as that would import bzrlib.trace instead of
778
# the standard library's trace.
779
trace = __import__('trace')
781
tracer = trace.Trace(count=1, trace=0)
782
sys.settrace(tracer.globaltrace)
783
threading.settrace(tracer.globaltrace)
786
return exception_to_return_code(the_callable, *args, **kwargs)
789
results = tracer.results()
790
results.write_results(show_missing=1, summary=False,
794
def apply_profiled(the_callable, *args, **kwargs):
798
pffileno, pfname = tempfile.mkstemp()
800
prof = hotshot.Profile(pfname)
802
ret = prof.runcall(exception_to_return_code, the_callable, *args,
806
stats = hotshot.stats.load(pfname)
808
stats.sort_stats('cum') # 'time'
809
## XXX: Might like to write to stderr or the trace file instead but
810
## print_stats seems hardcoded to stdout
811
stats.print_stats(20)
818
def exception_to_return_code(the_callable, *args, **kwargs):
819
"""UI level helper for profiling and coverage.
821
This transforms exceptions into a return value of 3. As such its only
822
relevant to the UI layer, and should never be called where catching
823
exceptions may be desirable.
826
return the_callable(*args, **kwargs)
827
except (KeyboardInterrupt, Exception), e:
828
# used to handle AssertionError and KeyboardInterrupt
829
# specially here, but hopefully they're handled ok by the logger now
830
exc_info = sys.exc_info()
831
exitcode = trace.report_exception(exc_info, sys.stderr)
832
if os.environ.get('BZR_PDB'):
833
print '**** entering debugger'
836
if sys.version_info[:2] < (2, 6):
838
# pdb.post_mortem(tb)
839
# but because pdb.post_mortem gives bad results for tracebacks
840
# from inside generators, we do it manually.
841
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
843
# Setup pdb on the traceback
846
p.setup(tb.tb_frame, tb)
847
# Point the debugger at the deepest frame of the stack
848
p.curindex = len(p.stack) - 1
849
p.curframe = p.stack[p.curindex][0]
850
# Start the pdb prompt.
851
p.print_stack_entry(p.stack[p.curindex])
859
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
860
from bzrlib.lsprof import profile
861
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
867
trace.note('Profile data written to "%s".', filename)
871
def shlex_split_unicode(unsplit):
873
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
876
def get_alias(cmd, config=None):
877
"""Return an expanded alias, or None if no alias exists.
880
Command to be checked for an alias.
882
Used to specify an alternative config to use,
883
which is especially useful for testing.
884
If it is unspecified, the global config will be used.
888
config = bzrlib.config.GlobalConfig()
889
alias = config.get_alias(cmd)
891
return shlex_split_unicode(alias)
896
"""Execute a command.
899
The command-line arguments, without the program name from argv[0]
900
These should already be decoded. All library/test code calling
901
run_bzr should be passing valid strings (don't need decoding).
903
Returns a command status or raises an exception.
905
Special master options: these must come before the command because
906
they control how the command is interpreted.
909
Do not load plugin modules at all
915
Only use builtin commands. (Plugins are still allowed to change
919
Run under the Python hotshot profiler.
922
Run under the Python lsprof profiler.
925
Generate line coverage report in the specified directory.
928
Specify the number of processes that can be run concurrently (selftest).
930
trace.mutter("bazaar version: " + bzrlib.__version__)
932
trace.mutter("bzr arguments: %r", argv)
934
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
935
opt_no_aliases = False
936
opt_lsprof_file = opt_coverage_dir = None
938
# --no-plugins is handled specially at a very early stage. We need
939
# to load plugins before doing other command parsing so that they
940
# can override commands, but this needs to happen first.
948
elif a == '--lsprof':
950
elif a == '--lsprof-file':
952
opt_lsprof_file = argv[i + 1]
954
elif a == '--no-plugins':
955
opt_no_plugins = True
956
elif a == '--no-aliases':
957
opt_no_aliases = True
958
elif a == '--builtin':
960
elif a == '--concurrency':
961
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
963
elif a == '--coverage':
964
opt_coverage_dir = argv[i + 1]
966
elif a.startswith('-D'):
967
debug.debug_flags.add(a[2:])
972
debug.set_debug_flags_from_config()
976
from bzrlib.builtins import cmd_help
977
cmd_help().run_argv_aliases([])
980
if argv[0] == '--version':
981
from bzrlib.builtins import cmd_version
982
cmd_version().run_argv_aliases([])
985
if not opt_no_plugins:
986
from bzrlib.plugin import load_plugins
989
from bzrlib.plugin import disable_plugins
994
if not opt_no_aliases:
995
alias_argv = get_alias(argv[0])
997
user_encoding = osutils.get_user_encoding()
998
alias_argv = [a.decode(user_encoding) for a in alias_argv]
999
argv[0] = alias_argv.pop(0)
1002
# We want only 'ascii' command names, but the user may have typed
1003
# in a Unicode name. In that case, they should just get a
1004
# 'command not found' error later.
1006
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1007
run = cmd_obj.run_argv_aliases
1008
run_argv = [argv, alias_argv]
1011
# We can be called recursively (tests for example), but we don't want
1012
# the verbosity level to propagate.
1013
saved_verbosity_level = option._verbosity_level
1014
option._verbosity_level = 0
1016
if opt_coverage_dir:
1018
'--coverage ignored, because --lsprof is in use.')
1019
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1021
if opt_coverage_dir:
1023
'--coverage ignored, because --profile is in use.')
1024
ret = apply_profiled(run, *run_argv)
1025
elif opt_coverage_dir:
1026
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1028
ret = run(*run_argv)
1031
# reset, in case we may do other commands later within the same
1032
# process. Commands that want to execute sub-commands must propagate
1033
# --verbose in their own way.
1034
if 'memory' in debug.debug_flags:
1035
trace.debug_memory('Process status after command:', short=False)
1036
option._verbosity_level = saved_verbosity_level
1039
def display_command(func):
1040
"""Decorator that suppresses pipe/interrupt errors."""
1041
def ignore_pipe(*args, **kwargs):
1043
result = func(*args, **kwargs)
1047
if getattr(e, 'errno', None) is None:
1049
if e.errno != errno.EPIPE:
1050
# Win32 raises IOError with errno=0 on a broken pipe
1051
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1054
except KeyboardInterrupt:
1059
def install_bzr_command_hooks():
1060
"""Install the hooks to supply bzr's own commands."""
1061
if _list_bzr_commands in Command.hooks["list_commands"]:
1063
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1065
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1067
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1068
"bzr plugin commands")
1069
Command.hooks.install_named_hook("get_command", _get_external_command,
1070
"bzr external command lookup")
1071
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1072
"bzr plugin-provider-db check")
1075
def main(argv=None):
1076
"""Main entry point of command-line interface.
1078
:param argv: list of unicode command-line arguments similar to sys.argv.
1079
argv[0] is script name usually, it will be ignored.
1080
Don't pass here sys.argv because this list contains plain strings
1081
and not unicode; pass None instead.
1083
:return: exit code of bzr command.
1086
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1087
sys.stdin, sys.stdout, sys.stderr)
1089
# Is this a final release version? If so, we should suppress warnings
1090
if bzrlib.version_info[3] == 'final':
1091
suppress_deprecation_warnings(override=True)
1093
argv = osutils.get_unicode_argv()
1097
# ensure all arguments are unicode strings
1099
if isinstance(a, unicode):
1102
new_argv.append(a.decode('ascii'))
1103
except UnicodeDecodeError:
1104
raise errors.BzrError("argv should be list of unicode strings.")
1106
ret = run_bzr_catch_errors(argv)
1107
bzrlib.ui.ui_factory.log_transport_activity(
1108
display=('bytes' in debug.debug_flags))
1109
trace.mutter("return code %d", ret)
1110
osutils.report_extension_load_failures()
1114
def run_bzr_catch_errors(argv):
1115
"""Run a bzr command with parameters as described by argv.
1117
This function assumed that that UI layer is setup, that symbol deprecations
1118
are already applied, and that unicode decoding has already been performed on argv.
1120
install_bzr_command_hooks()
1121
return exception_to_return_code(run_bzr, argv)
1124
def run_bzr_catch_user_errors(argv):
1125
"""Run bzr and report user errors, but let internal errors propagate.
1127
This is used for the test suite, and might be useful for other programs
1128
that want to wrap the commandline interface.
1130
install_bzr_command_hooks()
1132
return run_bzr(argv)
1133
except Exception, e:
1134
if (isinstance(e, (OSError, IOError))
1135
or not getattr(e, 'internal_error', True)):
1136
trace.report_exception(sys.exc_info(), sys.stderr)
1142
class HelpCommandIndex(object):
1143
"""A index for bzr help that returns commands."""
1146
self.prefix = 'commands/'
1148
def get_topics(self, topic):
1149
"""Search for topic amongst commands.
1151
:param topic: A topic to search for.
1152
:return: A list which is either empty or contains a single
1155
if topic and topic.startswith(self.prefix):
1156
topic = topic[len(self.prefix):]
1158
cmd = _get_cmd_object(topic)
1165
class Provider(object):
1166
'''Generic class to be overriden by plugins'''
1168
def plugin_for_command(self, cmd_name):
1169
'''Takes a command and returns the information for that plugin
1171
:return: A dictionary with all the available information
1172
for the requested plugin
1174
raise NotImplementedError
1177
class ProvidersRegistry(registry.Registry):
1178
'''This registry exists to allow other providers to exist'''
1181
for key, provider in self.iteritems():
1184
command_providers_registry = ProvidersRegistry()
1187
if __name__ == '__main__':
1188
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
