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.
35
from .lazy_import import lazy_import
36
lazy_import(globals(), """
51
from .hooks import Hooks
52
from .i18n import gettext
53
# Compatibility - Option used to be in commands.
54
from .option import Option
55
from .plugin import disable_plugins, load_plugins, plugin_name
56
from . import errors, registry
64
class BzrOptionError(errors.BzrCommandError):
66
_fmt = "Error in command line options"
69
class CommandAvailableInPlugin(Exception):
71
internal_error = False
73
def __init__(self, cmd_name, plugin_metadata, provider):
75
self.plugin_metadata = plugin_metadata
76
self.cmd_name = cmd_name
77
self.provider = provider
81
_fmt = ('"%s" is not a standard brz command. \n'
82
'However, the following official plugin provides this command: %s\n'
83
'You can install it by going to: %s'
84
% (self.cmd_name, self.plugin_metadata['name'],
85
self.plugin_metadata['url']))
90
class CommandInfo(object):
91
"""Information about a command."""
93
def __init__(self, aliases):
94
"""The list of aliases for the command."""
95
self.aliases = aliases
98
def from_command(klass, command):
99
"""Factory to construct a CommandInfo from a command."""
100
return klass(command.aliases)
103
class CommandRegistry(registry.Registry):
104
"""Special registry mapping command names to command classes.
106
:ivar overridden_registry: Look in this registry for commands being
107
overridden by this registry. This can be used to tell plugin commands
108
about the builtin they're decorating.
112
registry.Registry.__init__(self)
113
self.overridden_registry = None
114
# map from aliases to the real command that implements the name
115
self._alias_dict = {}
117
def get(self, command_name):
118
real_name = self._alias_dict.get(command_name, command_name)
119
return registry.Registry.get(self, real_name)
122
def _get_name(command_name):
123
if command_name.startswith("cmd_"):
124
return _unsquish_command_name(command_name)
128
def register(self, cmd, decorate=False):
129
"""Utility function to help register a command
131
:param cmd: Command subclass to register
132
:param decorate: If true, allow overriding an existing command
133
of the same name; the old command is returned by this function.
134
Otherwise it is an error to try to override an existing command.
137
k_unsquished = self._get_name(k)
139
previous = self.get(k_unsquished)
142
if self.overridden_registry:
144
previous = self.overridden_registry.get(k_unsquished)
147
info = CommandInfo.from_command(cmd)
149
registry.Registry.register(self, k_unsquished, cmd,
150
override_existing=decorate, info=info)
152
trace.warning('Two plugins defined the same command: %r' % k)
153
trace.warning('Not loading the one in %r' %
154
sys.modules[cmd.__module__])
155
trace.warning('Previously this command was registered from %r' %
156
sys.modules[previous.__module__])
157
for a in cmd.aliases:
158
self._alias_dict[a] = k_unsquished
161
def register_lazy(self, command_name, aliases, module_name):
162
"""Register a command without loading its module.
164
:param command_name: The primary name of the command.
165
:param aliases: A list of aliases for the command.
166
:module_name: The module that the command lives in.
168
key = self._get_name(command_name)
169
registry.Registry.register_lazy(self, key, module_name, command_name,
170
info=CommandInfo(aliases))
172
self._alias_dict[a] = key
175
plugin_cmds = CommandRegistry()
176
builtin_command_registry = CommandRegistry()
177
plugin_cmds.overridden_registry = builtin_command_registry
180
def register_command(cmd, decorate=False):
181
"""Register a plugin command.
183
Should generally be avoided in favor of lazy registration.
186
return plugin_cmds.register(cmd, decorate)
189
def _squish_command_name(cmd):
190
return 'cmd_' + cmd.replace('-', '_')
193
def _unsquish_command_name(cmd):
194
return cmd[4:].replace('_', '-')
197
def _register_builtin_commands():
198
if builtin_command_registry.keys():
201
import breezy.builtins
202
for cmd_class in _scan_module_for_commands(breezy.builtins):
203
builtin_command_registry.register(cmd_class)
204
breezy.builtins._register_lazy_builtins()
207
def _scan_module_for_commands(module):
208
module_dict = module.__dict__
209
for name in module_dict:
210
if name.startswith("cmd_"):
211
yield module_dict[name]
214
def _list_bzr_commands(names):
215
"""Find commands from bzr's core and plugins.
217
This is not the public interface, just the default hook called by all_command_names.
219
# to eliminate duplicates
220
names.update(builtin_command_names())
221
names.update(plugin_command_names())
225
def all_command_names():
226
"""Return a set of all command names."""
228
for hook in Command.hooks['list_commands']:
231
raise AssertionError(
232
'hook %s returned None' % Command.hooks.get_hook_name(hook))
236
def builtin_command_names():
237
"""Return list of builtin command names.
239
Use of all_command_names() is encouraged rather than builtin_command_names
240
and/or plugin_command_names.
242
_register_builtin_commands()
243
return builtin_command_registry.keys()
246
def plugin_command_names():
247
"""Returns command names from commands registered by plugins."""
248
return plugin_cmds.keys()
251
# Overrides for common mispellings that heuristics get wrong
253
'ic': {'ci': 0}, # heuristic finds nick
257
def guess_command(cmd_name):
258
"""Guess what command a user typoed.
260
:param cmd_name: Command to search for
261
:return: None if no command was found, name of a command otherwise
264
for name in all_command_names():
266
cmd = get_cmd_object(name)
267
names.update(cmd.aliases)
268
# candidate: modified levenshtein distance against cmd_name.
270
from . import patiencediff
271
for name in sorted(names):
272
matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
274
opcodes = matcher.get_opcodes()
275
for opcode, l1, l2, r1, r2 in opcodes:
276
if opcode == 'delete':
278
elif opcode == 'replace':
279
distance += max(l2-l1, r2-l1)
280
elif opcode == 'insert':
282
elif opcode == 'equal':
283
# Score equal ranges lower, making similar commands of equal
284
# length closer than arbitrary same length commands.
285
distance -= 0.1 * (l2-l1)
286
costs[name] = distance
287
costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
288
costs = sorted((costs[key], key) for key in costs)
293
candidate = costs[0][1]
297
def get_cmd_object(cmd_name, plugins_override=True):
298
"""Return the command object for a command.
301
If true, plugin commands can override builtins.
304
return _get_cmd_object(cmd_name, plugins_override)
306
# No command found, see if this was a typo
307
candidate = guess_command(cmd_name)
308
if candidate is not None:
309
raise errors.BzrCommandError(
310
gettext('unknown command "%s". Perhaps you meant "%s"')
311
% (cmd_name, candidate))
312
raise errors.BzrCommandError(gettext('unknown command "%s"')
316
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
317
"""Get a command object.
319
:param cmd_name: The name of the command.
320
:param plugins_override: Allow plugins to override builtins.
321
:param check_missing: Look up commands not found in the regular index via
322
the get_missing_command hook.
323
:return: A Command object instance
324
:raises KeyError: If no command is found.
326
# We want only 'ascii' command names, but the user may have typed
327
# in a Unicode name. In that case, they should just get a
328
# 'command not found' error later.
329
# In the future, we may actually support Unicode command names.
332
for hook in Command.hooks['get_command']:
333
cmd = hook(cmd, cmd_name)
334
if cmd is not None and not plugins_override and not cmd.plugin_name():
335
# We've found a non-plugin command, don't permit it to be
338
if cmd is None and check_missing:
339
for hook in Command.hooks['get_missing_command']:
346
# Allow plugins to extend commands
347
for hook in Command.hooks['extend_command']:
349
if getattr(cmd, 'invoked_as', None) is None:
350
cmd.invoked_as = cmd_name
354
class NoPluginAvailable(errors.BzrError):
358
def _try_plugin_provider(cmd_name):
359
"""Probe for a plugin provider having cmd_name."""
361
plugin_metadata, provider = probe_for_provider(cmd_name)
362
raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
363
except NoPluginAvailable:
367
def probe_for_provider(cmd_name):
368
"""Look for a provider for cmd_name.
370
:param cmd_name: The command name.
371
:return: plugin_metadata, provider for getting cmd_name.
372
:raises NoPluginAvailable: When no provider can supply the plugin.
374
# look for providers that provide this command but aren't installed
375
for provider in command_providers_registry:
377
return provider.plugin_for_command(cmd_name), provider
378
except NoPluginAvailable:
380
raise NoPluginAvailable(cmd_name)
383
def _get_bzr_command(cmd_or_None, cmd_name):
384
"""Get a command from bzr's core."""
386
cmd_class = builtin_command_registry.get(cmd_name)
394
def _get_external_command(cmd_or_None, cmd_name):
395
"""Lookup a command that is a shell script."""
396
# Only do external command lookups when no command is found so far.
397
if cmd_or_None is not None:
399
from breezy.externalcommand import ExternalCommand
400
cmd_obj = ExternalCommand.find_command(cmd_name)
405
def _get_plugin_command(cmd_or_None, cmd_name):
406
"""Get a command from brz's plugins."""
408
return plugin_cmds.get(cmd_name)()
411
for key in plugin_cmds.keys():
412
info = plugin_cmds.get_info(key)
413
if cmd_name in info.aliases:
414
return plugin_cmds.get(key)()
418
class Command(object):
419
"""Base class for commands.
421
Commands are the heart of the command-line brz interface.
423
The command object mostly handles the mapping of command-line
424
parameters into one or more breezy operations, and of the results
427
Commands normally don't have any state. All their arguments are
428
passed in to the run method. (Subclasses may take a different
429
policy if the behaviour of the instance needs to depend on e.g. a
430
shell plugin and not just its Python class.)
432
The docstring for an actual command should give a single-line
433
summary, then a complete description of the command. A grammar
434
description will be inserted.
436
:cvar aliases: Other accepted names for this command.
438
:cvar takes_args: List of argument forms, marked with whether they are
439
optional, repeated, etc. Examples::
441
['to_location', 'from_branch?', 'file*']
443
* 'to_location' is required
444
* 'from_branch' is optional
445
* 'file' can be specified 0 or more times
447
:cvar takes_options: List of options that may be given for this command.
448
These can be either strings, referring to globally-defined options, or
449
option objects. Retrieve through options().
451
:cvar hidden: If true, this command isn't advertised. This is typically
452
for commands intended for expert users.
454
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
455
been setup to properly handle encoding of unicode strings.
456
encoding_type determines what will happen when characters cannot be
459
* strict - abort if we cannot decode
460
* replace - put in a bogus character (typically '?')
461
* exact - do not encode sys.stdout
463
NOTE: by default on Windows, sys.stdout is opened as a text stream,
464
therefore LF line-endings are converted to CRLF. When a command uses
465
encoding_type = 'exact', then sys.stdout is forced to be a binary
466
stream, and line-endings will not mangled.
469
A string indicating the real name under which this command was
470
invoked, before expansion of aliases.
471
(This may be None if the command was constructed and run in-process.)
473
:cvar hooks: An instance of CommandHooks.
475
:cvar __doc__: The help shown by 'brz help command' for this command.
476
This is set by assigning explicitly to __doc__ so that -OO can
480
__doc__ = "My help goes here"
485
encoding_type = 'strict'
492
"""Construct an instance of this command."""
493
# List of standard options directly supported
494
self.supported_std_options = []
497
def add_cleanup(self, cleanup_func, *args, **kwargs):
498
"""Register a function to call after self.run returns or raises.
500
Functions will be called in LIFO order.
502
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
504
def cleanup_now(self):
505
"""Execute and empty pending cleanup functions immediately.
507
After cleanup_now all registered cleanups are forgotten. add_cleanup
508
may be called again after cleanup_now; these cleanups will be called
509
after self.run returns or raises (or when cleanup_now is next called).
511
This is useful for releasing expensive or contentious resources (such
512
as write locks) before doing further work that does not require those
513
resources (such as writing results to self.outf). Note though, that
514
as it releases all resources, this may release locks that the command
515
wants to hold, so use should be done with care.
517
self._operation.cleanup_now()
520
"""Return single-line grammar for this command.
522
Only describes arguments, not options.
524
s = 'brz ' + self.name() + ' '
525
for aname in self.takes_args:
526
aname = aname.upper()
527
if aname[-1] in ['$', '+']:
528
aname = aname[:-1] + '...'
529
elif aname[-1] == '?':
530
aname = '[' + aname[:-1] + ']'
531
elif aname[-1] == '*':
532
aname = '[' + aname[:-1] + '...]'
534
s = s[:-1] # remove last space
537
def get_help_text(self, additional_see_also=None, plain=True,
538
see_also_as_links=False, verbose=True):
539
"""Return a text string with help for this command.
541
:param additional_see_also: Additional help topics to be
543
:param plain: if False, raw help (reStructuredText) is
544
returned instead of plain text.
545
:param see_also_as_links: if True, convert items in 'See also'
546
list to internal links (used by bzr_man rstx generator)
547
:param verbose: if True, display the full help, otherwise
548
leave out the descriptive sections and just display
549
usage help (e.g. Purpose, Usage, Options) with a
550
message explaining how to obtain full help.
553
i18n.install() # Install i18n only for get_help_text for now.
556
# Note: If self.gettext() translates ':Usage:\n', the section will
557
# be shown after "Description" section and we don't want to
558
# translate the usage string.
559
# Though, brz export-pot don't exports :Usage: section and it must
561
doc = self.gettext(doc)
563
doc = gettext("No help for this command.")
565
# Extract the summary (purpose) and sections out from the text
566
purpose, sections, order = self._get_help_parts(doc)
568
# If a custom usage section was provided, use it
569
if 'Usage' in sections:
570
usage = sections.pop('Usage')
572
usage = self._usage()
574
# The header is the purpose and usage
576
result += gettext(':Purpose: %s\n') % (purpose,)
577
if usage.find('\n') >= 0:
578
result += gettext(':Usage:\n%s\n') % (usage,)
580
result += gettext(':Usage: %s\n') % (usage,)
585
# XXX: optparse implicitly rewraps the help, and not always perfectly,
586
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
588
parser = option.get_optparser([v for k, v in sorted(self.options().items())])
589
options = parser.format_option_help()
590
# FIXME: According to the spec, ReST option lists actually don't
591
# support options like --1.14 so that causes syntax errors (in Sphinx
592
# at least). As that pattern always appears in the commands that
593
# break, we trap on that and then format that block of 'format' options
594
# as a literal block. We use the most recent format still listed so we
595
# don't have to do that too often -- vila 20110514
596
if not plain and options.find(' --1.14 ') != -1:
597
options = options.replace(' format:\n', ' format::\n\n', 1)
598
if options.startswith('Options:'):
599
result += gettext(':Options:%s') % (options[len('options:'):],)
605
# Add the description, indenting it 2 spaces
606
# to match the indentation of the options
608
text = sections.pop(None)
609
text = '\n '.join(text.splitlines())
610
result += gettext(':Description:\n %s\n\n') % (text,)
612
# Add the custom sections (e.g. Examples). Note that there's no need
613
# to indent these as they must be indented already in the source.
616
if label in sections:
617
result += ':%s:\n%s\n' % (label, sections[label])
620
result += (gettext("See brz help %s for more details and examples.\n\n")
623
# Add the aliases, source (plug-in) and see also links, if any
625
result += gettext(':Aliases: ')
626
result += ', '.join(self.aliases) + '\n'
627
plugin_name = self.plugin_name()
628
if plugin_name is not None:
629
result += gettext(':From: plugin "%s"\n') % plugin_name
630
see_also = self.get_see_also(additional_see_also)
632
if not plain and see_also_as_links:
634
for item in see_also:
636
# topics doesn't have an independent section
637
# so don't create a real link
638
see_also_links.append(item)
640
# Use a Sphinx link for this entry
641
link_text = gettext(":doc:`{0} <{1}-help>`").format(
643
see_also_links.append(link_text)
644
see_also = see_also_links
645
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
647
# If this will be rendered as plain text, convert it
649
import breezy.help_topics
650
result = breezy.help_topics.help_as_plain_text(result)
654
def _get_help_parts(text):
655
"""Split help text into a summary and named sections.
657
:return: (summary,sections,order) where summary is the top line and
658
sections is a dictionary of the rest indexed by section name.
659
order is the order the section appear in the text.
660
A section starts with a heading line of the form ":xxx:".
661
Indented text on following lines is the section value.
662
All text found outside a named section is assigned to the
663
default section which is given the key of None.
665
def save_section(sections, order, label, section):
667
if label in sections:
668
sections[label] += '\n' + section
671
sections[label] = section
673
lines = text.rstrip().splitlines()
674
summary = lines.pop(0)
677
label, section = None, ''
679
if line.startswith(':') and line.endswith(':') and len(line) > 2:
680
save_section(sections, order, label, section)
681
label, section = line[1:-1], ''
682
elif (label is not None) and len(line) > 1 and not line[0].isspace():
683
save_section(sections, order, label, section)
684
label, section = None, line
687
section += '\n' + line
690
save_section(sections, order, label, section)
691
return summary, sections, order
693
def get_help_topic(self):
694
"""Return the commands help topic - its name."""
697
def get_see_also(self, additional_terms=None):
698
"""Return a list of help topics that are related to this command.
700
The list is derived from the content of the _see_also attribute. Any
701
duplicates are removed and the result is in lexical order.
702
:param additional_terms: Additional help topics to cross-reference.
703
:return: A list of help topics.
705
see_also = set(getattr(self, '_see_also', []))
707
see_also.update(additional_terms)
708
return sorted(see_also)
711
"""Return dict of valid options for this command.
713
Maps from long option name to option object."""
714
r = Option.STD_OPTIONS.copy()
716
for o in self.takes_options:
717
if isinstance(o, string_types):
718
o = option.Option.OPTIONS[o]
720
if o.name in std_names:
721
self.supported_std_options.append(o.name)
724
def _setup_outf(self):
725
"""Return a file linked to stdout, which has proper encoding."""
726
self.outf = ui.ui_factory.make_output_stream(
727
encoding_type=self.encoding_type)
729
def run_argv_aliases(self, argv, alias_argv=None):
730
"""Parse the command line and run with extra aliases in alias_argv."""
731
args, opts = parse_args(self, argv, alias_argv)
734
# Process the standard options
735
if 'help' in opts: # e.g. brz add --help
736
self.outf.write(self.get_help_text())
738
if 'usage' in opts: # e.g. brz add --usage
739
self.outf.write(self.get_help_text(verbose=False))
741
trace.set_verbosity_level(option._verbosity_level)
742
if 'verbose' in self.supported_std_options:
743
opts['verbose'] = trace.is_verbose()
744
elif 'verbose' in opts:
746
if 'quiet' in self.supported_std_options:
747
opts['quiet'] = trace.is_quiet()
748
elif 'quiet' in opts:
750
# mix arguments and options into one dictionary
751
cmdargs = _match_argform(self.name(), self.takes_args, args)
753
for k, v in opts.items():
754
cmdopts[k.replace('-', '_')] = v
756
all_cmd_args = cmdargs.copy()
757
all_cmd_args.update(cmdopts)
760
return self.run(**all_cmd_args)
762
# reset it, so that other commands run in the same process won't
763
# inherit state. Before we reset it, log any activity, so that it
764
# gets properly tracked.
765
ui.ui_factory.log_transport_activity(
766
display=('bytes' in debug.debug_flags))
767
trace.set_verbosity_level(0)
769
def _setup_run(self):
770
"""Wrap the defined run method on self with a cleanup.
772
This is called by __init__ to make the Command be able to be run
773
by just calling run(), as it could be before cleanups were added.
775
If a different form of cleanups are in use by your Command subclass,
776
you can override this method.
779
def run(*args, **kwargs):
780
for hook in Command.hooks['pre_command']:
782
self._operation = cleanup.OperationWithCleanups(class_run)
784
return self._operation.run_simple(*args, **kwargs)
787
for hook in Command.hooks['post_command']:
792
"""Actually run the command.
794
This is invoked with the options and arguments bound to
797
Return 0 or None if the command was successful, or a non-zero
798
shell error code if not. It's OK for this method to allow
799
an exception to raise up.
801
This method is automatically wrapped by Command.__init__ with a
802
cleanup operation, stored as self._operation. This can be used
803
via self.add_cleanup to perform automatic cleanups at the end of
806
The argument for run are assembled by introspection. So for instance,
807
if your command takes an argument files, you would declare::
809
def run(self, files=None):
812
raise NotImplementedError('no implementation of command %r'
816
"""Return help message for this class."""
817
from inspect import getdoc
818
if self.__doc__ is Command.__doc__:
822
def gettext(self, message):
823
"""Returns the gettext function used to translate this command's help.
825
Commands provided by plugins should override this to use their
828
return i18n.gettext_per_paragraph(message)
831
"""Return the canonical name for this command.
833
The name under which it was actually invoked is available in invoked_as.
835
return _unsquish_command_name(self.__class__.__name__)
837
def plugin_name(self):
838
"""Get the name of the plugin that provides this command.
840
:return: The name of the plugin or None if the command is builtin.
842
return plugin_name(self.__module__)
845
class CommandHooks(Hooks):
846
"""Hooks related to Command object creation/enumeration."""
849
"""Create the default hooks.
851
These are all empty initially, because by default nothing should get
854
Hooks.__init__(self, "breezy.commands", "Command.hooks")
855
self.add_hook('extend_command',
856
"Called after creating a command object to allow modifications "
857
"such as adding or removing options, docs etc. Called with the "
858
"new breezy.commands.Command object.", (1, 13))
859
self.add_hook('get_command',
860
"Called when creating a single command. Called with "
861
"(cmd_or_None, command_name). get_command should either return "
862
"the cmd_or_None parameter, or a replacement Command object that "
863
"should be used for the command. Note that the Command.hooks "
864
"hooks are core infrastructure. Many users will prefer to use "
865
"breezy.commands.register_command or plugin_cmds.register_lazy.",
867
self.add_hook('get_missing_command',
868
"Called when creating a single command if no command could be "
869
"found. Called with (command_name). get_missing_command should "
870
"either return None, or a Command object to be used for the "
872
self.add_hook('list_commands',
873
"Called when enumerating commands. Called with a set of "
874
"cmd_name strings for all the commands found so far. This set "
875
" is safe to mutate - e.g. to remove a command. "
876
"list_commands should return the updated set of command names.",
878
self.add_hook('pre_command',
879
"Called prior to executing a command. Called with the command "
881
self.add_hook('post_command',
882
"Called after executing a command. Called with the command "
885
Command.hooks = CommandHooks()
888
def parse_args(command, argv, alias_argv=None):
889
"""Parse command line.
891
Arguments and options are parsed at this level before being passed
892
down to specific command handlers. This routine knows, from a
893
lookup table, something about the available options, what optargs
894
they take, and which commands will accept them.
896
# TODO: make it a method of the Command?
897
parser = option.get_optparser(
898
[v for k, v in sorted(command.options().items())])
899
if alias_argv is not None:
900
args = alias_argv + argv
904
# python 2's optparse raises this exception if a non-ascii
905
# option name is given. See http://bugs.python.org/issue2931
907
options, args = parser.parse_args(args)
908
except UnicodeEncodeError as e:
909
raise errors.BzrCommandError(
910
gettext('Only ASCII permitted in option names'))
912
opts = dict((k, v) for k, v in options.__dict__.items() if
913
v is not option.OptionParser.DEFAULT_VALUE)
917
def _match_argform(cmd, takes_args, args):
920
# step through args and takes_args, allowing appropriate 0-many matches
921
for ap in takes_args:
925
argdict[argname] = args.pop(0)
926
elif ap[-1] == '*': # all remaining arguments
928
argdict[argname + '_list'] = args[:]
931
argdict[argname + '_list'] = None
934
raise errors.BzrCommandError(gettext(
935
"command {0!r} needs one or more {1}").format(
936
cmd, argname.upper()))
938
argdict[argname + '_list'] = args[:]
940
elif ap[-1] == '$': # all but one
942
raise errors.BzrCommandError(
943
gettext("command {0!r} needs one or more {1}").format(
944
cmd, argname.upper()))
945
argdict[argname + '_list'] = args[:-1]
951
raise errors.BzrCommandError(
952
gettext("command {0!r} requires argument {1}").format(
953
cmd, argname.upper()))
955
argdict[argname] = args.pop(0)
958
raise errors.BzrCommandError( gettext(
959
"extra argument to command {0}: {1}").format(
965
def apply_coveraged(the_callable, *args, **kwargs):
967
cov = coverage.Coverage()
968
os.environ['COVERAGE_PROCESS_START'] = cov.config_file
971
return exception_to_return_code(the_callable, *args, **kwargs)
977
def apply_profiled(the_callable, *args, **kwargs):
981
pffileno, pfname = tempfile.mkstemp()
983
prof = hotshot.Profile(pfname)
985
ret = prof.runcall(exception_to_return_code, the_callable, *args,
989
stats = hotshot.stats.load(pfname)
991
stats.sort_stats('cum') # 'time'
992
## XXX: Might like to write to stderr or the trace file instead but
993
## print_stats seems hardcoded to stdout
994
stats.print_stats(20)
1001
def exception_to_return_code(the_callable, *args, **kwargs):
1002
"""UI level helper for profiling and coverage.
1004
This transforms exceptions into a return value of 3. As such its only
1005
relevant to the UI layer, and should never be called where catching
1006
exceptions may be desirable.
1009
return the_callable(*args, **kwargs)
1010
except (KeyboardInterrupt, Exception) as e:
1011
# used to handle AssertionError and KeyboardInterrupt
1012
# specially here, but hopefully they're handled ok by the logger now
1013
exc_info = sys.exc_info()
1014
exitcode = trace.report_exception(exc_info, sys.stderr)
1015
if os.environ.get('BRZ_PDB'):
1016
print('**** entering debugger')
1018
pdb.post_mortem(exc_info[2])
1022
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1023
from breezy.lsprof import profile
1024
ret, stats = profile(exception_to_return_code, the_callable,
1027
if filename is None:
1030
stats.save(filename)
1031
trace.note(gettext('Profile data written to "%s".'), filename)
1035
def get_alias(cmd, config=None):
1036
"""Return an expanded alias, or None if no alias exists.
1039
Command to be checked for an alias.
1041
Used to specify an alternative config to use,
1042
which is especially useful for testing.
1043
If it is unspecified, the global config will be used.
1046
import breezy.config
1047
config = breezy.config.GlobalConfig()
1048
alias = config.get_alias(cmd)
1050
return cmdline.split(alias)
1054
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1055
"""Execute a command.
1057
:param argv: The command-line arguments, without the program name from
1058
argv[0] These should already be decoded. All library/test code calling
1059
run_bzr should be passing valid strings (don't need decoding).
1060
:param load_plugins: What function to call when triggering plugin loading.
1061
This function should take no arguments and cause all plugins to be
1063
:param disable_plugins: What function to call when disabling plugin
1064
loading. This function should take no arguments and cause all plugin
1065
loading to be prohibited (so that code paths in your application that
1066
know about some plugins possibly being present will fail to import
1067
those plugins even if they are installed.)
1068
:return: Returns a command exit code or raises an exception.
1070
Special master options: these must come before the command because
1071
they control how the command is interpreted.
1074
Do not load plugin modules at all
1077
Do not allow aliases
1080
Only use builtin commands. (Plugins are still allowed to change
1084
Run under the Python hotshot profiler.
1087
Run under the Python lsprof profiler.
1090
Generate code coverage report
1093
Specify the number of processes that can be run concurrently (selftest).
1095
trace.mutter("breezy version: " + breezy.__version__)
1096
argv = _specified_or_unicode_argv(argv)
1097
trace.mutter("brz arguments: %r", argv)
1099
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1100
opt_coverage = opt_no_l10n = opt_no_aliases = False
1101
opt_lsprof_file = None
1103
# --no-plugins is handled specially at a very early stage. We need
1104
# to load plugins before doing other command parsing so that they
1105
# can override commands, but this needs to happen first.
1109
override_config = []
1110
while i < len(argv):
1112
if a == '--profile':
1114
elif a == '--lsprof':
1116
elif a == '--lsprof-file':
1118
opt_lsprof_file = argv[i + 1]
1120
elif a == '--no-plugins':
1121
opt_no_plugins = True
1122
elif a == '--no-aliases':
1123
opt_no_aliases = True
1124
elif a == '--no-l10n':
1126
elif a == '--builtin':
1128
elif a == '--concurrency':
1129
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1131
elif a == '--coverage':
1133
elif a == '--profile-imports':
1134
pass # already handled in startup script Bug #588277
1135
elif a.startswith('-D'):
1136
debug.debug_flags.add(a[2:])
1137
elif a.startswith('-O'):
1138
override_config.append(a[2:])
1143
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1144
cmdline_overrides._from_cmdline(override_config)
1146
debug.set_debug_flags_from_config()
1148
if not opt_no_plugins:
1155
get_cmd_object('help').run_argv_aliases([])
1158
if argv[0] == '--version':
1159
get_cmd_object('version').run_argv_aliases([])
1164
if not opt_no_aliases:
1165
alias_argv = get_alias(argv[0])
1167
argv[0] = alias_argv.pop(0)
1170
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1172
cmd_obj.l10n = False
1173
run = cmd_obj.run_argv_aliases
1174
run_argv = [argv, alias_argv]
1177
# We can be called recursively (tests for example), but we don't want
1178
# the verbosity level to propagate.
1179
saved_verbosity_level = option._verbosity_level
1180
option._verbosity_level = 0
1184
'--coverage ignored, because --lsprof is in use.')
1185
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1189
'--coverage ignored, because --profile is in use.')
1190
ret = apply_profiled(run, *run_argv)
1192
ret = apply_coveraged(run, *run_argv)
1194
ret = run(*run_argv)
1197
# reset, in case we may do other commands later within the same
1198
# process. Commands that want to execute sub-commands must propagate
1199
# --verbose in their own way.
1200
if 'memory' in debug.debug_flags:
1201
trace.debug_memory('Process status after command:', short=False)
1202
option._verbosity_level = saved_verbosity_level
1203
# Reset the overrides
1204
cmdline_overrides._reset()
1207
def display_command(func):
1208
"""Decorator that suppresses pipe/interrupt errors."""
1209
def ignore_pipe(*args, **kwargs):
1211
result = func(*args, **kwargs)
1214
except IOError as e:
1215
if getattr(e, 'errno', None) is None:
1217
if e.errno != errno.EPIPE:
1218
# Win32 raises IOError with errno=0 on a broken pipe
1219
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1222
except KeyboardInterrupt:
1227
def install_bzr_command_hooks():
1228
"""Install the hooks to supply bzr's own commands."""
1229
if _list_bzr_commands in Command.hooks["list_commands"]:
1231
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1233
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1235
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1236
"bzr plugin commands")
1237
Command.hooks.install_named_hook("get_command", _get_external_command,
1238
"bzr external command lookup")
1239
Command.hooks.install_named_hook("get_missing_command",
1240
_try_plugin_provider,
1241
"bzr plugin-provider-db check")
1245
def _specified_or_unicode_argv(argv):
1246
# For internal or testing use, argv can be passed. Otherwise, get it from
1247
# the process arguments in a unicode-safe way.
1249
return osutils.get_unicode_argv()
1252
# ensure all arguments are unicode strings
1254
if not isinstance(a, string_types):
1255
raise ValueError('not native str or unicode: %r' % (a,))
1256
if isinstance(a, bytes):
1257
# For Python 2 only allow ascii native strings
1258
a = a.decode('ascii')
1260
except (ValueError, UnicodeDecodeError):
1261
raise errors.BzrError("argv should be list of unicode strings.")
1265
def main(argv=None):
1266
"""Main entry point of command-line interface.
1268
Typically `breezy.initialize` should be called first.
1270
:param argv: list of unicode command-line arguments similar to sys.argv.
1271
argv[0] is script name usually, it will be ignored.
1272
Don't pass here sys.argv because this list contains plain strings
1273
and not unicode; pass None instead.
1275
:return: exit code of brz command.
1277
if argv is not None:
1279
_register_builtin_commands()
1280
ret = run_bzr_catch_errors(argv)
1281
trace.mutter("return code %d", ret)
1285
def run_bzr_catch_errors(argv):
1286
"""Run a bzr command with parameters as described by argv.
1288
This function assumed that that UI layer is setup, that symbol deprecations
1289
are already applied, and that unicode decoding has already been performed on argv.
1291
# done here so that they're covered for every test run
1292
install_bzr_command_hooks()
1293
return exception_to_return_code(run_bzr, argv)
1296
def run_bzr_catch_user_errors(argv):
1297
"""Run brz and report user errors, but let internal errors propagate.
1299
This is used for the test suite, and might be useful for other programs
1300
that want to wrap the commandline interface.
1302
# done here so that they're covered for every test run
1303
install_bzr_command_hooks()
1305
return run_bzr(argv)
1306
except Exception as e:
1307
if (isinstance(e, (OSError, IOError))
1308
or not getattr(e, 'internal_error', True)):
1309
trace.report_exception(sys.exc_info(), sys.stderr)
1315
class HelpCommandIndex(object):
1316
"""A index for bzr help that returns commands."""
1319
self.prefix = 'commands/'
1321
def get_topics(self, topic):
1322
"""Search for topic amongst commands.
1324
:param topic: A topic to search for.
1325
:return: A list which is either empty or contains a single
1328
if topic and topic.startswith(self.prefix):
1329
topic = topic[len(self.prefix):]
1331
cmd = _get_cmd_object(topic, check_missing=False)
1338
class Provider(object):
1339
"""Generic class to be overriden by plugins"""
1341
def plugin_for_command(self, cmd_name):
1342
"""Takes a command and returns the information for that plugin
1344
:return: A dictionary with all the available information
1345
for the requested plugin
1347
raise NotImplementedError
1350
class ProvidersRegistry(registry.Registry):
1351
"""This registry exists to allow other providers to exist"""
1354
for key, provider in self.items():
1357
command_providers_registry = ProvidersRegistry()
added
removed
breezy/commands.py
