1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2004, 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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.
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Help messages for options.
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
28
# TODO: Help messages for options.
30
# TODO: Define arguments by objects, rather than just using names.
31
# Those objects can specify the expected type of the argument, which
32
# would help with validation and shell completion.
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.
38
from warnings import warn
39
from inspect import getdoc
43
from bzrlib.trace import mutter, note, log_error, warning
44
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
45
from bzrlib.revisionspec import RevisionSpec
46
from bzrlib import BZRDIR
51
def register_command(cmd):
52
"Utility function to help register a command"
181
53
global plugin_cmds
182
return plugin_cmds.register(cmd, decorate)
55
if k.startswith("cmd_"):
56
k_unsquished = _unsquish_command_name(k)
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
63
log_error('Two plugins defined the same command: %r' % k)
64
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
185
67
def _squish_command_name(cmd):
189
71
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:
72
assert cmd.startswith("cmd_")
73
return cmd[4:].replace('_','-')
76
def _parse_revision_str(revstr):
77
"""This handles a revision string -> revno.
79
This always returns a list. The list will have one element for
82
>>> _parse_revision_str('234')
83
[<RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..567')
85
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
86
>>> _parse_revision_str('..')
87
[<RevisionSpec None>, <RevisionSpec None>]
88
>>> _parse_revision_str('..234')
89
[<RevisionSpec None>, <RevisionSpec_int 234>]
90
>>> _parse_revision_str('234..')
91
[<RevisionSpec_int 234>, <RevisionSpec None>]
92
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
93
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
94
>>> _parse_revision_str('234....789') # Error?
95
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
96
>>> _parse_revision_str('revid:test@other.com-234234')
97
[<RevisionSpec_revid revid:test@other.com-234234>]
98
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
99
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
100
>>> _parse_revision_str('revid:test@other.com-234234..23')
101
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
102
>>> _parse_revision_str('date:2005-04-12')
103
[<RevisionSpec_date date:2005-04-12>]
104
>>> _parse_revision_str('date:2005-04-12 12:24:33')
105
[<RevisionSpec_date date:2005-04-12 12:24:33>]
106
>>> _parse_revision_str('date:2005-04-12T12:24:33')
107
[<RevisionSpec_date date:2005-04-12T12:24:33>]
108
>>> _parse_revision_str('date:2005-04-12,12:24:33')
109
[<RevisionSpec_date date:2005-04-12,12:24:33>]
110
>>> _parse_revision_str('-5..23')
111
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
112
>>> _parse_revision_str('-5')
113
[<RevisionSpec_int -5>]
114
>>> _parse_revision_str('123a')
115
Traceback (most recent call last):
117
BzrError: No namespace registered for string: '123a'
118
>>> _parse_revision_str('abc')
119
Traceback (most recent call last):
121
BzrError: No namespace registered for string: 'abc'
124
old_format_re = re.compile('\d*:\d*')
125
m = old_format_re.match(revstr)
128
warning('Colon separator for revision numbers is deprecated.'
130
for rev in revstr.split(':'):
132
revs.append(RevisionSpec(int(rev)))
134
revs.append(RevisionSpec(None))
136
for x in revstr.split('..'):
138
revs.append(RevisionSpec(None))
140
revs.append(RevisionSpec(x))
144
def get_merge_type(typestring):
145
"""Attempt to find the merge class/factory associated with a string."""
146
from merge import merge_types
148
return merge_types[typestring][0]
150
templ = '%s%%7s: %%s' % (' '*12)
151
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
152
type_list = '\n'.join(lines)
153
msg = "No known merge type %s. Supported types are:\n%s" %\
154
(typestring, type_list)
155
raise BzrCommandError(msg)
158
def _builtin_commands():
159
import bzrlib.builtins
161
builtins = bzrlib.builtins.__dict__
162
for name in builtins:
206
163
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))
164
real_name = _unsquish_command_name(name)
165
r[real_name] = builtins[name]
233
170
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()
171
"""Return list of builtin command names."""
172
return _builtin_commands().keys()
243
175
def plugin_command_names():
244
"""Returns command names from commands registered by plugins."""
245
176
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.
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]
179
def _get_cmd_dict(plugins_override=True):
180
"""Return name->class mapping for all commands."""
181
d = _builtin_commands()
183
d.update(plugin_cmds)
187
def get_all_cmds(plugins_override=True):
188
"""Return canonical name and class for all registered commands."""
189
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
294
193
def get_cmd_object(cmd_name, plugins_override=True):
295
"""Return the command object for a command.
194
"""Return the canonical name and command class for a command.
298
197
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
199
from bzrlib.externalcommand import ExternalCommand
201
cmd_name = str(cmd_name) # not unicode
203
# first look up this command under the specified name
204
cmds = _get_cmd_dict(plugins_override=plugins_override)
206
return cmds[cmd_name]()
210
# look for any command which claims this as an alias
211
for real_cmd_name, cmd_class in cmds.iteritems():
212
if cmd_name in cmd_class.aliases:
397
215
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)()
219
raise BzrCommandError("unknown command %r" % cmd_name)
415
222
class Command(object):
416
223
"""Base class for commands.
418
Commands are the heart of the command-line brz interface.
225
Commands are the heart of the command-line bzr interface.
420
227
The command object mostly handles the mapping of command-line
421
parameters into one or more breezy operations, and of the results
228
parameters into one or more bzrlib operations, and of the results
422
229
into textual output.
424
231
Commands normally don't have any state. All their arguments are
430
237
summary, then a complete description of the command. A grammar
431
238
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
241
Other accepted names for this command.
244
List of argument forms, marked with whether they are optional,
248
List of options that may be given for this command.
251
If true, this command isn't advertised. This is typically
449
252
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"
481
257
takes_options = []
482
encoding_type = 'strict'
488
261
def __init__(self):
489
262
"""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._exit_stack.callback(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._exit_stack.close()
516
def enter_context(self, cm):
517
return self._exit_stack.enter_context(cm)
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(
589
[v for k, v in sorted(self.options().items())])
590
options = parser.format_option_help()
591
# FIXME: According to the spec, ReST option lists actually don't
592
# support options like --1.14 so that causes syntax errors (in Sphinx
593
# at least). As that pattern always appears in the commands that
594
# break, we trap on that and then format that block of 'format' options
595
# as a literal block. We use the most recent format still listed so we
596
# don't have to do that too often -- vila 20110514
597
if not plain and options.find(' --1.14 ') != -1:
598
options = options.replace(' format:\n', ' format::\n\n', 1)
599
if options.startswith('Options:'):
600
result += gettext(':Options:%s') % (options[len('options:'):],)
606
# Add the description, indenting it 2 spaces
607
# to match the indentation of the options
609
text = sections.pop(None)
610
text = '\n '.join(text.splitlines())
611
result += gettext(':Description:\n %s\n\n') % (text,)
613
# Add the custom sections (e.g. Examples). Note that there's no need
614
# to indent these as they must be indented already in the source.
617
if label in sections:
618
result += ':%s:\n%s\n' % (label, sections[label])
621
result += (gettext("See brz help %s for more details and examples.\n\n")
624
# Add the aliases, source (plug-in) and see also links, if any
626
result += gettext(':Aliases: ')
627
result += ', '.join(self.aliases) + '\n'
628
plugin_name = self.plugin_name()
629
if plugin_name is not None:
630
result += gettext(':From: plugin "%s"\n') % plugin_name
631
see_also = self.get_see_also(additional_see_also)
633
if not plain and see_also_as_links:
635
for item in see_also:
637
# topics doesn't have an independent section
638
# so don't create a real link
639
see_also_links.append(item)
641
# Use a Sphinx link for this entry
642
link_text = gettext(":doc:`{0} <{1}-help>`").format(
644
see_also_links.append(link_text)
645
see_also = see_also_links
646
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
648
# If this will be rendered as plain text, convert it
650
import breezy.help_topics
651
result = breezy.help_topics.help_as_plain_text(result)
655
def _get_help_parts(text):
656
"""Split help text into a summary and named sections.
658
:return: (summary,sections,order) where summary is the top line and
659
sections is a dictionary of the rest indexed by section name.
660
order is the order the section appear in the text.
661
A section starts with a heading line of the form ":xxx:".
662
Indented text on following lines is the section value.
663
All text found outside a named section is assigned to the
664
default section which is given the key of None.
666
def save_section(sections, order, label, section):
668
if label in sections:
669
sections[label] += '\n' + section
672
sections[label] = section
674
lines = text.rstrip().splitlines()
675
summary = lines.pop(0)
678
label, section = None, ''
680
if line.startswith(':') and line.endswith(':') and len(line) > 2:
681
save_section(sections, order, label, section)
682
label, section = line[1:-1], ''
683
elif (label is not None and len(line) > 1 and
684
not line[0].isspace()):
685
save_section(sections, order, label, section)
686
label, section = None, line
689
section += '\n' + line
692
save_section(sections, order, label, section)
693
return summary, sections, order
695
def get_help_topic(self):
696
"""Return the commands help topic - its name."""
699
def get_see_also(self, additional_terms=None):
700
"""Return a list of help topics that are related to this command.
702
The list is derived from the content of the _see_also attribute. Any
703
duplicates are removed and the result is in lexical order.
704
:param additional_terms: Additional help topics to cross-reference.
705
:return: A list of help topics.
707
see_also = set(getattr(self, '_see_also', []))
709
see_also.update(additional_terms)
710
return sorted(see_also)
713
"""Return dict of valid options for this command.
715
Maps from long option name to option object."""
716
r = Option.STD_OPTIONS.copy()
718
for o in self.takes_options:
719
if isinstance(o, string_types):
720
o = option.Option.OPTIONS[o]
722
if o.name in std_names:
723
self.supported_std_options.append(o.name)
726
def _setup_outf(self):
727
"""Return a file linked to stdout, which has proper encoding."""
728
self.outf = ui.ui_factory.make_output_stream(
729
encoding_type=self.encoding_type)
731
def run_argv_aliases(self, argv, alias_argv=None):
732
"""Parse the command line and run with extra aliases in alias_argv."""
733
args, opts = parse_args(self, argv, alias_argv)
736
# Process the standard options
737
if 'help' in opts: # e.g. brz add --help
738
self.outf.write(self.get_help_text())
740
if 'usage' in opts: # e.g. brz add --usage
741
self.outf.write(self.get_help_text(verbose=False))
743
trace.set_verbosity_level(option._verbosity_level)
744
if 'verbose' in self.supported_std_options:
745
opts['verbose'] = trace.is_verbose()
746
elif 'verbose' in opts:
748
if 'quiet' in self.supported_std_options:
749
opts['quiet'] = trace.is_quiet()
750
elif 'quiet' in opts:
263
if self.__doc__ == Command.__doc__:
264
warn("No help message set for %r" % self)
267
def run_argv(self, argv):
268
"""Parse command line and run."""
269
args, opts = parse_args(argv)
271
if 'help' in opts: # e.g. bzr add --help
272
from bzrlib.help import help_on_command
273
help_on_command(self.name())
276
# check options are reasonable
277
allowed = self.takes_options
279
if oname not in allowed:
280
raise BzrCommandError("option '--%s' is not allowed for command %r"
281
% (oname, self.name()))
752
283
# mix arguments and options into one dictionary
753
284
cmdargs = _match_argform(self.name(), self.takes_args, args)
799
301
Return 0 or None if the command was successful, or a non-zero
800
302
shell error code if not. It's OK for this method to allow
801
303
an exception to raise up.
803
This method is automatically wrapped by Command.__init__ with a
804
ExitStack, stored as self._exit_stack. This can be used
805
via self.add_cleanup to perform automatic cleanups at the end of
808
The argument for run are assembled by introspection. So for instance,
809
if your command takes an argument files, you would declare::
811
def run(self, files=None):
814
raise NotImplementedError('no implementation of command %r'
305
raise NotImplementedError()
818
309
"""Return help message for this class."""
819
from inspect import getdoc
820
310
if self.__doc__ is Command.__doc__:
822
312
return getdoc(self)
824
def gettext(self, message):
825
"""Returns the gettext function used to translate this command's help.
827
Commands provided by plugins should override this to use their
830
return i18n.gettext_per_paragraph(message)
833
"""Return the canonical name for this command.
835
The name under which it was actually invoked is available in invoked_as
837
315
return _unsquish_command_name(self.__class__.__name__)
839
def plugin_name(self):
840
"""Get the name of the plugin that provides this command.
842
:return: The name of the plugin or None if the command is builtin.
844
return plugin_name(self.__module__)
847
class CommandHooks(Hooks):
848
"""Hooks related to Command object creation/enumeration."""
851
"""Create the default hooks.
853
These are all empty initially, because by default nothing should get
856
Hooks.__init__(self, "breezy.commands", "Command.hooks")
859
"Called after creating a command object to allow modifications "
860
"such as adding or removing options, docs etc. Called with the "
861
"new breezy.commands.Command object.", (1, 13))
864
"Called when creating a single command. Called with "
865
"(cmd_or_None, command_name). get_command should either return "
866
"the cmd_or_None parameter, or a replacement Command object that "
867
"should be used for the command. Note that the Command.hooks "
868
"hooks are core infrastructure. Many users will prefer to use "
869
"breezy.commands.register_command or plugin_cmds.register_lazy.",
872
'get_missing_command',
873
"Called when creating a single command if no command could be "
874
"found. Called with (command_name). get_missing_command should "
875
"either return None, or a Command object to be used for the "
879
"Called when enumerating commands. Called with a set of "
880
"cmd_name strings for all the commands found so far. This set "
881
" is safe to mutate - e.g. to remove a command. "
882
"list_commands should return the updated set of command names.",
886
"Called prior to executing a command. Called with the command "
890
"Called after executing a command. Called with the command "
894
Command.hooks = CommandHooks()
897
def parse_args(command, argv, alias_argv=None):
318
def parse_spec(spec):
324
>>> parse_spec("../@")
326
>>> parse_spec("../f/@35")
328
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
329
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
334
parsed = spec.split('/@')
335
assert len(parsed) == 2
340
parsed[1] = int(parsed[1])
342
pass # We can allow stuff like ./@revid:blahblahblah
346
parsed = [spec, None]
350
# list of all available options; the rhs can be either None for an
351
# option that takes no argument, or a constructor function that checks
364
'revision': _parse_revision_str,
376
'merge-type': get_merge_type,
390
def parse_args(argv):
898
391
"""Parse command line.
900
393
Arguments and options are parsed at this level before being passed
901
394
down to specific command handlers. This routine knows, from a
902
395
lookup table, something about the available options, what optargs
903
396
they take, and which commands will accept them.
398
>>> parse_args('--help'.split())
400
>>> parse_args('help -- --invalidcmd'.split())
401
(['help', '--invalidcmd'], {})
402
>>> parse_args('--version'.split())
403
([], {'version': True})
404
>>> parse_args('status --all'.split())
405
(['status'], {'all': True})
406
>>> parse_args('commit --message=biter'.split())
407
(['commit'], {'message': u'biter'})
408
>>> parse_args('log -r 500'.split())
409
(['log'], {'revision': [<RevisionSpec_int 500>]})
410
>>> parse_args('log -r500..600'.split())
411
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
412
>>> parse_args('log -vr500..600'.split())
413
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
414
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
415
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
905
# TODO: make it a method of the Command?
906
parser = option.get_optparser(
907
[v for k, v in sorted(command.options().items())])
908
if alias_argv is not None:
909
args = alias_argv + argv
913
# python 2's optparse raises this exception if a non-ascii
914
# option name is given. See http://bugs.python.org/issue2931
916
options, args = parser.parse_args(args)
917
except UnicodeEncodeError:
918
raise errors.BzrCommandError(
919
gettext('Only ASCII permitted in option names'))
921
opts = dict((k, v) for k, v in options.__dict__.items() if
922
v is not option.OptionParser.DEFAULT_VALUE)
423
if not argsover and a[0] == '-':
424
# option names must not be unicode
429
# We've received a standalone -- No more flags
432
mutter(" got option %r" % a)
434
optname, optarg = a[2:].split('=', 1)
437
if optname not in OPTIONS:
438
raise BzrError('unknown long option %r' % a)
441
if shortopt in SHORT_OPTIONS:
442
# Multi-character options must have a space to delimit
444
optname = SHORT_OPTIONS[shortopt]
446
# Single character short options, can be chained,
447
# and have their value appended to their name
449
if shortopt not in SHORT_OPTIONS:
450
# We didn't find the multi-character name, and we
451
# didn't find the single char name
452
raise BzrError('unknown short option %r' % a)
453
optname = SHORT_OPTIONS[shortopt]
456
# There are extra things on this option
457
# see if it is the value, or if it is another
459
optargfn = OPTIONS[optname]
461
# This option does not take an argument, so the
462
# next entry is another short option, pack it back
464
argv.insert(0, '-' + a[2:])
466
# This option takes an argument, so pack it
471
# XXX: Do we ever want to support this, e.g. for -r?
472
raise BzrError('repeated option %r' % a)
474
optargfn = OPTIONS[optname]
478
raise BzrError('option %r needs an argument' % a)
481
opts[optname] = optargfn(optarg)
484
raise BzrError('option %r takes no argument' % optname)
923
489
return args, opts
926
494
def _match_argform(cmd, takes_args, args):
940
508
argdict[argname + '_list'] = None
941
509
elif ap[-1] == '+':
943
raise errors.BzrCommandError(gettext(
944
"command {0!r} needs one or more {1}").format(
945
cmd, argname.upper()))
511
raise BzrCommandError("command %r needs one or more %s"
512
% (cmd, argname.upper()))
947
514
argdict[argname + '_list'] = args[:]
949
elif ap[-1] == '$': # all but one
516
elif ap[-1] == '$': # all but one
950
517
if len(args) < 2:
951
raise errors.BzrCommandError(
952
gettext("command {0!r} needs one or more {1}").format(
953
cmd, argname.upper()))
518
raise BzrCommandError("command %r needs one or more %s"
519
% (cmd, argname.upper()))
954
520
argdict[argname + '_list'] = args[:-1]
957
523
# just a plain arg
960
raise errors.BzrCommandError(
961
gettext("command {0!r} requires argument {1}").format(
962
cmd, argname.upper()))
526
raise BzrCommandError("command %r requires argument %s"
527
% (cmd, argname.upper()))
964
529
argdict[argname] = args.pop(0)
967
raise errors.BzrCommandError(gettext(
968
"extra argument to command {0}: {1}").format(
532
raise BzrCommandError("extra argument to command %s: %s"
974
def apply_coveraged(the_callable, *args, **kwargs):
976
cov = coverage.Coverage()
978
config_file = cov.config.config_file
979
except AttributeError: # older versions of coverage
980
config_file = cov.config_file
981
os.environ['COVERAGE_PROCESS_START'] = config_file
984
return exception_to_return_code(the_callable, *args, **kwargs)
990
539
def apply_profiled(the_callable, *args, **kwargs):
994
542
pffileno, pfname = tempfile.mkstemp()
996
544
prof = hotshot.Profile(pfname)
998
ret = prof.runcall(exception_to_return_code, the_callable, *args,
546
ret = prof.runcall(the_callable, *args, **kwargs) or 0
1002
551
stats = hotshot.stats.load(pfname)
1004
stats.sort_stats('cum') # 'time'
1005
# XXX: Might like to write to stderr or the trace file instead but
1006
# print_stats seems hardcoded to stdout
553
stats.sort_stats('time')
554
## XXX: Might like to write to stderr or the trace file instead but
555
## print_stats seems hardcoded to stdout
1007
556
stats.print_stats(20)
1010
560
os.close(pffileno)
1011
561
os.remove(pfname)
1014
def exception_to_return_code(the_callable, *args, **kwargs):
1015
"""UI level helper for profiling and coverage.
1017
This transforms exceptions into a return value of 3. As such its only
1018
relevant to the UI layer, and should never be called where catching
1019
exceptions may be desirable.
1022
return the_callable(*args, **kwargs)
1023
except (KeyboardInterrupt, Exception):
1024
# used to handle AssertionError and KeyboardInterrupt
1025
# specially here, but hopefully they're handled ok by the logger now
1026
exc_info = sys.exc_info()
1027
exitcode = trace.report_exception(exc_info, sys.stderr)
1028
if os.environ.get('BRZ_PDB'):
1029
print('**** entering debugger')
1031
pdb.post_mortem(exc_info[2])
1035
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1036
from breezy.lsprof import profile
1037
ret, stats = profile(exception_to_return_code, the_callable,
1040
if filename is None:
1043
stats.save(filename)
1044
trace.note(gettext('Profile data written to "%s".'), filename)
1048
def get_alias(cmd, config=None):
1049
"""Return an expanded alias, or None if no alias exists.
1052
Command to be checked for an alias.
1054
Used to specify an alternative config to use,
1055
which is especially useful for testing.
1056
If it is unspecified, the global config will be used.
1059
import breezy.config
1060
config = breezy.config.GlobalConfig()
1061
alias = config.get_alias(cmd)
1063
return cmdline.split(alias)
1067
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1068
565
"""Execute a command.
1070
:param argv: The command-line arguments, without the program name from
1071
argv[0] These should already be decoded. All library/test code calling
1072
run_bzr should be passing valid strings (don't need decoding).
1073
:param load_plugins: What function to call when triggering plugin loading.
1074
This function should take no arguments and cause all plugins to be
1076
:param disable_plugins: What function to call when disabling plugin
1077
loading. This function should take no arguments and cause all plugin
1078
loading to be prohibited (so that code paths in your application that
1079
know about some plugins possibly being present will fail to import
1080
those plugins even if they are installed.)
1081
:return: Returns a command exit code or raises an exception.
567
This is similar to main(), but without all the trappings for
568
logging and error handling.
571
The command-line arguments, without the program name from argv[0]
573
Returns a command status or raises an exception.
1083
575
Special master options: these must come before the command because
1084
576
they control how the command is interpreted.
1087
579
Do not load plugin modules at all
1090
Do not allow aliases
1093
582
Only use builtin commands. (Plugins are still allowed to change
1094
583
other behaviour.)
1097
Run under the Python hotshot profiler.
1100
Run under the Python lsprof profiler.
1103
Generate code coverage report
1106
Specify the number of processes that can be run concurrently
586
Run under the Python profiler.
1109
trace.mutter("breezy version: " + breezy.__version__)
1110
argv = _specified_or_unicode_argv(argv)
1111
trace.mutter("brz arguments: %r", argv)
589
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1113
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1114
opt_coverage = opt_no_l10n = opt_no_aliases = False
1115
opt_lsprof_file = None
591
opt_profile = opt_no_plugins = opt_builtin = False
1117
593
# --no-plugins is handled specially at a very early stage. We need
1118
594
# to load plugins before doing other command parsing so that they
1119
595
# can override commands, but this needs to happen first.
1123
override_config = []
1124
while i < len(argv):
1126
598
if a == '--profile':
1127
599
opt_profile = True
1128
elif a == '--lsprof':
1130
elif a == '--lsprof-file':
1132
opt_lsprof_file = argv[i + 1]
1134
600
elif a == '--no-plugins':
1135
601
opt_no_plugins = True
1136
elif a == '--no-aliases':
1137
opt_no_aliases = True
1138
elif a == '--no-l10n':
1140
602
elif a == '--builtin':
1141
603
opt_builtin = True
1142
elif a == '--concurrency':
1143
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1145
elif a == '--coverage':
1147
elif a == '--profile-imports':
1148
pass # already handled in startup script Bug #588277
1149
elif a.startswith('-D'):
1150
debug.debug_flags.add(a[2:])
1151
elif a.startswith('-O'):
1152
override_config.append(a[2:])
1157
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1158
cmdline_overrides._from_cmdline(override_config)
1160
debug.set_debug_flags_from_config()
608
if (not argv) or (argv[0] == '--help'):
609
from bzrlib.help import help
616
if argv[0] == '--version':
617
from bzrlib.builtins import show_version
1162
621
if not opt_no_plugins:
622
from bzrlib.plugin import load_plugins
1169
get_cmd_object('help').run_argv_aliases([])
1172
if argv[0] == '--version':
1173
get_cmd_object('version').run_argv_aliases([])
1178
if not opt_no_aliases:
1179
alias_argv = get_alias(argv[0])
1181
argv[0] = alias_argv.pop(0)
625
cmd = str(argv.pop(0))
1184
627
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1186
cmd_obj.l10n = False
1187
run = cmd_obj.run_argv_aliases
1188
run_argv = [argv, alias_argv]
1191
# We can be called recursively (tests for example), but we don't want
1192
# the verbosity level to propagate.
1193
saved_verbosity_level = option._verbosity_level
1194
option._verbosity_level = 0
1198
'--coverage ignored, because --lsprof is in use.')
1199
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1203
'--coverage ignored, because --profile is in use.')
1204
ret = apply_profiled(run, *run_argv)
1206
ret = apply_coveraged(run, *run_argv)
1208
ret = run(*run_argv)
1211
# reset, in case we may do other commands later within the same
1212
# process. Commands that want to execute sub-commands must propagate
1213
# --verbose in their own way.
1214
if 'memory' in debug.debug_flags:
1215
trace.debug_memory('Process status after command:', short=False)
1216
option._verbosity_level = saved_verbosity_level
1217
# Reset the overrides
1218
cmdline_overrides._reset()
1221
def display_command(func):
1222
"""Decorator that suppresses pipe/interrupt errors."""
1223
def ignore_pipe(*args, **kwargs):
1225
result = func(*args, **kwargs)
1228
except IOError as e:
1229
if getattr(e, 'errno', None) is None:
1231
if e.errno != errno.EPIPE:
1232
# Win32 raises IOError with errno=0 on a broken pipe
1233
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1236
except KeyboardInterrupt:
1241
def install_bzr_command_hooks():
1242
"""Install the hooks to supply bzr's own commands."""
1243
if _list_bzr_commands in Command.hooks["list_commands"]:
1245
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1247
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1249
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1250
"bzr plugin commands")
1251
Command.hooks.install_named_hook("get_command", _get_external_command,
1252
"bzr external command lookup")
1253
Command.hooks.install_named_hook("get_missing_command",
1254
_try_plugin_provider,
1255
"bzr plugin-provider-db check")
1258
def _specified_or_unicode_argv(argv):
1259
# For internal or testing use, argv can be passed. Otherwise, get it from
1260
# the process arguments in a unicode-safe way.
1262
return osutils.get_unicode_argv()
1265
# ensure all arguments are unicode strings
1267
if not isinstance(a, string_types):
1268
raise ValueError('not native str or unicode: %r' % (a,))
1269
if isinstance(a, bytes):
1270
# For Python 2 only allow ascii native strings
1271
a = a.decode('ascii')
1273
except (ValueError, UnicodeDecodeError):
1274
raise errors.BzrError("argv should be list of unicode strings.")
1278
def main(argv=None):
1279
"""Main entry point of command-line interface.
1281
Typically `breezy.initialize` should be called first.
1283
:param argv: list of unicode command-line arguments similar to sys.argv.
1284
argv[0] is script name usually, it will be ignored.
1285
Don't pass here sys.argv because this list contains plain strings
1286
and not unicode; pass None instead.
1288
:return: exit code of brz command.
1290
if argv is not None:
1292
_register_builtin_commands()
1293
ret = run_bzr_catch_errors(argv)
1294
trace.mutter("return code %d", ret)
630
ret = apply_profiled(cmd_obj.run_argv, argv)
632
ret = cmd_obj.run_argv(argv)
638
bzrlib.trace.log_startup(argv)
639
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
641
return run_bzr_catch_errors(argv[1:])
1298
644
def run_bzr_catch_errors(argv):
1299
"""Run a bzr command with parameters as described by argv.
1301
This function assumed that that UI layer is setup, that symbol deprecations
1302
are already applied, and that unicode decoding has already been performed
1305
# done here so that they're covered for every test run
1306
install_bzr_command_hooks()
1307
return exception_to_return_code(run_bzr, argv)
1310
def run_bzr_catch_user_errors(argv):
1311
"""Run brz and report user errors, but let internal errors propagate.
1313
This is used for the test suite, and might be useful for other programs
1314
that want to wrap the commandline interface.
1316
# done here so that they're covered for every test run
1317
install_bzr_command_hooks()
1319
return run_bzr(argv)
1320
except Exception as e:
1321
if (isinstance(e, (OSError, IOError))
1322
or not getattr(e, 'internal_error', True)):
1323
trace.report_exception(sys.exc_info(), sys.stderr)
1329
class HelpCommandIndex(object):
1330
"""A index for bzr help that returns commands."""
1333
self.prefix = 'commands/'
1335
def get_topics(self, topic):
1336
"""Search for topic amongst commands.
1338
:param topic: A topic to search for.
1339
:return: A list which is either empty or contains a single
1342
if topic and topic.startswith(self.prefix):
1343
topic = topic[len(self.prefix):]
1345
cmd = _get_cmd_object(topic, check_missing=False)
650
# do this here inside the exception wrappers to catch EPIPE
652
#wrap common errors as CommandErrors.
653
except (NotBranchError,), e:
654
raise BzrCommandError(str(e))
655
except BzrCommandError, e:
656
# command line syntax error, etc
660
bzrlib.trace.log_exception()
662
except AssertionError, e:
663
bzrlib.trace.log_exception('assertion failed: ' + str(e))
665
except KeyboardInterrupt, e:
666
bzrlib.trace.note('interrupted')
670
if (isinstance(e, IOError)
671
and hasattr(e, 'errno')
672
and e.errno == errno.EPIPE):
673
bzrlib.trace.note('broken pipe')
1352
class Provider(object):
1353
"""Generic class to be overriden by plugins"""
1355
def plugin_for_command(self, cmd_name):
1356
"""Takes a command and returns the information for that plugin
1358
:return: A dictionary with all the available information
1359
for the requested plugin
1361
raise NotImplementedError
1364
class ProvidersRegistry(registry.Registry):
1365
"""This registry exists to allow other providers to exist"""
1368
for key, provider in self.items():
1372
command_providers_registry = ProvidersRegistry()
676
bzrlib.trace.log_exception()
680
if __name__ == '__main__':
681
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
