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
55
from bzrlib.hooks import HookPoint, Hooks
56
# Compatibility - Option used to be in commands.
57
from bzrlib.option import Option
58
from bzrlib import registry
59
from bzrlib.symbol_versioning import (
63
suppress_deprecation_warnings,
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
@deprecated_function(deprecated_in((1, 17, 0)))
191
def get_all_cmds(plugins_override=False):
192
"""Return canonical name and class for most commands.
194
NB: This does not return all commands since the introduction of
195
command hooks, and returning the class is not sufficient to
196
get correctly setup commands, which is why it is deprecated.
198
Use 'all_command_names' + 'get_cmd_object' instead.
200
d = _builtin_commands()
202
d.update(plugin_cmds.iteritems())
203
for k, v in d.iteritems():
207
def get_cmd_object(cmd_name, plugins_override=True):
208
"""Return the command object for a command.
211
If true, plugin commands can override builtins.
214
return _get_cmd_object(cmd_name, plugins_override)
216
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
219
def _get_cmd_object(cmd_name, plugins_override=True):
220
"""Get a command object.
222
:param cmd_name: The name of the command.
223
:param plugins_override: Allow plugins to override builtins.
224
:return: A Command object instance
225
:raises KeyError: If no command is found.
227
# We want only 'ascii' command names, but the user may have typed
228
# in a Unicode name. In that case, they should just get a
229
# 'command not found' error later.
230
# In the future, we may actually support Unicode command names.
233
for hook in Command.hooks['get_command']:
234
cmd = hook(cmd, cmd_name)
235
if cmd is not None and not plugins_override and not cmd.plugin_name():
236
# We've found a non-plugin command, don't permit it to be
240
for hook in Command.hooks['get_missing_command']:
247
# Allow plugins to extend commands
248
for hook in Command.hooks['extend_command']:
253
def _try_plugin_provider(cmd_name):
254
"""Probe for a plugin provider having cmd_name."""
256
plugin_metadata, provider = probe_for_provider(cmd_name)
257
raise errors.CommandAvailableInPlugin(cmd_name,
258
plugin_metadata, provider)
259
except errors.NoPluginAvailable:
263
def probe_for_provider(cmd_name):
264
"""Look for a provider for cmd_name.
266
:param cmd_name: The command name.
267
:return: plugin_metadata, provider for getting cmd_name.
268
:raises NoPluginAvailable: When no provider can supply the plugin.
270
# look for providers that provide this command but aren't installed
271
for provider in command_providers_registry:
273
return provider.plugin_for_command(cmd_name), provider
274
except errors.NoPluginAvailable:
276
raise errors.NoPluginAvailable(cmd_name)
279
def _get_bzr_command(cmd_or_None, cmd_name):
280
"""Get a command from bzr's core."""
281
cmds = _builtin_commands()
283
return cmds[cmd_name]()
286
# look for any command which claims this as an alias
287
for real_cmd_name, cmd_class in cmds.iteritems():
288
if cmd_name in cmd_class.aliases:
293
def _get_external_command(cmd_or_None, cmd_name):
294
"""Lookup a command that is a shell script."""
295
# Only do external command lookups when no command is found so far.
296
if cmd_or_None is not None:
298
from bzrlib.externalcommand import ExternalCommand
299
cmd_obj = ExternalCommand.find_command(cmd_name)
304
def _get_plugin_command(cmd_or_None, cmd_name):
305
"""Get a command from bzr's plugins."""
307
return plugin_cmds.get(cmd_name)()
310
for key in plugin_cmds.keys():
311
info = plugin_cmds.get_info(key)
312
if cmd_name in info.aliases:
313
return plugin_cmds.get(key)()
317
class Command(object):
318
"""Base class for commands.
320
Commands are the heart of the command-line bzr interface.
322
The command object mostly handles the mapping of command-line
323
parameters into one or more bzrlib operations, and of the results
326
Commands normally don't have any state. All their arguments are
327
passed in to the run method. (Subclasses may take a different
328
policy if the behaviour of the instance needs to depend on e.g. a
329
shell plugin and not just its Python class.)
331
The docstring for an actual command should give a single-line
332
summary, then a complete description of the command. A grammar
333
description will be inserted.
336
Other accepted names for this command.
339
List of argument forms, marked with whether they are optional,
344
['to_location', 'from_branch?', 'file*']
346
'to_location' is required
347
'from_branch' is optional
348
'file' can be specified 0 or more times
351
List of options that may be given for this command. These can
352
be either strings, referring to globally-defined options,
353
or option objects. Retrieve through options().
356
If true, this command isn't advertised. This is typically
357
for commands intended for expert users.
360
Command objects will get a 'outf' attribute, which has been
361
setup to properly handle encoding of unicode strings.
362
encoding_type determines what will happen when characters cannot
364
strict - abort if we cannot decode
365
replace - put in a bogus character (typically '?')
366
exact - do not encode sys.stdout
368
NOTE: by default on Windows, sys.stdout is opened as a text
369
stream, therefore LF line-endings are converted to CRLF.
370
When a command uses encoding_type = 'exact', then
371
sys.stdout is forced to be a binary stream, and line-endings
374
:cvar hooks: An instance of CommandHooks.
379
encoding_type = 'strict'
384
"""Construct an instance of this command."""
385
if self.__doc__ == Command.__doc__:
386
warn("No help message set for %r" % self)
387
# List of standard options directly supported
388
self.supported_std_options = []
389
self._operation = cleanup.OperationWithCleanups(self.run)
391
def add_cleanup(self, cleanup_func, *args, **kwargs):
392
"""Register a function to call after self.run returns or raises.
394
Functions will be called in LIFO order.
396
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
398
def cleanup_now(self):
399
"""Execute and empty pending cleanup functions immediately.
401
After cleanup_now all registered cleanups are forgotten. add_cleanup
402
may be called again after cleanup_now; these cleanups will be called
403
after self.run returns or raises (or when cleanup_now is next called).
405
This is useful for releasing expensive or contentious resources (such
406
as write locks) before doing further work that does not require those
407
resources (such as writing results to self.outf).
409
self._operation.cleanup_now()
411
@deprecated_method(deprecated_in((2, 1, 0)))
412
def _maybe_expand_globs(self, file_list):
413
"""Glob expand file_list if the platform does not do that itself.
415
Not used anymore, now that the bzr command-line parser globs on
418
:return: A possibly empty list of unicode paths.
420
Introduced in bzrlib 0.18.
425
"""Return single-line grammar for this command.
427
Only describes arguments, not options.
429
s = 'bzr ' + self.name() + ' '
430
for aname in self.takes_args:
431
aname = aname.upper()
432
if aname[-1] in ['$', '+']:
433
aname = aname[:-1] + '...'
434
elif aname[-1] == '?':
435
aname = '[' + aname[:-1] + ']'
436
elif aname[-1] == '*':
437
aname = '[' + aname[:-1] + '...]'
439
s = s[:-1] # remove last space
442
def get_help_text(self, additional_see_also=None, plain=True,
443
see_also_as_links=False, verbose=True):
444
"""Return a text string with help for this command.
446
:param additional_see_also: Additional help topics to be
448
:param plain: if False, raw help (reStructuredText) is
449
returned instead of plain text.
450
:param see_also_as_links: if True, convert items in 'See also'
451
list to internal links (used by bzr_man rstx generator)
452
:param verbose: if True, display the full help, otherwise
453
leave out the descriptive sections and just display
454
usage help (e.g. Purpose, Usage, Options) with a
455
message explaining how to obtain full help.
459
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
461
# Extract the summary (purpose) and sections out from the text
462
purpose,sections,order = self._get_help_parts(doc)
464
# If a custom usage section was provided, use it
465
if sections.has_key('Usage'):
466
usage = sections.pop('Usage')
468
usage = self._usage()
470
# The header is the purpose and usage
472
result += ':Purpose: %s\n' % purpose
473
if usage.find('\n') >= 0:
474
result += ':Usage:\n%s\n' % usage
476
result += ':Usage: %s\n' % usage
481
# XXX: optparse implicitly rewraps the help, and not always perfectly,
482
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
484
options = option.get_optparser(self.options()).format_option_help()
485
# XXX: According to the spec, ReST option lists actually don't support
486
# options like --1.9 so that causes syntax errors (in Sphinx at least).
487
# As that pattern always appears in the commands that break, we trap
488
# on that and then format that block of 'format' options as a literal
490
if not plain and options.find(' --1.9 ') != -1:
491
options = options.replace(' format:\n', ' format::\n\n', 1)
492
if options.startswith('Options:'):
493
result += ':' + options
494
elif options.startswith('options:'):
495
# Python 2.4 version of optparse
496
result += ':Options:' + options[len('options:'):]
502
# Add the description, indenting it 2 spaces
503
# to match the indentation of the options
504
if sections.has_key(None):
505
text = sections.pop(None)
506
text = '\n '.join(text.splitlines())
507
result += ':%s:\n %s\n\n' % ('Description',text)
509
# Add the custom sections (e.g. Examples). Note that there's no need
510
# to indent these as they must be indented already in the source.
513
if sections.has_key(label):
514
result += ':%s:\n%s\n' % (label,sections[label])
517
result += ("See bzr help %s for more details and examples.\n\n"
520
# Add the aliases, source (plug-in) and see also links, if any
522
result += ':Aliases: '
523
result += ', '.join(self.aliases) + '\n'
524
plugin_name = self.plugin_name()
525
if plugin_name is not None:
526
result += ':From: plugin "%s"\n' % plugin_name
527
see_also = self.get_see_also(additional_see_also)
529
if not plain and see_also_as_links:
531
for item in see_also:
533
# topics doesn't have an independent section
534
# so don't create a real link
535
see_also_links.append(item)
537
# Use a Sphinx link for this entry
538
link_text = ":doc:`%s <%s-help>`" % (item, item)
539
see_also_links.append(link_text)
540
see_also = see_also_links
541
result += ':See also: '
542
result += ', '.join(see_also) + '\n'
544
# If this will be rendered as plain text, convert it
546
import bzrlib.help_topics
547
result = bzrlib.help_topics.help_as_plain_text(result)
551
def _get_help_parts(text):
552
"""Split help text into a summary and named sections.
554
:return: (summary,sections,order) where summary is the top line and
555
sections is a dictionary of the rest indexed by section name.
556
order is the order the section appear in the text.
557
A section starts with a heading line of the form ":xxx:".
558
Indented text on following lines is the section value.
559
All text found outside a named section is assigned to the
560
default section which is given the key of None.
562
def save_section(sections, order, label, section):
564
if sections.has_key(label):
565
sections[label] += '\n' + section
568
sections[label] = section
570
lines = text.rstrip().splitlines()
571
summary = lines.pop(0)
574
label,section = None,''
576
if line.startswith(':') and line.endswith(':') and len(line) > 2:
577
save_section(sections, order, label, section)
578
label,section = line[1:-1],''
579
elif (label is not None) and len(line) > 1 and not line[0].isspace():
580
save_section(sections, order, label, section)
581
label,section = None,line
584
section += '\n' + line
587
save_section(sections, order, label, section)
588
return summary, sections, order
590
def get_help_topic(self):
591
"""Return the commands help topic - its name."""
594
def get_see_also(self, additional_terms=None):
595
"""Return a list of help topics that are related to this command.
597
The list is derived from the content of the _see_also attribute. Any
598
duplicates are removed and the result is in lexical order.
599
:param additional_terms: Additional help topics to cross-reference.
600
:return: A list of help topics.
602
see_also = set(getattr(self, '_see_also', []))
604
see_also.update(additional_terms)
605
return sorted(see_also)
608
"""Return dict of valid options for this command.
610
Maps from long option name to option object."""
611
r = Option.STD_OPTIONS.copy()
613
for o in self.takes_options:
614
if isinstance(o, basestring):
615
o = option.Option.OPTIONS[o]
617
if o.name in std_names:
618
self.supported_std_options.append(o.name)
621
def _setup_outf(self):
622
"""Return a file linked to stdout, which has proper encoding."""
623
self.outf = ui.ui_factory.make_output_stream(
624
encoding_type=self.encoding_type)
626
def run_argv_aliases(self, argv, alias_argv=None):
627
"""Parse the command line and run with extra aliases in alias_argv."""
629
warn("Passing None for [] is deprecated from bzrlib 0.10",
630
DeprecationWarning, stacklevel=2)
632
args, opts = parse_args(self, argv, alias_argv)
634
# Process the standard options
635
if 'help' in opts: # e.g. bzr add --help
636
sys.stdout.write(self.get_help_text())
638
if 'usage' in opts: # e.g. bzr add --usage
639
sys.stdout.write(self.get_help_text(verbose=False))
641
trace.set_verbosity_level(option._verbosity_level)
642
if 'verbose' in self.supported_std_options:
643
opts['verbose'] = trace.is_verbose()
644
elif opts.has_key('verbose'):
646
if 'quiet' in self.supported_std_options:
647
opts['quiet'] = trace.is_quiet()
648
elif opts.has_key('quiet'):
651
# mix arguments and options into one dictionary
652
cmdargs = _match_argform(self.name(), self.takes_args, args)
654
for k, v in opts.items():
655
cmdopts[k.replace('-', '_')] = v
657
all_cmd_args = cmdargs.copy()
658
all_cmd_args.update(cmdopts)
662
return self.run_direct(**all_cmd_args)
664
def run_direct(self, *args, **kwargs):
665
"""Call run directly with objects (without parsing an argv list)."""
666
return self._operation.run_simple(*args, **kwargs)
669
"""Actually run the command.
671
This is invoked with the options and arguments bound to
674
Return 0 or None if the command was successful, or a non-zero
675
shell error code if not. It's OK for this method to allow
676
an exception to raise up.
678
raise NotImplementedError('no implementation of command %r'
682
"""Return help message for this class."""
683
from inspect import getdoc
684
if self.__doc__ is Command.__doc__:
689
return _unsquish_command_name(self.__class__.__name__)
691
def plugin_name(self):
692
"""Get the name of the plugin that provides this command.
694
:return: The name of the plugin or None if the command is builtin.
696
mod_parts = self.__module__.split('.')
697
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
703
class CommandHooks(Hooks):
704
"""Hooks related to Command object creation/enumeration."""
707
"""Create the default hooks.
709
These are all empty initially, because by default nothing should get
713
self.create_hook(HookPoint('extend_command',
714
"Called after creating a command object to allow modifications "
715
"such as adding or removing options, docs etc. Called with the "
716
"new bzrlib.commands.Command object.", (1, 13), None))
717
self.create_hook(HookPoint('get_command',
718
"Called when creating a single command. Called with "
719
"(cmd_or_None, command_name). get_command should either return "
720
"the cmd_or_None parameter, or a replacement Command object that "
721
"should be used for the command. Note that the Command.hooks "
722
"hooks are core infrastructure. Many users will prefer to use "
723
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
725
self.create_hook(HookPoint('get_missing_command',
726
"Called when creating a single command if no command could be "
727
"found. Called with (command_name). get_missing_command should "
728
"either return None, or a Command object to be used for the "
729
"command.", (1, 17), None))
730
self.create_hook(HookPoint('list_commands',
731
"Called when enumerating commands. Called with a set of "
732
"cmd_name strings for all the commands found so far. This set "
733
" is safe to mutate - e.g. to remove a command. "
734
"list_commands should return the updated set of command names.",
737
Command.hooks = CommandHooks()
740
def parse_args(command, argv, alias_argv=None):
741
"""Parse command line.
743
Arguments and options are parsed at this level before being passed
744
down to specific command handlers. This routine knows, from a
745
lookup table, something about the available options, what optargs
746
they take, and which commands will accept them.
748
# TODO: make it a method of the Command?
749
parser = option.get_optparser(command.options())
750
if alias_argv is not None:
751
args = alias_argv + argv
755
options, args = parser.parse_args(args)
756
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
757
v is not option.OptionParser.DEFAULT_VALUE])
761
def _match_argform(cmd, takes_args, args):
764
# step through args and takes_args, allowing appropriate 0-many matches
765
for ap in takes_args:
769
argdict[argname] = args.pop(0)
770
elif ap[-1] == '*': # all remaining arguments
772
argdict[argname + '_list'] = args[:]
775
argdict[argname + '_list'] = None
778
raise errors.BzrCommandError("command %r needs one or more %s"
779
% (cmd, argname.upper()))
781
argdict[argname + '_list'] = args[:]
783
elif ap[-1] == '$': # all but one
785
raise errors.BzrCommandError("command %r needs one or more %s"
786
% (cmd, argname.upper()))
787
argdict[argname + '_list'] = args[:-1]
793
raise errors.BzrCommandError("command %r requires argument %s"
794
% (cmd, argname.upper()))
796
argdict[argname] = args.pop(0)
799
raise errors.BzrCommandError("extra argument to command %s: %s"
804
def apply_coveraged(dirname, the_callable, *args, **kwargs):
805
# Cannot use "import trace", as that would import bzrlib.trace instead of
806
# the standard library's trace.
807
trace = __import__('trace')
809
tracer = trace.Trace(count=1, trace=0)
810
sys.settrace(tracer.globaltrace)
811
threading.settrace(tracer.globaltrace)
814
return exception_to_return_code(the_callable, *args, **kwargs)
817
results = tracer.results()
818
results.write_results(show_missing=1, summary=False,
822
def apply_profiled(the_callable, *args, **kwargs):
826
pffileno, pfname = tempfile.mkstemp()
828
prof = hotshot.Profile(pfname)
830
ret = prof.runcall(exception_to_return_code, the_callable, *args,
834
stats = hotshot.stats.load(pfname)
836
stats.sort_stats('cum') # 'time'
837
## XXX: Might like to write to stderr or the trace file instead but
838
## print_stats seems hardcoded to stdout
839
stats.print_stats(20)
846
def exception_to_return_code(the_callable, *args, **kwargs):
847
"""UI level helper for profiling and coverage.
849
This transforms exceptions into a return value of 3. As such its only
850
relevant to the UI layer, and should never be called where catching
851
exceptions may be desirable.
854
return the_callable(*args, **kwargs)
855
except (KeyboardInterrupt, Exception), e:
856
# used to handle AssertionError and KeyboardInterrupt
857
# specially here, but hopefully they're handled ok by the logger now
858
exc_info = sys.exc_info()
859
exitcode = trace.report_exception(exc_info, sys.stderr)
860
if os.environ.get('BZR_PDB'):
861
print '**** entering debugger'
864
if sys.version_info[:2] < (2, 6):
866
# pdb.post_mortem(tb)
867
# but because pdb.post_mortem gives bad results for tracebacks
868
# from inside generators, we do it manually.
869
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
871
# Setup pdb on the traceback
874
p.setup(tb.tb_frame, tb)
875
# Point the debugger at the deepest frame of the stack
876
p.curindex = len(p.stack) - 1
877
p.curframe = p.stack[p.curindex][0]
878
# Start the pdb prompt.
879
p.print_stack_entry(p.stack[p.curindex])
887
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
888
from bzrlib.lsprof import profile
889
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
895
trace.note('Profile data written to "%s".', filename)
899
def get_alias(cmd, config=None):
900
"""Return an expanded alias, or None if no alias exists.
903
Command to be checked for an alias.
905
Used to specify an alternative config to use,
906
which is especially useful for testing.
907
If it is unspecified, the global config will be used.
911
config = bzrlib.config.GlobalConfig()
912
alias = config.get_alias(cmd)
914
return cmdline.split(alias)
919
"""Execute a command.
922
The command-line arguments, without the program name from argv[0]
923
These should already be decoded. All library/test code calling
924
run_bzr should be passing valid strings (don't need decoding).
926
Returns a command status or raises an exception.
928
Special master options: these must come before the command because
929
they control how the command is interpreted.
932
Do not load plugin modules at all
938
Only use builtin commands. (Plugins are still allowed to change
942
Run under the Python hotshot profiler.
945
Run under the Python lsprof profiler.
948
Generate line coverage report in the specified directory.
951
Specify the number of processes that can be run concurrently (selftest).
953
trace.mutter("bazaar version: " + bzrlib.__version__)
955
trace.mutter("bzr arguments: %r", argv)
957
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
958
opt_no_aliases = False
959
opt_lsprof_file = opt_coverage_dir = None
961
# --no-plugins is handled specially at a very early stage. We need
962
# to load plugins before doing other command parsing so that they
963
# can override commands, but this needs to happen first.
971
elif a == '--lsprof':
973
elif a == '--lsprof-file':
975
opt_lsprof_file = argv[i + 1]
977
elif a == '--no-plugins':
978
opt_no_plugins = True
979
elif a == '--no-aliases':
980
opt_no_aliases = True
981
elif a == '--builtin':
983
elif a == '--concurrency':
984
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
986
elif a == '--coverage':
987
opt_coverage_dir = argv[i + 1]
989
elif a.startswith('-D'):
990
debug.debug_flags.add(a[2:])
995
debug.set_debug_flags_from_config()
999
from bzrlib.builtins import cmd_help
1000
cmd_help().run_argv_aliases([])
1003
if argv[0] == '--version':
1004
from bzrlib.builtins import cmd_version
1005
cmd_version().run_argv_aliases([])
1008
if not opt_no_plugins:
1009
from bzrlib.plugin import load_plugins
1012
from bzrlib.plugin import disable_plugins
1017
if not opt_no_aliases:
1018
alias_argv = get_alias(argv[0])
1020
user_encoding = osutils.get_user_encoding()
1021
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1022
argv[0] = alias_argv.pop(0)
1025
# We want only 'ascii' command names, but the user may have typed
1026
# in a Unicode name. In that case, they should just get a
1027
# 'command not found' error later.
1029
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1030
run = cmd_obj.run_argv_aliases
1031
run_argv = [argv, alias_argv]
1034
# We can be called recursively (tests for example), but we don't want
1035
# the verbosity level to propagate.
1036
saved_verbosity_level = option._verbosity_level
1037
option._verbosity_level = 0
1039
if opt_coverage_dir:
1041
'--coverage ignored, because --lsprof is in use.')
1042
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1044
if opt_coverage_dir:
1046
'--coverage ignored, because --profile is in use.')
1047
ret = apply_profiled(run, *run_argv)
1048
elif opt_coverage_dir:
1049
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1051
ret = run(*run_argv)
1054
# reset, in case we may do other commands later within the same
1055
# process. Commands that want to execute sub-commands must propagate
1056
# --verbose in their own way.
1057
if 'memory' in debug.debug_flags:
1058
trace.debug_memory('Process status after command:', short=False)
1059
option._verbosity_level = saved_verbosity_level
1062
def display_command(func):
1063
"""Decorator that suppresses pipe/interrupt errors."""
1064
def ignore_pipe(*args, **kwargs):
1066
result = func(*args, **kwargs)
1070
if getattr(e, 'errno', None) is None:
1072
if e.errno != errno.EPIPE:
1073
# Win32 raises IOError with errno=0 on a broken pipe
1074
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1077
except KeyboardInterrupt:
1082
def install_bzr_command_hooks():
1083
"""Install the hooks to supply bzr's own commands."""
1084
if _list_bzr_commands in Command.hooks["list_commands"]:
1086
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1088
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1090
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1091
"bzr plugin commands")
1092
Command.hooks.install_named_hook("get_command", _get_external_command,
1093
"bzr external command lookup")
1094
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1095
"bzr plugin-provider-db check")
1098
def main(argv=None):
1099
"""Main entry point of command-line interface.
1101
:param argv: list of unicode command-line arguments similar to sys.argv.
1102
argv[0] is script name usually, it will be ignored.
1103
Don't pass here sys.argv because this list contains plain strings
1104
and not unicode; pass None instead.
1106
:return: exit code of bzr command.
1109
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1110
sys.stdin, sys.stdout, sys.stderr)
1112
# Is this a final release version? If so, we should suppress warnings
1113
if bzrlib.version_info[3] == 'final':
1114
suppress_deprecation_warnings(override=True)
1116
argv = osutils.get_unicode_argv()
1120
# ensure all arguments are unicode strings
1122
if isinstance(a, unicode):
1125
new_argv.append(a.decode('ascii'))
1126
except UnicodeDecodeError:
1127
raise errors.BzrError("argv should be list of unicode strings.")
1129
ret = run_bzr_catch_errors(argv)
1130
bzrlib.ui.ui_factory.log_transport_activity(
1131
display=('bytes' in debug.debug_flags))
1132
trace.mutter("return code %d", ret)
1133
osutils.report_extension_load_failures()
1137
def run_bzr_catch_errors(argv):
1138
"""Run a bzr command with parameters as described by argv.
1140
This function assumed that that UI layer is setup, that symbol deprecations
1141
are already applied, and that unicode decoding has already been performed on argv.
1143
install_bzr_command_hooks()
1144
return exception_to_return_code(run_bzr, argv)
1147
def run_bzr_catch_user_errors(argv):
1148
"""Run bzr and report user errors, but let internal errors propagate.
1150
This is used for the test suite, and might be useful for other programs
1151
that want to wrap the commandline interface.
1153
install_bzr_command_hooks()
1155
return run_bzr(argv)
1156
except Exception, e:
1157
if (isinstance(e, (OSError, IOError))
1158
or not getattr(e, 'internal_error', True)):
1159
trace.report_exception(sys.exc_info(), sys.stderr)
1165
class HelpCommandIndex(object):
1166
"""A index for bzr help that returns commands."""
1169
self.prefix = 'commands/'
1171
def get_topics(self, topic):
1172
"""Search for topic amongst commands.
1174
:param topic: A topic to search for.
1175
:return: A list which is either empty or contains a single
1178
if topic and topic.startswith(self.prefix):
1179
topic = topic[len(self.prefix):]
1181
cmd = _get_cmd_object(topic)
1188
class Provider(object):
1189
'''Generic class to be overriden by plugins'''
1191
def plugin_for_command(self, cmd_name):
1192
'''Takes a command and returns the information for that plugin
1194
:return: A dictionary with all the available information
1195
for the requested plugin
1197
raise NotImplementedError
1200
class ProvidersRegistry(registry.Registry):
1201
'''This registry exists to allow other providers to exist'''
1204
for key, provider in self.iteritems():
1207
command_providers_registry = ProvidersRegistry()
1210
if __name__ == '__main__':
1211
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
