1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Define arguments by objects, rather than just using names.
22
# Those objects can specify the expected type of the argument, which
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
39
from warnings import warn
55
from bzrlib.hooks import HookPoint, Hooks
56
# Compatibility - Option used to be in commands.
57
from bzrlib.option import Option
58
from bzrlib.plugin import disable_plugins, load_plugins
59
from bzrlib import registry
60
from bzrlib.symbol_versioning import (
67
class CommandInfo(object):
68
"""Information about a command."""
70
def __init__(self, aliases):
71
"""The list of aliases for the command."""
72
self.aliases = aliases
75
def from_command(klass, command):
76
"""Factory to construct a CommandInfo from a command."""
77
return klass(command.aliases)
80
class CommandRegistry(registry.Registry):
83
def _get_name(command_name):
84
if command_name.startswith("cmd_"):
85
return _unsquish_command_name(command_name)
89
def register(self, cmd, decorate=False):
90
"""Utility function to help register a command
92
:param cmd: Command subclass to register
93
:param decorate: If true, allow overriding an existing command
94
of the same name; the old command is returned by this function.
95
Otherwise it is an error to try to override an existing command.
98
k_unsquished = self._get_name(k)
100
previous = self.get(k_unsquished)
102
previous = _builtin_commands().get(k_unsquished)
103
info = CommandInfo.from_command(cmd)
105
registry.Registry.register(self, k_unsquished, cmd,
106
override_existing=decorate, info=info)
108
trace.warning('Two plugins defined the same command: %r' % k)
109
trace.warning('Not loading the one in %r' %
110
sys.modules[cmd.__module__])
111
trace.warning('Previously this command was registered from %r' %
112
sys.modules[previous.__module__])
115
def register_lazy(self, command_name, aliases, module_name):
116
"""Register a command without loading its module.
118
:param command_name: The primary name of the command.
119
:param aliases: A list of aliases for the command.
120
:module_name: The module that the command lives in.
122
key = self._get_name(command_name)
123
registry.Registry.register_lazy(self, key, module_name, command_name,
124
info=CommandInfo(aliases))
127
plugin_cmds = CommandRegistry()
130
def register_command(cmd, decorate=False):
132
return plugin_cmds.register(cmd, decorate)
135
def _squish_command_name(cmd):
136
return 'cmd_' + cmd.replace('-', '_')
139
def _unsquish_command_name(cmd):
140
return cmd[4:].replace('_','-')
143
def _builtin_commands():
144
import bzrlib.builtins
145
return _scan_module_for_commands(bzrlib.builtins)
148
def _scan_module_for_commands(module):
150
for name, obj in module.__dict__.iteritems():
151
if name.startswith("cmd_"):
152
real_name = _unsquish_command_name(name)
157
def _list_bzr_commands(names):
158
"""Find commands from bzr's core and plugins."""
159
# to eliminate duplicates
160
names.update(builtin_command_names())
161
names.update(plugin_command_names())
165
def all_command_names():
166
"""Return a set of all command names."""
168
for hook in Command.hooks['list_commands']:
171
raise AssertionError(
172
'hook %s returned None' % Command.hooks.get_hook_name(hook))
176
def builtin_command_names():
177
"""Return list of builtin command names.
179
Use of all_command_names() is encouraged rather than builtin_command_names
180
and/or plugin_command_names.
182
return _builtin_commands().keys()
185
def plugin_command_names():
186
"""Returns command names from commands registered by plugins."""
187
return plugin_cmds.keys()
190
def get_cmd_object(cmd_name, plugins_override=True):
191
"""Return the command object for a command.
194
If true, plugin commands can override builtins.
197
return _get_cmd_object(cmd_name, plugins_override)
199
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
202
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
203
"""Get a command object.
205
:param cmd_name: The name of the command.
206
:param plugins_override: Allow plugins to override builtins.
207
:param check_missing: Look up commands not found in the regular index via
208
the get_missing_command hook.
209
:return: A Command object instance
210
:raises KeyError: If no command is found.
212
# We want only 'ascii' command names, but the user may have typed
213
# in a Unicode name. In that case, they should just get a
214
# 'command not found' error later.
215
# In the future, we may actually support Unicode command names.
218
for hook in Command.hooks['get_command']:
219
cmd = hook(cmd, cmd_name)
220
if cmd is not None and not plugins_override and not cmd.plugin_name():
221
# We've found a non-plugin command, don't permit it to be
224
if cmd is None and check_missing:
225
for hook in Command.hooks['get_missing_command']:
232
# Allow plugins to extend commands
233
for hook in Command.hooks['extend_command']:
238
def _try_plugin_provider(cmd_name):
239
"""Probe for a plugin provider having cmd_name."""
241
plugin_metadata, provider = probe_for_provider(cmd_name)
242
raise errors.CommandAvailableInPlugin(cmd_name,
243
plugin_metadata, provider)
244
except errors.NoPluginAvailable:
248
def probe_for_provider(cmd_name):
249
"""Look for a provider for cmd_name.
251
:param cmd_name: The command name.
252
:return: plugin_metadata, provider for getting cmd_name.
253
:raises NoPluginAvailable: When no provider can supply the plugin.
255
# look for providers that provide this command but aren't installed
256
for provider in command_providers_registry:
258
return provider.plugin_for_command(cmd_name), provider
259
except errors.NoPluginAvailable:
261
raise errors.NoPluginAvailable(cmd_name)
264
def _get_bzr_command(cmd_or_None, cmd_name):
265
"""Get a command from bzr's core."""
266
cmds = _builtin_commands()
268
return cmds[cmd_name]()
271
# look for any command which claims this as an alias
272
for real_cmd_name, cmd_class in cmds.iteritems():
273
if cmd_name in cmd_class.aliases:
278
def _get_external_command(cmd_or_None, cmd_name):
279
"""Lookup a command that is a shell script."""
280
# Only do external command lookups when no command is found so far.
281
if cmd_or_None is not None:
283
from bzrlib.externalcommand import ExternalCommand
284
cmd_obj = ExternalCommand.find_command(cmd_name)
289
def _get_plugin_command(cmd_or_None, cmd_name):
290
"""Get a command from bzr's plugins."""
292
return plugin_cmds.get(cmd_name)()
295
for key in plugin_cmds.keys():
296
info = plugin_cmds.get_info(key)
297
if cmd_name in info.aliases:
298
return plugin_cmds.get(key)()
302
class Command(object):
303
"""Base class for commands.
305
Commands are the heart of the command-line bzr interface.
307
The command object mostly handles the mapping of command-line
308
parameters into one or more bzrlib operations, and of the results
311
Commands normally don't have any state. All their arguments are
312
passed in to the run method. (Subclasses may take a different
313
policy if the behaviour of the instance needs to depend on e.g. a
314
shell plugin and not just its Python class.)
316
The docstring for an actual command should give a single-line
317
summary, then a complete description of the command. A grammar
318
description will be inserted.
321
Other accepted names for this command.
324
List of argument forms, marked with whether they are optional,
329
['to_location', 'from_branch?', 'file*']
331
'to_location' is required
332
'from_branch' is optional
333
'file' can be specified 0 or more times
336
List of options that may be given for this command. These can
337
be either strings, referring to globally-defined options,
338
or option objects. Retrieve through options().
341
If true, this command isn't advertised. This is typically
342
for commands intended for expert users.
345
Command objects will get a 'outf' attribute, which has been
346
setup to properly handle encoding of unicode strings.
347
encoding_type determines what will happen when characters cannot
349
strict - abort if we cannot decode
350
replace - put in a bogus character (typically '?')
351
exact - do not encode sys.stdout
353
NOTE: by default on Windows, sys.stdout is opened as a text
354
stream, therefore LF line-endings are converted to CRLF.
355
When a command uses encoding_type = 'exact', then
356
sys.stdout is forced to be a binary stream, and line-endings
359
:cvar hooks: An instance of CommandHooks.
364
encoding_type = 'strict'
369
"""Construct an instance of this command."""
370
if self.__doc__ == Command.__doc__:
371
warn("No help message set for %r" % self)
372
# List of standard options directly supported
373
self.supported_std_options = []
374
self._operation = cleanup.OperationWithCleanups(self.run)
376
def add_cleanup(self, cleanup_func, *args, **kwargs):
377
"""Register a function to call after self.run returns or raises.
379
Functions will be called in LIFO order.
381
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
383
def cleanup_now(self):
384
"""Execute and empty pending cleanup functions immediately.
386
After cleanup_now all registered cleanups are forgotten. add_cleanup
387
may be called again after cleanup_now; these cleanups will be called
388
after self.run returns or raises (or when cleanup_now is next called).
390
This is useful for releasing expensive or contentious resources (such
391
as write locks) before doing further work that does not require those
392
resources (such as writing results to self.outf).
394
self._operation.cleanup_now()
396
@deprecated_method(deprecated_in((2, 1, 0)))
397
def _maybe_expand_globs(self, file_list):
398
"""Glob expand file_list if the platform does not do that itself.
400
Not used anymore, now that the bzr command-line parser globs on
403
:return: A possibly empty list of unicode paths.
405
Introduced in bzrlib 0.18.
410
"""Return single-line grammar for this command.
412
Only describes arguments, not options.
414
s = 'bzr ' + self.name() + ' '
415
for aname in self.takes_args:
416
aname = aname.upper()
417
if aname[-1] in ['$', '+']:
418
aname = aname[:-1] + '...'
419
elif aname[-1] == '?':
420
aname = '[' + aname[:-1] + ']'
421
elif aname[-1] == '*':
422
aname = '[' + aname[:-1] + '...]'
424
s = s[:-1] # remove last space
427
def get_help_text(self, additional_see_also=None, plain=True,
428
see_also_as_links=False, verbose=True):
429
"""Return a text string with help for this command.
431
:param additional_see_also: Additional help topics to be
433
:param plain: if False, raw help (reStructuredText) is
434
returned instead of plain text.
435
:param see_also_as_links: if True, convert items in 'See also'
436
list to internal links (used by bzr_man rstx generator)
437
:param verbose: if True, display the full help, otherwise
438
leave out the descriptive sections and just display
439
usage help (e.g. Purpose, Usage, Options) with a
440
message explaining how to obtain full help.
444
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
446
# Extract the summary (purpose) and sections out from the text
447
purpose,sections,order = self._get_help_parts(doc)
449
# If a custom usage section was provided, use it
450
if sections.has_key('Usage'):
451
usage = sections.pop('Usage')
453
usage = self._usage()
455
# The header is the purpose and usage
457
result += ':Purpose: %s\n' % purpose
458
if usage.find('\n') >= 0:
459
result += ':Usage:\n%s\n' % usage
461
result += ':Usage: %s\n' % usage
466
# XXX: optparse implicitly rewraps the help, and not always perfectly,
467
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
469
options = option.get_optparser(self.options()).format_option_help()
470
# XXX: According to the spec, ReST option lists actually don't support
471
# options like --1.9 so that causes syntax errors (in Sphinx at least).
472
# As that pattern always appears in the commands that break, we trap
473
# on that and then format that block of 'format' options as a literal
475
if not plain and options.find(' --1.9 ') != -1:
476
options = options.replace(' format:\n', ' format::\n\n', 1)
477
if options.startswith('Options:'):
478
result += ':' + options
479
elif options.startswith('options:'):
480
# Python 2.4 version of optparse
481
result += ':Options:' + options[len('options:'):]
487
# Add the description, indenting it 2 spaces
488
# to match the indentation of the options
489
if sections.has_key(None):
490
text = sections.pop(None)
491
text = '\n '.join(text.splitlines())
492
result += ':%s:\n %s\n\n' % ('Description',text)
494
# Add the custom sections (e.g. Examples). Note that there's no need
495
# to indent these as they must be indented already in the source.
498
if sections.has_key(label):
499
result += ':%s:\n%s\n' % (label,sections[label])
502
result += ("See bzr help %s for more details and examples.\n\n"
505
# Add the aliases, source (plug-in) and see also links, if any
507
result += ':Aliases: '
508
result += ', '.join(self.aliases) + '\n'
509
plugin_name = self.plugin_name()
510
if plugin_name is not None:
511
result += ':From: plugin "%s"\n' % plugin_name
512
see_also = self.get_see_also(additional_see_also)
514
if not plain and see_also_as_links:
516
for item in see_also:
518
# topics doesn't have an independent section
519
# so don't create a real link
520
see_also_links.append(item)
522
# Use a Sphinx link for this entry
523
link_text = ":doc:`%s <%s-help>`" % (item, item)
524
see_also_links.append(link_text)
525
see_also = see_also_links
526
result += ':See also: '
527
result += ', '.join(see_also) + '\n'
529
# If this will be rendered as plain text, convert it
531
import bzrlib.help_topics
532
result = bzrlib.help_topics.help_as_plain_text(result)
536
def _get_help_parts(text):
537
"""Split help text into a summary and named sections.
539
:return: (summary,sections,order) where summary is the top line and
540
sections is a dictionary of the rest indexed by section name.
541
order is the order the section appear in the text.
542
A section starts with a heading line of the form ":xxx:".
543
Indented text on following lines is the section value.
544
All text found outside a named section is assigned to the
545
default section which is given the key of None.
547
def save_section(sections, order, label, section):
549
if sections.has_key(label):
550
sections[label] += '\n' + section
553
sections[label] = section
555
lines = text.rstrip().splitlines()
556
summary = lines.pop(0)
559
label,section = None,''
561
if line.startswith(':') and line.endswith(':') and len(line) > 2:
562
save_section(sections, order, label, section)
563
label,section = line[1:-1],''
564
elif (label is not None) and len(line) > 1 and not line[0].isspace():
565
save_section(sections, order, label, section)
566
label,section = None,line
569
section += '\n' + line
572
save_section(sections, order, label, section)
573
return summary, sections, order
575
def get_help_topic(self):
576
"""Return the commands help topic - its name."""
579
def get_see_also(self, additional_terms=None):
580
"""Return a list of help topics that are related to this command.
582
The list is derived from the content of the _see_also attribute. Any
583
duplicates are removed and the result is in lexical order.
584
:param additional_terms: Additional help topics to cross-reference.
585
:return: A list of help topics.
587
see_also = set(getattr(self, '_see_also', []))
589
see_also.update(additional_terms)
590
return sorted(see_also)
593
"""Return dict of valid options for this command.
595
Maps from long option name to option object."""
596
r = Option.STD_OPTIONS.copy()
598
for o in self.takes_options:
599
if isinstance(o, basestring):
600
o = option.Option.OPTIONS[o]
602
if o.name in std_names:
603
self.supported_std_options.append(o.name)
606
def _setup_outf(self):
607
"""Return a file linked to stdout, which has proper encoding."""
608
self.outf = ui.ui_factory.make_output_stream(
609
encoding_type=self.encoding_type)
611
def run_argv_aliases(self, argv, alias_argv=None):
612
"""Parse the command line and run with extra aliases in alias_argv."""
613
args, opts = parse_args(self, argv, alias_argv)
615
# Process the standard options
616
if 'help' in opts: # e.g. bzr add --help
617
sys.stdout.write(self.get_help_text())
619
if 'usage' in opts: # e.g. bzr add --usage
620
sys.stdout.write(self.get_help_text(verbose=False))
622
trace.set_verbosity_level(option._verbosity_level)
623
if 'verbose' in self.supported_std_options:
624
opts['verbose'] = trace.is_verbose()
625
elif opts.has_key('verbose'):
627
if 'quiet' in self.supported_std_options:
628
opts['quiet'] = trace.is_quiet()
629
elif opts.has_key('quiet'):
632
# mix arguments and options into one dictionary
633
cmdargs = _match_argform(self.name(), self.takes_args, args)
635
for k, v in opts.items():
636
cmdopts[k.replace('-', '_')] = v
638
all_cmd_args = cmdargs.copy()
639
all_cmd_args.update(cmdopts)
643
return self.run_direct(**all_cmd_args)
645
def run_direct(self, *args, **kwargs):
646
"""Call run directly with objects (without parsing an argv list)."""
647
return self._operation.run_simple(*args, **kwargs)
650
"""Actually run the command.
652
This is invoked with the options and arguments bound to
655
Return 0 or None if the command was successful, or a non-zero
656
shell error code if not. It's OK for this method to allow
657
an exception to raise up.
659
raise NotImplementedError('no implementation of command %r'
663
"""Return help message for this class."""
664
from inspect import getdoc
665
if self.__doc__ is Command.__doc__:
670
return _unsquish_command_name(self.__class__.__name__)
672
def plugin_name(self):
673
"""Get the name of the plugin that provides this command.
675
:return: The name of the plugin or None if the command is builtin.
677
mod_parts = self.__module__.split('.')
678
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
684
class CommandHooks(Hooks):
685
"""Hooks related to Command object creation/enumeration."""
688
"""Create the default hooks.
690
These are all empty initially, because by default nothing should get
694
self.create_hook(HookPoint('extend_command',
695
"Called after creating a command object to allow modifications "
696
"such as adding or removing options, docs etc. Called with the "
697
"new bzrlib.commands.Command object.", (1, 13), None))
698
self.create_hook(HookPoint('get_command',
699
"Called when creating a single command. Called with "
700
"(cmd_or_None, command_name). get_command should either return "
701
"the cmd_or_None parameter, or a replacement Command object that "
702
"should be used for the command. Note that the Command.hooks "
703
"hooks are core infrastructure. Many users will prefer to use "
704
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
706
self.create_hook(HookPoint('get_missing_command',
707
"Called when creating a single command if no command could be "
708
"found. Called with (command_name). get_missing_command should "
709
"either return None, or a Command object to be used for the "
710
"command.", (1, 17), None))
711
self.create_hook(HookPoint('list_commands',
712
"Called when enumerating commands. Called with a set of "
713
"cmd_name strings for all the commands found so far. This set "
714
" is safe to mutate - e.g. to remove a command. "
715
"list_commands should return the updated set of command names.",
718
Command.hooks = CommandHooks()
721
def parse_args(command, argv, alias_argv=None):
722
"""Parse command line.
724
Arguments and options are parsed at this level before being passed
725
down to specific command handlers. This routine knows, from a
726
lookup table, something about the available options, what optargs
727
they take, and which commands will accept them.
729
# TODO: make it a method of the Command?
730
parser = option.get_optparser(command.options())
731
if alias_argv is not None:
732
args = alias_argv + argv
736
options, args = parser.parse_args(args)
737
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
738
v is not option.OptionParser.DEFAULT_VALUE])
742
def _match_argform(cmd, takes_args, args):
745
# step through args and takes_args, allowing appropriate 0-many matches
746
for ap in takes_args:
750
argdict[argname] = args.pop(0)
751
elif ap[-1] == '*': # all remaining arguments
753
argdict[argname + '_list'] = args[:]
756
argdict[argname + '_list'] = None
759
raise errors.BzrCommandError("command %r needs one or more %s"
760
% (cmd, argname.upper()))
762
argdict[argname + '_list'] = args[:]
764
elif ap[-1] == '$': # all but one
766
raise errors.BzrCommandError("command %r needs one or more %s"
767
% (cmd, argname.upper()))
768
argdict[argname + '_list'] = args[:-1]
774
raise errors.BzrCommandError("command %r requires argument %s"
775
% (cmd, argname.upper()))
777
argdict[argname] = args.pop(0)
780
raise errors.BzrCommandError("extra argument to command %s: %s"
785
def apply_coveraged(dirname, the_callable, *args, **kwargs):
786
# Cannot use "import trace", as that would import bzrlib.trace instead of
787
# the standard library's trace.
788
trace = __import__('trace')
790
tracer = trace.Trace(count=1, trace=0)
791
sys.settrace(tracer.globaltrace)
792
threading.settrace(tracer.globaltrace)
795
return exception_to_return_code(the_callable, *args, **kwargs)
798
results = tracer.results()
799
results.write_results(show_missing=1, summary=False,
803
def apply_profiled(the_callable, *args, **kwargs):
807
pffileno, pfname = tempfile.mkstemp()
809
prof = hotshot.Profile(pfname)
811
ret = prof.runcall(exception_to_return_code, the_callable, *args,
815
stats = hotshot.stats.load(pfname)
817
stats.sort_stats('cum') # 'time'
818
## XXX: Might like to write to stderr or the trace file instead but
819
## print_stats seems hardcoded to stdout
820
stats.print_stats(20)
827
def exception_to_return_code(the_callable, *args, **kwargs):
828
"""UI level helper for profiling and coverage.
830
This transforms exceptions into a return value of 3. As such its only
831
relevant to the UI layer, and should never be called where catching
832
exceptions may be desirable.
835
return the_callable(*args, **kwargs)
836
except (KeyboardInterrupt, Exception), e:
837
# used to handle AssertionError and KeyboardInterrupt
838
# specially here, but hopefully they're handled ok by the logger now
839
exc_info = sys.exc_info()
840
exitcode = trace.report_exception(exc_info, sys.stderr)
841
if os.environ.get('BZR_PDB'):
842
print '**** entering debugger'
845
if sys.version_info[:2] < (2, 6):
847
# pdb.post_mortem(tb)
848
# but because pdb.post_mortem gives bad results for tracebacks
849
# from inside generators, we do it manually.
850
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
852
# Setup pdb on the traceback
855
p.setup(tb.tb_frame, tb)
856
# Point the debugger at the deepest frame of the stack
857
p.curindex = len(p.stack) - 1
858
p.curframe = p.stack[p.curindex][0]
859
# Start the pdb prompt.
860
p.print_stack_entry(p.stack[p.curindex])
868
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
869
from bzrlib.lsprof import profile
870
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
876
trace.note('Profile data written to "%s".', filename)
880
@deprecated_function(deprecated_in((2, 2, 0)))
881
def shlex_split_unicode(unsplit):
882
return cmdline.split(unsplit)
885
def get_alias(cmd, config=None):
886
"""Return an expanded alias, or None if no alias exists.
889
Command to be checked for an alias.
891
Used to specify an alternative config to use,
892
which is especially useful for testing.
893
If it is unspecified, the global config will be used.
897
config = bzrlib.config.GlobalConfig()
898
alias = config.get_alias(cmd)
900
return cmdline.split(alias)
904
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
905
"""Execute a command.
907
:param argv: The command-line arguments, without the program name from
908
argv[0] These should already be decoded. All library/test code calling
909
run_bzr should be passing valid strings (don't need decoding).
910
:param load_plugins: What function to call when triggering plugin loading.
911
This function should take no arguments and cause all plugins to be
913
:param disable_plugins: What function to call when disabling plugin
914
loading. This function should take no arguments and cause all plugin
915
loading to be prohibited (so that code paths in your application that
916
know about some plugins possibly being present will fail to import
917
those plugins even if they are installed.)
918
:return: Returns a command exit code or raises an exception.
920
Special master options: these must come before the command because
921
they control how the command is interpreted.
924
Do not load plugin modules at all
930
Only use builtin commands. (Plugins are still allowed to change
934
Run under the Python hotshot profiler.
937
Run under the Python lsprof profiler.
940
Generate line coverage report in the specified directory.
943
Specify the number of processes that can be run concurrently (selftest).
945
trace.mutter("bazaar version: " + bzrlib.__version__)
947
trace.mutter("bzr arguments: %r", argv)
949
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
950
opt_no_aliases = False
951
opt_lsprof_file = opt_coverage_dir = None
953
# --no-plugins is handled specially at a very early stage. We need
954
# to load plugins before doing other command parsing so that they
955
# can override commands, but this needs to happen first.
963
elif a == '--lsprof':
965
elif a == '--lsprof-file':
967
opt_lsprof_file = argv[i + 1]
969
elif a == '--no-plugins':
970
opt_no_plugins = True
971
elif a == '--no-aliases':
972
opt_no_aliases = True
973
elif a == '--builtin':
975
elif a == '--concurrency':
976
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
978
elif a == '--coverage':
979
opt_coverage_dir = argv[i + 1]
981
elif a.startswith('-D'):
982
debug.debug_flags.add(a[2:])
987
debug.set_debug_flags_from_config()
989
if not opt_no_plugins:
996
get_cmd_object('help').run_argv_aliases([])
999
if argv[0] == '--version':
1000
get_cmd_object('version').run_argv_aliases([])
1005
if not opt_no_aliases:
1006
alias_argv = get_alias(argv[0])
1008
user_encoding = osutils.get_user_encoding()
1009
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1010
argv[0] = alias_argv.pop(0)
1013
# We want only 'ascii' command names, but the user may have typed
1014
# in a Unicode name. In that case, they should just get a
1015
# 'command not found' error later.
1017
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1018
run = cmd_obj.run_argv_aliases
1019
run_argv = [argv, alias_argv]
1022
# We can be called recursively (tests for example), but we don't want
1023
# the verbosity level to propagate.
1024
saved_verbosity_level = option._verbosity_level
1025
option._verbosity_level = 0
1027
if opt_coverage_dir:
1029
'--coverage ignored, because --lsprof is in use.')
1030
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1032
if opt_coverage_dir:
1034
'--coverage ignored, because --profile is in use.')
1035
ret = apply_profiled(run, *run_argv)
1036
elif opt_coverage_dir:
1037
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1039
ret = run(*run_argv)
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
if 'memory' in debug.debug_flags:
1046
trace.debug_memory('Process status after command:', short=False)
1047
option._verbosity_level = saved_verbosity_level
1050
def display_command(func):
1051
"""Decorator that suppresses pipe/interrupt errors."""
1052
def ignore_pipe(*args, **kwargs):
1054
result = func(*args, **kwargs)
1058
if getattr(e, 'errno', None) is None:
1060
if e.errno != errno.EPIPE:
1061
# Win32 raises IOError with errno=0 on a broken pipe
1062
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1065
except KeyboardInterrupt:
1070
def install_bzr_command_hooks():
1071
"""Install the hooks to supply bzr's own commands."""
1072
if _list_bzr_commands in Command.hooks["list_commands"]:
1074
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1076
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1078
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1079
"bzr plugin commands")
1080
Command.hooks.install_named_hook("get_command", _get_external_command,
1081
"bzr external command lookup")
1082
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1083
"bzr plugin-provider-db check")
1087
def _specified_or_unicode_argv(argv):
1088
# For internal or testing use, argv can be passed. Otherwise, get it from
1089
# the process arguments in a unicode-safe way.
1091
return osutils.get_unicode_argv()
1095
# ensure all arguments are unicode strings
1097
if isinstance(a, unicode):
1100
new_argv.append(a.decode('ascii'))
1101
except UnicodeDecodeError:
1102
raise errors.BzrError("argv should be list of unicode strings.")
1106
def main(argv=None):
1107
"""Main entry point of command-line interface.
1109
Typically `bzrlib.initialize` should be called first.
1111
:param argv: list of unicode command-line arguments similar to sys.argv.
1112
argv[0] is script name usually, it will be ignored.
1113
Don't pass here sys.argv because this list contains plain strings
1114
and not unicode; pass None instead.
1116
:return: exit code of bzr command.
1118
argv = _specified_or_unicode_argv(argv)
1119
ret = run_bzr_catch_errors(argv)
1120
bzrlib.ui.ui_factory.log_transport_activity(
1121
display=('bytes' in debug.debug_flags))
1122
trace.mutter("return code %d", ret)
1126
def run_bzr_catch_errors(argv):
1127
"""Run a bzr command with parameters as described by argv.
1129
This function assumed that that UI layer is setup, that symbol deprecations
1130
are already applied, and that unicode decoding has already been performed on argv.
1132
# done here so that they're covered for every test run
1133
install_bzr_command_hooks()
1134
return exception_to_return_code(run_bzr, argv)
1137
def run_bzr_catch_user_errors(argv):
1138
"""Run bzr and report user errors, but let internal errors propagate.
1140
This is used for the test suite, and might be useful for other programs
1141
that want to wrap the commandline interface.
1143
# done here so that they're covered for every test run
1144
install_bzr_command_hooks()
1146
return run_bzr(argv)
1147
except Exception, e:
1148
if (isinstance(e, (OSError, IOError))
1149
or not getattr(e, 'internal_error', True)):
1150
trace.report_exception(sys.exc_info(), sys.stderr)
1156
class HelpCommandIndex(object):
1157
"""A index for bzr help that returns commands."""
1160
self.prefix = 'commands/'
1162
def get_topics(self, topic):
1163
"""Search for topic amongst commands.
1165
:param topic: A topic to search for.
1166
:return: A list which is either empty or contains a single
1169
if topic and topic.startswith(self.prefix):
1170
topic = topic[len(self.prefix):]
1172
cmd = _get_cmd_object(topic, check_missing=False)
1179
class Provider(object):
1180
'''Generic class to be overriden by plugins'''
1182
def plugin_for_command(self, cmd_name):
1183
'''Takes a command and returns the information for that plugin
1185
:return: A dictionary with all the available information
1186
for the requested plugin
1188
raise NotImplementedError
1191
class ProvidersRegistry(registry.Registry):
1192
'''This registry exists to allow other providers to exist'''
1195
for key, provider in self.iteritems():
1198
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
