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.
29
from bzrlib.lazy_import import lazy_import
30
lazy_import(globals(), """
38
from warnings import warn
39
from inspect import getdoc
48
from bzrlib.hooks import Hooks
49
from bzrlib.i18n import gettext
50
# Compatibility - Option used to be in commands.
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
56
class CommandInfo(object):
57
"""Information about a command."""
59
def __init__(self, aliases):
60
"""The list of aliases for the command."""
61
self.aliases = aliases
64
def from_command(klass, command):
65
"""Factory to construct a CommandInfo from a command."""
66
return klass(command.aliases)
69
class CommandRegistry(registry.Registry):
70
"""Special registry mapping command names to command classes.
72
:ivar overridden_registry: Look in this registry for commands being
73
overridden by this registry. This can be used to tell plugin commands
74
about the builtin they're decorating.
78
registry.Registry.__init__(self)
79
self.overridden_registry = None
80
# map from aliases to the real command that implements the name
83
def get(self, command_name):
84
real_name = self._alias_dict.get(command_name, command_name)
85
return registry.Registry.get(self, real_name)
88
def _get_name(command_name):
89
if command_name.startswith("cmd_"):
90
return _unsquish_command_name(command_name)
94
def register(self, cmd, decorate=False):
95
"""Utility function to help register a command
97
:param cmd: Command subclass to register
98
:param decorate: If true, allow overriding an existing command
99
of the same name; the old command is returned by this function.
100
Otherwise it is an error to try to override an existing command.
103
k_unsquished = self._get_name(k)
105
previous = self.get(k_unsquished)
108
if self.overridden_registry:
110
previous = self.overridden_registry.get(k_unsquished)
113
info = CommandInfo.from_command(cmd)
115
registry.Registry.register(self, k_unsquished, cmd,
116
override_existing=decorate, info=info)
118
trace.warning('Two plugins defined the same command: %r' % k)
119
trace.warning('Not loading the one in %r' %
120
sys.modules[cmd.__module__])
121
trace.warning('Previously this command was registered from %r' %
122
sys.modules[previous.__module__])
123
for a in cmd.aliases:
124
self._alias_dict[a] = k_unsquished
127
def register_lazy(self, command_name, aliases, module_name):
128
"""Register a command without loading its module.
130
:param command_name: The primary name of the command.
131
:param aliases: A list of aliases for the command.
132
:module_name: The module that the command lives in.
134
key = self._get_name(command_name)
135
registry.Registry.register_lazy(self, key, module_name, command_name,
136
info=CommandInfo(aliases))
138
self._alias_dict[a] = key
141
plugin_cmds = CommandRegistry()
142
builtin_command_registry = CommandRegistry()
143
plugin_cmds.overridden_registry = builtin_command_registry
146
def register_command(cmd, decorate=False):
147
"""Register a plugin command.
149
Should generally be avoided in favor of lazy registration.
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"
151
53
global plugin_cmds
152
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__])
155
67
def _squish_command_name(cmd):
159
71
def _unsquish_command_name(cmd):
72
assert cmd.startswith("cmd_")
160
73
return cmd[4:].replace('_','-')
163
def _register_builtin_commands():
164
if builtin_command_registry.keys():
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():
167
159
import bzrlib.builtins
168
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
169
builtin_command_registry.register(cmd_class)
170
bzrlib.builtins._register_lazy_builtins()
173
def _scan_module_for_commands(module):
175
for name, obj in module.__dict__.iteritems():
161
builtins = bzrlib.builtins.__dict__
162
for name in builtins:
176
163
if name.startswith("cmd_"):
177
real_name = _unsquish_command_name(name)
164
real_name = _unsquish_command_name(name)
165
r[real_name] = builtins[name]
182
def _list_bzr_commands(names):
183
"""Find commands from bzr's core and plugins.
185
This is not the public interface, just the default hook called by all_command_names.
187
# to eliminate duplicates
188
names.update(builtin_command_names())
189
names.update(plugin_command_names())
193
def all_command_names():
194
"""Return a set of all command names."""
196
for hook in Command.hooks['list_commands']:
199
raise AssertionError(
200
'hook %s returned None' % Command.hooks.get_hook_name(hook))
204
170
def builtin_command_names():
205
"""Return list of builtin command names.
171
"""Return list of builtin command names."""
172
return _builtin_commands().keys()
207
Use of all_command_names() is encouraged rather than builtin_command_names
208
and/or plugin_command_names.
210
_register_builtin_commands()
211
return builtin_command_registry.keys()
214
175
def plugin_command_names():
215
"""Returns command names from commands registered by plugins."""
216
176
return plugin_cmds.keys()
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():
219
193
def get_cmd_object(cmd_name, plugins_override=True):
220
"""Return the command object for a command.
194
"""Return the canonical name and command class for a command.
223
197
If true, plugin commands can override builtins.
226
return _get_cmd_object(cmd_name, plugins_override)
228
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
231
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
232
"""Get a command object.
234
:param cmd_name: The name of the command.
235
:param plugins_override: Allow plugins to override builtins.
236
:param check_missing: Look up commands not found in the regular index via
237
the get_missing_command hook.
238
:return: A Command object instance
239
:raises KeyError: If no command is found.
241
# We want only 'ascii' command names, but the user may have typed
242
# in a Unicode name. In that case, they should just get a
243
# 'command not found' error later.
244
# In the future, we may actually support Unicode command names.
247
for hook in Command.hooks['get_command']:
248
cmd = hook(cmd, cmd_name)
249
if cmd is not None and not plugins_override and not cmd.plugin_name():
250
# We've found a non-plugin command, don't permit it to be
253
if cmd is None and check_missing:
254
for hook in Command.hooks['get_missing_command']:
261
# Allow plugins to extend commands
262
for hook in Command.hooks['extend_command']:
264
if getattr(cmd, 'invoked_as', None) is None:
265
cmd.invoked_as = cmd_name
269
def _try_plugin_provider(cmd_name):
270
"""Probe for a plugin provider having cmd_name."""
272
plugin_metadata, provider = probe_for_provider(cmd_name)
273
raise errors.CommandAvailableInPlugin(cmd_name,
274
plugin_metadata, provider)
275
except errors.NoPluginAvailable:
279
def probe_for_provider(cmd_name):
280
"""Look for a provider for cmd_name.
282
:param cmd_name: The command name.
283
:return: plugin_metadata, provider for getting cmd_name.
284
:raises NoPluginAvailable: When no provider can supply the plugin.
286
# look for providers that provide this command but aren't installed
287
for provider in command_providers_registry:
289
return provider.plugin_for_command(cmd_name), provider
290
except errors.NoPluginAvailable:
292
raise errors.NoPluginAvailable(cmd_name)
295
def _get_bzr_command(cmd_or_None, cmd_name):
296
"""Get a command from bzr's core."""
298
cmd_class = builtin_command_registry.get(cmd_name)
306
def _get_external_command(cmd_or_None, cmd_name):
307
"""Lookup a command that is a shell script."""
308
# Only do external command lookups when no command is found so far.
309
if cmd_or_None is not None:
311
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:
312
215
cmd_obj = ExternalCommand.find_command(cmd_name)
317
def _get_plugin_command(cmd_or_None, cmd_name):
318
"""Get a command from bzr's plugins."""
320
return plugin_cmds.get(cmd_name)()
323
for key in plugin_cmds.keys():
324
info = plugin_cmds.get_info(key)
325
if cmd_name in info.aliases:
326
return plugin_cmds.get(key)()
219
raise BzrCommandError("unknown command %r" % cmd_name)
330
222
class Command(object):
345
237
summary, then a complete description of the command. A grammar
346
238
description will be inserted.
348
:cvar aliases: Other accepted names for this command.
350
:cvar takes_args: List of argument forms, marked with whether they are
351
optional, repeated, etc. Examples::
353
['to_location', 'from_branch?', 'file*']
355
* 'to_location' is required
356
* 'from_branch' is optional
357
* 'file' can be specified 0 or more times
359
:cvar takes_options: List of options that may be given for this command.
360
These can be either strings, referring to globally-defined options, or
361
option objects. Retrieve through options().
363
: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
364
252
for commands intended for expert users.
366
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
367
been setup to properly handle encoding of unicode strings.
368
encoding_type determines what will happen when characters cannot be
371
* strict - abort if we cannot decode
372
* replace - put in a bogus character (typically '?')
373
* exact - do not encode sys.stdout
375
NOTE: by default on Windows, sys.stdout is opened as a text stream,
376
therefore LF line-endings are converted to CRLF. When a command uses
377
encoding_type = 'exact', then sys.stdout is forced to be a binary
378
stream, and line-endings will not mangled.
381
A string indicating the real name under which this command was
382
invoked, before expansion of aliases.
383
(This may be None if the command was constructed and run in-process.)
385
:cvar hooks: An instance of CommandHooks.
387
:cvar __doc__: The help shown by 'bzr help command' for this command.
388
This is set by assigning explicitly to __doc__ so that -OO can
392
__doc__ = "My help goes here"
396
257
takes_options = []
397
encoding_type = 'strict'
403
261
def __init__(self):
404
262
"""Construct an instance of this command."""
405
# List of standard options directly supported
406
self.supported_std_options = []
409
def add_cleanup(self, cleanup_func, *args, **kwargs):
410
"""Register a function to call after self.run returns or raises.
412
Functions will be called in LIFO order.
414
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
416
def cleanup_now(self):
417
"""Execute and empty pending cleanup functions immediately.
419
After cleanup_now all registered cleanups are forgotten. add_cleanup
420
may be called again after cleanup_now; these cleanups will be called
421
after self.run returns or raises (or when cleanup_now is next called).
423
This is useful for releasing expensive or contentious resources (such
424
as write locks) before doing further work that does not require those
425
resources (such as writing results to self.outf). Note though, that
426
as it releases all resources, this may release locks that the command
427
wants to hold, so use should be done with care.
429
self._operation.cleanup_now()
432
"""Return single-line grammar for this command.
434
Only describes arguments, not options.
436
s = 'bzr ' + self.name() + ' '
437
for aname in self.takes_args:
438
aname = aname.upper()
439
if aname[-1] in ['$', '+']:
440
aname = aname[:-1] + '...'
441
elif aname[-1] == '?':
442
aname = '[' + aname[:-1] + ']'
443
elif aname[-1] == '*':
444
aname = '[' + aname[:-1] + '...]'
446
s = s[:-1] # remove last space
449
def get_help_text(self, additional_see_also=None, plain=True,
450
see_also_as_links=False, verbose=True):
451
"""Return a text string with help for this command.
453
:param additional_see_also: Additional help topics to be
455
:param plain: if False, raw help (reStructuredText) is
456
returned instead of plain text.
457
:param see_also_as_links: if True, convert items in 'See also'
458
list to internal links (used by bzr_man rstx generator)
459
:param verbose: if True, display the full help, otherwise
460
leave out the descriptive sections and just display
461
usage help (e.g. Purpose, Usage, Options) with a
462
message explaining how to obtain full help.
465
i18n.install() # Install i18n only for get_help_text for now.
468
# Note: If self.gettext() translates ':Usage:\n', the section will
469
# be shown after "Description" section and we don't want to
470
# translate the usage string.
471
# Though, bzr export-pot don't exports :Usage: section and it must
473
doc = self.gettext(doc)
475
doc = gettext("No help for this command.")
477
# Extract the summary (purpose) and sections out from the text
478
purpose,sections,order = self._get_help_parts(doc)
480
# If a custom usage section was provided, use it
481
if sections.has_key('Usage'):
482
usage = sections.pop('Usage')
484
usage = self._usage()
486
# The header is the purpose and usage
488
result += gettext(':Purpose: %s\n') % (purpose,)
489
if usage.find('\n') >= 0:
490
result += gettext(':Usage:\n%s\n') % (usage,)
492
result += gettext(':Usage: %s\n') % (usage,)
497
# XXX: optparse implicitly rewraps the help, and not always perfectly,
498
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
500
parser = option.get_optparser(self.options())
501
options = parser.format_option_help()
502
# FIXME: According to the spec, ReST option lists actually don't
503
# support options like --1.14 so that causes syntax errors (in Sphinx
504
# at least). As that pattern always appears in the commands that
505
# break, we trap on that and then format that block of 'format' options
506
# as a literal block. We use the most recent format still listed so we
507
# don't have to do that too often -- vila 20110514
508
if not plain and options.find(' --1.14 ') != -1:
509
options = options.replace(' format:\n', ' format::\n\n', 1)
510
if options.startswith('Options:'):
511
result += gettext(':Options:%s') % (options[len('options:'):],)
517
# Add the description, indenting it 2 spaces
518
# to match the indentation of the options
519
if sections.has_key(None):
520
text = sections.pop(None)
521
text = '\n '.join(text.splitlines())
522
result += gettext(':Description:\n %s\n\n') % (text,)
524
# Add the custom sections (e.g. Examples). Note that there's no need
525
# to indent these as they must be indented already in the source.
528
if label in sections:
529
result += ':%s:\n%s\n' % (label, sections[label])
532
result += (gettext("See bzr help %s for more details and examples.\n\n")
535
# Add the aliases, source (plug-in) and see also links, if any
537
result += gettext(':Aliases: ')
538
result += ', '.join(self.aliases) + '\n'
539
plugin_name = self.plugin_name()
540
if plugin_name is not None:
541
result += gettext(':From: plugin "%s"\n') % plugin_name
542
see_also = self.get_see_also(additional_see_also)
544
if not plain and see_also_as_links:
546
for item in see_also:
548
# topics doesn't have an independent section
549
# so don't create a real link
550
see_also_links.append(item)
552
# Use a Sphinx link for this entry
553
link_text = gettext(":doc:`{0} <{1}-help>`").format(
555
see_also_links.append(link_text)
556
see_also = see_also_links
557
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
559
# If this will be rendered as plain text, convert it
561
import bzrlib.help_topics
562
result = bzrlib.help_topics.help_as_plain_text(result)
566
def _get_help_parts(text):
567
"""Split help text into a summary and named sections.
569
:return: (summary,sections,order) where summary is the top line and
570
sections is a dictionary of the rest indexed by section name.
571
order is the order the section appear in the text.
572
A section starts with a heading line of the form ":xxx:".
573
Indented text on following lines is the section value.
574
All text found outside a named section is assigned to the
575
default section which is given the key of None.
577
def save_section(sections, order, label, section):
579
if sections.has_key(label):
580
sections[label] += '\n' + section
583
sections[label] = section
585
lines = text.rstrip().splitlines()
586
summary = lines.pop(0)
589
label,section = None,''
591
if line.startswith(':') and line.endswith(':') and len(line) > 2:
592
save_section(sections, order, label, section)
593
label,section = line[1:-1],''
594
elif (label is not None) and len(line) > 1 and not line[0].isspace():
595
save_section(sections, order, label, section)
596
label,section = None,line
599
section += '\n' + line
602
save_section(sections, order, label, section)
603
return summary, sections, order
605
def get_help_topic(self):
606
"""Return the commands help topic - its name."""
609
def get_see_also(self, additional_terms=None):
610
"""Return a list of help topics that are related to this command.
612
The list is derived from the content of the _see_also attribute. Any
613
duplicates are removed and the result is in lexical order.
614
:param additional_terms: Additional help topics to cross-reference.
615
:return: A list of help topics.
617
see_also = set(getattr(self, '_see_also', []))
619
see_also.update(additional_terms)
620
return sorted(see_also)
623
"""Return dict of valid options for this command.
625
Maps from long option name to option object."""
626
r = Option.STD_OPTIONS.copy()
628
for o in self.takes_options:
629
if isinstance(o, basestring):
630
o = option.Option.OPTIONS[o]
632
if o.name in std_names:
633
self.supported_std_options.append(o.name)
636
def _setup_outf(self):
637
"""Return a file linked to stdout, which has proper encoding."""
638
self.outf = ui.ui_factory.make_output_stream(
639
encoding_type=self.encoding_type)
641
def run_argv_aliases(self, argv, alias_argv=None):
642
"""Parse the command line and run with extra aliases in alias_argv."""
643
args, opts = parse_args(self, argv, alias_argv)
646
# Process the standard options
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)
647
271
if 'help' in opts: # e.g. bzr add --help
648
self.outf.write(self.get_help_text())
650
if 'usage' in opts: # e.g. bzr add --usage
651
self.outf.write(self.get_help_text(verbose=False))
653
trace.set_verbosity_level(option._verbosity_level)
654
if 'verbose' in self.supported_std_options:
655
opts['verbose'] = trace.is_verbose()
656
elif opts.has_key('verbose'):
658
if 'quiet' in self.supported_std_options:
659
opts['quiet'] = trace.is_quiet()
660
elif opts.has_key('quiet'):
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()))
662
283
# mix arguments and options into one dictionary
663
284
cmdargs = _match_argform(self.name(), self.takes_args, args)
705
301
Return 0 or None if the command was successful, or a non-zero
706
302
shell error code if not. It's OK for this method to allow
707
303
an exception to raise up.
709
This method is automatically wrapped by Command.__init__ with a
710
cleanup operation, stored as self._operation. This can be used
711
via self.add_cleanup to perform automatic cleanups at the end of
714
The argument for run are assembled by introspection. So for instance,
715
if your command takes an argument files, you would declare::
717
def run(self, files=None):
720
raise NotImplementedError('no implementation of command %r'
305
raise NotImplementedError()
724
309
"""Return help message for this class."""
725
from inspect import getdoc
726
310
if self.__doc__ is Command.__doc__:
728
312
return getdoc(self)
730
def gettext(self, message):
731
"""Returns the gettext function used to translate this command's help.
733
Commands provided by plugins should override this to use their
736
return i18n.gettext_per_paragraph(message)
739
"""Return the canonical name for this command.
741
The name under which it was actually invoked is available in invoked_as.
743
315
return _unsquish_command_name(self.__class__.__name__)
745
def plugin_name(self):
746
"""Get the name of the plugin that provides this command.
748
:return: The name of the plugin or None if the command is builtin.
750
mod_parts = self.__module__.split('.')
751
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
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
757
class CommandHooks(Hooks):
758
"""Hooks related to Command object creation/enumeration."""
761
"""Create the default hooks.
763
These are all empty initially, because by default nothing should get
766
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
767
self.add_hook('extend_command',
768
"Called after creating a command object to allow modifications "
769
"such as adding or removing options, docs etc. Called with the "
770
"new bzrlib.commands.Command object.", (1, 13))
771
self.add_hook('get_command',
772
"Called when creating a single command. Called with "
773
"(cmd_or_None, command_name). get_command should either return "
774
"the cmd_or_None parameter, or a replacement Command object that "
775
"should be used for the command. Note that the Command.hooks "
776
"hooks are core infrastructure. Many users will prefer to use "
777
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
779
self.add_hook('get_missing_command',
780
"Called when creating a single command if no command could be "
781
"found. Called with (command_name). get_missing_command should "
782
"either return None, or a Command object to be used for the "
784
self.add_hook('list_commands',
785
"Called when enumerating commands. Called with a set of "
786
"cmd_name strings for all the commands found so far. This set "
787
" is safe to mutate - e.g. to remove a command. "
788
"list_commands should return the updated set of command names.",
791
Command.hooks = CommandHooks()
794
def parse_args(command, argv, alias_argv=None):
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):
795
391
"""Parse command line.
797
393
Arguments and options are parsed at this level before being passed
798
394
down to specific command handlers. This routine knows, from a
799
395
lookup table, something about the available options, what optargs
800
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>]})
802
# TODO: make it a method of the Command?
803
parser = option.get_optparser(command.options())
804
if alias_argv is not None:
805
args = alias_argv + argv
809
# for python 2.5 and later, optparse raises this exception if a non-ascii
810
# option name is given. See http://bugs.python.org/issue2931
812
options, args = parser.parse_args(args)
813
except UnicodeEncodeError,e:
814
raise errors.BzrCommandError(
815
gettext('Only ASCII permitted in option names'))
817
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
818
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)
819
489
return args, opts
822
494
def _match_argform(cmd, takes_args, args):
836
508
argdict[argname + '_list'] = None
837
509
elif ap[-1] == '+':
839
raise errors.BzrCommandError(gettext(
840
"command {0!r} needs one or more {1}").format(
841
cmd, argname.upper()))
511
raise BzrCommandError("command %r needs one or more %s"
512
% (cmd, argname.upper()))
843
514
argdict[argname + '_list'] = args[:]
845
516
elif ap[-1] == '$': # all but one
846
517
if len(args) < 2:
847
raise errors.BzrCommandError(
848
gettext("command {0!r} needs one or more {1}").format(
849
cmd, argname.upper()))
518
raise BzrCommandError("command %r needs one or more %s"
519
% (cmd, argname.upper()))
850
520
argdict[argname + '_list'] = args[:-1]
853
523
# just a plain arg
856
raise errors.BzrCommandError(
857
gettext("command {0!r} requires argument {1}").format(
858
cmd, argname.upper()))
526
raise BzrCommandError("command %r requires argument %s"
527
% (cmd, argname.upper()))
860
529
argdict[argname] = args.pop(0)
863
raise errors.BzrCommandError( gettext(
864
"extra argument to command {0}: {1}").format(
532
raise BzrCommandError("extra argument to command %s: %s"
869
def apply_coveraged(dirname, the_callable, *args, **kwargs):
870
# Cannot use "import trace", as that would import bzrlib.trace instead of
871
# the standard library's trace.
872
trace = __import__('trace')
874
tracer = trace.Trace(count=1, trace=0)
875
sys.settrace(tracer.globaltrace)
876
threading.settrace(tracer.globaltrace)
879
return exception_to_return_code(the_callable, *args, **kwargs)
882
results = tracer.results()
883
results.write_results(show_missing=1, summary=False,
887
539
def apply_profiled(the_callable, *args, **kwargs):
891
542
pffileno, pfname = tempfile.mkstemp()
893
544
prof = hotshot.Profile(pfname)
895
ret = prof.runcall(exception_to_return_code, the_callable, *args,
546
ret = prof.runcall(the_callable, *args, **kwargs) or 0
899
551
stats = hotshot.stats.load(pfname)
901
stats.sort_stats('cum') # 'time'
553
stats.sort_stats('time')
902
554
## XXX: Might like to write to stderr or the trace file instead but
903
555
## print_stats seems hardcoded to stdout
904
556
stats.print_stats(20)
907
560
os.close(pffileno)
908
561
os.remove(pfname)
911
def exception_to_return_code(the_callable, *args, **kwargs):
912
"""UI level helper for profiling and coverage.
914
This transforms exceptions into a return value of 3. As such its only
915
relevant to the UI layer, and should never be called where catching
916
exceptions may be desirable.
919
return the_callable(*args, **kwargs)
920
except (KeyboardInterrupt, Exception), e:
921
# used to handle AssertionError and KeyboardInterrupt
922
# specially here, but hopefully they're handled ok by the logger now
923
exc_info = sys.exc_info()
924
exitcode = trace.report_exception(exc_info, sys.stderr)
925
if os.environ.get('BZR_PDB'):
926
print '**** entering debugger'
929
if sys.version_info[:2] < (2, 6):
931
# pdb.post_mortem(tb)
932
# but because pdb.post_mortem gives bad results for tracebacks
933
# from inside generators, we do it manually.
934
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
936
# Setup pdb on the traceback
939
p.setup(tb.tb_frame, tb)
940
# Point the debugger at the deepest frame of the stack
941
p.curindex = len(p.stack) - 1
942
p.curframe = p.stack[p.curindex][0]
943
# Start the pdb prompt.
944
p.print_stack_entry(p.stack[p.curindex])
952
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
953
from bzrlib.lsprof import profile
954
ret, stats = profile(exception_to_return_code, the_callable,
961
trace.note(gettext('Profile data written to "%s".'), filename)
965
def get_alias(cmd, config=None):
966
"""Return an expanded alias, or None if no alias exists.
969
Command to be checked for an alias.
971
Used to specify an alternative config to use,
972
which is especially useful for testing.
973
If it is unspecified, the global config will be used.
977
config = bzrlib.config.GlobalConfig()
978
alias = config.get_alias(cmd)
980
return cmdline.split(alias)
984
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
985
565
"""Execute a command.
987
:param argv: The command-line arguments, without the program name from
988
argv[0] These should already be decoded. All library/test code calling
989
run_bzr should be passing valid strings (don't need decoding).
990
:param load_plugins: What function to call when triggering plugin loading.
991
This function should take no arguments and cause all plugins to be
993
:param disable_plugins: What function to call when disabling plugin
994
loading. This function should take no arguments and cause all plugin
995
loading to be prohibited (so that code paths in your application that
996
know about some plugins possibly being present will fail to import
997
those plugins even if they are installed.)
998
: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.
1000
575
Special master options: these must come before the command because
1001
576
they control how the command is interpreted.
1004
579
Do not load plugin modules at all
1007
Do not allow aliases
1010
582
Only use builtin commands. (Plugins are still allowed to change
1011
583
other behaviour.)
1014
Run under the Python hotshot profiler.
1017
Run under the Python lsprof profiler.
1020
Generate line coverage report in the specified directory.
1023
Specify the number of processes that can be run concurrently (selftest).
586
Run under the Python profiler.
1025
trace.mutter("bazaar version: " + bzrlib.__version__)
1026
argv = _specified_or_unicode_argv(argv)
1027
trace.mutter("bzr arguments: %r", argv)
589
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1029
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1030
opt_no_l10n = opt_no_aliases = False
1031
opt_lsprof_file = opt_coverage_dir = None
591
opt_profile = opt_no_plugins = opt_builtin = False
1033
593
# --no-plugins is handled specially at a very early stage. We need
1034
594
# to load plugins before doing other command parsing so that they
1035
595
# can override commands, but this needs to happen first.
1039
override_config = []
1040
while i < len(argv):
1042
598
if a == '--profile':
1043
599
opt_profile = True
1044
elif a == '--lsprof':
1046
elif a == '--lsprof-file':
1048
opt_lsprof_file = argv[i + 1]
1050
600
elif a == '--no-plugins':
1051
601
opt_no_plugins = True
1052
elif a == '--no-aliases':
1053
opt_no_aliases = True
1054
elif a == '--no-l10n':
1056
602
elif a == '--builtin':
1057
603
opt_builtin = True
1058
elif a == '--concurrency':
1059
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1061
elif a == '--coverage':
1062
opt_coverage_dir = argv[i + 1]
1064
elif a == '--profile-imports':
1065
pass # already handled in startup script Bug #588277
1066
elif a.startswith('-D'):
1067
debug.debug_flags.add(a[2:])
1068
elif a.startswith('-O'):
1069
override_config.append(a[2:])
1074
bzrlib.global_state.cmdline_overrides._from_cmdline(override_config)
1076
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
1078
621
if not opt_no_plugins:
622
from bzrlib.plugin import load_plugins
1085
get_cmd_object('help').run_argv_aliases([])
1088
if argv[0] == '--version':
1089
get_cmd_object('version').run_argv_aliases([])
1094
if not opt_no_aliases:
1095
alias_argv = get_alias(argv[0])
1097
argv[0] = alias_argv.pop(0)
625
cmd = str(argv.pop(0))
1100
627
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1103
run = cmd_obj.run_argv_aliases
1104
run_argv = [argv, alias_argv]
1107
# We can be called recursively (tests for example), but we don't want
1108
# the verbosity level to propagate.
1109
saved_verbosity_level = option._verbosity_level
1110
option._verbosity_level = 0
1112
if opt_coverage_dir:
1114
'--coverage ignored, because --lsprof is in use.')
1115
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1117
if opt_coverage_dir:
1119
'--coverage ignored, because --profile is in use.')
1120
ret = apply_profiled(run, *run_argv)
1121
elif opt_coverage_dir:
1122
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1124
ret = run(*run_argv)
1127
# reset, in case we may do other commands later within the same
1128
# process. Commands that want to execute sub-commands must propagate
1129
# --verbose in their own way.
1130
if 'memory' in debug.debug_flags:
1131
trace.debug_memory('Process status after command:', short=False)
1132
option._verbosity_level = saved_verbosity_level
1133
# Reset the overrides
1134
bzrlib.global_state.cmdline_overrides._reset()
1137
def display_command(func):
1138
"""Decorator that suppresses pipe/interrupt errors."""
1139
def ignore_pipe(*args, **kwargs):
1141
result = func(*args, **kwargs)
1145
if getattr(e, 'errno', None) is None:
1147
if e.errno != errno.EPIPE:
1148
# Win32 raises IOError with errno=0 on a broken pipe
1149
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1152
except KeyboardInterrupt:
1157
def install_bzr_command_hooks():
1158
"""Install the hooks to supply bzr's own commands."""
1159
if _list_bzr_commands in Command.hooks["list_commands"]:
1161
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1163
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1165
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1166
"bzr plugin commands")
1167
Command.hooks.install_named_hook("get_command", _get_external_command,
1168
"bzr external command lookup")
1169
Command.hooks.install_named_hook("get_missing_command",
1170
_try_plugin_provider,
1171
"bzr plugin-provider-db check")
1175
def _specified_or_unicode_argv(argv):
1176
# For internal or testing use, argv can be passed. Otherwise, get it from
1177
# the process arguments in a unicode-safe way.
1179
return osutils.get_unicode_argv()
630
ret = apply_profiled(cmd_obj.run_argv, argv)
1183
# ensure all arguments are unicode strings
1185
if isinstance(a, unicode):
1188
new_argv.append(a.decode('ascii'))
1189
except UnicodeDecodeError:
1190
raise errors.BzrError("argv should be list of unicode strings.")
1194
def main(argv=None):
1195
"""Main entry point of command-line interface.
1197
Typically `bzrlib.initialize` should be called first.
1199
:param argv: list of unicode command-line arguments similar to sys.argv.
1200
argv[0] is script name usually, it will be ignored.
1201
Don't pass here sys.argv because this list contains plain strings
1202
and not unicode; pass None instead.
1204
:return: exit code of bzr command.
1206
if argv is not None:
1208
_register_builtin_commands()
1209
ret = run_bzr_catch_errors(argv)
1210
trace.mutter("return code %d", ret)
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:])
1214
644
def run_bzr_catch_errors(argv):
1215
"""Run a bzr command with parameters as described by argv.
1217
This function assumed that that UI layer is setup, that symbol deprecations
1218
are already applied, and that unicode decoding has already been performed on argv.
1220
# done here so that they're covered for every test run
1221
install_bzr_command_hooks()
1222
return exception_to_return_code(run_bzr, argv)
1225
def run_bzr_catch_user_errors(argv):
1226
"""Run bzr and report user errors, but let internal errors propagate.
1228
This is used for the test suite, and might be useful for other programs
1229
that want to wrap the commandline interface.
1231
# done here so that they're covered for every test run
1232
install_bzr_command_hooks()
1234
return run_bzr(argv)
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')
1235
668
except Exception, e:
1236
if (isinstance(e, (OSError, IOError))
1237
or not getattr(e, 'internal_error', True)):
1238
trace.report_exception(sys.exc_info(), sys.stderr)
1244
class HelpCommandIndex(object):
1245
"""A index for bzr help that returns commands."""
1248
self.prefix = 'commands/'
1250
def get_topics(self, topic):
1251
"""Search for topic amongst commands.
1253
:param topic: A topic to search for.
1254
:return: A list which is either empty or contains a single
1257
if topic and topic.startswith(self.prefix):
1258
topic = topic[len(self.prefix):]
1260
cmd = _get_cmd_object(topic, check_missing=False)
1267
class Provider(object):
1268
"""Generic class to be overriden by plugins"""
1270
def plugin_for_command(self, cmd_name):
1271
"""Takes a command and returns the information for that plugin
1273
:return: A dictionary with all the available information
1274
for the requested plugin
1276
raise NotImplementedError
1279
class ProvidersRegistry(registry.Registry):
1280
"""This registry exists to allow other providers to exist"""
1283
for key, provider in self.iteritems():
1286
command_providers_registry = ProvidersRegistry()
670
if (isinstance(e, IOError)
671
and hasattr(e, 'errno')
672
and e.errno == errno.EPIPE):
673
bzrlib.trace.note('broken pipe')
676
bzrlib.trace.log_exception()
680
if __name__ == '__main__':
681
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
