1
# Copyright (C) 2006, 2008 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
52
from bzrlib.hooks import HookPoint, Hooks
53
# Compatibility - Option used to be in commands.
54
from bzrlib.option import Option
55
from bzrlib import registry
56
from bzrlib.symbol_versioning import (
59
suppress_deprecation_warnings,
63
class CommandInfo(object):
64
"""Information about a command."""
66
def __init__(self, aliases):
67
"""The list of aliases for the command."""
68
self.aliases = aliases
71
def from_command(klass, command):
72
"""Factory to construct a CommandInfo from a command."""
73
return klass(command.aliases)
76
class CommandRegistry(registry.Registry):
79
def _get_name(command_name):
80
if command_name.startswith("cmd_"):
81
return _unsquish_command_name(command_name)
85
def register(self, cmd, decorate=False):
86
"""Utility function to help register a command
88
:param cmd: Command subclass to register
89
:param decorate: If true, allow overriding an existing command
90
of the same name; the old command is returned by this function.
91
Otherwise it is an error to try to override an existing command.
94
k_unsquished = self._get_name(k)
96
previous = self.get(k_unsquished)
98
previous = _builtin_commands().get(k_unsquished)
99
info = CommandInfo.from_command(cmd)
101
registry.Registry.register(self, k_unsquished, cmd,
102
override_existing=decorate, info=info)
104
trace.log_error('Two plugins defined the same command: %r' % k)
105
trace.log_error('Not loading the one in %r' %
106
sys.modules[cmd.__module__])
107
trace.log_error('Previously this command was registered from %r' %
108
sys.modules[previous.__module__])
111
def register_lazy(self, command_name, aliases, module_name):
112
"""Register a command without loading its module.
114
:param command_name: The primary name of the command.
115
:param aliases: A list of aliases for the command.
116
:module_name: The module that the command lives in.
118
key = self._get_name(command_name)
119
registry.Registry.register_lazy(self, key, module_name, command_name,
120
info=CommandInfo(aliases))
123
plugin_cmds = CommandRegistry()
126
def register_command(cmd, decorate=False):
128
return plugin_cmds.register(cmd, decorate)
131
def _squish_command_name(cmd):
132
return 'cmd_' + cmd.replace('-', '_')
135
def _unsquish_command_name(cmd):
136
return cmd[4:].replace('_','-')
139
def _builtin_commands():
140
import bzrlib.builtins
141
return _scan_module_for_commands(bzrlib.builtins)
144
def _scan_module_for_commands(module):
146
for name, obj in module.__dict__.iteritems():
147
if name.startswith("cmd_"):
148
real_name = _unsquish_command_name(name)
153
def _list_bzr_commands(names):
154
"""Find commands from bzr's core and plugins."""
155
# to eliminate duplicates
156
names.update(builtin_command_names())
157
names.update(plugin_command_names())
161
def all_command_names():
162
"""Return a set of all command names."""
164
for hook in Command.hooks['list_commands']:
167
raise AssertionError(
168
'hook %s returned None' % Command.hooks.get_hook_name(hook))
172
def builtin_command_names():
173
"""Return list of builtin command names.
175
Use of all_command_names() is encouraged rather than builtin_command_names
176
and/or plugin_command_names.
178
return _builtin_commands().keys()
181
def plugin_command_names():
182
"""Returns command names from commands registered by plugins."""
183
return plugin_cmds.keys()
186
@deprecated_function(deprecated_in((1, 17, 0)))
187
def get_all_cmds(plugins_override=False):
188
"""Return canonical name and class for most commands.
190
NB: This does not return all commands since the introduction of
191
command hooks, and returning the class is not sufficient to
192
get correctly setup commands, which is why it is deprecated.
194
Use 'all_command_names' + 'get_cmd_object' instead.
196
d = _builtin_commands()
198
d.update(plugin_cmds.iteritems())
199
for k, v in d.iteritems():
203
def get_cmd_object(cmd_name, plugins_override=True):
204
"""Return the command object for a command.
207
If true, plugin commands can override builtins.
210
return _get_cmd_object(cmd_name, plugins_override)
212
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
215
def _get_cmd_object(cmd_name, plugins_override=True):
216
"""Get a command object.
218
:param cmd_name: The name of the command.
219
:param plugins_override: Allow plugins to override builtins.
220
:return: A Command object instance
221
:raises KeyError: If no command is found.
223
# We want only 'ascii' command names, but the user may have typed
224
# in a Unicode name. In that case, they should just get a
225
# 'command not found' error later.
226
# In the future, we may actually support Unicode command names.
229
for hook in Command.hooks['get_command']:
230
cmd = hook(cmd, cmd_name)
231
if cmd is not None and not plugins_override and not cmd.plugin_name():
232
# We've found a non-plugin command, don't permit it to be
236
for hook in Command.hooks['get_missing_command']:
243
# Allow plugins to extend commands
244
for hook in Command.hooks['extend_command']:
249
def _try_plugin_provider(cmd_name):
250
"""Probe for a plugin provider having cmd_name."""
252
plugin_metadata, provider = probe_for_provider(cmd_name)
253
raise errors.CommandAvailableInPlugin(cmd_name,
254
plugin_metadata, provider)
255
except errors.NoPluginAvailable:
259
def probe_for_provider(cmd_name):
260
"""Look for a provider for cmd_name.
262
:param cmd_name: The command name.
263
:return: plugin_metadata, provider for getting cmd_name.
264
:raises NoPluginAvailable: When no provider can supply the plugin.
266
# look for providers that provide this command but aren't installed
267
for provider in command_providers_registry:
269
return provider.plugin_for_command(cmd_name), provider
270
except errors.NoPluginAvailable:
272
raise errors.NoPluginAvailable(cmd_name)
275
def _get_bzr_command(cmd_or_None, cmd_name):
276
"""Get a command from bzr's core."""
277
cmds = _builtin_commands()
279
return cmds[cmd_name]()
282
# look for any command which claims this as an alias
283
for real_cmd_name, cmd_class in cmds.iteritems():
284
if cmd_name in cmd_class.aliases:
289
def _get_external_command(cmd_or_None, cmd_name):
290
"""Lookup a command that is a shell script."""
291
# Only do external command lookups when no command is found so far.
292
if cmd_or_None is not None:
294
from bzrlib.externalcommand import ExternalCommand
295
cmd_obj = ExternalCommand.find_command(cmd_name)
300
def _get_plugin_command(cmd_or_None, cmd_name):
301
"""Get a command from bzr's plugins."""
303
return plugin_cmds.get(cmd_name)()
306
for key in plugin_cmds.keys():
307
info = plugin_cmds.get_info(key)
308
if cmd_name in info.aliases:
309
return plugin_cmds.get(key)()
313
class Command(object):
314
"""Base class for commands.
316
Commands are the heart of the command-line bzr interface.
318
The command object mostly handles the mapping of command-line
319
parameters into one or more bzrlib operations, and of the results
322
Commands normally don't have any state. All their arguments are
323
passed in to the run method. (Subclasses may take a different
324
policy if the behaviour of the instance needs to depend on e.g. a
325
shell plugin and not just its Python class.)
327
The docstring for an actual command should give a single-line
328
summary, then a complete description of the command. A grammar
329
description will be inserted.
332
Other accepted names for this command.
335
List of argument forms, marked with whether they are optional,
340
['to_location', 'from_branch?', 'file*']
342
'to_location' is required
343
'from_branch' is optional
344
'file' can be specified 0 or more times
347
List of options that may be given for this command. These can
348
be either strings, referring to globally-defined options,
349
or option objects. Retrieve through options().
352
If true, this command isn't advertised. This is typically
353
for commands intended for expert users.
356
Command objects will get a 'outf' attribute, which has been
357
setup to properly handle encoding of unicode strings.
358
encoding_type determines what will happen when characters cannot
360
strict - abort if we cannot decode
361
replace - put in a bogus character (typically '?')
362
exact - do not encode sys.stdout
364
NOTE: by default on Windows, sys.stdout is opened as a text
365
stream, therefore LF line-endings are converted to CRLF.
366
When a command uses encoding_type = 'exact', then
367
sys.stdout is forced to be a binary stream, and line-endings
370
:cvar hooks: An instance of CommandHooks.
375
encoding_type = 'strict'
380
"""Construct an instance of this command."""
381
if self.__doc__ == Command.__doc__:
382
warn("No help message set for %r" % self)
383
# List of standard options directly supported
384
self.supported_std_options = []
386
def _maybe_expand_globs(self, file_list):
387
"""Glob expand file_list if the platform does not do that itself.
389
:return: A possibly empty list of unicode paths.
391
Introduced in bzrlib 0.18.
395
if sys.platform == 'win32':
396
file_list = win32utils.glob_expand(file_list)
397
return list(file_list)
400
"""Return single-line grammar for this command.
402
Only describes arguments, not options.
404
s = 'bzr ' + self.name() + ' '
405
for aname in self.takes_args:
406
aname = aname.upper()
407
if aname[-1] in ['$', '+']:
408
aname = aname[:-1] + '...'
409
elif aname[-1] == '?':
410
aname = '[' + aname[:-1] + ']'
411
elif aname[-1] == '*':
412
aname = '[' + aname[:-1] + '...]'
414
s = s[:-1] # remove last space
417
def get_help_text(self, additional_see_also=None, plain=True,
418
see_also_as_links=False, verbose=True):
419
"""Return a text string with help for this command.
421
:param additional_see_also: Additional help topics to be
423
:param plain: if False, raw help (reStructuredText) is
424
returned instead of plain text.
425
:param see_also_as_links: if True, convert items in 'See also'
426
list to internal links (used by bzr_man rstx generator)
427
:param verbose: if True, display the full help, otherwise
428
leave out the descriptive sections and just display
429
usage help (e.g. Purpose, Usage, Options) with a
430
message explaining how to obtain full help.
434
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
436
# Extract the summary (purpose) and sections out from the text
437
purpose,sections,order = self._get_help_parts(doc)
439
# If a custom usage section was provided, use it
440
if sections.has_key('Usage'):
441
usage = sections.pop('Usage')
443
usage = self._usage()
445
# The header is the purpose and usage
447
result += ':Purpose: %s\n' % purpose
448
if usage.find('\n') >= 0:
449
result += ':Usage:\n%s\n' % usage
451
result += ':Usage: %s\n' % usage
456
# XXX: optparse implicitly rewraps the help, and not always perfectly,
457
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
459
options = option.get_optparser(self.options()).format_option_help()
460
# XXX: According to the spec, ReST option lists actually don't support
461
# options like --1.9 so that causes syntax errors (in Sphinx at least).
462
# As that pattern always appears in the commands that break, we trap
463
# on that and then format that block of 'format' options as a literal
465
if not plain and options.find(' --1.9 ') != -1:
466
options = options.replace(' format:\n', ' format::\n\n', 1)
467
if options.startswith('Options:'):
468
result += ':' + options
469
elif options.startswith('options:'):
470
# Python 2.4 version of optparse
471
result += ':Options:' + options[len('options:'):]
477
# Add the description, indenting it 2 spaces
478
# to match the indentation of the options
479
if sections.has_key(None):
480
text = sections.pop(None)
481
text = '\n '.join(text.splitlines())
482
result += ':%s:\n %s\n\n' % ('Description',text)
484
# Add the custom sections (e.g. Examples). Note that there's no need
485
# to indent these as they must be indented already in the source.
488
if sections.has_key(label):
489
result += ':%s:\n%s\n' % (label,sections[label])
492
result += ("See bzr help %s for more details and examples.\n\n"
495
# Add the aliases, source (plug-in) and see also links, if any
497
result += ':Aliases: '
498
result += ', '.join(self.aliases) + '\n'
499
plugin_name = self.plugin_name()
500
if plugin_name is not None:
501
result += ':From: plugin "%s"\n' % plugin_name
502
see_also = self.get_see_also(additional_see_also)
504
if not plain and see_also_as_links:
506
for item in see_also:
508
# topics doesn't have an independent section
509
# so don't create a real link
510
see_also_links.append(item)
512
# Use a reST link for this entry
513
see_also_links.append("`%s`_" % (item,))
514
see_also = see_also_links
515
result += ':See also: '
516
result += ', '.join(see_also) + '\n'
518
# If this will be rendered as plain text, convert it
520
import bzrlib.help_topics
521
result = bzrlib.help_topics.help_as_plain_text(result)
525
def _get_help_parts(text):
526
"""Split help text into a summary and named sections.
528
:return: (summary,sections,order) where summary is the top line and
529
sections is a dictionary of the rest indexed by section name.
530
order is the order the section appear in the text.
531
A section starts with a heading line of the form ":xxx:".
532
Indented text on following lines is the section value.
533
All text found outside a named section is assigned to the
534
default section which is given the key of None.
536
def save_section(sections, order, label, section):
538
if sections.has_key(label):
539
sections[label] += '\n' + section
542
sections[label] = section
544
lines = text.rstrip().splitlines()
545
summary = lines.pop(0)
548
label,section = None,''
550
if line.startswith(':') and line.endswith(':') and len(line) > 2:
551
save_section(sections, order, label, section)
552
label,section = line[1:-1],''
553
elif (label is not None) and len(line) > 1 and not line[0].isspace():
554
save_section(sections, order, label, section)
555
label,section = None,line
558
section += '\n' + line
561
save_section(sections, order, label, section)
562
return summary, sections, order
564
def get_help_topic(self):
565
"""Return the commands help topic - its name."""
568
def get_see_also(self, additional_terms=None):
569
"""Return a list of help topics that are related to this command.
571
The list is derived from the content of the _see_also attribute. Any
572
duplicates are removed and the result is in lexical order.
573
:param additional_terms: Additional help topics to cross-reference.
574
:return: A list of help topics.
576
see_also = set(getattr(self, '_see_also', []))
578
see_also.update(additional_terms)
579
return sorted(see_also)
582
"""Return dict of valid options for this command.
584
Maps from long option name to option object."""
585
r = Option.STD_OPTIONS.copy()
587
for o in self.takes_options:
588
if isinstance(o, basestring):
589
o = option.Option.OPTIONS[o]
591
if o.name in std_names:
592
self.supported_std_options.append(o.name)
595
def _setup_outf(self):
596
"""Return a file linked to stdout, which has proper encoding."""
597
# Originally I was using self.stdout, but that looks
598
# *way* too much like sys.stdout
599
if self.encoding_type == 'exact':
600
# force sys.stdout to be binary stream on win32
601
if sys.platform == 'win32':
602
fileno = getattr(sys.stdout, 'fileno', None)
605
msvcrt.setmode(fileno(), os.O_BINARY)
606
self.outf = sys.stdout
609
output_encoding = osutils.get_terminal_encoding()
611
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
612
errors=self.encoding_type)
613
# For whatever reason codecs.getwriter() does not advertise its encoding
614
# it just returns the encoding of the wrapped file, which is completely
615
# bogus. So set the attribute, so we can find the correct encoding later.
616
self.outf.encoding = output_encoding
618
def run_argv_aliases(self, argv, alias_argv=None):
619
"""Parse the command line and run with extra aliases in alias_argv."""
621
warn("Passing None for [] is deprecated from bzrlib 0.10",
622
DeprecationWarning, stacklevel=2)
624
args, opts = parse_args(self, argv, alias_argv)
626
# Process the standard options
627
if 'help' in opts: # e.g. bzr add --help
628
sys.stdout.write(self.get_help_text())
630
if 'usage' in opts: # e.g. bzr add --usage
631
sys.stdout.write(self.get_help_text(verbose=False))
633
trace.set_verbosity_level(option._verbosity_level)
634
if 'verbose' in self.supported_std_options:
635
opts['verbose'] = trace.is_verbose()
636
elif opts.has_key('verbose'):
638
if 'quiet' in self.supported_std_options:
639
opts['quiet'] = trace.is_quiet()
640
elif opts.has_key('quiet'):
643
# mix arguments and options into one dictionary
644
cmdargs = _match_argform(self.name(), self.takes_args, args)
646
for k, v in opts.items():
647
cmdopts[k.replace('-', '_')] = v
649
all_cmd_args = cmdargs.copy()
650
all_cmd_args.update(cmdopts)
654
return self.run(**all_cmd_args)
657
"""Actually run the command.
659
This is invoked with the options and arguments bound to
662
Return 0 or None if the command was successful, or a non-zero
663
shell error code if not. It's OK for this method to allow
664
an exception to raise up.
666
raise NotImplementedError('no implementation of command %r'
670
"""Return help message for this class."""
671
from inspect import getdoc
672
if self.__doc__ is Command.__doc__:
677
return _unsquish_command_name(self.__class__.__name__)
679
def plugin_name(self):
680
"""Get the name of the plugin that provides this command.
682
:return: The name of the plugin or None if the command is builtin.
684
mod_parts = self.__module__.split('.')
685
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
691
class CommandHooks(Hooks):
692
"""Hooks related to Command object creation/enumeration."""
695
"""Create the default hooks.
697
These are all empty initially, because by default nothing should get
701
self.create_hook(HookPoint('extend_command',
702
"Called after creating a command object to allow modifications "
703
"such as adding or removing options, docs etc. Called with the "
704
"new bzrlib.commands.Command object.", (1, 13), None))
705
self.create_hook(HookPoint('get_command',
706
"Called when creating a single command. Called with "
707
"(cmd_or_None, command_name). get_command should either return "
708
"the cmd_or_None parameter, or a replacement Command object that "
709
"should be used for the command. Note that the Command.hooks "
710
"hooks are core infrastructure. Many users will prefer to use "
711
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
713
self.create_hook(HookPoint('get_missing_command',
714
"Called when creating a single command if no command could be "
715
"found. Called with (command_name). get_missing_command should "
716
"either return None, or a Command object to be used for the "
717
"command.", (1, 17), None))
718
self.create_hook(HookPoint('list_commands',
719
"Called when enumerating commands. Called with a set of "
720
"cmd_name strings for all the commands found so far. This set "
721
" is safe to mutate - e.g. to remove a command. "
722
"list_commands should return the updated set of command names.",
725
Command.hooks = CommandHooks()
728
def parse_args(command, argv, alias_argv=None):
729
"""Parse command line.
731
Arguments and options are parsed at this level before being passed
732
down to specific command handlers. This routine knows, from a
733
lookup table, something about the available options, what optargs
734
they take, and which commands will accept them.
736
# TODO: make it a method of the Command?
737
parser = option.get_optparser(command.options())
738
if alias_argv is not None:
739
args = alias_argv + argv
743
options, args = parser.parse_args(args)
744
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
745
v is not option.OptionParser.DEFAULT_VALUE])
749
def _match_argform(cmd, takes_args, args):
752
# step through args and takes_args, allowing appropriate 0-many matches
753
for ap in takes_args:
757
argdict[argname] = args.pop(0)
758
elif ap[-1] == '*': # all remaining arguments
760
argdict[argname + '_list'] = args[:]
763
argdict[argname + '_list'] = None
766
raise errors.BzrCommandError("command %r needs one or more %s"
767
% (cmd, argname.upper()))
769
argdict[argname + '_list'] = args[:]
771
elif ap[-1] == '$': # all but one
773
raise errors.BzrCommandError("command %r needs one or more %s"
774
% (cmd, argname.upper()))
775
argdict[argname + '_list'] = args[:-1]
781
raise errors.BzrCommandError("command %r requires argument %s"
782
% (cmd, argname.upper()))
784
argdict[argname] = args.pop(0)
787
raise errors.BzrCommandError("extra argument to command %s: %s"
792
def apply_coveraged(dirname, the_callable, *args, **kwargs):
793
# Cannot use "import trace", as that would import bzrlib.trace instead of
794
# the standard library's trace.
795
trace = __import__('trace')
797
tracer = trace.Trace(count=1, trace=0)
798
sys.settrace(tracer.globaltrace)
799
threading.settrace(tracer.globaltrace)
802
return exception_to_return_code(the_callable, *args, **kwargs)
805
results = tracer.results()
806
results.write_results(show_missing=1, summary=False,
810
def apply_profiled(the_callable, *args, **kwargs):
814
pffileno, pfname = tempfile.mkstemp()
816
prof = hotshot.Profile(pfname)
818
ret = prof.runcall(exception_to_return_code, the_callable, *args,
822
stats = hotshot.stats.load(pfname)
824
stats.sort_stats('cum') # 'time'
825
## XXX: Might like to write to stderr or the trace file instead but
826
## print_stats seems hardcoded to stdout
827
stats.print_stats(20)
834
def exception_to_return_code(the_callable, *args, **kwargs):
835
"""UI level helper for profiling and coverage.
837
This transforms exceptions into a return value of 3. As such its only
838
relevant to the UI layer, and should never be called where catching
839
exceptions may be desirable.
842
return the_callable(*args, **kwargs)
843
except (KeyboardInterrupt, Exception), e:
844
# used to handle AssertionError and KeyboardInterrupt
845
# specially here, but hopefully they're handled ok by the logger now
846
exc_info = sys.exc_info()
847
exitcode = trace.report_exception(exc_info, sys.stderr)
848
if os.environ.get('BZR_PDB'):
849
print '**** entering debugger'
852
if sys.version_info[:2] < (2, 6):
854
# pdb.post_mortem(tb)
855
# but because pdb.post_mortem gives bad results for tracebacks
856
# from inside generators, we do it manually.
857
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
859
# Setup pdb on the traceback
862
p.setup(tb.tb_frame, tb)
863
# Point the debugger at the deepest frame of the stack
864
p.curindex = len(p.stack) - 1
865
p.curframe = p.stack[p.curindex][0]
866
# Start the pdb prompt.
867
p.print_stack_entry(p.stack[p.curindex])
875
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
876
from bzrlib.lsprof import profile
877
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
883
trace.note('Profile data written to "%s".', filename)
887
def shlex_split_unicode(unsplit):
889
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
892
def get_alias(cmd, config=None):
893
"""Return an expanded alias, or None if no alias exists.
896
Command to be checked for an alias.
898
Used to specify an alternative config to use,
899
which is especially useful for testing.
900
If it is unspecified, the global config will be used.
904
config = bzrlib.config.GlobalConfig()
905
alias = config.get_alias(cmd)
907
return shlex_split_unicode(alias)
912
"""Execute a command.
915
The command-line arguments, without the program name from argv[0]
916
These should already be decoded. All library/test code calling
917
run_bzr should be passing valid strings (don't need decoding).
919
Returns a command status or raises an exception.
921
Special master options: these must come before the command because
922
they control how the command is interpreted.
925
Do not load plugin modules at all
931
Only use builtin commands. (Plugins are still allowed to change
935
Run under the Python hotshot profiler.
938
Run under the Python lsprof profiler.
941
Generate line coverage report in the specified directory.
944
trace.mutter("bzr arguments: %r", argv)
946
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
947
opt_no_aliases = False
948
opt_lsprof_file = opt_coverage_dir = None
950
# --no-plugins is handled specially at a very early stage. We need
951
# to load plugins before doing other command parsing so that they
952
# can override commands, but this needs to happen first.
960
elif a == '--lsprof':
962
elif a == '--lsprof-file':
964
opt_lsprof_file = argv[i + 1]
966
elif a == '--no-plugins':
967
opt_no_plugins = True
968
elif a == '--no-aliases':
969
opt_no_aliases = True
970
elif a == '--builtin':
972
elif a == '--coverage':
973
opt_coverage_dir = argv[i + 1]
975
elif a.startswith('-D'):
976
debug.debug_flags.add(a[2:])
981
debug.set_debug_flags_from_config()
985
from bzrlib.builtins import cmd_help
986
cmd_help().run_argv_aliases([])
989
if argv[0] == '--version':
990
from bzrlib.builtins import cmd_version
991
cmd_version().run_argv_aliases([])
994
if not opt_no_plugins:
995
from bzrlib.plugin import load_plugins
998
from bzrlib.plugin import disable_plugins
1003
if not opt_no_aliases:
1004
alias_argv = get_alias(argv[0])
1006
user_encoding = osutils.get_user_encoding()
1007
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1008
argv[0] = alias_argv.pop(0)
1011
# We want only 'ascii' command names, but the user may have typed
1012
# in a Unicode name. In that case, they should just get a
1013
# 'command not found' error later.
1015
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1016
run = cmd_obj.run_argv_aliases
1017
run_argv = [argv, alias_argv]
1020
# We can be called recursively (tests for example), but we don't want
1021
# the verbosity level to propagate.
1022
saved_verbosity_level = option._verbosity_level
1023
option._verbosity_level = 0
1025
if opt_coverage_dir:
1027
'--coverage ignored, because --lsprof is in use.')
1028
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1030
if opt_coverage_dir:
1032
'--coverage ignored, because --profile is in use.')
1033
ret = apply_profiled(run, *run_argv)
1034
elif opt_coverage_dir:
1035
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1037
ret = run(*run_argv)
1038
if 'memory' in debug.debug_flags:
1039
trace.debug_memory('Process status after command:', short=False)
1042
# reset, in case we may do other commands later within the same
1043
# process. Commands that want to execute sub-commands must propagate
1044
# --verbose in their own way.
1045
option._verbosity_level = saved_verbosity_level
1048
def display_command(func):
1049
"""Decorator that suppresses pipe/interrupt errors."""
1050
def ignore_pipe(*args, **kwargs):
1052
result = func(*args, **kwargs)
1056
if getattr(e, 'errno', None) is None:
1058
if e.errno != errno.EPIPE:
1059
# Win32 raises IOError with errno=0 on a broken pipe
1060
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1063
except KeyboardInterrupt:
1068
def install_bzr_command_hooks():
1069
"""Install the hooks to supply bzr's own commands."""
1070
if _list_bzr_commands in Command.hooks["list_commands"]:
1072
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1074
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1076
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1077
"bzr plugin commands")
1078
Command.hooks.install_named_hook("get_command", _get_external_command,
1079
"bzr external command lookup")
1080
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1081
"bzr plugin-provider-db check")
1084
def main(argv=None):
1085
"""Main entry point of command-line interface.
1087
:param argv: list of unicode command-line arguments similar to sys.argv.
1088
argv[0] is script name usually, it will be ignored.
1089
Don't pass here sys.argv because this list contains plain strings
1090
and not unicode; pass None instead.
1092
:return: exit code of bzr command.
1095
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1096
sys.stdin, sys.stdout, sys.stderr)
1098
# Is this a final release version? If so, we should suppress warnings
1099
if bzrlib.version_info[3] == 'final':
1100
suppress_deprecation_warnings(override=True)
1102
argv = osutils.get_unicode_argv()
1106
# ensure all arguments are unicode strings
1108
if isinstance(a, unicode):
1111
new_argv.append(a.decode('ascii'))
1112
except UnicodeDecodeError:
1113
raise errors.BzrError("argv should be list of unicode strings.")
1115
ret = run_bzr_catch_errors(argv)
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
install_bzr_command_hooks()
1127
return exception_to_return_code(run_bzr, argv)
1130
def run_bzr_catch_user_errors(argv):
1131
"""Run bzr and report user errors, but let internal errors propagate.
1133
This is used for the test suite, and might be useful for other programs
1134
that want to wrap the commandline interface.
1136
install_bzr_command_hooks()
1138
return run_bzr(argv)
1139
except Exception, e:
1140
if (isinstance(e, (OSError, IOError))
1141
or not getattr(e, 'internal_error', True)):
1142
trace.report_exception(sys.exc_info(), sys.stderr)
1148
class HelpCommandIndex(object):
1149
"""A index for bzr help that returns commands."""
1152
self.prefix = 'commands/'
1154
def get_topics(self, topic):
1155
"""Search for topic amongst commands.
1157
:param topic: A topic to search for.
1158
:return: A list which is either empty or contains a single
1161
if topic and topic.startswith(self.prefix):
1162
topic = topic[len(self.prefix):]
1164
cmd = _get_cmd_object(topic)
1171
class Provider(object):
1172
'''Generic class to be overriden by plugins'''
1174
def plugin_for_command(self, cmd_name):
1175
'''Takes a command and returns the information for that plugin
1177
:return: A dictionary with all the available information
1178
for the requested plugin
1180
raise NotImplementedError
1183
class ProvidersRegistry(registry.Registry):
1184
'''This registry exists to allow other providers to exist'''
1187
for key, provider in self.iteritems():
1190
command_providers_registry = ProvidersRegistry()
1193
if __name__ == '__main__':
1194
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
