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
23
18
# TODO: Define arguments by objects, rather than just using names.
24
19
# 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?
20
# would help with validation and shell completion. They could also provide
21
# help/explanation for that argument in a structured way.
23
# TODO: Specific "examples" property on commands for consistent formatting.
32
from warnings import warn
33
from inspect import getdoc
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
37
from bzrlib.trace import mutter, note, log_error, warning
38
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
39
from bzrlib.revisionspec import RevisionSpec
40
from bzrlib import BZRDIR
47
from bzrlib.hooks import Hooks
48
from bzrlib.i18n import gettext
49
# Compatibility - Option used to be in commands.
41
50
from bzrlib.option import Option
46
def register_command(cmd):
47
"Utility function to help register a command"
51
from bzrlib.plugin import disable_plugins, load_plugins
52
from bzrlib import registry
53
from bzrlib.symbol_versioning import (
60
class CommandInfo(object):
61
"""Information about a command."""
63
def __init__(self, aliases):
64
"""The list of aliases for the command."""
65
self.aliases = aliases
68
def from_command(klass, command):
69
"""Factory to construct a CommandInfo from a command."""
70
return klass(command.aliases)
73
class CommandRegistry(registry.Registry):
74
"""Special registry mapping command names to command classes.
76
:ivar overridden_registry: Look in this registry for commands being
77
overridden by this registry. This can be used to tell plugin commands
78
about the builtin they're decorating.
82
registry.Registry.__init__(self)
83
self.overridden_registry = None
84
# map from aliases to the real command that implements the name
87
def get(self, command_name):
88
real_name = self._alias_dict.get(command_name, command_name)
89
return registry.Registry.get(self, real_name)
92
def _get_name(command_name):
93
if command_name.startswith("cmd_"):
94
return _unsquish_command_name(command_name)
98
def register(self, cmd, decorate=False):
99
"""Utility function to help register a command
101
:param cmd: Command subclass to register
102
:param decorate: If true, allow overriding an existing command
103
of the same name; the old command is returned by this function.
104
Otherwise it is an error to try to override an existing command.
107
k_unsquished = self._get_name(k)
109
previous = self.get(k_unsquished)
112
if self.overridden_registry:
114
previous = self.overridden_registry.get(k_unsquished)
117
info = CommandInfo.from_command(cmd)
119
registry.Registry.register(self, k_unsquished, cmd,
120
override_existing=decorate, info=info)
122
trace.warning('Two plugins defined the same command: %r' % k)
123
trace.warning('Not loading the one in %r' %
124
sys.modules[cmd.__module__])
125
trace.warning('Previously this command was registered from %r' %
126
sys.modules[previous.__module__])
127
for a in cmd.aliases:
128
self._alias_dict[a] = k_unsquished
131
def register_lazy(self, command_name, aliases, module_name):
132
"""Register a command without loading its module.
134
:param command_name: The primary name of the command.
135
:param aliases: A list of aliases for the command.
136
:module_name: The module that the command lives in.
138
key = self._get_name(command_name)
139
registry.Registry.register_lazy(self, key, module_name, command_name,
140
info=CommandInfo(aliases))
142
self._alias_dict[a] = key
145
plugin_cmds = CommandRegistry()
146
builtin_command_registry = CommandRegistry()
147
plugin_cmds.overridden_registry = builtin_command_registry
150
def register_command(cmd, decorate=False):
151
"""Register a plugin command.
153
Should generally be avoided in favor of lazy registration.
48
155
global plugin_cmds
50
if k.startswith("cmd_"):
51
k_unsquished = _unsquish_command_name(k)
54
if not plugin_cmds.has_key(k_unsquished):
55
plugin_cmds[k_unsquished] = cmd
56
mutter('registered plugin command %s', k_unsquished)
58
log_error('Two plugins defined the same command: %r' % k)
59
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
156
return plugin_cmds.register(cmd, decorate)
62
159
def _squish_command_name(cmd):
66
163
def _unsquish_command_name(cmd):
67
assert cmd.startswith("cmd_")
68
164
return cmd[4:].replace('_','-')
71
def _builtin_commands():
167
def _register_builtin_commands():
168
if builtin_command_registry.keys():
72
171
import bzrlib.builtins
172
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
173
builtin_command_registry.register(cmd_class)
174
bzrlib.builtins._register_lazy_builtins()
177
def _scan_module_for_commands(module):
74
builtins = bzrlib.builtins.__dict__
179
for name, obj in module.__dict__.iteritems():
76
180
if name.startswith("cmd_"):
77
real_name = _unsquish_command_name(name)
78
r[real_name] = builtins[name]
181
real_name = _unsquish_command_name(name)
186
def _list_bzr_commands(names):
187
"""Find commands from bzr's core and plugins.
189
This is not the public interface, just the default hook called by all_command_names.
191
# to eliminate duplicates
192
names.update(builtin_command_names())
193
names.update(plugin_command_names())
197
def all_command_names():
198
"""Return a set of all command names."""
200
for hook in Command.hooks['list_commands']:
203
raise AssertionError(
204
'hook %s returned None' % Command.hooks.get_hook_name(hook))
83
208
def builtin_command_names():
84
"""Return list of builtin command names."""
85
return _builtin_commands().keys()
209
"""Return list of builtin command names.
211
Use of all_command_names() is encouraged rather than builtin_command_names
212
and/or plugin_command_names.
214
_register_builtin_commands()
215
return builtin_command_registry.keys()
88
218
def plugin_command_names():
219
"""Returns command names from commands registered by plugins."""
89
220
return plugin_cmds.keys()
92
def _get_cmd_dict(plugins_override=True):
93
"""Return name->class mapping for all commands."""
94
d = _builtin_commands()
100
def get_all_cmds(plugins_override=True):
101
"""Return canonical name and class for all registered commands."""
102
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
106
223
def get_cmd_object(cmd_name, plugins_override=True):
107
"""Return the canonical name and command class for a command.
224
"""Return the command object for a command.
110
227
If true, plugin commands can override builtins.
230
return _get_cmd_object(cmd_name, plugins_override)
232
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
235
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
236
"""Get a command object.
238
:param cmd_name: The name of the command.
239
:param plugins_override: Allow plugins to override builtins.
240
:param check_missing: Look up commands not found in the regular index via
241
the get_missing_command hook.
242
:return: A Command object instance
243
:raises KeyError: If no command is found.
245
# We want only 'ascii' command names, but the user may have typed
246
# in a Unicode name. In that case, they should just get a
247
# 'command not found' error later.
248
# In the future, we may actually support Unicode command names.
251
for hook in Command.hooks['get_command']:
252
cmd = hook(cmd, cmd_name)
253
if cmd is not None and not plugins_override and not cmd.plugin_name():
254
# We've found a non-plugin command, don't permit it to be
257
if cmd is None and check_missing:
258
for hook in Command.hooks['get_missing_command']:
265
# Allow plugins to extend commands
266
for hook in Command.hooks['extend_command']:
268
if getattr(cmd, 'invoked_as', None) is None:
269
cmd.invoked_as = cmd_name
273
def _try_plugin_provider(cmd_name):
274
"""Probe for a plugin provider having cmd_name."""
276
plugin_metadata, provider = probe_for_provider(cmd_name)
277
raise errors.CommandAvailableInPlugin(cmd_name,
278
plugin_metadata, provider)
279
except errors.NoPluginAvailable:
283
def probe_for_provider(cmd_name):
284
"""Look for a provider for cmd_name.
286
:param cmd_name: The command name.
287
:return: plugin_metadata, provider for getting cmd_name.
288
:raises NoPluginAvailable: When no provider can supply the plugin.
290
# look for providers that provide this command but aren't installed
291
for provider in command_providers_registry:
293
return provider.plugin_for_command(cmd_name), provider
294
except errors.NoPluginAvailable:
296
raise errors.NoPluginAvailable(cmd_name)
299
def _get_bzr_command(cmd_or_None, cmd_name):
300
"""Get a command from bzr's core."""
302
cmd_class = builtin_command_registry.get(cmd_name)
310
def _get_external_command(cmd_or_None, cmd_name):
311
"""Lookup a command that is a shell script."""
312
# Only do external command lookups when no command is found so far.
313
if cmd_or_None is not None:
112
315
from bzrlib.externalcommand import ExternalCommand
114
cmd_name = str(cmd_name) # not unicode
116
# first look up this command under the specified name
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
119
return cmds[cmd_name]()
123
# look for any command which claims this as an alias
124
for real_cmd_name, cmd_class in cmds.iteritems():
125
if cmd_name in cmd_class.aliases:
128
316
cmd_obj = ExternalCommand.find_command(cmd_name)
132
raise BzrCommandError("unknown command %r" % cmd_name)
321
def _get_plugin_command(cmd_or_None, cmd_name):
322
"""Get a command from bzr's plugins."""
324
return plugin_cmds.get(cmd_name)()
327
for key in plugin_cmds.keys():
328
info = plugin_cmds.get_info(key)
329
if cmd_name in info.aliases:
330
return plugin_cmds.get(key)()
135
334
class Command(object):
150
349
summary, then a complete description of the command. A grammar
151
350
description will be inserted.
154
Other accepted names for this command.
157
List of argument forms, marked with whether they are optional,
161
List of options that may be given for this command. These can
162
be either strings, referring to globally-defined options,
163
or option objects. Retrieve through options().
166
If true, this command isn't advertised. This is typically
352
:cvar aliases: Other accepted names for this command.
354
:cvar takes_args: List of argument forms, marked with whether they are
355
optional, repeated, etc. Examples::
357
['to_location', 'from_branch?', 'file*']
359
* 'to_location' is required
360
* 'from_branch' is optional
361
* 'file' can be specified 0 or more times
363
:cvar takes_options: List of options that may be given for this command.
364
These can be either strings, referring to globally-defined options, or
365
option objects. Retrieve through options().
367
:cvar hidden: If true, this command isn't advertised. This is typically
167
368
for commands intended for expert users.
370
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
371
been setup to properly handle encoding of unicode strings.
372
encoding_type determines what will happen when characters cannot be
375
* strict - abort if we cannot decode
376
* replace - put in a bogus character (typically '?')
377
* exact - do not encode sys.stdout
379
NOTE: by default on Windows, sys.stdout is opened as a text stream,
380
therefore LF line-endings are converted to CRLF. When a command uses
381
encoding_type = 'exact', then sys.stdout is forced to be a binary
382
stream, and line-endings will not mangled.
385
A string indicating the real name under which this command was
386
invoked, before expansion of aliases.
387
(This may be None if the command was constructed and run in-process.)
389
:cvar hooks: An instance of CommandHooks.
391
:cvar __doc__: The help shown by 'bzr help command' for this command.
392
This is set by assigning explicitly to __doc__ so that -OO can
396
__doc__ = "My help goes here"
171
400
takes_options = []
401
encoding_type = 'strict'
175
407
def __init__(self):
176
408
"""Construct an instance of this command."""
177
if self.__doc__ == Command.__doc__:
178
warn("No help message set for %r" % self)
409
# List of standard options directly supported
410
self.supported_std_options = []
413
def add_cleanup(self, cleanup_func, *args, **kwargs):
414
"""Register a function to call after self.run returns or raises.
416
Functions will be called in LIFO order.
418
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
420
def cleanup_now(self):
421
"""Execute and empty pending cleanup functions immediately.
423
After cleanup_now all registered cleanups are forgotten. add_cleanup
424
may be called again after cleanup_now; these cleanups will be called
425
after self.run returns or raises (or when cleanup_now is next called).
427
This is useful for releasing expensive or contentious resources (such
428
as write locks) before doing further work that does not require those
429
resources (such as writing results to self.outf). Note though, that
430
as it releases all resources, this may release locks that the command
431
wants to hold, so use should be done with care.
433
self._operation.cleanup_now()
436
"""Return single-line grammar for this command.
438
Only describes arguments, not options.
440
s = 'bzr ' + self.name() + ' '
441
for aname in self.takes_args:
442
aname = aname.upper()
443
if aname[-1] in ['$', '+']:
444
aname = aname[:-1] + '...'
445
elif aname[-1] == '?':
446
aname = '[' + aname[:-1] + ']'
447
elif aname[-1] == '*':
448
aname = '[' + aname[:-1] + '...]'
450
s = s[:-1] # remove last space
453
def get_help_text(self, additional_see_also=None, plain=True,
454
see_also_as_links=False, verbose=True):
455
"""Return a text string with help for this command.
457
:param additional_see_also: Additional help topics to be
459
:param plain: if False, raw help (reStructuredText) is
460
returned instead of plain text.
461
:param see_also_as_links: if True, convert items in 'See also'
462
list to internal links (used by bzr_man rstx generator)
463
:param verbose: if True, display the full help, otherwise
464
leave out the descriptive sections and just display
465
usage help (e.g. Purpose, Usage, Options) with a
466
message explaining how to obtain full help.
468
if self.l10n and not i18n.installed():
469
i18n.install() # Install i18n only for get_help_text for now.
472
# Note: If self.gettext() translates ':Usage:\n', the section will
473
# be shown after "Description" section and we don't want to
474
# translate the usage string.
475
# Though, bzr export-pot don't exports :Usage: section and it must
477
doc = self.gettext(doc)
479
doc = gettext("No help for this command.")
481
# Extract the summary (purpose) and sections out from the text
482
purpose,sections,order = self._get_help_parts(doc)
484
# If a custom usage section was provided, use it
485
if sections.has_key('Usage'):
486
usage = sections.pop('Usage')
488
usage = self._usage()
490
# The header is the purpose and usage
492
result += gettext(':Purpose: %s\n') % (purpose,)
493
if usage.find('\n') >= 0:
494
result += gettext(':Usage:\n%s\n') % (usage,)
496
result += gettext(':Usage: %s\n') % (usage,)
501
# XXX: optparse implicitly rewraps the help, and not always perfectly,
502
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
504
parser = option.get_optparser(self.options())
505
options = parser.format_option_help()
506
# FIXME: According to the spec, ReST option lists actually don't
507
# support options like --1.14 so that causes syntax errors (in Sphinx
508
# at least). As that pattern always appears in the commands that
509
# break, we trap on that and then format that block of 'format' options
510
# as a literal block. We use the most recent format still listed so we
511
# don't have to do that too often -- vila 20110514
512
if not plain and options.find(' --1.14 ') != -1:
513
options = options.replace(' format:\n', ' format::\n\n', 1)
514
if options.startswith('Options:'):
515
result += gettext(':Options:%s') % (options[len('options:'):],)
521
# Add the description, indenting it 2 spaces
522
# to match the indentation of the options
523
if sections.has_key(None):
524
text = sections.pop(None)
525
text = '\n '.join(text.splitlines())
526
result += gettext(':Description:\n %s\n\n') % (text,)
528
# Add the custom sections (e.g. Examples). Note that there's no need
529
# to indent these as they must be indented already in the source.
532
if label in sections:
533
result += ':%s:\n%s\n' % (label, sections[label])
536
result += (gettext("See bzr help %s for more details and examples.\n\n")
539
# Add the aliases, source (plug-in) and see also links, if any
541
result += gettext(':Aliases: ')
542
result += ', '.join(self.aliases) + '\n'
543
plugin_name = self.plugin_name()
544
if plugin_name is not None:
545
result += gettext(':From: plugin "%s"\n') % plugin_name
546
see_also = self.get_see_also(additional_see_also)
548
if not plain and see_also_as_links:
550
for item in see_also:
552
# topics doesn't have an independent section
553
# so don't create a real link
554
see_also_links.append(item)
556
# Use a Sphinx link for this entry
557
link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
558
see_also_links.append(link_text)
559
see_also = see_also_links
560
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
562
# If this will be rendered as plain text, convert it
564
import bzrlib.help_topics
565
result = bzrlib.help_topics.help_as_plain_text(result)
569
def _get_help_parts(text):
570
"""Split help text into a summary and named sections.
572
:return: (summary,sections,order) where summary is the top line and
573
sections is a dictionary of the rest indexed by section name.
574
order is the order the section appear in the text.
575
A section starts with a heading line of the form ":xxx:".
576
Indented text on following lines is the section value.
577
All text found outside a named section is assigned to the
578
default section which is given the key of None.
580
def save_section(sections, order, label, section):
582
if sections.has_key(label):
583
sections[label] += '\n' + section
586
sections[label] = section
588
lines = text.rstrip().splitlines()
589
summary = lines.pop(0)
592
label,section = None,''
594
if line.startswith(':') and line.endswith(':') and len(line) > 2:
595
save_section(sections, order, label, section)
596
label,section = line[1:-1],''
597
elif (label is not None) and len(line) > 1 and not line[0].isspace():
598
save_section(sections, order, label, section)
599
label,section = None,line
602
section += '\n' + line
605
save_section(sections, order, label, section)
606
return summary, sections, order
608
def get_help_topic(self):
609
"""Return the commands help topic - its name."""
612
def get_see_also(self, additional_terms=None):
613
"""Return a list of help topics that are related to this command.
615
The list is derived from the content of the _see_also attribute. Any
616
duplicates are removed and the result is in lexical order.
617
:param additional_terms: Additional help topics to cross-reference.
618
:return: A list of help topics.
620
see_also = set(getattr(self, '_see_also', []))
622
see_also.update(additional_terms)
623
return sorted(see_also)
180
625
def options(self):
181
626
"""Return dict of valid options for this command.
183
628
Maps from long option name to option object."""
185
r['help'] = Option.OPTIONS['help']
629
r = Option.STD_OPTIONS.copy()
186
631
for o in self.takes_options:
187
if not isinstance(o, Option):
188
o = Option.OPTIONS[o]
632
if isinstance(o, basestring):
633
o = option.Option.OPTIONS[o]
635
if o.name in std_names:
636
self.supported_std_options.append(o.name)
192
def run_argv(self, argv):
193
"""Parse command line and run."""
194
args, opts = parse_args(self, argv)
639
def _setup_outf(self):
640
"""Return a file linked to stdout, which has proper encoding."""
641
self.outf = ui.ui_factory.make_output_stream(
642
encoding_type=self.encoding_type)
644
def run_argv_aliases(self, argv, alias_argv=None):
645
"""Parse the command line and run with extra aliases in alias_argv."""
646
args, opts = parse_args(self, argv, alias_argv)
649
# Process the standard options
195
650
if 'help' in opts: # e.g. bzr add --help
196
from bzrlib.help import help_on_command
197
help_on_command(self.name())
199
# XXX: This should be handled by the parser
200
allowed_names = self.options().keys()
202
if oname not in allowed_names:
203
raise BzrCommandError("option '--%s' is not allowed for command %r"
204
% (oname, self.name()))
651
self.outf.write(self.get_help_text())
653
if 'usage' in opts: # e.g. bzr add --usage
654
self.outf.write(self.get_help_text(verbose=False))
656
trace.set_verbosity_level(option._verbosity_level)
657
if 'verbose' in self.supported_std_options:
658
opts['verbose'] = trace.is_verbose()
659
elif opts.has_key('verbose'):
661
if 'quiet' in self.supported_std_options:
662
opts['quiet'] = trace.is_quiet()
663
elif opts.has_key('quiet'):
205
666
# mix arguments and options into one dictionary
206
667
cmdargs = _match_argform(self.name(), self.takes_args, args)
223
709
Return 0 or None if the command was successful, or a non-zero
224
710
shell error code if not. It's OK for this method to allow
225
711
an exception to raise up.
713
This method is automatically wrapped by Command.__init__ with a
714
cleanup operation, stored as self._operation. This can be used
715
via self.add_cleanup to perform automatic cleanups at the end of
718
The argument for run are assembled by introspection. So for instance,
719
if your command takes an argument files, you would declare::
721
def run(self, files=None):
227
raise NotImplementedError()
724
raise NotImplementedError('no implementation of command %r'
231
728
"""Return help message for this class."""
729
from inspect import getdoc
232
730
if self.__doc__ is Command.__doc__:
234
732
return getdoc(self)
734
def gettext(self, message):
735
"""Returns the gettext function used to translate this command's help.
737
Commands provided by plugins should override this to use their
740
return i18n.gettext_per_paragraph(message)
743
"""Return the canonical name for this command.
745
The name under which it was actually invoked is available in invoked_as.
237
747
return _unsquish_command_name(self.__class__.__name__)
749
def plugin_name(self):
750
"""Get the name of the plugin that provides this command.
240
def parse_spec(spec):
246
>>> parse_spec("../@")
248
>>> parse_spec("../f/@35")
250
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
251
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
256
parsed = spec.split('/@')
257
assert len(parsed) == 2
752
:return: The name of the plugin or None if the command is builtin.
754
mod_parts = self.__module__.split('.')
755
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
262
parsed[1] = int(parsed[1])
264
pass # We can allow stuff like ./@revid:blahblahblah
268
parsed = [spec, None]
271
def parse_args(command, argv):
761
class CommandHooks(Hooks):
762
"""Hooks related to Command object creation/enumeration."""
765
"""Create the default hooks.
767
These are all empty initially, because by default nothing should get
770
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
771
self.add_hook('extend_command',
772
"Called after creating a command object to allow modifications "
773
"such as adding or removing options, docs etc. Called with the "
774
"new bzrlib.commands.Command object.", (1, 13))
775
self.add_hook('get_command',
776
"Called when creating a single command. Called with "
777
"(cmd_or_None, command_name). get_command should either return "
778
"the cmd_or_None parameter, or a replacement Command object that "
779
"should be used for the command. Note that the Command.hooks "
780
"hooks are core infrastructure. Many users will prefer to use "
781
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
783
self.add_hook('get_missing_command',
784
"Called when creating a single command if no command could be "
785
"found. Called with (command_name). get_missing_command should "
786
"either return None, or a Command object to be used for the "
788
self.add_hook('list_commands',
789
"Called when enumerating commands. Called with a set of "
790
"cmd_name strings for all the commands found so far. This set "
791
" is safe to mutate - e.g. to remove a command. "
792
"list_commands should return the updated set of command names.",
795
Command.hooks = CommandHooks()
798
def parse_args(command, argv, alias_argv=None):
272
799
"""Parse command line.
274
801
Arguments and options are parsed at this level before being passed
275
802
down to specific command handlers. This routine knows, from a
276
803
lookup table, something about the available options, what optargs
277
804
they take, and which commands will accept them.
279
# TODO: chop up this beast; make it a method of the Command
283
cmd_options = command.options()
291
# We've received a standalone -- No more flags
295
# option names must not be unicode
299
mutter(" got option %r" % a)
301
optname, optarg = a[2:].split('=', 1)
304
if optname not in cmd_options:
305
raise BzrCommandError('unknown long option %r for command %s'
309
if shortopt in Option.SHORT_OPTIONS:
310
# Multi-character options must have a space to delimit
312
# ^^^ what does this mean? mbp 20051014
313
optname = Option.SHORT_OPTIONS[shortopt].name
315
# Single character short options, can be chained,
316
# and have their value appended to their name
318
if shortopt not in Option.SHORT_OPTIONS:
319
# We didn't find the multi-character name, and we
320
# didn't find the single char name
321
raise BzrError('unknown short option %r' % a)
322
optname = Option.SHORT_OPTIONS[shortopt].name
325
# There are extra things on this option
326
# see if it is the value, or if it is another
328
optargfn = Option.OPTIONS[optname].type
330
# This option does not take an argument, so the
331
# next entry is another short option, pack it back
333
argv.insert(0, '-' + a[2:])
335
# This option takes an argument, so pack it
340
# XXX: Do we ever want to support this, e.g. for -r?
341
raise BzrError('repeated option %r' % a)
343
option_obj = cmd_options[optname]
344
optargfn = option_obj.type
348
raise BzrError('option %r needs an argument' % a)
351
opts[optname] = optargfn(optarg)
354
raise BzrError('option %r takes no argument' % optname)
806
# TODO: make it a method of the Command?
807
parser = option.get_optparser(command.options())
808
if alias_argv is not None:
809
args = alias_argv + argv
813
# for python 2.5 and later, optparse raises this exception if a non-ascii
814
# option name is given. See http://bugs.python.org/issue2931
816
options, args = parser.parse_args(args)
817
except UnicodeEncodeError,e:
818
raise errors.BzrCommandError('Only ASCII permitted in option names')
820
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
821
v is not option.OptionParser.DEFAULT_VALUE])
358
822
return args, opts
426
907
os.remove(pfname)
910
def exception_to_return_code(the_callable, *args, **kwargs):
911
"""UI level helper for profiling and coverage.
913
This transforms exceptions into a return value of 3. As such its only
914
relevant to the UI layer, and should never be called where catching
915
exceptions may be desirable.
918
return the_callable(*args, **kwargs)
919
except (KeyboardInterrupt, Exception), e:
920
# used to handle AssertionError and KeyboardInterrupt
921
# specially here, but hopefully they're handled ok by the logger now
922
exc_info = sys.exc_info()
923
exitcode = trace.report_exception(exc_info, sys.stderr)
924
if os.environ.get('BZR_PDB'):
925
print '**** entering debugger'
928
if sys.version_info[:2] < (2, 6):
930
# pdb.post_mortem(tb)
931
# but because pdb.post_mortem gives bad results for tracebacks
932
# from inside generators, we do it manually.
933
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
935
# Setup pdb on the traceback
938
p.setup(tb.tb_frame, tb)
939
# Point the debugger at the deepest frame of the stack
940
p.curindex = len(p.stack) - 1
941
p.curframe = p.stack[p.curindex][0]
942
# Start the pdb prompt.
943
p.print_stack_entry(p.stack[p.curindex])
951
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
952
from bzrlib.lsprof import profile
953
ret, stats = profile(exception_to_return_code, the_callable,
960
trace.note('Profile data written to "%s".', filename)
964
def get_alias(cmd, config=None):
965
"""Return an expanded alias, or None if no alias exists.
968
Command to be checked for an alias.
970
Used to specify an alternative config to use,
971
which is especially useful for testing.
972
If it is unspecified, the global config will be used.
976
config = bzrlib.config.GlobalConfig()
977
alias = config.get_alias(cmd)
979
return cmdline.split(alias)
983
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
430
984
"""Execute a command.
432
This is similar to main(), but without all the trappings for
433
logging and error handling.
436
The command-line arguments, without the program name from argv[0]
438
Returns a command status or raises an exception.
986
:param argv: The command-line arguments, without the program name from
987
argv[0] These should already be decoded. All library/test code calling
988
run_bzr should be passing valid strings (don't need decoding).
989
:param load_plugins: What function to call when triggering plugin loading.
990
This function should take no arguments and cause all plugins to be
992
:param disable_plugins: What function to call when disabling plugin
993
loading. This function should take no arguments and cause all plugin
994
loading to be prohibited (so that code paths in your application that
995
know about some plugins possibly being present will fail to import
996
those plugins even if they are installed.)
997
:return: Returns a command exit code or raises an exception.
440
999
Special master options: these must come before the command because
441
1000
they control how the command is interpreted.
444
1003
Do not load plugin modules at all
1006
Do not allow aliases
447
1009
Only use builtin commands. (Plugins are still allowed to change
448
1010
other behaviour.)
451
Run under the Python profiler.
1013
Run under the Python hotshot profiler.
1016
Run under the Python lsprof profiler.
1019
Generate line coverage report in the specified directory.
1022
Specify the number of processes that can be run concurrently (selftest).
453
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1024
trace.mutter("bazaar version: " + bzrlib.__version__)
1025
argv = _specified_or_unicode_argv(argv)
1026
trace.mutter("bzr arguments: %r", argv)
455
opt_profile = opt_no_plugins = opt_builtin = False
1028
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1029
opt_no_l10n = opt_no_aliases = False
1030
opt_lsprof_file = opt_coverage_dir = None
457
1032
# --no-plugins is handled specially at a very early stage. We need
458
1033
# to load plugins before doing other command parsing so that they
459
1034
# can override commands, but this needs to happen first.
1038
while i < len(argv):
462
1040
if a == '--profile':
463
1041
opt_profile = True
1042
elif a == '--lsprof':
1044
elif a == '--lsprof-file':
1046
opt_lsprof_file = argv[i + 1]
464
1048
elif a == '--no-plugins':
465
1049
opt_no_plugins = True
1050
elif a == '--no-aliases':
1051
opt_no_aliases = True
1052
elif a == '--no-l10n':
466
1054
elif a == '--builtin':
467
1055
opt_builtin = True
472
if (not argv) or (argv[0] == '--help'):
473
from bzrlib.help import help
480
if argv[0] == '--version':
481
from bzrlib.builtins import show_version
1056
elif a == '--concurrency':
1057
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1059
elif a == '--coverage':
1060
opt_coverage_dir = argv[i + 1]
1062
elif a == '--profile-imports':
1063
pass # already handled in startup script Bug #588277
1064
elif a.startswith('-D'):
1065
debug.debug_flags.add(a[2:])
1070
debug.set_debug_flags_from_config()
485
1072
if not opt_no_plugins:
486
from bzrlib.plugin import load_plugins
489
cmd = str(argv.pop(0))
1079
get_cmd_object('help').run_argv_aliases([])
1082
if argv[0] == '--version':
1083
get_cmd_object('version').run_argv_aliases([])
1088
if not opt_no_aliases:
1089
alias_argv = get_alias(argv[0])
1091
argv[0] = alias_argv.pop(0)
491
1094
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
494
ret = apply_profiled(cmd_obj.run_argv, argv)
1097
run = cmd_obj.run_argv_aliases
1098
run_argv = [argv, alias_argv]
1101
# We can be called recursively (tests for example), but we don't want
1102
# the verbosity level to propagate.
1103
saved_verbosity_level = option._verbosity_level
1104
option._verbosity_level = 0
1106
if opt_coverage_dir:
1108
'--coverage ignored, because --lsprof is in use.')
1109
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1111
if opt_coverage_dir:
1113
'--coverage ignored, because --profile is in use.')
1114
ret = apply_profiled(run, *run_argv)
1115
elif opt_coverage_dir:
1116
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1118
ret = run(*run_argv)
1121
# reset, in case we may do other commands later within the same
1122
# process. Commands that want to execute sub-commands must propagate
1123
# --verbose in their own way.
1124
if 'memory' in debug.debug_flags:
1125
trace.debug_memory('Process status after command:', short=False)
1126
option._verbosity_level = saved_verbosity_level
1129
def display_command(func):
1130
"""Decorator that suppresses pipe/interrupt errors."""
1131
def ignore_pipe(*args, **kwargs):
1133
result = func(*args, **kwargs)
1137
if getattr(e, 'errno', None) is None:
1139
if e.errno != errno.EPIPE:
1140
# Win32 raises IOError with errno=0 on a broken pipe
1141
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1144
except KeyboardInterrupt:
1149
def install_bzr_command_hooks():
1150
"""Install the hooks to supply bzr's own commands."""
1151
if _list_bzr_commands in Command.hooks["list_commands"]:
1153
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1155
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1157
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1158
"bzr plugin commands")
1159
Command.hooks.install_named_hook("get_command", _get_external_command,
1160
"bzr external command lookup")
1161
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1162
"bzr plugin-provider-db check")
1166
def _specified_or_unicode_argv(argv):
1167
# For internal or testing use, argv can be passed. Otherwise, get it from
1168
# the process arguments in a unicode-safe way.
1170
return osutils.get_unicode_argv()
496
ret = cmd_obj.run_argv(argv)
502
bzrlib.trace.log_startup(argv)
503
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
505
return run_bzr_catch_errors(argv[1:])
1174
# ensure all arguments are unicode strings
1176
if isinstance(a, unicode):
1179
new_argv.append(a.decode('ascii'))
1180
except UnicodeDecodeError:
1181
raise errors.BzrError("argv should be list of unicode strings.")
1185
def main(argv=None):
1186
"""Main entry point of command-line interface.
1188
Typically `bzrlib.initialize` should be called first.
1190
:param argv: list of unicode command-line arguments similar to sys.argv.
1191
argv[0] is script name usually, it will be ignored.
1192
Don't pass here sys.argv because this list contains plain strings
1193
and not unicode; pass None instead.
1195
:return: exit code of bzr command.
1197
if argv is not None:
1199
_register_builtin_commands()
1200
ret = run_bzr_catch_errors(argv)
1201
trace.mutter("return code %d", ret)
508
1205
def run_bzr_catch_errors(argv):
1206
"""Run a bzr command with parameters as described by argv.
1208
This function assumed that that UI layer is setup, that symbol deprecations
1209
are already applied, and that unicode decoding has already been performed on argv.
1211
# done here so that they're covered for every test run
1212
install_bzr_command_hooks()
1213
return exception_to_return_code(run_bzr, argv)
1216
def run_bzr_catch_user_errors(argv):
1217
"""Run bzr and report user errors, but let internal errors propagate.
1219
This is used for the test suite, and might be useful for other programs
1220
that want to wrap the commandline interface.
1222
# done here so that they're covered for every test run
1223
install_bzr_command_hooks()
513
# do this here inside the exception wrappers to catch EPIPE
515
except BzrCommandError, e:
516
# command line syntax error, etc
520
bzrlib.trace.log_exception()
522
except AssertionError, e:
523
bzrlib.trace.log_exception('assertion failed: ' + str(e))
525
except KeyboardInterrupt, e:
526
bzrlib.trace.log_exception('interrupted')
1225
return run_bzr(argv)
528
1226
except Exception, e:
530
if (isinstance(e, IOError)
531
and hasattr(e, 'errno')
532
and e.errno == errno.EPIPE):
533
bzrlib.trace.note('broken pipe')
538
bzrlib.trace.log_exception()
541
if __name__ == '__main__':
542
sys.exit(main(sys.argv))
1227
if (isinstance(e, (OSError, IOError))
1228
or not getattr(e, 'internal_error', True)):
1229
trace.report_exception(sys.exc_info(), sys.stderr)
1235
class HelpCommandIndex(object):
1236
"""A index for bzr help that returns commands."""
1239
self.prefix = 'commands/'
1241
def get_topics(self, topic):
1242
"""Search for topic amongst commands.
1244
:param topic: A topic to search for.
1245
:return: A list which is either empty or contains a single
1248
if topic and topic.startswith(self.prefix):
1249
topic = topic[len(self.prefix):]
1251
cmd = _get_cmd_object(topic, check_missing=False)
1258
class Provider(object):
1259
"""Generic class to be overriden by plugins"""
1261
def plugin_for_command(self, cmd_name):
1262
"""Takes a command and returns the information for that plugin
1264
:return: A dictionary with all the available information
1265
for the requested plugin
1267
raise NotImplementedError
1270
class ProvidersRegistry(registry.Registry):
1271
"""This registry exists to allow other providers to exist"""
1274
for key, provider in self.iteritems():
1277
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
