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(), """
48
from .hooks import Hooks
49
from .i18n import gettext
50
# Compatibility - Option used to be in commands.
51
from .option import Option
52
from .plugin import disable_plugins, load_plugins, plugin_name
53
from . import errors, registry
60
class BzrOptionError(errors.BzrCommandError):
62
_fmt = "Error in command line options"
65
class CommandAvailableInPlugin(Exception):
67
internal_error = False
69
def __init__(self, cmd_name, plugin_metadata, provider):
71
self.plugin_metadata = plugin_metadata
72
self.cmd_name = cmd_name
73
self.provider = provider
77
_fmt = ('"%s" is not a standard brz command. \n'
78
'However, the following official plugin provides this command: %s\n'
79
'You can install it by going to: %s'
80
% (self.cmd_name, self.plugin_metadata['name'],
81
self.plugin_metadata['url']))
86
class CommandInfo(object):
87
"""Information about a command."""
89
def __init__(self, aliases):
90
"""The list of aliases for the command."""
91
self.aliases = aliases
94
def from_command(klass, command):
95
"""Factory to construct a CommandInfo from a command."""
96
return klass(command.aliases)
99
class CommandRegistry(registry.Registry):
100
"""Special registry mapping command names to command classes.
102
:ivar overridden_registry: Look in this registry for commands being
103
overridden by this registry. This can be used to tell plugin commands
104
about the builtin they're decorating.
108
registry.Registry.__init__(self)
109
self.overridden_registry = None
110
# map from aliases to the real command that implements the name
111
self._alias_dict = {}
113
def get(self, command_name):
114
real_name = self._alias_dict.get(command_name, command_name)
115
return registry.Registry.get(self, real_name)
118
def _get_name(command_name):
119
if command_name.startswith("cmd_"):
120
return _unsquish_command_name(command_name)
124
def register(self, cmd, decorate=False):
125
"""Utility function to help register a command
127
:param cmd: Command subclass to register
128
:param decorate: If true, allow overriding an existing command
129
of the same name; the old command is returned by this function.
130
Otherwise it is an error to try to override an existing command.
133
k_unsquished = self._get_name(k)
135
previous = self.get(k_unsquished)
138
if self.overridden_registry:
140
previous = self.overridden_registry.get(k_unsquished)
143
info = CommandInfo.from_command(cmd)
145
registry.Registry.register(self, k_unsquished, cmd,
146
override_existing=decorate, info=info)
148
trace.warning('Two plugins defined the same command: %r' % k)
149
trace.warning('Not loading the one in %r' %
150
sys.modules[cmd.__module__])
151
trace.warning('Previously this command was registered from %r' %
152
sys.modules[previous.__module__])
153
for a in cmd.aliases:
154
self._alias_dict[a] = k_unsquished
157
def register_lazy(self, command_name, aliases, module_name):
158
"""Register a command without loading its module.
160
:param command_name: The primary name of the command.
161
:param aliases: A list of aliases for the command.
162
:module_name: The module that the command lives in.
164
key = self._get_name(command_name)
165
registry.Registry.register_lazy(self, key, module_name, command_name,
166
info=CommandInfo(aliases))
168
self._alias_dict[a] = key
171
plugin_cmds = CommandRegistry()
172
builtin_command_registry = CommandRegistry()
173
plugin_cmds.overridden_registry = builtin_command_registry
176
def register_command(cmd, decorate=False):
177
"""Register a plugin command.
179
Should generally be avoided in favor of lazy registration.
182
return plugin_cmds.register(cmd, decorate)
185
def _squish_command_name(cmd):
186
return 'cmd_' + cmd.replace('-', '_')
189
def _unsquish_command_name(cmd):
190
return cmd[4:].replace('_', '-')
193
def _register_builtin_commands():
194
if builtin_command_registry.keys():
197
import breezy.builtins
198
for cmd_class in _scan_module_for_commands(breezy.builtins):
199
builtin_command_registry.register(cmd_class)
200
breezy.builtins._register_lazy_builtins()
203
def _scan_module_for_commands(module):
204
module_dict = module.__dict__
205
for name in module_dict:
206
if name.startswith("cmd_"):
207
yield module_dict[name]
210
def _list_bzr_commands(names):
211
"""Find commands from bzr's core and plugins.
213
This is not the public interface, just the default hook called by all_command_names.
215
# to eliminate duplicates
216
names.update(builtin_command_names())
217
names.update(plugin_command_names())
221
def all_command_names():
222
"""Return a set of all command names."""
224
for hook in Command.hooks['list_commands']:
227
raise AssertionError(
228
'hook %s returned None' % Command.hooks.get_hook_name(hook))
232
def builtin_command_names():
233
"""Return list of builtin command names.
235
Use of all_command_names() is encouraged rather than builtin_command_names
236
and/or plugin_command_names.
238
_register_builtin_commands()
239
return builtin_command_registry.keys()
242
def plugin_command_names():
243
"""Returns command names from commands registered by plugins."""
244
return plugin_cmds.keys()
247
# Overrides for common mispellings that heuristics get wrong
249
'ic': {'ci': 0}, # heuristic finds nick
253
def guess_command(cmd_name):
254
"""Guess what command a user typoed.
256
:param cmd_name: Command to search for
257
:return: None if no command was found, name of a command otherwise
260
for name in all_command_names():
262
cmd = get_cmd_object(name)
263
names.update(cmd.aliases)
264
# candidate: modified levenshtein distance against cmd_name.
266
from . import patiencediff
267
for name in sorted(names):
268
matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
270
opcodes = matcher.get_opcodes()
271
for opcode, l1, l2, r1, r2 in opcodes:
272
if opcode == 'delete':
274
elif opcode == 'replace':
275
distance += max(l2-l1, r2-l1)
276
elif opcode == 'insert':
278
elif opcode == 'equal':
279
# Score equal ranges lower, making similar commands of equal
280
# length closer than arbitrary same length commands.
281
distance -= 0.1 * (l2-l1)
282
costs[name] = distance
283
costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
284
costs = sorted((costs[key], key) for key in costs)
289
candidate = costs[0][1]
293
def get_cmd_object(cmd_name, plugins_override=True):
294
"""Return the command object for a command.
297
If true, plugin commands can override builtins.
300
return _get_cmd_object(cmd_name, plugins_override)
302
# No command found, see if this was a typo
303
candidate = guess_command(cmd_name)
304
if candidate is not None:
305
raise errors.BzrCommandError(
306
gettext('unknown command "%s". Perhaps you meant "%s"')
307
% (cmd_name, candidate))
308
raise errors.BzrCommandError(gettext('unknown command "%s"')
312
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
313
"""Get a command object.
315
:param cmd_name: The name of the command.
316
:param plugins_override: Allow plugins to override builtins.
317
:param check_missing: Look up commands not found in the regular index via
318
the get_missing_command hook.
319
:return: A Command object instance
320
:raises KeyError: If no command is found.
322
# We want only 'ascii' command names, but the user may have typed
323
# in a Unicode name. In that case, they should just get a
324
# 'command not found' error later.
325
# In the future, we may actually support Unicode command names.
328
for hook in Command.hooks['get_command']:
329
cmd = hook(cmd, cmd_name)
330
if cmd is not None and not plugins_override and not cmd.plugin_name():
331
# We've found a non-plugin command, don't permit it to be
334
if cmd is None and check_missing:
335
for hook in Command.hooks['get_missing_command']:
342
# Allow plugins to extend commands
343
for hook in Command.hooks['extend_command']:
345
if getattr(cmd, 'invoked_as', None) is None:
346
cmd.invoked_as = cmd_name
350
class NoPluginAvailable(errors.BzrError):
354
def _try_plugin_provider(cmd_name):
355
"""Probe for a plugin provider having cmd_name."""
357
plugin_metadata, provider = probe_for_provider(cmd_name)
358
raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
359
except NoPluginAvailable:
363
def probe_for_provider(cmd_name):
364
"""Look for a provider for cmd_name.
366
:param cmd_name: The command name.
367
:return: plugin_metadata, provider for getting cmd_name.
368
:raises NoPluginAvailable: When no provider can supply the plugin.
370
# look for providers that provide this command but aren't installed
371
for provider in command_providers_registry:
373
return provider.plugin_for_command(cmd_name), provider
374
except NoPluginAvailable:
376
raise NoPluginAvailable(cmd_name)
379
def _get_bzr_command(cmd_or_None, cmd_name):
380
"""Get a command from bzr's core."""
382
cmd_class = builtin_command_registry.get(cmd_name)
390
def _get_external_command(cmd_or_None, cmd_name):
391
"""Lookup a command that is a shell script."""
392
# Only do external command lookups when no command is found so far.
393
if cmd_or_None is not None:
395
from breezy.externalcommand import ExternalCommand
396
cmd_obj = ExternalCommand.find_command(cmd_name)
401
def _get_plugin_command(cmd_or_None, cmd_name):
402
"""Get a command from brz's plugins."""
404
return plugin_cmds.get(cmd_name)()
407
for key in plugin_cmds.keys():
408
info = plugin_cmds.get_info(key)
409
if cmd_name in info.aliases:
410
return plugin_cmds.get(key)()
414
class Command(object):
415
"""Base class for commands.
417
Commands are the heart of the command-line brz interface.
419
The command object mostly handles the mapping of command-line
420
parameters into one or more breezy operations, and of the results
423
Commands normally don't have any state. All their arguments are
424
passed in to the run method. (Subclasses may take a different
425
policy if the behaviour of the instance needs to depend on e.g. a
426
shell plugin and not just its Python class.)
428
The docstring for an actual command should give a single-line
429
summary, then a complete description of the command. A grammar
430
description will be inserted.
432
:cvar aliases: Other accepted names for this command.
434
:cvar takes_args: List of argument forms, marked with whether they are
435
optional, repeated, etc. Examples::
437
['to_location', 'from_branch?', 'file*']
439
* 'to_location' is required
440
* 'from_branch' is optional
441
* 'file' can be specified 0 or more times
443
:cvar takes_options: List of options that may be given for this command.
444
These can be either strings, referring to globally-defined options, or
445
option objects. Retrieve through options().
447
:cvar hidden: If true, this command isn't advertised. This is typically
448
for commands intended for expert users.
450
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
451
been setup to properly handle encoding of unicode strings.
452
encoding_type determines what will happen when characters cannot be
455
* strict - abort if we cannot decode
456
* replace - put in a bogus character (typically '?')
457
* exact - do not encode sys.stdout
459
NOTE: by default on Windows, sys.stdout is opened as a text stream,
460
therefore LF line-endings are converted to CRLF. When a command uses
461
encoding_type = 'exact', then sys.stdout is forced to be a binary
462
stream, and line-endings will not mangled.
465
A string indicating the real name under which this command was
466
invoked, before expansion of aliases.
467
(This may be None if the command was constructed and run in-process.)
469
:cvar hooks: An instance of CommandHooks.
471
:cvar __doc__: The help shown by 'brz help command' for this command.
472
This is set by assigning explicitly to __doc__ so that -OO can
476
__doc__ = "My help goes here"
481
encoding_type = 'strict'
488
"""Construct an instance of this command."""
489
# List of standard options directly supported
490
self.supported_std_options = []
493
def add_cleanup(self, cleanup_func, *args, **kwargs):
494
"""Register a function to call after self.run returns or raises.
496
Functions will be called in LIFO order.
498
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
500
def cleanup_now(self):
501
"""Execute and empty pending cleanup functions immediately.
503
After cleanup_now all registered cleanups are forgotten. add_cleanup
504
may be called again after cleanup_now; these cleanups will be called
505
after self.run returns or raises (or when cleanup_now is next called).
507
This is useful for releasing expensive or contentious resources (such
508
as write locks) before doing further work that does not require those
509
resources (such as writing results to self.outf). Note though, that
510
as it releases all resources, this may release locks that the command
511
wants to hold, so use should be done with care.
513
self._operation.cleanup_now()
516
"""Return single-line grammar for this command.
518
Only describes arguments, not options.
520
s = 'brz ' + self.name() + ' '
521
for aname in self.takes_args:
522
aname = aname.upper()
523
if aname[-1] in ['$', '+']:
524
aname = aname[:-1] + '...'
525
elif aname[-1] == '?':
526
aname = '[' + aname[:-1] + ']'
527
elif aname[-1] == '*':
528
aname = '[' + aname[:-1] + '...]'
530
s = s[:-1] # remove last space
533
def get_help_text(self, additional_see_also=None, plain=True,
534
see_also_as_links=False, verbose=True):
535
"""Return a text string with help for this command.
537
:param additional_see_also: Additional help topics to be
539
:param plain: if False, raw help (reStructuredText) is
540
returned instead of plain text.
541
:param see_also_as_links: if True, convert items in 'See also'
542
list to internal links (used by bzr_man rstx generator)
543
:param verbose: if True, display the full help, otherwise
544
leave out the descriptive sections and just display
545
usage help (e.g. Purpose, Usage, Options) with a
546
message explaining how to obtain full help.
549
i18n.install() # Install i18n only for get_help_text for now.
552
# Note: If self.gettext() translates ':Usage:\n', the section will
553
# be shown after "Description" section and we don't want to
554
# translate the usage string.
555
# Though, brz export-pot don't exports :Usage: section and it must
557
doc = self.gettext(doc)
559
doc = gettext("No help for this command.")
561
# Extract the summary (purpose) and sections out from the text
562
purpose, sections, order = self._get_help_parts(doc)
564
# If a custom usage section was provided, use it
565
if 'Usage' in sections:
566
usage = sections.pop('Usage')
568
usage = self._usage()
570
# The header is the purpose and usage
572
result += gettext(':Purpose: %s\n') % (purpose,)
573
if usage.find('\n') >= 0:
574
result += gettext(':Usage:\n%s\n') % (usage,)
576
result += gettext(':Usage: %s\n') % (usage,)
581
# XXX: optparse implicitly rewraps the help, and not always perfectly,
582
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
584
parser = option.get_optparser(self.options())
585
options = parser.format_option_help()
586
# FIXME: According to the spec, ReST option lists actually don't
587
# support options like --1.14 so that causes syntax errors (in Sphinx
588
# at least). As that pattern always appears in the commands that
589
# break, we trap on that and then format that block of 'format' options
590
# as a literal block. We use the most recent format still listed so we
591
# don't have to do that too often -- vila 20110514
592
if not plain and options.find(' --1.14 ') != -1:
593
options = options.replace(' format:\n', ' format::\n\n', 1)
594
if options.startswith('Options:'):
595
result += gettext(':Options:%s') % (options[len('options:'):],)
601
# Add the description, indenting it 2 spaces
602
# to match the indentation of the options
604
text = sections.pop(None)
605
text = '\n '.join(text.splitlines())
606
result += gettext(':Description:\n %s\n\n') % (text,)
608
# Add the custom sections (e.g. Examples). Note that there's no need
609
# to indent these as they must be indented already in the source.
612
if label in sections:
613
result += ':%s:\n%s\n' % (label, sections[label])
616
result += (gettext("See brz help %s for more details and examples.\n\n")
619
# Add the aliases, source (plug-in) and see also links, if any
621
result += gettext(':Aliases: ')
622
result += ', '.join(self.aliases) + '\n'
623
plugin_name = self.plugin_name()
624
if plugin_name is not None:
625
result += gettext(':From: plugin "%s"\n') % plugin_name
626
see_also = self.get_see_also(additional_see_also)
628
if not plain and see_also_as_links:
630
for item in see_also:
632
# topics doesn't have an independent section
633
# so don't create a real link
634
see_also_links.append(item)
636
# Use a Sphinx link for this entry
637
link_text = gettext(":doc:`{0} <{1}-help>`").format(
639
see_also_links.append(link_text)
640
see_also = see_also_links
641
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
643
# If this will be rendered as plain text, convert it
645
import breezy.help_topics
646
result = breezy.help_topics.help_as_plain_text(result)
650
def _get_help_parts(text):
651
"""Split help text into a summary and named sections.
653
:return: (summary,sections,order) where summary is the top line and
654
sections is a dictionary of the rest indexed by section name.
655
order is the order the section appear in the text.
656
A section starts with a heading line of the form ":xxx:".
657
Indented text on following lines is the section value.
658
All text found outside a named section is assigned to the
659
default section which is given the key of None.
661
def save_section(sections, order, label, section):
663
if label in sections:
664
sections[label] += '\n' + section
667
sections[label] = section
669
lines = text.rstrip().splitlines()
670
summary = lines.pop(0)
673
label, section = None, ''
675
if line.startswith(':') and line.endswith(':') and len(line) > 2:
676
save_section(sections, order, label, section)
677
label, section = line[1:-1], ''
678
elif (label is not None) and len(line) > 1 and not line[0].isspace():
679
save_section(sections, order, label, section)
680
label, section = None, line
683
section += '\n' + line
686
save_section(sections, order, label, section)
687
return summary, sections, order
689
def get_help_topic(self):
690
"""Return the commands help topic - its name."""
693
def get_see_also(self, additional_terms=None):
694
"""Return a list of help topics that are related to this command.
696
The list is derived from the content of the _see_also attribute. Any
697
duplicates are removed and the result is in lexical order.
698
:param additional_terms: Additional help topics to cross-reference.
699
:return: A list of help topics.
701
see_also = set(getattr(self, '_see_also', []))
703
see_also.update(additional_terms)
704
return sorted(see_also)
707
"""Return dict of valid options for this command.
709
Maps from long option name to option object."""
710
r = Option.STD_OPTIONS.copy()
712
for o in self.takes_options:
713
if isinstance(o, string_types):
714
o = option.Option.OPTIONS[o]
716
if o.name in std_names:
717
self.supported_std_options.append(o.name)
720
def _setup_outf(self):
721
"""Return a file linked to stdout, which has proper encoding."""
722
self.outf = ui.ui_factory.make_output_stream(
723
encoding_type=self.encoding_type)
725
def run_argv_aliases(self, argv, alias_argv=None):
726
"""Parse the command line and run with extra aliases in alias_argv."""
727
args, opts = parse_args(self, argv, alias_argv)
730
# Process the standard options
731
if 'help' in opts: # e.g. brz add --help
732
self.outf.write(self.get_help_text())
734
if 'usage' in opts: # e.g. brz add --usage
735
self.outf.write(self.get_help_text(verbose=False))
737
trace.set_verbosity_level(option._verbosity_level)
738
if 'verbose' in self.supported_std_options:
739
opts['verbose'] = trace.is_verbose()
740
elif 'verbose' in opts:
742
if 'quiet' in self.supported_std_options:
743
opts['quiet'] = trace.is_quiet()
744
elif 'quiet' in opts:
746
# mix arguments and options into one dictionary
747
cmdargs = _match_argform(self.name(), self.takes_args, args)
749
for k, v in opts.items():
750
cmdopts[k.replace('-', '_')] = v
752
all_cmd_args = cmdargs.copy()
753
all_cmd_args.update(cmdopts)
756
return self.run(**all_cmd_args)
758
# reset it, so that other commands run in the same process won't
759
# inherit state. Before we reset it, log any activity, so that it
760
# gets properly tracked.
761
ui.ui_factory.log_transport_activity(
762
display=('bytes' in debug.debug_flags))
763
trace.set_verbosity_level(0)
765
def _setup_run(self):
766
"""Wrap the defined run method on self with a cleanup.
768
This is called by __init__ to make the Command be able to be run
769
by just calling run(), as it could be before cleanups were added.
771
If a different form of cleanups are in use by your Command subclass,
772
you can override this method.
775
def run(*args, **kwargs):
776
for hook in Command.hooks['pre_command']:
778
self._operation = cleanup.OperationWithCleanups(class_run)
780
return self._operation.run_simple(*args, **kwargs)
783
for hook in Command.hooks['post_command']:
788
"""Actually run the command.
790
This is invoked with the options and arguments bound to
793
Return 0 or None if the command was successful, or a non-zero
794
shell error code if not. It's OK for this method to allow
795
an exception to raise up.
797
This method is automatically wrapped by Command.__init__ with a
798
cleanup operation, stored as self._operation. This can be used
799
via self.add_cleanup to perform automatic cleanups at the end of
802
The argument for run are assembled by introspection. So for instance,
803
if your command takes an argument files, you would declare::
805
def run(self, files=None):
808
raise NotImplementedError('no implementation of command %r'
812
"""Return help message for this class."""
813
from inspect import getdoc
814
if self.__doc__ is Command.__doc__:
818
def gettext(self, message):
819
"""Returns the gettext function used to translate this command's help.
821
Commands provided by plugins should override this to use their
824
return i18n.gettext_per_paragraph(message)
827
"""Return the canonical name for this command.
829
The name under which it was actually invoked is available in invoked_as.
831
return _unsquish_command_name(self.__class__.__name__)
833
def plugin_name(self):
834
"""Get the name of the plugin that provides this command.
836
:return: The name of the plugin or None if the command is builtin.
838
return plugin_name(self.__module__)
841
class CommandHooks(Hooks):
842
"""Hooks related to Command object creation/enumeration."""
845
"""Create the default hooks.
847
These are all empty initially, because by default nothing should get
850
Hooks.__init__(self, "breezy.commands", "Command.hooks")
851
self.add_hook('extend_command',
852
"Called after creating a command object to allow modifications "
853
"such as adding or removing options, docs etc. Called with the "
854
"new breezy.commands.Command object.", (1, 13))
855
self.add_hook('get_command',
856
"Called when creating a single command. Called with "
857
"(cmd_or_None, command_name). get_command should either return "
858
"the cmd_or_None parameter, or a replacement Command object that "
859
"should be used for the command. Note that the Command.hooks "
860
"hooks are core infrastructure. Many users will prefer to use "
861
"breezy.commands.register_command or plugin_cmds.register_lazy.",
863
self.add_hook('get_missing_command',
864
"Called when creating a single command if no command could be "
865
"found. Called with (command_name). get_missing_command should "
866
"either return None, or a Command object to be used for the "
868
self.add_hook('list_commands',
869
"Called when enumerating commands. Called with a set of "
870
"cmd_name strings for all the commands found so far. This set "
871
" is safe to mutate - e.g. to remove a command. "
872
"list_commands should return the updated set of command names.",
874
self.add_hook('pre_command',
875
"Called prior to executing a command. Called with the command "
877
self.add_hook('post_command',
878
"Called after executing a command. Called with the command "
881
Command.hooks = CommandHooks()
884
def parse_args(command, argv, alias_argv=None):
885
"""Parse command line.
887
Arguments and options are parsed at this level before being passed
888
down to specific command handlers. This routine knows, from a
889
lookup table, something about the available options, what optargs
890
they take, and which commands will accept them.
892
# TODO: make it a method of the Command?
893
parser = option.get_optparser(command.options())
894
if alias_argv is not None:
895
args = alias_argv + argv
899
# for python 2.5 and later, optparse raises this exception if a non-ascii
900
# option name is given. See http://bugs.python.org/issue2931
902
options, args = parser.parse_args(args)
903
except UnicodeEncodeError as e:
904
raise errors.BzrCommandError(
905
gettext('Only ASCII permitted in option names'))
907
opts = dict((k, v) for k, v in options.__dict__.items() if
908
v is not option.OptionParser.DEFAULT_VALUE)
912
def _match_argform(cmd, takes_args, args):
915
# step through args and takes_args, allowing appropriate 0-many matches
916
for ap in takes_args:
920
argdict[argname] = args.pop(0)
921
elif ap[-1] == '*': # all remaining arguments
923
argdict[argname + '_list'] = args[:]
926
argdict[argname + '_list'] = None
929
raise errors.BzrCommandError(gettext(
930
"command {0!r} needs one or more {1}").format(
931
cmd, argname.upper()))
933
argdict[argname + '_list'] = args[:]
935
elif ap[-1] == '$': # all but one
937
raise errors.BzrCommandError(
938
gettext("command {0!r} needs one or more {1}").format(
939
cmd, argname.upper()))
940
argdict[argname + '_list'] = args[:-1]
946
raise errors.BzrCommandError(
947
gettext("command {0!r} requires argument {1}").format(
948
cmd, argname.upper()))
950
argdict[argname] = args.pop(0)
953
raise errors.BzrCommandError( gettext(
954
"extra argument to command {0}: {1}").format(
960
def apply_coveraged(the_callable, *args, **kwargs):
962
cov = coverage.Coverage()
963
os.environ['COVERAGE_PROCESS_START'] = cov.config_file
966
return exception_to_return_code(the_callable, *args, **kwargs)
972
def apply_profiled(the_callable, *args, **kwargs):
976
pffileno, pfname = tempfile.mkstemp()
978
prof = hotshot.Profile(pfname)
980
ret = prof.runcall(exception_to_return_code, the_callable, *args,
984
stats = hotshot.stats.load(pfname)
986
stats.sort_stats('cum') # 'time'
987
## XXX: Might like to write to stderr or the trace file instead but
988
## print_stats seems hardcoded to stdout
989
stats.print_stats(20)
996
def exception_to_return_code(the_callable, *args, **kwargs):
997
"""UI level helper for profiling and coverage.
999
This transforms exceptions into a return value of 3. As such its only
1000
relevant to the UI layer, and should never be called where catching
1001
exceptions may be desirable.
1004
return the_callable(*args, **kwargs)
1005
except (KeyboardInterrupt, Exception) as e:
1006
# used to handle AssertionError and KeyboardInterrupt
1007
# specially here, but hopefully they're handled ok by the logger now
1008
exc_info = sys.exc_info()
1009
exitcode = trace.report_exception(exc_info, sys.stderr)
1010
if os.environ.get('BRZ_PDB'):
1011
print('**** entering debugger')
1013
pdb.post_mortem(exc_info[2])
1017
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1018
from breezy.lsprof import profile
1019
ret, stats = profile(exception_to_return_code, the_callable,
1022
if filename is None:
1025
stats.save(filename)
1026
trace.note(gettext('Profile data written to "%s".'), filename)
1030
def get_alias(cmd, config=None):
1031
"""Return an expanded alias, or None if no alias exists.
1034
Command to be checked for an alias.
1036
Used to specify an alternative config to use,
1037
which is especially useful for testing.
1038
If it is unspecified, the global config will be used.
1041
import breezy.config
1042
config = breezy.config.GlobalConfig()
1043
alias = config.get_alias(cmd)
1045
return cmdline.split(alias)
1049
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1050
"""Execute a command.
1052
:param argv: The command-line arguments, without the program name from
1053
argv[0] These should already be decoded. All library/test code calling
1054
run_bzr should be passing valid strings (don't need decoding).
1055
:param load_plugins: What function to call when triggering plugin loading.
1056
This function should take no arguments and cause all plugins to be
1058
:param disable_plugins: What function to call when disabling plugin
1059
loading. This function should take no arguments and cause all plugin
1060
loading to be prohibited (so that code paths in your application that
1061
know about some plugins possibly being present will fail to import
1062
those plugins even if they are installed.)
1063
:return: Returns a command exit code or raises an exception.
1065
Special master options: these must come before the command because
1066
they control how the command is interpreted.
1069
Do not load plugin modules at all
1072
Do not allow aliases
1075
Only use builtin commands. (Plugins are still allowed to change
1079
Run under the Python hotshot profiler.
1082
Run under the Python lsprof profiler.
1085
Generate code coverage report
1088
Specify the number of processes that can be run concurrently (selftest).
1090
trace.mutter("breezy version: " + breezy.__version__)
1091
argv = _specified_or_unicode_argv(argv)
1092
trace.mutter("brz arguments: %r", argv)
1094
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1095
opt_coverage = opt_no_l10n = opt_no_aliases = False
1096
opt_lsprof_file = None
1098
# --no-plugins is handled specially at a very early stage. We need
1099
# to load plugins before doing other command parsing so that they
1100
# can override commands, but this needs to happen first.
1104
override_config = []
1105
while i < len(argv):
1107
if a == '--profile':
1109
elif a == '--lsprof':
1111
elif a == '--lsprof-file':
1113
opt_lsprof_file = argv[i + 1]
1115
elif a == '--no-plugins':
1116
opt_no_plugins = True
1117
elif a == '--no-aliases':
1118
opt_no_aliases = True
1119
elif a == '--no-l10n':
1121
elif a == '--builtin':
1123
elif a == '--concurrency':
1124
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1126
elif a == '--coverage':
1128
elif a == '--profile-imports':
1129
pass # already handled in startup script Bug #588277
1130
elif a.startswith('-D'):
1131
debug.debug_flags.add(a[2:])
1132
elif a.startswith('-O'):
1133
override_config.append(a[2:])
1138
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1139
cmdline_overrides._from_cmdline(override_config)
1141
debug.set_debug_flags_from_config()
1143
if not opt_no_plugins:
1150
get_cmd_object('help').run_argv_aliases([])
1153
if argv[0] == '--version':
1154
get_cmd_object('version').run_argv_aliases([])
1159
if not opt_no_aliases:
1160
alias_argv = get_alias(argv[0])
1162
argv[0] = alias_argv.pop(0)
1165
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1167
cmd_obj.l10n = False
1168
run = cmd_obj.run_argv_aliases
1169
run_argv = [argv, alias_argv]
1172
# We can be called recursively (tests for example), but we don't want
1173
# the verbosity level to propagate.
1174
saved_verbosity_level = option._verbosity_level
1175
option._verbosity_level = 0
1179
'--coverage ignored, because --lsprof is in use.')
1180
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1184
'--coverage ignored, because --profile is in use.')
1185
ret = apply_profiled(run, *run_argv)
1187
ret = apply_coveraged(run, *run_argv)
1189
ret = run(*run_argv)
1192
# reset, in case we may do other commands later within the same
1193
# process. Commands that want to execute sub-commands must propagate
1194
# --verbose in their own way.
1195
if 'memory' in debug.debug_flags:
1196
trace.debug_memory('Process status after command:', short=False)
1197
option._verbosity_level = saved_verbosity_level
1198
# Reset the overrides
1199
cmdline_overrides._reset()
1202
def display_command(func):
1203
"""Decorator that suppresses pipe/interrupt errors."""
1204
def ignore_pipe(*args, **kwargs):
1206
result = func(*args, **kwargs)
1209
except IOError as e:
1210
if getattr(e, 'errno', None) is None:
1212
if e.errno != errno.EPIPE:
1213
# Win32 raises IOError with errno=0 on a broken pipe
1214
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1217
except KeyboardInterrupt:
1222
def install_bzr_command_hooks():
1223
"""Install the hooks to supply bzr's own commands."""
1224
if _list_bzr_commands in Command.hooks["list_commands"]:
1226
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1228
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1230
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1231
"bzr plugin commands")
1232
Command.hooks.install_named_hook("get_command", _get_external_command,
1233
"bzr external command lookup")
1234
Command.hooks.install_named_hook("get_missing_command",
1235
_try_plugin_provider,
1236
"bzr plugin-provider-db check")
1240
def _specified_or_unicode_argv(argv):
1241
# For internal or testing use, argv can be passed. Otherwise, get it from
1242
# the process arguments in a unicode-safe way.
1244
return osutils.get_unicode_argv()
1247
# ensure all arguments are unicode strings
1249
if not isinstance(a, string_types):
1250
raise ValueError('not native str or unicode: %r' % (a,))
1251
if isinstance(a, bytes):
1252
# For Python 2 only allow ascii native strings
1253
a = a.decode('ascii')
1255
except (ValueError, UnicodeDecodeError):
1256
raise errors.BzrError("argv should be list of unicode strings.")
1260
def main(argv=None):
1261
"""Main entry point of command-line interface.
1263
Typically `breezy.initialize` should be called first.
1265
:param argv: list of unicode command-line arguments similar to sys.argv.
1266
argv[0] is script name usually, it will be ignored.
1267
Don't pass here sys.argv because this list contains plain strings
1268
and not unicode; pass None instead.
1270
:return: exit code of brz command.
1272
if argv is not None:
1274
_register_builtin_commands()
1275
ret = run_bzr_catch_errors(argv)
1276
trace.mutter("return code %d", ret)
1280
def run_bzr_catch_errors(argv):
1281
"""Run a bzr command with parameters as described by argv.
1283
This function assumed that that UI layer is setup, that symbol deprecations
1284
are already applied, and that unicode decoding has already been performed on argv.
1286
# done here so that they're covered for every test run
1287
install_bzr_command_hooks()
1288
return exception_to_return_code(run_bzr, argv)
1291
def run_bzr_catch_user_errors(argv):
1292
"""Run brz and report user errors, but let internal errors propagate.
1294
This is used for the test suite, and might be useful for other programs
1295
that want to wrap the commandline interface.
1297
# done here so that they're covered for every test run
1298
install_bzr_command_hooks()
1300
return run_bzr(argv)
1301
except Exception as e:
1302
if (isinstance(e, (OSError, IOError))
1303
or not getattr(e, 'internal_error', True)):
1304
trace.report_exception(sys.exc_info(), sys.stderr)
1310
class HelpCommandIndex(object):
1311
"""A index for bzr help that returns commands."""
1314
self.prefix = 'commands/'
1316
def get_topics(self, topic):
1317
"""Search for topic amongst commands.
1319
:param topic: A topic to search for.
1320
:return: A list which is either empty or contains a single
1323
if topic and topic.startswith(self.prefix):
1324
topic = topic[len(self.prefix):]
1326
cmd = _get_cmd_object(topic, check_missing=False)
1333
class Provider(object):
1334
"""Generic class to be overriden by plugins"""
1336
def plugin_for_command(self, cmd_name):
1337
"""Takes a command and returns the information for that plugin
1339
:return: A dictionary with all the available information
1340
for the requested plugin
1342
raise NotImplementedError
1345
class ProvidersRegistry(registry.Registry):
1346
"""This registry exists to allow other providers to exist"""
1349
for key, provider in self.items():
1352
command_providers_registry = ProvidersRegistry()
added
removed
breezy/commands.py
