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(), """
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 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
216
# to eliminate duplicates
217
names.update(builtin_command_names())
218
names.update(plugin_command_names())
222
def all_command_names():
223
"""Return a set of all command names."""
225
for hook in Command.hooks['list_commands']:
228
raise AssertionError(
229
'hook %s returned None' % Command.hooks.get_hook_name(hook))
233
def builtin_command_names():
234
"""Return list of builtin command names.
236
Use of all_command_names() is encouraged rather than builtin_command_names
237
and/or plugin_command_names.
239
_register_builtin_commands()
240
return builtin_command_registry.keys()
243
def plugin_command_names():
244
"""Returns command names from commands registered by plugins."""
245
return plugin_cmds.keys()
248
# Overrides for common mispellings that heuristics get wrong
250
'ic': {'ci': 0}, # heuristic finds nick
254
def guess_command(cmd_name):
255
"""Guess what command a user typoed.
257
:param cmd_name: Command to search for
258
:return: None if no command was found, name of a command otherwise
261
for name in all_command_names():
263
cmd = get_cmd_object(name)
264
names.update(cmd.aliases)
265
# candidate: modified levenshtein distance against cmd_name.
267
from . import patiencediff
268
for name in sorted(names):
269
matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
271
opcodes = matcher.get_opcodes()
272
for opcode, l1, l2, r1, r2 in opcodes:
273
if opcode == 'delete':
275
elif opcode == 'replace':
276
distance += max(l2 - l1, r2 - l1)
277
elif opcode == 'insert':
279
elif opcode == 'equal':
280
# Score equal ranges lower, making similar commands of equal
281
# length closer than arbitrary same length commands.
282
distance -= 0.1 * (l2 - l1)
283
costs[name] = distance
284
costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
285
costs = sorted((costs[key], key) for key in costs)
290
candidate = costs[0][1]
294
def get_cmd_object(cmd_name, plugins_override=True):
295
"""Return the command object for a command.
298
If true, plugin commands can override builtins.
301
return _get_cmd_object(cmd_name, plugins_override)
303
# No command found, see if this was a typo
304
candidate = guess_command(cmd_name)
305
if candidate is not None:
306
raise errors.BzrCommandError(
307
gettext('unknown command "%s". Perhaps you meant "%s"')
308
% (cmd_name, candidate))
309
raise errors.BzrCommandError(gettext('unknown command "%s"')
313
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
314
"""Get a command object.
316
:param cmd_name: The name of the command.
317
:param plugins_override: Allow plugins to override builtins.
318
:param check_missing: Look up commands not found in the regular index via
319
the get_missing_command hook.
320
:return: A Command object instance
321
:raises KeyError: If no command is found.
323
# We want only 'ascii' command names, but the user may have typed
324
# in a Unicode name. In that case, they should just get a
325
# 'command not found' error later.
326
# In the future, we may actually support Unicode command names.
329
for hook in Command.hooks['get_command']:
330
cmd = hook(cmd, cmd_name)
331
if cmd is not None and not plugins_override and not cmd.plugin_name():
332
# We've found a non-plugin command, don't permit it to be
335
if cmd is None and check_missing:
336
for hook in Command.hooks['get_missing_command']:
343
# Allow plugins to extend commands
344
for hook in Command.hooks['extend_command']:
346
if getattr(cmd, 'invoked_as', None) is None:
347
cmd.invoked_as = cmd_name
351
class NoPluginAvailable(errors.BzrError):
355
def _try_plugin_provider(cmd_name):
356
"""Probe for a plugin provider having cmd_name."""
358
plugin_metadata, provider = probe_for_provider(cmd_name)
359
raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
360
except NoPluginAvailable:
364
def probe_for_provider(cmd_name):
365
"""Look for a provider for cmd_name.
367
:param cmd_name: The command name.
368
:return: plugin_metadata, provider for getting cmd_name.
369
:raises NoPluginAvailable: When no provider can supply the plugin.
371
# look for providers that provide this command but aren't installed
372
for provider in command_providers_registry:
374
return provider.plugin_for_command(cmd_name), provider
375
except NoPluginAvailable:
377
raise NoPluginAvailable(cmd_name)
380
def _get_bzr_command(cmd_or_None, cmd_name):
381
"""Get a command from bzr's core."""
383
cmd_class = builtin_command_registry.get(cmd_name)
391
def _get_external_command(cmd_or_None, cmd_name):
392
"""Lookup a command that is a shell script."""
393
# Only do external command lookups when no command is found so far.
394
if cmd_or_None is not None:
396
from breezy.externalcommand import ExternalCommand
397
cmd_obj = ExternalCommand.find_command(cmd_name)
402
def _get_plugin_command(cmd_or_None, cmd_name):
403
"""Get a command from brz's plugins."""
405
return plugin_cmds.get(cmd_name)()
408
for key in plugin_cmds.keys():
409
info = plugin_cmds.get_info(key)
410
if cmd_name in info.aliases:
411
return plugin_cmds.get(key)()
415
class Command(object):
416
"""Base class for commands.
418
Commands are the heart of the command-line brz interface.
420
The command object mostly handles the mapping of command-line
421
parameters into one or more breezy operations, and of the results
424
Commands normally don't have any state. All their arguments are
425
passed in to the run method. (Subclasses may take a different
426
policy if the behaviour of the instance needs to depend on e.g. a
427
shell plugin and not just its Python class.)
429
The docstring for an actual command should give a single-line
430
summary, then a complete description of the command. A grammar
431
description will be inserted.
433
:cvar aliases: Other accepted names for this command.
435
:cvar takes_args: List of argument forms, marked with whether they are
436
optional, repeated, etc. Examples::
438
['to_location', 'from_branch?', 'file*']
440
* 'to_location' is required
441
* 'from_branch' is optional
442
* 'file' can be specified 0 or more times
444
:cvar takes_options: List of options that may be given for this command.
445
These can be either strings, referring to globally-defined options, or
446
option objects. Retrieve through options().
448
:cvar hidden: If true, this command isn't advertised. This is typically
449
for commands intended for expert users.
451
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
452
been setup to properly handle encoding of unicode strings.
453
encoding_type determines what will happen when characters cannot be
456
* strict - abort if we cannot decode
457
* replace - put in a bogus character (typically '?')
458
* exact - do not encode sys.stdout
460
NOTE: by default on Windows, sys.stdout is opened as a text stream,
461
therefore LF line-endings are converted to CRLF. When a command uses
462
encoding_type = 'exact', then sys.stdout is forced to be a binary
463
stream, and line-endings will not mangled.
466
A string indicating the real name under which this command was
467
invoked, before expansion of aliases.
468
(This may be None if the command was constructed and run in-process.)
470
:cvar hooks: An instance of CommandHooks.
472
:cvar __doc__: The help shown by 'brz help command' for this command.
473
This is set by assigning explicitly to __doc__ so that -OO can
477
__doc__ = "My help goes here"
482
encoding_type = 'strict'
489
"""Construct an instance of this command."""
490
# List of standard options directly supported
491
self.supported_std_options = []
494
def add_cleanup(self, cleanup_func, *args, **kwargs):
495
"""Register a function to call after self.run returns or raises.
497
Functions will be called in LIFO order.
499
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
501
def cleanup_now(self):
502
"""Execute and empty pending cleanup functions immediately.
504
After cleanup_now all registered cleanups are forgotten. add_cleanup
505
may be called again after cleanup_now; these cleanups will be called
506
after self.run returns or raises (or when cleanup_now is next called).
508
This is useful for releasing expensive or contentious resources (such
509
as write locks) before doing further work that does not require those
510
resources (such as writing results to self.outf). Note though, that
511
as it releases all resources, this may release locks that the command
512
wants to hold, so use should be done with care.
514
self._operation.cleanup_now()
517
"""Return single-line grammar for this command.
519
Only describes arguments, not options.
521
s = 'brz ' + self.name() + ' '
522
for aname in self.takes_args:
523
aname = aname.upper()
524
if aname[-1] in ['$', '+']:
525
aname = aname[:-1] + '...'
526
elif aname[-1] == '?':
527
aname = '[' + aname[:-1] + ']'
528
elif aname[-1] == '*':
529
aname = '[' + aname[:-1] + '...]'
531
s = s[:-1] # remove last space
534
def get_help_text(self, additional_see_also=None, plain=True,
535
see_also_as_links=False, verbose=True):
536
"""Return a text string with help for this command.
538
:param additional_see_also: Additional help topics to be
540
:param plain: if False, raw help (reStructuredText) is
541
returned instead of plain text.
542
:param see_also_as_links: if True, convert items in 'See also'
543
list to internal links (used by bzr_man rstx generator)
544
:param verbose: if True, display the full help, otherwise
545
leave out the descriptive sections and just display
546
usage help (e.g. Purpose, Usage, Options) with a
547
message explaining how to obtain full help.
550
i18n.install() # Install i18n only for get_help_text for now.
553
# Note: If self.gettext() translates ':Usage:\n', the section will
554
# be shown after "Description" section and we don't want to
555
# translate the usage string.
556
# Though, brz export-pot don't exports :Usage: section and it must
558
doc = self.gettext(doc)
560
doc = gettext("No help for this command.")
562
# Extract the summary (purpose) and sections out from the text
563
purpose, sections, order = self._get_help_parts(doc)
565
# If a custom usage section was provided, use it
566
if 'Usage' in sections:
567
usage = sections.pop('Usage')
569
usage = self._usage()
571
# The header is the purpose and usage
573
result += gettext(':Purpose: %s\n') % (purpose,)
574
if usage.find('\n') >= 0:
575
result += gettext(':Usage:\n%s\n') % (usage,)
577
result += gettext(':Usage: %s\n') % (usage,)
582
# XXX: optparse implicitly rewraps the help, and not always perfectly,
583
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
585
parser = option.get_optparser(
586
[v for k, v in sorted(self.options().items())])
587
options = parser.format_option_help()
588
# FIXME: According to the spec, ReST option lists actually don't
589
# support options like --1.14 so that causes syntax errors (in Sphinx
590
# at least). As that pattern always appears in the commands that
591
# break, we trap on that and then format that block of 'format' options
592
# as a literal block. We use the most recent format still listed so we
593
# don't have to do that too often -- vila 20110514
594
if not plain and options.find(' --1.14 ') != -1:
595
options = options.replace(' format:\n', ' format::\n\n', 1)
596
if options.startswith('Options:'):
597
result += gettext(':Options:%s') % (options[len('options:'):],)
603
# Add the description, indenting it 2 spaces
604
# to match the indentation of the options
606
text = sections.pop(None)
607
text = '\n '.join(text.splitlines())
608
result += gettext(':Description:\n %s\n\n') % (text,)
610
# Add the custom sections (e.g. Examples). Note that there's no need
611
# to indent these as they must be indented already in the source.
614
if label in sections:
615
result += ':%s:\n%s\n' % (label, sections[label])
618
result += (gettext("See brz help %s for more details and examples.\n\n")
621
# Add the aliases, source (plug-in) and see also links, if any
623
result += gettext(':Aliases: ')
624
result += ', '.join(self.aliases) + '\n'
625
plugin_name = self.plugin_name()
626
if plugin_name is not None:
627
result += gettext(':From: plugin "%s"\n') % plugin_name
628
see_also = self.get_see_also(additional_see_also)
630
if not plain and see_also_as_links:
632
for item in see_also:
634
# topics doesn't have an independent section
635
# so don't create a real link
636
see_also_links.append(item)
638
# Use a Sphinx link for this entry
639
link_text = gettext(":doc:`{0} <{1}-help>`").format(
641
see_also_links.append(link_text)
642
see_also = see_also_links
643
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
645
# If this will be rendered as plain text, convert it
647
import breezy.help_topics
648
result = breezy.help_topics.help_as_plain_text(result)
652
def _get_help_parts(text):
653
"""Split help text into a summary and named sections.
655
:return: (summary,sections,order) where summary is the top line and
656
sections is a dictionary of the rest indexed by section name.
657
order is the order the section appear in the text.
658
A section starts with a heading line of the form ":xxx:".
659
Indented text on following lines is the section value.
660
All text found outside a named section is assigned to the
661
default section which is given the key of None.
663
def save_section(sections, order, label, section):
665
if label in sections:
666
sections[label] += '\n' + section
669
sections[label] = section
671
lines = text.rstrip().splitlines()
672
summary = lines.pop(0)
675
label, section = None, ''
677
if line.startswith(':') and line.endswith(':') and len(line) > 2:
678
save_section(sections, order, label, section)
679
label, section = line[1:-1], ''
680
elif (label is not None and len(line) > 1 and
681
not line[0].isspace()):
682
save_section(sections, order, label, section)
683
label, section = None, line
686
section += '\n' + line
689
save_section(sections, order, label, section)
690
return summary, sections, order
692
def get_help_topic(self):
693
"""Return the commands help topic - its name."""
696
def get_see_also(self, additional_terms=None):
697
"""Return a list of help topics that are related to this command.
699
The list is derived from the content of the _see_also attribute. Any
700
duplicates are removed and the result is in lexical order.
701
:param additional_terms: Additional help topics to cross-reference.
702
:return: A list of help topics.
704
see_also = set(getattr(self, '_see_also', []))
706
see_also.update(additional_terms)
707
return sorted(see_also)
710
"""Return dict of valid options for this command.
712
Maps from long option name to option object."""
713
r = Option.STD_OPTIONS.copy()
715
for o in self.takes_options:
716
if isinstance(o, string_types):
717
o = option.Option.OPTIONS[o]
719
if o.name in std_names:
720
self.supported_std_options.append(o.name)
723
def _setup_outf(self):
724
"""Return a file linked to stdout, which has proper encoding."""
725
self.outf = ui.ui_factory.make_output_stream(
726
encoding_type=self.encoding_type)
728
def run_argv_aliases(self, argv, alias_argv=None):
729
"""Parse the command line and run with extra aliases in alias_argv."""
730
args, opts = parse_args(self, argv, alias_argv)
733
# Process the standard options
734
if 'help' in opts: # e.g. brz add --help
735
self.outf.write(self.get_help_text())
737
if 'usage' in opts: # e.g. brz add --usage
738
self.outf.write(self.get_help_text(verbose=False))
740
trace.set_verbosity_level(option._verbosity_level)
741
if 'verbose' in self.supported_std_options:
742
opts['verbose'] = trace.is_verbose()
743
elif 'verbose' in opts:
745
if 'quiet' in self.supported_std_options:
746
opts['quiet'] = trace.is_quiet()
747
elif 'quiet' in opts:
749
# mix arguments and options into one dictionary
750
cmdargs = _match_argform(self.name(), self.takes_args, args)
752
for k, v in opts.items():
753
cmdopts[k.replace('-', '_')] = v
755
all_cmd_args = cmdargs.copy()
756
all_cmd_args.update(cmdopts)
759
return self.run(**all_cmd_args)
761
# reset it, so that other commands run in the same process won't
762
# inherit state. Before we reset it, log any activity, so that it
763
# gets properly tracked.
764
ui.ui_factory.log_transport_activity(
765
display=('bytes' in debug.debug_flags))
766
trace.set_verbosity_level(0)
768
def _setup_run(self):
769
"""Wrap the defined run method on self with a cleanup.
771
This is called by __init__ to make the Command be able to be run
772
by just calling run(), as it could be before cleanups were added.
774
If a different form of cleanups are in use by your Command subclass,
775
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")
857
"Called after creating a command object to allow modifications "
858
"such as adding or removing options, docs etc. Called with the "
859
"new breezy.commands.Command object.", (1, 13))
862
"Called when creating a single command. Called with "
863
"(cmd_or_None, command_name). get_command should either return "
864
"the cmd_or_None parameter, or a replacement Command object that "
865
"should be used for the command. Note that the Command.hooks "
866
"hooks are core infrastructure. Many users will prefer to use "
867
"breezy.commands.register_command or plugin_cmds.register_lazy.",
870
'get_missing_command',
871
"Called when creating a single command if no command could be "
872
"found. Called with (command_name). get_missing_command should "
873
"either return None, or a Command object to be used for the "
877
"Called when enumerating commands. Called with a set of "
878
"cmd_name strings for all the commands found so far. This set "
879
" is safe to mutate - e.g. to remove a command. "
880
"list_commands should return the updated set of command names.",
884
"Called prior to executing a command. Called with the command "
888
"Called after executing a command. Called with the command "
892
Command.hooks = CommandHooks()
895
def parse_args(command, argv, alias_argv=None):
896
"""Parse command line.
898
Arguments and options are parsed at this level before being passed
899
down to specific command handlers. This routine knows, from a
900
lookup table, something about the available options, what optargs
901
they take, and which commands will accept them.
903
# TODO: make it a method of the Command?
904
parser = option.get_optparser(
905
[v for k, v in sorted(command.options().items())])
906
if alias_argv is not None:
907
args = alias_argv + argv
911
# python 2's optparse raises this exception if a non-ascii
912
# option name is given. See http://bugs.python.org/issue2931
914
options, args = parser.parse_args(args)
915
except UnicodeEncodeError:
916
raise errors.BzrCommandError(
917
gettext('Only ASCII permitted in option names'))
919
opts = dict((k, v) for k, v in options.__dict__.items() if
920
v is not option.OptionParser.DEFAULT_VALUE)
924
def _match_argform(cmd, takes_args, args):
927
# step through args and takes_args, allowing appropriate 0-many matches
928
for ap in takes_args:
932
argdict[argname] = args.pop(0)
933
elif ap[-1] == '*': # all remaining arguments
935
argdict[argname + '_list'] = args[:]
938
argdict[argname + '_list'] = None
941
raise errors.BzrCommandError(gettext(
942
"command {0!r} needs one or more {1}").format(
943
cmd, argname.upper()))
945
argdict[argname + '_list'] = args[:]
947
elif ap[-1] == '$': # all but one
949
raise errors.BzrCommandError(
950
gettext("command {0!r} needs one or more {1}").format(
951
cmd, argname.upper()))
952
argdict[argname + '_list'] = args[:-1]
958
raise errors.BzrCommandError(
959
gettext("command {0!r} requires argument {1}").format(
960
cmd, argname.upper()))
962
argdict[argname] = args.pop(0)
965
raise errors.BzrCommandError(gettext(
966
"extra argument to command {0}: {1}").format(
972
def apply_coveraged(the_callable, *args, **kwargs):
974
cov = coverage.Coverage()
975
os.environ['COVERAGE_PROCESS_START'] = cov.config_file
978
return exception_to_return_code(the_callable, *args, **kwargs)
984
def apply_profiled(the_callable, *args, **kwargs):
988
pffileno, pfname = tempfile.mkstemp()
990
prof = hotshot.Profile(pfname)
992
ret = prof.runcall(exception_to_return_code, the_callable, *args,
996
stats = hotshot.stats.load(pfname)
998
stats.sort_stats('cum') # 'time'
999
# XXX: Might like to write to stderr or the trace file instead but
1000
# print_stats seems hardcoded to stdout
1001
stats.print_stats(20)
1008
def exception_to_return_code(the_callable, *args, **kwargs):
1009
"""UI level helper for profiling and coverage.
1011
This transforms exceptions into a return value of 3. As such its only
1012
relevant to the UI layer, and should never be called where catching
1013
exceptions may be desirable.
1016
return the_callable(*args, **kwargs)
1017
except (KeyboardInterrupt, Exception):
1018
# used to handle AssertionError and KeyboardInterrupt
1019
# specially here, but hopefully they're handled ok by the logger now
1020
exc_info = sys.exc_info()
1021
exitcode = trace.report_exception(exc_info, sys.stderr)
1022
if os.environ.get('BRZ_PDB'):
1023
print('**** entering debugger')
1025
pdb.post_mortem(exc_info[2])
1029
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1030
from breezy.lsprof import profile
1031
ret, stats = profile(exception_to_return_code, the_callable,
1034
if filename is None:
1037
stats.save(filename)
1038
trace.note(gettext('Profile data written to "%s".'), filename)
1042
def get_alias(cmd, config=None):
1043
"""Return an expanded alias, or None if no alias exists.
1046
Command to be checked for an alias.
1048
Used to specify an alternative config to use,
1049
which is especially useful for testing.
1050
If it is unspecified, the global config will be used.
1053
import breezy.config
1054
config = breezy.config.GlobalConfig()
1055
alias = config.get_alias(cmd)
1057
return cmdline.split(alias)
1061
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1062
"""Execute a command.
1064
:param argv: The command-line arguments, without the program name from
1065
argv[0] These should already be decoded. All library/test code calling
1066
run_bzr should be passing valid strings (don't need decoding).
1067
:param load_plugins: What function to call when triggering plugin loading.
1068
This function should take no arguments and cause all plugins to be
1070
:param disable_plugins: What function to call when disabling plugin
1071
loading. This function should take no arguments and cause all plugin
1072
loading to be prohibited (so that code paths in your application that
1073
know about some plugins possibly being present will fail to import
1074
those plugins even if they are installed.)
1075
:return: Returns a command exit code or raises an exception.
1077
Special master options: these must come before the command because
1078
they control how the command is interpreted.
1081
Do not load plugin modules at all
1084
Do not allow aliases
1087
Only use builtin commands. (Plugins are still allowed to change
1091
Run under the Python hotshot profiler.
1094
Run under the Python lsprof profiler.
1097
Generate code coverage report
1100
Specify the number of processes that can be run concurrently
1103
trace.mutter("breezy version: " + breezy.__version__)
1104
argv = _specified_or_unicode_argv(argv)
1105
trace.mutter("brz arguments: %r", argv)
1107
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1108
opt_coverage = opt_no_l10n = opt_no_aliases = False
1109
opt_lsprof_file = None
1111
# --no-plugins is handled specially at a very early stage. We need
1112
# to load plugins before doing other command parsing so that they
1113
# can override commands, but this needs to happen first.
1117
override_config = []
1118
while i < len(argv):
1120
if a == '--profile':
1122
elif a == '--lsprof':
1124
elif a == '--lsprof-file':
1126
opt_lsprof_file = argv[i + 1]
1128
elif a == '--no-plugins':
1129
opt_no_plugins = True
1130
elif a == '--no-aliases':
1131
opt_no_aliases = True
1132
elif a == '--no-l10n':
1134
elif a == '--builtin':
1136
elif a == '--concurrency':
1137
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1139
elif a == '--coverage':
1141
elif a == '--profile-imports':
1142
pass # already handled in startup script Bug #588277
1143
elif a.startswith('-D'):
1144
debug.debug_flags.add(a[2:])
1145
elif a.startswith('-O'):
1146
override_config.append(a[2:])
1151
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1152
cmdline_overrides._from_cmdline(override_config)
1154
debug.set_debug_flags_from_config()
1156
if not opt_no_plugins:
1163
get_cmd_object('help').run_argv_aliases([])
1166
if argv[0] == '--version':
1167
get_cmd_object('version').run_argv_aliases([])
1172
if not opt_no_aliases:
1173
alias_argv = get_alias(argv[0])
1175
argv[0] = alias_argv.pop(0)
1178
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1180
cmd_obj.l10n = False
1181
run = cmd_obj.run_argv_aliases
1182
run_argv = [argv, alias_argv]
1185
# We can be called recursively (tests for example), but we don't want
1186
# the verbosity level to propagate.
1187
saved_verbosity_level = option._verbosity_level
1188
option._verbosity_level = 0
1192
'--coverage ignored, because --lsprof is in use.')
1193
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1197
'--coverage ignored, because --profile is in use.')
1198
ret = apply_profiled(run, *run_argv)
1200
ret = apply_coveraged(run, *run_argv)
1202
ret = run(*run_argv)
1205
# reset, in case we may do other commands later within the same
1206
# process. Commands that want to execute sub-commands must propagate
1207
# --verbose in their own way.
1208
if 'memory' in debug.debug_flags:
1209
trace.debug_memory('Process status after command:', short=False)
1210
option._verbosity_level = saved_verbosity_level
1211
# Reset the overrides
1212
cmdline_overrides._reset()
1215
def display_command(func):
1216
"""Decorator that suppresses pipe/interrupt errors."""
1217
def ignore_pipe(*args, **kwargs):
1219
result = func(*args, **kwargs)
1222
except IOError as e:
1223
if getattr(e, 'errno', None) is None:
1225
if e.errno != errno.EPIPE:
1226
# Win32 raises IOError with errno=0 on a broken pipe
1227
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1230
except KeyboardInterrupt:
1235
def install_bzr_command_hooks():
1236
"""Install the hooks to supply bzr's own commands."""
1237
if _list_bzr_commands in Command.hooks["list_commands"]:
1239
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1241
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1243
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1244
"bzr plugin commands")
1245
Command.hooks.install_named_hook("get_command", _get_external_command,
1246
"bzr external command lookup")
1247
Command.hooks.install_named_hook("get_missing_command",
1248
_try_plugin_provider,
1249
"bzr plugin-provider-db check")
1252
def _specified_or_unicode_argv(argv):
1253
# For internal or testing use, argv can be passed. Otherwise, get it from
1254
# the process arguments in a unicode-safe way.
1256
return osutils.get_unicode_argv()
1259
# ensure all arguments are unicode strings
1261
if not isinstance(a, string_types):
1262
raise ValueError('not native str or unicode: %r' % (a,))
1263
if isinstance(a, bytes):
1264
# For Python 2 only allow ascii native strings
1265
a = a.decode('ascii')
1267
except (ValueError, UnicodeDecodeError):
1268
raise errors.BzrError("argv should be list of unicode strings.")
1272
def main(argv=None):
1273
"""Main entry point of command-line interface.
1275
Typically `breezy.initialize` should be called first.
1277
:param argv: list of unicode command-line arguments similar to sys.argv.
1278
argv[0] is script name usually, it will be ignored.
1279
Don't pass here sys.argv because this list contains plain strings
1280
and not unicode; pass None instead.
1282
:return: exit code of brz command.
1284
if argv is not None:
1286
_register_builtin_commands()
1287
ret = run_bzr_catch_errors(argv)
1288
trace.mutter("return code %d", ret)
1292
def run_bzr_catch_errors(argv):
1293
"""Run a bzr command with parameters as described by argv.
1295
This function assumed that that UI layer is setup, that symbol deprecations
1296
are already applied, and that unicode decoding has already been performed
1299
# done here so that they're covered for every test run
1300
install_bzr_command_hooks()
1301
return exception_to_return_code(run_bzr, argv)
1304
def run_bzr_catch_user_errors(argv):
1305
"""Run brz and report user errors, but let internal errors propagate.
1307
This is used for the test suite, and might be useful for other programs
1308
that want to wrap the commandline interface.
1310
# done here so that they're covered for every test run
1311
install_bzr_command_hooks()
1313
return run_bzr(argv)
1314
except Exception as e:
1315
if (isinstance(e, (OSError, IOError))
1316
or not getattr(e, 'internal_error', True)):
1317
trace.report_exception(sys.exc_info(), sys.stderr)
1323
class HelpCommandIndex(object):
1324
"""A index for bzr help that returns commands."""
1327
self.prefix = 'commands/'
1329
def get_topics(self, topic):
1330
"""Search for topic amongst commands.
1332
:param topic: A topic to search for.
1333
:return: A list which is either empty or contains a single
1336
if topic and topic.startswith(self.prefix):
1337
topic = topic[len(self.prefix):]
1339
cmd = _get_cmd_object(topic, check_missing=False)
1346
class Provider(object):
1347
"""Generic class to be overriden by plugins"""
1349
def plugin_for_command(self, cmd_name):
1350
"""Takes a command and returns the information for that plugin
1352
:return: A dictionary with all the available information
1353
for the requested plugin
1355
raise NotImplementedError
1358
class ProvidersRegistry(registry.Registry):
1359
"""This registry exists to allow other providers to exist"""
1362
for key, provider in self.items():
1366
command_providers_registry = ProvidersRegistry()
added
removed
breezy/commands.py
