1
# Copyright (C) 2005-2011 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
17
from __future__ import absolute_import
19
# TODO: Define arguments by objects, rather than just using names.
20
# Those objects can specify the expected type of the argument, which
21
# would help with validation and shell completion. They could also provide
22
# help/explanation for that argument in a structured way.
24
# TODO: Specific "examples" property on commands for consistent formatting.
29
from .lazy_import import lazy_import
30
lazy_import(globals(), """
49
from .hooks import Hooks
50
from .i18n import gettext
51
# Compatibility - Option used to be in commands.
52
from .option import Option
53
from .plugin import disable_plugins, load_plugins, plugin_name
54
from . import registry
60
class CommandInfo(object):
61
"""Information about a command."""
63
def __init__(self, aliases):
64
"""The list of aliases for the command."""
65
self.aliases = aliases
68
def from_command(klass, command):
69
"""Factory to construct a CommandInfo from a command."""
70
return klass(command.aliases)
73
class CommandRegistry(registry.Registry):
74
"""Special registry mapping command names to command classes.
76
:ivar overridden_registry: Look in this registry for commands being
77
overridden by this registry. This can be used to tell plugin commands
78
about the builtin they're decorating.
82
registry.Registry.__init__(self)
83
self.overridden_registry = None
84
# map from aliases to the real command that implements the name
87
def get(self, command_name):
88
real_name = self._alias_dict.get(command_name, command_name)
89
return registry.Registry.get(self, real_name)
92
def _get_name(command_name):
93
if command_name.startswith("cmd_"):
94
return _unsquish_command_name(command_name)
98
def register(self, cmd, decorate=False):
99
"""Utility function to help register a command
101
:param cmd: Command subclass to register
102
:param decorate: If true, allow overriding an existing command
103
of the same name; the old command is returned by this function.
104
Otherwise it is an error to try to override an existing command.
107
k_unsquished = self._get_name(k)
109
previous = self.get(k_unsquished)
112
if self.overridden_registry:
114
previous = self.overridden_registry.get(k_unsquished)
117
info = CommandInfo.from_command(cmd)
119
registry.Registry.register(self, k_unsquished, cmd,
120
override_existing=decorate, info=info)
122
trace.warning('Two plugins defined the same command: %r' % k)
123
trace.warning('Not loading the one in %r' %
124
sys.modules[cmd.__module__])
125
trace.warning('Previously this command was registered from %r' %
126
sys.modules[previous.__module__])
127
for a in cmd.aliases:
128
self._alias_dict[a] = k_unsquished
131
def register_lazy(self, command_name, aliases, module_name):
132
"""Register a command without loading its module.
134
:param command_name: The primary name of the command.
135
:param aliases: A list of aliases for the command.
136
:module_name: The module that the command lives in.
138
key = self._get_name(command_name)
139
registry.Registry.register_lazy(self, key, module_name, command_name,
140
info=CommandInfo(aliases))
142
self._alias_dict[a] = key
145
plugin_cmds = CommandRegistry()
146
builtin_command_registry = CommandRegistry()
147
plugin_cmds.overridden_registry = builtin_command_registry
150
def register_command(cmd, decorate=False):
151
"""Register a plugin command.
153
Should generally be avoided in favor of lazy registration.
156
return plugin_cmds.register(cmd, decorate)
159
def _squish_command_name(cmd):
160
return 'cmd_' + cmd.replace('-', '_')
163
def _unsquish_command_name(cmd):
164
return cmd[4:].replace('_','-')
167
def _register_builtin_commands():
168
if builtin_command_registry.keys():
171
import breezy.builtins
172
for cmd_class in _scan_module_for_commands(breezy.builtins):
173
builtin_command_registry.register(cmd_class)
174
breezy.builtins._register_lazy_builtins()
177
def _scan_module_for_commands(module):
178
module_dict = module.__dict__
179
for name in module_dict:
180
if name.startswith("cmd_"):
181
yield module_dict[name]
184
def _list_bzr_commands(names):
185
"""Find commands from bzr's core and plugins.
187
This is not the public interface, just the default hook called by all_command_names.
189
# to eliminate duplicates
190
names.update(builtin_command_names())
191
names.update(plugin_command_names())
195
def all_command_names():
196
"""Return a set of all command names."""
198
for hook in Command.hooks['list_commands']:
201
raise AssertionError(
202
'hook %s returned None' % Command.hooks.get_hook_name(hook))
206
def builtin_command_names():
207
"""Return list of builtin command names.
209
Use of all_command_names() is encouraged rather than builtin_command_names
210
and/or plugin_command_names.
212
_register_builtin_commands()
213
return builtin_command_registry.keys()
216
def plugin_command_names():
217
"""Returns command names from commands registered by plugins."""
218
return plugin_cmds.keys()
221
def get_cmd_object(cmd_name, plugins_override=True):
222
"""Return the command object for a command.
225
If true, plugin commands can override builtins.
228
return _get_cmd_object(cmd_name, plugins_override)
230
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
233
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
234
"""Get a command object.
236
:param cmd_name: The name of the command.
237
:param plugins_override: Allow plugins to override builtins.
238
:param check_missing: Look up commands not found in the regular index via
239
the get_missing_command hook.
240
:return: A Command object instance
241
:raises KeyError: If no command is found.
243
# We want only 'ascii' command names, but the user may have typed
244
# in a Unicode name. In that case, they should just get a
245
# 'command not found' error later.
246
# In the future, we may actually support Unicode command names.
249
for hook in Command.hooks['get_command']:
250
cmd = hook(cmd, cmd_name)
251
if cmd is not None and not plugins_override and not cmd.plugin_name():
252
# We've found a non-plugin command, don't permit it to be
255
if cmd is None and check_missing:
256
for hook in Command.hooks['get_missing_command']:
263
# Allow plugins to extend commands
264
for hook in Command.hooks['extend_command']:
266
if getattr(cmd, 'invoked_as', None) is None:
267
cmd.invoked_as = cmd_name
271
def _try_plugin_provider(cmd_name):
272
"""Probe for a plugin provider having cmd_name."""
274
plugin_metadata, provider = probe_for_provider(cmd_name)
275
raise errors.CommandAvailableInPlugin(cmd_name,
276
plugin_metadata, provider)
277
except errors.NoPluginAvailable:
281
def probe_for_provider(cmd_name):
282
"""Look for a provider for cmd_name.
284
:param cmd_name: The command name.
285
:return: plugin_metadata, provider for getting cmd_name.
286
:raises NoPluginAvailable: When no provider can supply the plugin.
288
# look for providers that provide this command but aren't installed
289
for provider in command_providers_registry:
291
return provider.plugin_for_command(cmd_name), provider
292
except errors.NoPluginAvailable:
294
raise errors.NoPluginAvailable(cmd_name)
297
def _get_bzr_command(cmd_or_None, cmd_name):
298
"""Get a command from bzr's core."""
300
cmd_class = builtin_command_registry.get(cmd_name)
308
def _get_external_command(cmd_or_None, cmd_name):
309
"""Lookup a command that is a shell script."""
310
# Only do external command lookups when no command is found so far.
311
if cmd_or_None is not None:
313
from breezy.externalcommand import ExternalCommand
314
cmd_obj = ExternalCommand.find_command(cmd_name)
319
def _get_plugin_command(cmd_or_None, cmd_name):
320
"""Get a command from brz's plugins."""
322
return plugin_cmds.get(cmd_name)()
325
for key in plugin_cmds.keys():
326
info = plugin_cmds.get_info(key)
327
if cmd_name in info.aliases:
328
return plugin_cmds.get(key)()
332
class Command(object):
333
"""Base class for commands.
335
Commands are the heart of the command-line brz interface.
337
The command object mostly handles the mapping of command-line
338
parameters into one or more breezy operations, and of the results
341
Commands normally don't have any state. All their arguments are
342
passed in to the run method. (Subclasses may take a different
343
policy if the behaviour of the instance needs to depend on e.g. a
344
shell plugin and not just its Python class.)
346
The docstring for an actual command should give a single-line
347
summary, then a complete description of the command. A grammar
348
description will be inserted.
350
:cvar aliases: Other accepted names for this command.
352
:cvar takes_args: List of argument forms, marked with whether they are
353
optional, repeated, etc. Examples::
355
['to_location', 'from_branch?', 'file*']
357
* 'to_location' is required
358
* 'from_branch' is optional
359
* 'file' can be specified 0 or more times
361
:cvar takes_options: List of options that may be given for this command.
362
These can be either strings, referring to globally-defined options, or
363
option objects. Retrieve through options().
365
:cvar hidden: If true, this command isn't advertised. This is typically
366
for commands intended for expert users.
368
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
369
been setup to properly handle encoding of unicode strings.
370
encoding_type determines what will happen when characters cannot be
373
* strict - abort if we cannot decode
374
* replace - put in a bogus character (typically '?')
375
* exact - do not encode sys.stdout
377
NOTE: by default on Windows, sys.stdout is opened as a text stream,
378
therefore LF line-endings are converted to CRLF. When a command uses
379
encoding_type = 'exact', then sys.stdout is forced to be a binary
380
stream, and line-endings will not mangled.
383
A string indicating the real name under which this command was
384
invoked, before expansion of aliases.
385
(This may be None if the command was constructed and run in-process.)
387
:cvar hooks: An instance of CommandHooks.
389
:cvar __doc__: The help shown by 'brz help command' for this command.
390
This is set by assigning explicitly to __doc__ so that -OO can
394
__doc__ = "My help goes here"
399
encoding_type = 'strict'
406
"""Construct an instance of this command."""
407
# List of standard options directly supported
408
self.supported_std_options = []
411
def add_cleanup(self, cleanup_func, *args, **kwargs):
412
"""Register a function to call after self.run returns or raises.
414
Functions will be called in LIFO order.
416
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
418
def cleanup_now(self):
419
"""Execute and empty pending cleanup functions immediately.
421
After cleanup_now all registered cleanups are forgotten. add_cleanup
422
may be called again after cleanup_now; these cleanups will be called
423
after self.run returns or raises (or when cleanup_now is next called).
425
This is useful for releasing expensive or contentious resources (such
426
as write locks) before doing further work that does not require those
427
resources (such as writing results to self.outf). Note though, that
428
as it releases all resources, this may release locks that the command
429
wants to hold, so use should be done with care.
431
self._operation.cleanup_now()
434
"""Return single-line grammar for this command.
436
Only describes arguments, not options.
438
s = 'brz ' + self.name() + ' '
439
for aname in self.takes_args:
440
aname = aname.upper()
441
if aname[-1] in ['$', '+']:
442
aname = aname[:-1] + '...'
443
elif aname[-1] == '?':
444
aname = '[' + aname[:-1] + ']'
445
elif aname[-1] == '*':
446
aname = '[' + aname[:-1] + '...]'
448
s = s[:-1] # remove last space
451
def get_help_text(self, additional_see_also=None, plain=True,
452
see_also_as_links=False, verbose=True):
453
"""Return a text string with help for this command.
455
:param additional_see_also: Additional help topics to be
457
:param plain: if False, raw help (reStructuredText) is
458
returned instead of plain text.
459
:param see_also_as_links: if True, convert items in 'See also'
460
list to internal links (used by bzr_man rstx generator)
461
:param verbose: if True, display the full help, otherwise
462
leave out the descriptive sections and just display
463
usage help (e.g. Purpose, Usage, Options) with a
464
message explaining how to obtain full help.
467
i18n.install() # Install i18n only for get_help_text for now.
470
# Note: If self.gettext() translates ':Usage:\n', the section will
471
# be shown after "Description" section and we don't want to
472
# translate the usage string.
473
# Though, brz export-pot don't exports :Usage: section and it must
475
doc = self.gettext(doc)
477
doc = gettext("No help for this command.")
479
# Extract the summary (purpose) and sections out from the text
480
purpose,sections,order = self._get_help_parts(doc)
482
# If a custom usage section was provided, use it
483
if 'Usage' in sections:
484
usage = sections.pop('Usage')
486
usage = self._usage()
488
# The header is the purpose and usage
490
result += gettext(':Purpose: %s\n') % (purpose,)
491
if usage.find('\n') >= 0:
492
result += gettext(':Usage:\n%s\n') % (usage,)
494
result += gettext(':Usage: %s\n') % (usage,)
499
# XXX: optparse implicitly rewraps the help, and not always perfectly,
500
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
502
parser = option.get_optparser(self.options())
503
options = parser.format_option_help()
504
# FIXME: According to the spec, ReST option lists actually don't
505
# support options like --1.14 so that causes syntax errors (in Sphinx
506
# at least). As that pattern always appears in the commands that
507
# break, we trap on that and then format that block of 'format' options
508
# as a literal block. We use the most recent format still listed so we
509
# don't have to do that too often -- vila 20110514
510
if not plain and options.find(' --1.14 ') != -1:
511
options = options.replace(' format:\n', ' format::\n\n', 1)
512
if options.startswith('Options:'):
513
result += gettext(':Options:%s') % (options[len('options:'):],)
519
# Add the description, indenting it 2 spaces
520
# to match the indentation of the options
522
text = sections.pop(None)
523
text = '\n '.join(text.splitlines())
524
result += gettext(':Description:\n %s\n\n') % (text,)
526
# Add the custom sections (e.g. Examples). Note that there's no need
527
# to indent these as they must be indented already in the source.
530
if label in sections:
531
result += ':%s:\n%s\n' % (label, sections[label])
534
result += (gettext("See brz help %s for more details and examples.\n\n")
537
# Add the aliases, source (plug-in) and see also links, if any
539
result += gettext(':Aliases: ')
540
result += ', '.join(self.aliases) + '\n'
541
plugin_name = self.plugin_name()
542
if plugin_name is not None:
543
result += gettext(':From: plugin "%s"\n') % plugin_name
544
see_also = self.get_see_also(additional_see_also)
546
if not plain and see_also_as_links:
548
for item in see_also:
550
# topics doesn't have an independent section
551
# so don't create a real link
552
see_also_links.append(item)
554
# Use a Sphinx link for this entry
555
link_text = gettext(":doc:`{0} <{1}-help>`").format(
557
see_also_links.append(link_text)
558
see_also = see_also_links
559
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
561
# If this will be rendered as plain text, convert it
563
import breezy.help_topics
564
result = breezy.help_topics.help_as_plain_text(result)
568
def _get_help_parts(text):
569
"""Split help text into a summary and named sections.
571
:return: (summary,sections,order) where summary is the top line and
572
sections is a dictionary of the rest indexed by section name.
573
order is the order the section appear in the text.
574
A section starts with a heading line of the form ":xxx:".
575
Indented text on following lines is the section value.
576
All text found outside a named section is assigned to the
577
default section which is given the key of None.
579
def save_section(sections, order, label, section):
581
if label in sections:
582
sections[label] += '\n' + section
585
sections[label] = section
587
lines = text.rstrip().splitlines()
588
summary = lines.pop(0)
591
label,section = None,''
593
if line.startswith(':') and line.endswith(':') and len(line) > 2:
594
save_section(sections, order, label, section)
595
label,section = line[1:-1],''
596
elif (label is not None) and len(line) > 1 and not line[0].isspace():
597
save_section(sections, order, label, section)
598
label,section = None,line
601
section += '\n' + line
604
save_section(sections, order, label, section)
605
return summary, sections, order
607
def get_help_topic(self):
608
"""Return the commands help topic - its name."""
611
def get_see_also(self, additional_terms=None):
612
"""Return a list of help topics that are related to this command.
614
The list is derived from the content of the _see_also attribute. Any
615
duplicates are removed and the result is in lexical order.
616
:param additional_terms: Additional help topics to cross-reference.
617
:return: A list of help topics.
619
see_also = set(getattr(self, '_see_also', []))
621
see_also.update(additional_terms)
622
return sorted(see_also)
625
"""Return dict of valid options for this command.
627
Maps from long option name to option object."""
628
r = Option.STD_OPTIONS.copy()
630
for o in self.takes_options:
631
if isinstance(o, string_types):
632
o = option.Option.OPTIONS[o]
634
if o.name in std_names:
635
self.supported_std_options.append(o.name)
638
def _setup_outf(self):
639
"""Return a file linked to stdout, which has proper encoding."""
640
self.outf = ui.ui_factory.make_output_stream(
641
encoding_type=self.encoding_type)
643
def run_argv_aliases(self, argv, alias_argv=None):
644
"""Parse the command line and run with extra aliases in alias_argv."""
645
args, opts = parse_args(self, argv, alias_argv)
648
# Process the standard options
649
if 'help' in opts: # e.g. brz add --help
650
self.outf.write(self.get_help_text())
652
if 'usage' in opts: # e.g. brz add --usage
653
self.outf.write(self.get_help_text(verbose=False))
655
trace.set_verbosity_level(option._verbosity_level)
656
if 'verbose' in self.supported_std_options:
657
opts['verbose'] = trace.is_verbose()
658
elif 'verbose' in opts:
660
if 'quiet' in self.supported_std_options:
661
opts['quiet'] = trace.is_quiet()
662
elif 'quiet' in opts:
664
# mix arguments and options into one dictionary
665
cmdargs = _match_argform(self.name(), self.takes_args, args)
667
for k, v in opts.items():
668
cmdopts[k.replace('-', '_')] = v
670
all_cmd_args = cmdargs.copy()
671
all_cmd_args.update(cmdopts)
674
return self.run(**all_cmd_args)
676
# reset it, so that other commands run in the same process won't
677
# inherit state. Before we reset it, log any activity, so that it
678
# gets properly tracked.
679
ui.ui_factory.log_transport_activity(
680
display=('bytes' in debug.debug_flags))
681
trace.set_verbosity_level(0)
683
def _setup_run(self):
684
"""Wrap the defined run method on self with a cleanup.
686
This is called by __init__ to make the Command be able to be run
687
by just calling run(), as it could be before cleanups were added.
689
If a different form of cleanups are in use by your Command subclass,
690
you can override this method.
693
def run(*args, **kwargs):
694
for hook in Command.hooks['pre_command']:
696
self._operation = cleanup.OperationWithCleanups(class_run)
698
return self._operation.run_simple(*args, **kwargs)
701
for hook in Command.hooks['post_command']:
706
"""Actually run the command.
708
This is invoked with the options and arguments bound to
711
Return 0 or None if the command was successful, or a non-zero
712
shell error code if not. It's OK for this method to allow
713
an exception to raise up.
715
This method is automatically wrapped by Command.__init__ with a
716
cleanup operation, stored as self._operation. This can be used
717
via self.add_cleanup to perform automatic cleanups at the end of
720
The argument for run are assembled by introspection. So for instance,
721
if your command takes an argument files, you would declare::
723
def run(self, files=None):
726
raise NotImplementedError('no implementation of command %r'
730
"""Return help message for this class."""
731
from inspect import getdoc
732
if self.__doc__ is Command.__doc__:
736
def gettext(self, message):
737
"""Returns the gettext function used to translate this command's help.
739
Commands provided by plugins should override this to use their
742
return i18n.gettext_per_paragraph(message)
745
"""Return the canonical name for this command.
747
The name under which it was actually invoked is available in invoked_as.
749
return _unsquish_command_name(self.__class__.__name__)
751
def plugin_name(self):
752
"""Get the name of the plugin that provides this command.
754
:return: The name of the plugin or None if the command is builtin.
756
return plugin_name(self.__module__)
759
class CommandHooks(Hooks):
760
"""Hooks related to Command object creation/enumeration."""
763
"""Create the default hooks.
765
These are all empty initially, because by default nothing should get
768
Hooks.__init__(self, "breezy.commands", "Command.hooks")
769
self.add_hook('extend_command',
770
"Called after creating a command object to allow modifications "
771
"such as adding or removing options, docs etc. Called with the "
772
"new breezy.commands.Command object.", (1, 13))
773
self.add_hook('get_command',
774
"Called when creating a single command. Called with "
775
"(cmd_or_None, command_name). get_command should either return "
776
"the cmd_or_None parameter, or a replacement Command object that "
777
"should be used for the command. Note that the Command.hooks "
778
"hooks are core infrastructure. Many users will prefer to use "
779
"breezy.commands.register_command or plugin_cmds.register_lazy.",
781
self.add_hook('get_missing_command',
782
"Called when creating a single command if no command could be "
783
"found. Called with (command_name). get_missing_command should "
784
"either return None, or a Command object to be used for the "
786
self.add_hook('list_commands',
787
"Called when enumerating commands. Called with a set of "
788
"cmd_name strings for all the commands found so far. This set "
789
" is safe to mutate - e.g. to remove a command. "
790
"list_commands should return the updated set of command names.",
792
self.add_hook('pre_command',
793
"Called prior to executing a command. Called with the command "
795
self.add_hook('post_command',
796
"Called after executing a command. Called with the command "
799
Command.hooks = CommandHooks()
802
def parse_args(command, argv, alias_argv=None):
803
"""Parse command line.
805
Arguments and options are parsed at this level before being passed
806
down to specific command handlers. This routine knows, from a
807
lookup table, something about the available options, what optargs
808
they take, and which commands will accept them.
810
# TODO: make it a method of the Command?
811
parser = option.get_optparser(command.options())
812
if alias_argv is not None:
813
args = alias_argv + argv
817
# for python 2.5 and later, optparse raises this exception if a non-ascii
818
# option name is given. See http://bugs.python.org/issue2931
820
options, args = parser.parse_args(args)
821
except UnicodeEncodeError as e:
822
raise errors.BzrCommandError(
823
gettext('Only ASCII permitted in option names'))
825
opts = dict((k, v) for k, v in options.__dict__.items() if
826
v is not option.OptionParser.DEFAULT_VALUE)
830
def _match_argform(cmd, takes_args, args):
833
# step through args and takes_args, allowing appropriate 0-many matches
834
for ap in takes_args:
838
argdict[argname] = args.pop(0)
839
elif ap[-1] == '*': # all remaining arguments
841
argdict[argname + '_list'] = args[:]
844
argdict[argname + '_list'] = None
847
raise errors.BzrCommandError(gettext(
848
"command {0!r} needs one or more {1}").format(
849
cmd, argname.upper()))
851
argdict[argname + '_list'] = args[:]
853
elif ap[-1] == '$': # all but one
855
raise errors.BzrCommandError(
856
gettext("command {0!r} needs one or more {1}").format(
857
cmd, argname.upper()))
858
argdict[argname + '_list'] = args[:-1]
864
raise errors.BzrCommandError(
865
gettext("command {0!r} requires argument {1}").format(
866
cmd, argname.upper()))
868
argdict[argname] = args.pop(0)
871
raise errors.BzrCommandError( gettext(
872
"extra argument to command {0}: {1}").format(
877
def apply_coveraged(dirname, the_callable, *args, **kwargs):
878
# Cannot use "import trace", as that would import breezy.trace instead of
879
# the standard library's trace.
880
trace = __import__('trace')
882
tracer = trace.Trace(count=1, trace=0)
883
sys.settrace(tracer.globaltrace)
884
threading.settrace(tracer.globaltrace)
887
return exception_to_return_code(the_callable, *args, **kwargs)
890
results = tracer.results()
891
results.write_results(show_missing=1, summary=False,
895
def apply_profiled(the_callable, *args, **kwargs):
899
pffileno, pfname = tempfile.mkstemp()
901
prof = hotshot.Profile(pfname)
903
ret = prof.runcall(exception_to_return_code, the_callable, *args,
907
stats = hotshot.stats.load(pfname)
909
stats.sort_stats('cum') # 'time'
910
## XXX: Might like to write to stderr or the trace file instead but
911
## print_stats seems hardcoded to stdout
912
stats.print_stats(20)
919
def exception_to_return_code(the_callable, *args, **kwargs):
920
"""UI level helper for profiling and coverage.
922
This transforms exceptions into a return value of 3. As such its only
923
relevant to the UI layer, and should never be called where catching
924
exceptions may be desirable.
927
return the_callable(*args, **kwargs)
928
except (KeyboardInterrupt, Exception) as e:
929
# used to handle AssertionError and KeyboardInterrupt
930
# specially here, but hopefully they're handled ok by the logger now
931
exc_info = sys.exc_info()
932
exitcode = trace.report_exception(exc_info, sys.stderr)
933
if os.environ.get('BRZ_PDB'):
934
print('**** entering debugger')
936
pdb.post_mortem(exc_info[2])
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
from breezy.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable,
949
trace.note(gettext('Profile data written to "%s".'), filename)
953
def get_alias(cmd, config=None):
954
"""Return an expanded alias, or None if no alias exists.
957
Command to be checked for an alias.
959
Used to specify an alternative config to use,
960
which is especially useful for testing.
961
If it is unspecified, the global config will be used.
965
config = breezy.config.GlobalConfig()
966
alias = config.get_alias(cmd)
968
return cmdline.split(alias)
972
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
973
"""Execute a command.
975
:param argv: The command-line arguments, without the program name from
976
argv[0] These should already be decoded. All library/test code calling
977
run_bzr should be passing valid strings (don't need decoding).
978
:param load_plugins: What function to call when triggering plugin loading.
979
This function should take no arguments and cause all plugins to be
981
:param disable_plugins: What function to call when disabling plugin
982
loading. This function should take no arguments and cause all plugin
983
loading to be prohibited (so that code paths in your application that
984
know about some plugins possibly being present will fail to import
985
those plugins even if they are installed.)
986
:return: Returns a command exit code or raises an exception.
988
Special master options: these must come before the command because
989
they control how the command is interpreted.
992
Do not load plugin modules at all
998
Only use builtin commands. (Plugins are still allowed to change
1002
Run under the Python hotshot profiler.
1005
Run under the Python lsprof profiler.
1008
Generate line coverage report in the specified directory.
1011
Specify the number of processes that can be run concurrently (selftest).
1013
trace.mutter("breezy version: " + breezy.__version__)
1014
argv = _specified_or_unicode_argv(argv)
1015
trace.mutter("brz arguments: %r", argv)
1017
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1018
opt_no_l10n = opt_no_aliases = False
1019
opt_lsprof_file = opt_coverage_dir = None
1021
# --no-plugins is handled specially at a very early stage. We need
1022
# to load plugins before doing other command parsing so that they
1023
# can override commands, but this needs to happen first.
1027
override_config = []
1028
while i < len(argv):
1030
if a == '--profile':
1032
elif a == '--lsprof':
1034
elif a == '--lsprof-file':
1036
opt_lsprof_file = argv[i + 1]
1038
elif a == '--no-plugins':
1039
opt_no_plugins = True
1040
elif a == '--no-aliases':
1041
opt_no_aliases = True
1042
elif a == '--no-l10n':
1044
elif a == '--builtin':
1046
elif a == '--concurrency':
1047
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1049
elif a == '--coverage':
1050
opt_coverage_dir = argv[i + 1]
1052
elif a == '--profile-imports':
1053
pass # already handled in startup script Bug #588277
1054
elif a.startswith('-D'):
1055
debug.debug_flags.add(a[2:])
1056
elif a.startswith('-O'):
1057
override_config.append(a[2:])
1062
if breezy.global_state is None:
1063
# FIXME: Workaround for users that imported breezy but didn't call
1064
# breezy.initialize -- vila 2012-01-19
1065
cmdline_overrides = config.CommandLineStore()
1067
cmdline_overrides = breezy.global_state.cmdline_overrides
1068
cmdline_overrides._from_cmdline(override_config)
1070
debug.set_debug_flags_from_config()
1072
if not opt_no_plugins:
1079
get_cmd_object('help').run_argv_aliases([])
1082
if argv[0] == '--version':
1083
get_cmd_object('version').run_argv_aliases([])
1088
if not opt_no_aliases:
1089
alias_argv = get_alias(argv[0])
1091
argv[0] = alias_argv.pop(0)
1094
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1096
cmd_obj.l10n = False
1097
run = cmd_obj.run_argv_aliases
1098
run_argv = [argv, alias_argv]
1101
# We can be called recursively (tests for example), but we don't want
1102
# the verbosity level to propagate.
1103
saved_verbosity_level = option._verbosity_level
1104
option._verbosity_level = 0
1106
if opt_coverage_dir:
1108
'--coverage ignored, because --lsprof is in use.')
1109
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1111
if opt_coverage_dir:
1113
'--coverage ignored, because --profile is in use.')
1114
ret = apply_profiled(run, *run_argv)
1115
elif opt_coverage_dir:
1116
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1118
ret = run(*run_argv)
1121
# reset, in case we may do other commands later within the same
1122
# process. Commands that want to execute sub-commands must propagate
1123
# --verbose in their own way.
1124
if 'memory' in debug.debug_flags:
1125
trace.debug_memory('Process status after command:', short=False)
1126
option._verbosity_level = saved_verbosity_level
1127
# Reset the overrides
1128
cmdline_overrides._reset()
1131
def display_command(func):
1132
"""Decorator that suppresses pipe/interrupt errors."""
1133
def ignore_pipe(*args, **kwargs):
1135
result = func(*args, **kwargs)
1138
except IOError as e:
1139
if getattr(e, 'errno', None) is None:
1141
if e.errno != errno.EPIPE:
1142
# Win32 raises IOError with errno=0 on a broken pipe
1143
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1146
except KeyboardInterrupt:
1151
def install_bzr_command_hooks():
1152
"""Install the hooks to supply bzr's own commands."""
1153
if _list_bzr_commands in Command.hooks["list_commands"]:
1155
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1157
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1159
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1160
"bzr plugin commands")
1161
Command.hooks.install_named_hook("get_command", _get_external_command,
1162
"bzr external command lookup")
1163
Command.hooks.install_named_hook("get_missing_command",
1164
_try_plugin_provider,
1165
"bzr plugin-provider-db check")
1169
def _specified_or_unicode_argv(argv):
1170
# For internal or testing use, argv can be passed. Otherwise, get it from
1171
# the process arguments in a unicode-safe way.
1173
return osutils.get_unicode_argv()
1177
# ensure all arguments are unicode strings
1179
if isinstance(a, unicode):
1182
new_argv.append(a.decode('ascii'))
1183
except UnicodeDecodeError:
1184
raise errors.BzrError("argv should be list of unicode strings.")
1188
def main(argv=None):
1189
"""Main entry point of command-line interface.
1191
Typically `breezy.initialize` should be called first.
1193
:param argv: list of unicode command-line arguments similar to sys.argv.
1194
argv[0] is script name usually, it will be ignored.
1195
Don't pass here sys.argv because this list contains plain strings
1196
and not unicode; pass None instead.
1198
:return: exit code of brz command.
1200
if argv is not None:
1202
_register_builtin_commands()
1203
ret = run_bzr_catch_errors(argv)
1204
trace.mutter("return code %d", ret)
1208
def run_bzr_catch_errors(argv):
1209
"""Run a bzr command with parameters as described by argv.
1211
This function assumed that that UI layer is setup, that symbol deprecations
1212
are already applied, and that unicode decoding has already been performed on argv.
1214
# done here so that they're covered for every test run
1215
install_bzr_command_hooks()
1216
return exception_to_return_code(run_bzr, argv)
1219
def run_bzr_catch_user_errors(argv):
1220
"""Run brz and report user errors, but let internal errors propagate.
1222
This is used for the test suite, and might be useful for other programs
1223
that want to wrap the commandline interface.
1225
# done here so that they're covered for every test run
1226
install_bzr_command_hooks()
1228
return run_bzr(argv)
1229
except Exception as e:
1230
if (isinstance(e, (OSError, IOError))
1231
or not getattr(e, 'internal_error', True)):
1232
trace.report_exception(sys.exc_info(), sys.stderr)
1238
class HelpCommandIndex(object):
1239
"""A index for bzr help that returns commands."""
1242
self.prefix = 'commands/'
1244
def get_topics(self, topic):
1245
"""Search for topic amongst commands.
1247
:param topic: A topic to search for.
1248
:return: A list which is either empty or contains a single
1251
if topic and topic.startswith(self.prefix):
1252
topic = topic[len(self.prefix):]
1254
cmd = _get_cmd_object(topic, check_missing=False)
1261
class Provider(object):
1262
"""Generic class to be overriden by plugins"""
1264
def plugin_for_command(self, cmd_name):
1265
"""Takes a command and returns the information for that plugin
1267
:return: A dictionary with all the available information
1268
for the requested plugin
1270
raise NotImplementedError
1273
class ProvidersRegistry(registry.Registry):
1274
"""This registry exists to allow other providers to exist"""
1277
for key, provider in self.items():
1280
command_providers_registry = ProvidersRegistry()
added
removed
breezy/commands.py
