1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2005-2011 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., 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.
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
23
19
# TODO: Define arguments by objects, rather than just using names.
24
20
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
27
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
28
# the profile output behind so it can be interactively examined?
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.
32
from warnings import warn
33
from inspect import getdoc
29
from bzrlib.lazy_import import lazy_import
30
lazy_import(globals(), """
38
from bzrlib.trace import mutter, note, log_error, warning
39
from bzrlib.errors import (BzrError,
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib import BZRDIR
49
from bzrlib.hooks import Hooks
50
from bzrlib.i18n import gettext
51
# Compatibility - Option used to be in commands.
46
52
from bzrlib.option import Option
53
from bzrlib.plugin import disable_plugins, load_plugins
54
from bzrlib import registry
57
class CommandInfo(object):
58
"""Information about a command."""
60
def __init__(self, aliases):
61
"""The list of aliases for the command."""
62
self.aliases = aliases
65
def from_command(klass, command):
66
"""Factory to construct a CommandInfo from a command."""
67
return klass(command.aliases)
70
class CommandRegistry(registry.Registry):
71
"""Special registry mapping command names to command classes.
73
:ivar overridden_registry: Look in this registry for commands being
74
overridden by this registry. This can be used to tell plugin commands
75
about the builtin they're decorating.
79
registry.Registry.__init__(self)
80
self.overridden_registry = None
81
# map from aliases to the real command that implements the name
84
def get(self, command_name):
85
real_name = self._alias_dict.get(command_name, command_name)
86
return registry.Registry.get(self, real_name)
89
def _get_name(command_name):
90
if command_name.startswith("cmd_"):
91
return _unsquish_command_name(command_name)
95
def register(self, cmd, decorate=False):
96
"""Utility function to help register a command
98
:param cmd: Command subclass to register
99
:param decorate: If true, allow overriding an existing command
100
of the same name; the old command is returned by this function.
101
Otherwise it is an error to try to override an existing command.
104
k_unsquished = self._get_name(k)
106
previous = self.get(k_unsquished)
109
if self.overridden_registry:
111
previous = self.overridden_registry.get(k_unsquished)
114
info = CommandInfo.from_command(cmd)
116
registry.Registry.register(self, k_unsquished, cmd,
117
override_existing=decorate, info=info)
119
trace.warning('Two plugins defined the same command: %r' % k)
120
trace.warning('Not loading the one in %r' %
121
sys.modules[cmd.__module__])
122
trace.warning('Previously this command was registered from %r' %
123
sys.modules[previous.__module__])
124
for a in cmd.aliases:
125
self._alias_dict[a] = k_unsquished
128
def register_lazy(self, command_name, aliases, module_name):
129
"""Register a command without loading its module.
131
:param command_name: The primary name of the command.
132
:param aliases: A list of aliases for the command.
133
:module_name: The module that the command lives in.
135
key = self._get_name(command_name)
136
registry.Registry.register_lazy(self, key, module_name, command_name,
137
info=CommandInfo(aliases))
139
self._alias_dict[a] = key
142
plugin_cmds = CommandRegistry()
143
builtin_command_registry = CommandRegistry()
144
plugin_cmds.overridden_registry = builtin_command_registry
51
147
def register_command(cmd, decorate=False):
52
"Utility function to help register a command"
148
"""Register a plugin command.
150
Should generally be avoided in favor of lazy registration.
53
152
global plugin_cmds
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)
62
if decorate and k_unsquished in builtin_command_names():
63
return _builtin_commands()[k_unsquished]
65
result = plugin_cmds[k_unsquished]
66
plugin_cmds[k_unsquished] = cmd
69
log_error('Two plugins defined the same command: %r' % k)
70
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
153
return plugin_cmds.register(cmd, decorate)
73
156
def _squish_command_name(cmd):
77
160
def _unsquish_command_name(cmd):
78
assert cmd.startswith("cmd_")
79
161
return cmd[4:].replace('_','-')
82
def _builtin_commands():
164
def _register_builtin_commands():
165
if builtin_command_registry.keys():
83
168
import bzrlib.builtins
169
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
170
builtin_command_registry.register(cmd_class)
171
bzrlib.builtins._register_lazy_builtins()
174
def _scan_module_for_commands(module):
85
builtins = bzrlib.builtins.__dict__
176
for name, obj in module.__dict__.iteritems():
87
177
if name.startswith("cmd_"):
88
real_name = _unsquish_command_name(name)
89
r[real_name] = builtins[name]
178
real_name = _unsquish_command_name(name)
183
def _list_bzr_commands(names):
184
"""Find commands from bzr's core and plugins.
186
This is not the public interface, just the default hook called by all_command_names.
188
# to eliminate duplicates
189
names.update(builtin_command_names())
190
names.update(plugin_command_names())
194
def all_command_names():
195
"""Return a set of all command names."""
197
for hook in Command.hooks['list_commands']:
200
raise AssertionError(
201
'hook %s returned None' % Command.hooks.get_hook_name(hook))
94
205
def builtin_command_names():
95
"""Return list of builtin command names."""
96
return _builtin_commands().keys()
206
"""Return list of builtin command names.
208
Use of all_command_names() is encouraged rather than builtin_command_names
209
and/or plugin_command_names.
211
_register_builtin_commands()
212
return builtin_command_registry.keys()
99
215
def plugin_command_names():
216
"""Returns command names from commands registered by plugins."""
100
217
return plugin_cmds.keys()
103
def _get_cmd_dict(plugins_override=True):
104
"""Return name->class mapping for all commands."""
105
d = _builtin_commands()
107
d.update(plugin_cmds)
111
def get_all_cmds(plugins_override=True):
112
"""Return canonical name and class for all registered commands."""
113
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
117
220
def get_cmd_object(cmd_name, plugins_override=True):
118
"""Return the canonical name and command class for a command.
221
"""Return the command object for a command.
121
224
If true, plugin commands can override builtins.
227
return _get_cmd_object(cmd_name, plugins_override)
229
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
232
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
233
"""Get a command object.
235
:param cmd_name: The name of the command.
236
:param plugins_override: Allow plugins to override builtins.
237
:param check_missing: Look up commands not found in the regular index via
238
the get_missing_command hook.
239
:return: A Command object instance
240
:raises KeyError: If no command is found.
242
# We want only 'ascii' command names, but the user may have typed
243
# in a Unicode name. In that case, they should just get a
244
# 'command not found' error later.
245
# In the future, we may actually support Unicode command names.
248
for hook in Command.hooks['get_command']:
249
cmd = hook(cmd, cmd_name)
250
if cmd is not None and not plugins_override and not cmd.plugin_name():
251
# We've found a non-plugin command, don't permit it to be
254
if cmd is None and check_missing:
255
for hook in Command.hooks['get_missing_command']:
262
# Allow plugins to extend commands
263
for hook in Command.hooks['extend_command']:
265
if getattr(cmd, 'invoked_as', None) is None:
266
cmd.invoked_as = cmd_name
270
def _try_plugin_provider(cmd_name):
271
"""Probe for a plugin provider having cmd_name."""
273
plugin_metadata, provider = probe_for_provider(cmd_name)
274
raise errors.CommandAvailableInPlugin(cmd_name,
275
plugin_metadata, provider)
276
except errors.NoPluginAvailable:
280
def probe_for_provider(cmd_name):
281
"""Look for a provider for cmd_name.
283
:param cmd_name: The command name.
284
:return: plugin_metadata, provider for getting cmd_name.
285
:raises NoPluginAvailable: When no provider can supply the plugin.
287
# look for providers that provide this command but aren't installed
288
for provider in command_providers_registry:
290
return provider.plugin_for_command(cmd_name), provider
291
except errors.NoPluginAvailable:
293
raise errors.NoPluginAvailable(cmd_name)
296
def _get_bzr_command(cmd_or_None, cmd_name):
297
"""Get a command from bzr's core."""
299
cmd_class = builtin_command_registry.get(cmd_name)
307
def _get_external_command(cmd_or_None, cmd_name):
308
"""Lookup a command that is a shell script."""
309
# Only do external command lookups when no command is found so far.
310
if cmd_or_None is not None:
123
312
from bzrlib.externalcommand import ExternalCommand
125
cmd_name = str(cmd_name) # not unicode
127
# first look up this command under the specified name
128
cmds = _get_cmd_dict(plugins_override=plugins_override)
130
return cmds[cmd_name]()
134
# look for any command which claims this as an alias
135
for real_cmd_name, cmd_class in cmds.iteritems():
136
if cmd_name in cmd_class.aliases:
139
313
cmd_obj = ExternalCommand.find_command(cmd_name)
143
raise BzrCommandError("unknown command %r" % cmd_name)
318
def _get_plugin_command(cmd_or_None, cmd_name):
319
"""Get a command from bzr's plugins."""
321
return plugin_cmds.get(cmd_name)()
324
for key in plugin_cmds.keys():
325
info = plugin_cmds.get_info(key)
326
if cmd_name in info.aliases:
327
return plugin_cmds.get(key)()
146
331
class Command(object):
161
346
summary, then a complete description of the command. A grammar
162
347
description will be inserted.
165
Other accepted names for this command.
168
List of argument forms, marked with whether they are optional,
173
['to_location', 'from_branch?', 'file*']
175
'to_location' is required
176
'from_branch' is optional
177
'file' can be specified 0 or more times
180
List of options that may be given for this command. These can
181
be either strings, referring to globally-defined options,
182
or option objects. Retrieve through options().
185
If true, this command isn't advertised. This is typically
349
:cvar aliases: Other accepted names for this command.
351
:cvar takes_args: List of argument forms, marked with whether they are
352
optional, repeated, etc. Examples::
354
['to_location', 'from_branch?', 'file*']
356
* 'to_location' is required
357
* 'from_branch' is optional
358
* 'file' can be specified 0 or more times
360
:cvar takes_options: List of options that may be given for this command.
361
These can be either strings, referring to globally-defined options, or
362
option objects. Retrieve through options().
364
:cvar hidden: If true, this command isn't advertised. This is typically
186
365
for commands intended for expert users.
367
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
368
been setup to properly handle encoding of unicode strings.
369
encoding_type determines what will happen when characters cannot be
372
* strict - abort if we cannot decode
373
* replace - put in a bogus character (typically '?')
374
* exact - do not encode sys.stdout
376
NOTE: by default on Windows, sys.stdout is opened as a text stream,
377
therefore LF line-endings are converted to CRLF. When a command uses
378
encoding_type = 'exact', then sys.stdout is forced to be a binary
379
stream, and line-endings will not mangled.
382
A string indicating the real name under which this command was
383
invoked, before expansion of aliases.
384
(This may be None if the command was constructed and run in-process.)
386
:cvar hooks: An instance of CommandHooks.
388
:cvar __doc__: The help shown by 'bzr help command' for this command.
389
This is set by assigning explicitly to __doc__ so that -OO can
393
__doc__ = "My help goes here"
190
397
takes_options = []
398
encoding_type = 'strict'
194
404
def __init__(self):
195
405
"""Construct an instance of this command."""
196
if self.__doc__ == Command.__doc__:
197
warn("No help message set for %r" % self)
406
# List of standard options directly supported
407
self.supported_std_options = []
410
def add_cleanup(self, cleanup_func, *args, **kwargs):
411
"""Register a function to call after self.run returns or raises.
413
Functions will be called in LIFO order.
415
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
417
def cleanup_now(self):
418
"""Execute and empty pending cleanup functions immediately.
420
After cleanup_now all registered cleanups are forgotten. add_cleanup
421
may be called again after cleanup_now; these cleanups will be called
422
after self.run returns or raises (or when cleanup_now is next called).
424
This is useful for releasing expensive or contentious resources (such
425
as write locks) before doing further work that does not require those
426
resources (such as writing results to self.outf). Note though, that
427
as it releases all resources, this may release locks that the command
428
wants to hold, so use should be done with care.
430
self._operation.cleanup_now()
433
"""Return single-line grammar for this command.
435
Only describes arguments, not options.
437
s = 'bzr ' + self.name() + ' '
438
for aname in self.takes_args:
439
aname = aname.upper()
440
if aname[-1] in ['$', '+']:
441
aname = aname[:-1] + '...'
442
elif aname[-1] == '?':
443
aname = '[' + aname[:-1] + ']'
444
elif aname[-1] == '*':
445
aname = '[' + aname[:-1] + '...]'
447
s = s[:-1] # remove last space
450
def get_help_text(self, additional_see_also=None, plain=True,
451
see_also_as_links=False, verbose=True):
452
"""Return a text string with help for this command.
454
:param additional_see_also: Additional help topics to be
456
:param plain: if False, raw help (reStructuredText) is
457
returned instead of plain text.
458
:param see_also_as_links: if True, convert items in 'See also'
459
list to internal links (used by bzr_man rstx generator)
460
:param verbose: if True, display the full help, otherwise
461
leave out the descriptive sections and just display
462
usage help (e.g. Purpose, Usage, Options) with a
463
message explaining how to obtain full help.
466
i18n.install() # Install i18n only for get_help_text for now.
469
# Note: If self.gettext() translates ':Usage:\n', the section will
470
# be shown after "Description" section and we don't want to
471
# translate the usage string.
472
# Though, bzr export-pot don't exports :Usage: section and it must
474
doc = self.gettext(doc)
476
doc = gettext("No help for this command.")
478
# Extract the summary (purpose) and sections out from the text
479
purpose,sections,order = self._get_help_parts(doc)
481
# If a custom usage section was provided, use it
482
if sections.has_key('Usage'):
483
usage = sections.pop('Usage')
485
usage = self._usage()
487
# The header is the purpose and usage
489
result += gettext(':Purpose: %s\n') % (purpose,)
490
if usage.find('\n') >= 0:
491
result += gettext(':Usage:\n%s\n') % (usage,)
493
result += gettext(':Usage: %s\n') % (usage,)
498
# XXX: optparse implicitly rewraps the help, and not always perfectly,
499
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
501
parser = option.get_optparser(self.options())
502
options = parser.format_option_help()
503
# FIXME: According to the spec, ReST option lists actually don't
504
# support options like --1.14 so that causes syntax errors (in Sphinx
505
# at least). As that pattern always appears in the commands that
506
# break, we trap on that and then format that block of 'format' options
507
# as a literal block. We use the most recent format still listed so we
508
# don't have to do that too often -- vila 20110514
509
if not plain and options.find(' --1.14 ') != -1:
510
options = options.replace(' format:\n', ' format::\n\n', 1)
511
if options.startswith('Options:'):
512
result += gettext(':Options:%s') % (options[len('options:'):],)
518
# Add the description, indenting it 2 spaces
519
# to match the indentation of the options
520
if sections.has_key(None):
521
text = sections.pop(None)
522
text = '\n '.join(text.splitlines())
523
result += gettext(':Description:\n %s\n\n') % (text,)
525
# Add the custom sections (e.g. Examples). Note that there's no need
526
# to indent these as they must be indented already in the source.
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
536
# Add the aliases, source (plug-in) and see also links, if any
538
result += gettext(':Aliases: ')
539
result += ', '.join(self.aliases) + '\n'
540
plugin_name = self.plugin_name()
541
if plugin_name is not None:
542
result += gettext(':From: plugin "%s"\n') % plugin_name
543
see_also = self.get_see_also(additional_see_also)
545
if not plain and see_also_as_links:
547
for item in see_also:
549
# topics doesn't have an independent section
550
# so don't create a real link
551
see_also_links.append(item)
553
# Use a Sphinx link for this entry
554
link_text = gettext(":doc:`{0} <{1}-help>`").format(
556
see_also_links.append(link_text)
557
see_also = see_also_links
558
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
560
# If this will be rendered as plain text, convert it
562
import bzrlib.help_topics
563
result = bzrlib.help_topics.help_as_plain_text(result)
567
def _get_help_parts(text):
568
"""Split help text into a summary and named sections.
570
:return: (summary,sections,order) where summary is the top line and
571
sections is a dictionary of the rest indexed by section name.
572
order is the order the section appear in the text.
573
A section starts with a heading line of the form ":xxx:".
574
Indented text on following lines is the section value.
575
All text found outside a named section is assigned to the
576
default section which is given the key of None.
578
def save_section(sections, order, label, section):
580
if sections.has_key(label):
581
sections[label] += '\n' + section
584
sections[label] = section
586
lines = text.rstrip().splitlines()
587
summary = lines.pop(0)
590
label,section = None,''
592
if line.startswith(':') and line.endswith(':') and len(line) > 2:
593
save_section(sections, order, label, section)
594
label,section = line[1:-1],''
595
elif (label is not None) and len(line) > 1 and not line[0].isspace():
596
save_section(sections, order, label, section)
597
label,section = None,line
600
section += '\n' + line
603
save_section(sections, order, label, section)
604
return summary, sections, order
606
def get_help_topic(self):
607
"""Return the commands help topic - its name."""
610
def get_see_also(self, additional_terms=None):
611
"""Return a list of help topics that are related to this command.
613
The list is derived from the content of the _see_also attribute. Any
614
duplicates are removed and the result is in lexical order.
615
:param additional_terms: Additional help topics to cross-reference.
616
:return: A list of help topics.
618
see_also = set(getattr(self, '_see_also', []))
620
see_also.update(additional_terms)
621
return sorted(see_also)
199
623
def options(self):
200
624
"""Return dict of valid options for this command.
202
626
Maps from long option name to option object."""
204
r['help'] = Option.OPTIONS['help']
627
r = Option.STD_OPTIONS.copy()
205
629
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
630
if isinstance(o, basestring):
631
o = option.Option.OPTIONS[o]
633
if o.name in std_names:
634
self.supported_std_options.append(o.name)
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
637
def _setup_outf(self):
638
"""Return a file linked to stdout, which has proper encoding."""
639
self.outf = ui.ui_factory.make_output_stream(
640
encoding_type=self.encoding_type)
642
def run_argv_aliases(self, argv, alias_argv=None):
643
"""Parse the command line and run with extra aliases in alias_argv."""
644
args, opts = parse_args(self, argv, alias_argv)
647
# Process the standard options
214
648
if 'help' in opts: # e.g. bzr add --help
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
649
self.outf.write(self.get_help_text())
651
if 'usage' in opts: # e.g. bzr add --usage
652
self.outf.write(self.get_help_text(verbose=False))
654
trace.set_verbosity_level(option._verbosity_level)
655
if 'verbose' in self.supported_std_options:
656
opts['verbose'] = trace.is_verbose()
657
elif opts.has_key('verbose'):
659
if 'quiet' in self.supported_std_options:
660
opts['quiet'] = trace.is_quiet()
661
elif opts.has_key('quiet'):
224
663
# mix arguments and options into one dictionary
225
664
cmdargs = _match_argform(self.name(), self.takes_args, args)
241
706
Return 0 or None if the command was successful, or a non-zero
242
707
shell error code if not. It's OK for this method to allow
243
708
an exception to raise up.
710
This method is automatically wrapped by Command.__init__ with a
711
cleanup operation, stored as self._operation. This can be used
712
via self.add_cleanup to perform automatic cleanups at the end of
715
The argument for run are assembled by introspection. So for instance,
716
if your command takes an argument files, you would declare::
718
def run(self, files=None):
245
raise NotImplementedError()
721
raise NotImplementedError('no implementation of command %r'
249
725
"""Return help message for this class."""
726
from inspect import getdoc
250
727
if self.__doc__ is Command.__doc__:
252
729
return getdoc(self)
731
def gettext(self, message):
732
"""Returns the gettext function used to translate this command's help.
734
Commands provided by plugins should override this to use their
737
return i18n.gettext_per_paragraph(message)
740
"""Return the canonical name for this command.
742
The name under which it was actually invoked is available in invoked_as.
255
744
return _unsquish_command_name(self.__class__.__name__)
746
def plugin_name(self):
747
"""Get the name of the plugin that provides this command.
258
def parse_spec(spec):
264
>>> parse_spec("../@")
266
>>> parse_spec("../f/@35")
268
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
269
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
274
parsed = spec.split('/@')
275
assert len(parsed) == 2
749
:return: The name of the plugin or None if the command is builtin.
751
mod_parts = self.__module__.split('.')
752
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
280
parsed[1] = int(parsed[1])
282
pass # We can allow stuff like ./@revid:blahblahblah
286
parsed = [spec, None]
289
def parse_args(command, argv):
758
class CommandHooks(Hooks):
759
"""Hooks related to Command object creation/enumeration."""
762
"""Create the default hooks.
764
These are all empty initially, because by default nothing should get
767
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
768
self.add_hook('extend_command',
769
"Called after creating a command object to allow modifications "
770
"such as adding or removing options, docs etc. Called with the "
771
"new bzrlib.commands.Command object.", (1, 13))
772
self.add_hook('get_command',
773
"Called when creating a single command. Called with "
774
"(cmd_or_None, command_name). get_command should either return "
775
"the cmd_or_None parameter, or a replacement Command object that "
776
"should be used for the command. Note that the Command.hooks "
777
"hooks are core infrastructure. Many users will prefer to use "
778
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
780
self.add_hook('get_missing_command',
781
"Called when creating a single command if no command could be "
782
"found. Called with (command_name). get_missing_command should "
783
"either return None, or a Command object to be used for the "
785
self.add_hook('list_commands',
786
"Called when enumerating commands. Called with a set of "
787
"cmd_name strings for all the commands found so far. This set "
788
" is safe to mutate - e.g. to remove a command. "
789
"list_commands should return the updated set of command names.",
792
Command.hooks = CommandHooks()
795
def parse_args(command, argv, alias_argv=None):
290
796
"""Parse command line.
292
798
Arguments and options are parsed at this level before being passed
293
799
down to specific command handlers. This routine knows, from a
294
800
lookup table, something about the available options, what optargs
295
801
they take, and which commands will accept them.
297
# TODO: chop up this beast; make it a method of the Command
301
cmd_options = command.options()
309
# We've received a standalone -- No more flags
313
# option names must not be unicode
317
mutter(" got option %r", a)
319
optname, optarg = a[2:].split('=', 1)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
327
if shortopt in Option.SHORT_OPTIONS:
328
# Multi-character options must have a space to delimit
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
333
# Single character short options, can be chained,
334
# and have their value appended to their name
336
if shortopt not in Option.SHORT_OPTIONS:
337
# We didn't find the multi-character name, and we
338
# didn't find the single char name
339
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
343
# There are extra things on this option
344
# see if it is the value, or if it is another
346
optargfn = Option.OPTIONS[optname].type
348
# This option does not take an argument, so the
349
# next entry is another short option, pack it back
351
argv.insert(0, '-' + a[2:])
353
# This option takes an argument, so pack it
357
if optname not in cmd_options:
358
raise BzrOptionError('unknown short option %r for command'
359
' %s' % (shortopt, command.name()))
361
# XXX: Do we ever want to support this, e.g. for -r?
362
raise BzrError('repeated option %r' % a)
364
option_obj = cmd_options[optname]
365
optargfn = option_obj.type
369
raise BzrError('option %r needs an argument' % a)
372
opts[optname] = optargfn(optarg)
375
raise BzrError('option %r takes no argument' % optname)
803
# TODO: make it a method of the Command?
804
parser = option.get_optparser(command.options())
805
if alias_argv is not None:
806
args = alias_argv + argv
810
# for python 2.5 and later, optparse raises this exception if a non-ascii
811
# option name is given. See http://bugs.python.org/issue2931
813
options, args = parser.parse_args(args)
814
except UnicodeEncodeError,e:
815
raise errors.BzrCommandError(
816
gettext('Only ASCII permitted in option names'))
818
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
819
v is not option.OptionParser.DEFAULT_VALUE])
379
820
return args, opts
447
909
os.remove(pfname)
912
def exception_to_return_code(the_callable, *args, **kwargs):
913
"""UI level helper for profiling and coverage.
915
This transforms exceptions into a return value of 3. As such its only
916
relevant to the UI layer, and should never be called where catching
917
exceptions may be desirable.
920
return the_callable(*args, **kwargs)
921
except (KeyboardInterrupt, Exception), e:
922
# used to handle AssertionError and KeyboardInterrupt
923
# specially here, but hopefully they're handled ok by the logger now
924
exc_info = sys.exc_info()
925
exitcode = trace.report_exception(exc_info, sys.stderr)
926
if os.environ.get('BZR_PDB'):
927
print '**** entering debugger'
930
if sys.version_info[:2] < (2, 6):
932
# pdb.post_mortem(tb)
933
# but because pdb.post_mortem gives bad results for tracebacks
934
# from inside generators, we do it manually.
935
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
937
# Setup pdb on the traceback
940
p.setup(tb.tb_frame, tb)
941
# Point the debugger at the deepest frame of the stack
942
p.curindex = len(p.stack) - 1
943
p.curframe = p.stack[p.curindex][0]
944
# Start the pdb prompt.
945
p.print_stack_entry(p.stack[p.curindex])
953
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
954
from bzrlib.lsprof import profile
955
ret, stats = profile(exception_to_return_code, the_callable,
962
trace.note(gettext('Profile data written to "%s".'), filename)
966
def get_alias(cmd, config=None):
967
"""Return an expanded alias, or None if no alias exists.
970
Command to be checked for an alias.
972
Used to specify an alternative config to use,
973
which is especially useful for testing.
974
If it is unspecified, the global config will be used.
978
config = bzrlib.config.GlobalConfig()
979
alias = config.get_alias(cmd)
981
return cmdline.split(alias)
985
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
451
986
"""Execute a command.
453
This is similar to main(), but without all the trappings for
454
logging and error handling.
457
The command-line arguments, without the program name from argv[0]
459
Returns a command status or raises an exception.
988
:param argv: The command-line arguments, without the program name from
989
argv[0] These should already be decoded. All library/test code calling
990
run_bzr should be passing valid strings (don't need decoding).
991
:param load_plugins: What function to call when triggering plugin loading.
992
This function should take no arguments and cause all plugins to be
994
:param disable_plugins: What function to call when disabling plugin
995
loading. This function should take no arguments and cause all plugin
996
loading to be prohibited (so that code paths in your application that
997
know about some plugins possibly being present will fail to import
998
those plugins even if they are installed.)
999
:return: Returns a command exit code or raises an exception.
461
1001
Special master options: these must come before the command because
462
1002
they control how the command is interpreted.
465
1005
Do not load plugin modules at all
1008
Do not allow aliases
468
1011
Only use builtin commands. (Plugins are still allowed to change
469
1012
other behaviour.)
472
Run under the Python profiler.
1015
Run under the Python hotshot profiler.
1018
Run under the Python lsprof profiler.
1021
Generate line coverage report in the specified directory.
1024
Specify the number of processes that can be run concurrently (selftest).
474
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1026
trace.mutter("bazaar version: " + bzrlib.__version__)
1027
argv = _specified_or_unicode_argv(argv)
1028
trace.mutter("bzr arguments: %r", argv)
476
opt_profile = opt_no_plugins = opt_builtin = False
1030
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1031
opt_no_l10n = opt_no_aliases = False
1032
opt_lsprof_file = opt_coverage_dir = None
478
1034
# --no-plugins is handled specially at a very early stage. We need
479
1035
# to load plugins before doing other command parsing so that they
480
1036
# can override commands, but this needs to happen first.
1040
override_config = []
1041
while i < len(argv):
483
1043
if a == '--profile':
484
1044
opt_profile = True
1045
elif a == '--lsprof':
1047
elif a == '--lsprof-file':
1049
opt_lsprof_file = argv[i + 1]
485
1051
elif a == '--no-plugins':
486
1052
opt_no_plugins = True
1053
elif a == '--no-aliases':
1054
opt_no_aliases = True
1055
elif a == '--no-l10n':
487
1057
elif a == '--builtin':
488
1058
opt_builtin = True
493
if (not argv) or (argv[0] == '--help'):
494
from bzrlib.help import help
501
if argv[0] == '--version':
502
from bzrlib.builtins import show_version
1059
elif a == '--concurrency':
1060
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1062
elif a == '--coverage':
1063
opt_coverage_dir = argv[i + 1]
1065
elif a == '--profile-imports':
1066
pass # already handled in startup script Bug #588277
1067
elif a.startswith('-D'):
1068
debug.debug_flags.add(a[2:])
1069
elif a.startswith('-O'):
1070
override_config.append(a[2:])
1075
if bzrlib.global_state is None:
1076
# FIXME: Workaround for users that imported bzrlib but didn't call
1077
# bzrlib.initialize -- vila 2012-01-19
1078
cmdline_overrides = config.CommandLineStore()
1080
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1081
cmdline_overrides._from_cmdline(override_config)
1083
debug.set_debug_flags_from_config()
506
1085
if not opt_no_plugins:
507
from bzrlib.plugin import load_plugins
510
cmd = str(argv.pop(0))
1092
get_cmd_object('help').run_argv_aliases([])
1095
if argv[0] == '--version':
1096
get_cmd_object('version').run_argv_aliases([])
1101
if not opt_no_aliases:
1102
alias_argv = get_alias(argv[0])
1104
argv[0] = alias_argv.pop(0)
512
1107
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
515
ret = apply_profiled(cmd_obj.run_argv, argv)
517
ret = cmd_obj.run_argv(argv)
1110
run = cmd_obj.run_argv_aliases
1111
run_argv = [argv, alias_argv]
1114
# We can be called recursively (tests for example), but we don't want
1115
# the verbosity level to propagate.
1116
saved_verbosity_level = option._verbosity_level
1117
option._verbosity_level = 0
1119
if opt_coverage_dir:
1121
'--coverage ignored, because --lsprof is in use.')
1122
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1124
if opt_coverage_dir:
1126
'--coverage ignored, because --profile is in use.')
1127
ret = apply_profiled(run, *run_argv)
1128
elif opt_coverage_dir:
1129
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1131
ret = run(*run_argv)
1134
# reset, in case we may do other commands later within the same
1135
# process. Commands that want to execute sub-commands must propagate
1136
# --verbose in their own way.
1137
if 'memory' in debug.debug_flags:
1138
trace.debug_memory('Process status after command:', short=False)
1139
option._verbosity_level = saved_verbosity_level
1140
# Reset the overrides
1141
cmdline_overrides._reset()
520
1144
def display_command(func):
521
1145
"""Decorator that suppresses pipe/interrupt errors."""
525
1149
sys.stdout.flush()
527
1151
except IOError, e:
528
if not hasattr(e, 'errno'):
1152
if getattr(e, 'errno', None) is None:
530
1154
if e.errno != errno.EPIPE:
1155
# Win32 raises IOError with errno=0 on a broken pipe
1156
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
533
1159
except KeyboardInterrupt:
535
1161
return ignore_pipe
539
bzrlib.trace.log_startup(argv)
540
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
542
return run_bzr_catch_errors(argv[1:])
1164
def install_bzr_command_hooks():
1165
"""Install the hooks to supply bzr's own commands."""
1166
if _list_bzr_commands in Command.hooks["list_commands"]:
1168
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1170
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1172
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1173
"bzr plugin commands")
1174
Command.hooks.install_named_hook("get_command", _get_external_command,
1175
"bzr external command lookup")
1176
Command.hooks.install_named_hook("get_missing_command",
1177
_try_plugin_provider,
1178
"bzr plugin-provider-db check")
1182
def _specified_or_unicode_argv(argv):
1183
# For internal or testing use, argv can be passed. Otherwise, get it from
1184
# the process arguments in a unicode-safe way.
1186
return osutils.get_unicode_argv()
1190
# ensure all arguments are unicode strings
1192
if isinstance(a, unicode):
1195
new_argv.append(a.decode('ascii'))
1196
except UnicodeDecodeError:
1197
raise errors.BzrError("argv should be list of unicode strings.")
1201
def main(argv=None):
1202
"""Main entry point of command-line interface.
1204
Typically `bzrlib.initialize` should be called first.
1206
:param argv: list of unicode command-line arguments similar to sys.argv.
1207
argv[0] is script name usually, it will be ignored.
1208
Don't pass here sys.argv because this list contains plain strings
1209
and not unicode; pass None instead.
1211
:return: exit code of bzr command.
1213
if argv is not None:
1215
_register_builtin_commands()
1216
ret = run_bzr_catch_errors(argv)
1217
trace.mutter("return code %d", ret)
545
1221
def run_bzr_catch_errors(argv):
1222
"""Run a bzr command with parameters as described by argv.
1224
This function assumed that that UI layer is setup, that symbol deprecations
1225
are already applied, and that unicode decoding has already been performed on argv.
1227
# done here so that they're covered for every test run
1228
install_bzr_command_hooks()
1229
return exception_to_return_code(run_bzr, argv)
1232
def run_bzr_catch_user_errors(argv):
1233
"""Run bzr and report user errors, but let internal errors propagate.
1235
This is used for the test suite, and might be useful for other programs
1236
that want to wrap the commandline interface.
1238
# done here so that they're covered for every test run
1239
install_bzr_command_hooks()
550
# do this here inside the exception wrappers to catch EPIPE
1241
return run_bzr(argv)
552
1242
except Exception, e:
553
# used to handle AssertionError and KeyboardInterrupt
554
# specially here, but hopefully they're handled ok by the logger now
556
if (isinstance(e, IOError)
557
and hasattr(e, 'errno')
558
and e.errno == errno.EPIPE):
559
bzrlib.trace.note('broken pipe')
562
bzrlib.trace.log_exception()
563
if os.environ.get('BZR_PDB'):
564
print '**** entering debugger'
566
pdb.post_mortem(sys.exc_traceback)
569
if __name__ == '__main__':
570
sys.exit(main(sys.argv))
1243
if (isinstance(e, (OSError, IOError))
1244
or not getattr(e, 'internal_error', True)):
1245
trace.report_exception(sys.exc_info(), sys.stderr)
1251
class HelpCommandIndex(object):
1252
"""A index for bzr help that returns commands."""
1255
self.prefix = 'commands/'
1257
def get_topics(self, topic):
1258
"""Search for topic amongst commands.
1260
:param topic: A topic to search for.
1261
:return: A list which is either empty or contains a single
1264
if topic and topic.startswith(self.prefix):
1265
topic = topic[len(self.prefix):]
1267
cmd = _get_cmd_object(topic, check_missing=False)
1274
class Provider(object):
1275
"""Generic class to be overriden by plugins"""
1277
def plugin_for_command(self, cmd_name):
1278
"""Takes a command and returns the information for that plugin
1280
:return: A dictionary with all the available information
1281
for the requested plugin
1283
raise NotImplementedError
1286
class ProvidersRegistry(registry.Registry):
1287
"""This registry exists to allow other providers to exist"""
1290
for key, provider in self.iteritems():
1293
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
