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
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.
18
23
# TODO: Define arguments by objects, rather than just using names.
19
24
# Those objects can specify the expected type of the argument, which
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.
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?
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
32
from warnings import warn
33
from inspect import getdoc
47
from bzrlib.hooks import Hooks
48
from bzrlib.i18n import gettext
49
# Compatibility - Option used to be in commands.
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib import BZRDIR
50
46
from bzrlib.option import Option
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
51
def register_command(cmd, decorate=False):
151
"""Register a plugin command.
153
Should generally be avoided in favor of lazy registration.
52
"Utility function to help register a command"
155
53
global plugin_cmds
156
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)
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__])
159
73
def _squish_command_name(cmd):
163
77
def _unsquish_command_name(cmd):
78
assert cmd.startswith("cmd_")
164
79
return cmd[4:].replace('_','-')
167
@deprecated_function(deprecated_in((2, 2, 0)))
168
82
def _builtin_commands():
169
"""Return a dict of {name: cmd_class} for builtin commands.
171
:deprecated: Use the builtin_command_registry registry instead
173
# return dict(name: cmd_class)
174
return dict(builtin_command_registry.items())
177
def _register_builtin_commands():
178
if builtin_command_registry.keys():
181
83
import bzrlib.builtins
182
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
183
builtin_command_registry.register(cmd_class)
184
bzrlib.builtins._register_lazy_builtins()
187
def _scan_module_for_commands(module):
189
for name, obj in module.__dict__.iteritems():
85
builtins = bzrlib.builtins.__dict__
190
87
if name.startswith("cmd_"):
191
real_name = _unsquish_command_name(name)
88
real_name = _unsquish_command_name(name)
89
r[real_name] = builtins[name]
196
def _list_bzr_commands(names):
197
"""Find commands from bzr's core and plugins.
199
This is not the public interface, just the default hook called by all_command_names.
201
# to eliminate duplicates
202
names.update(builtin_command_names())
203
names.update(plugin_command_names())
207
def all_command_names():
208
"""Return a set of all command names."""
210
for hook in Command.hooks['list_commands']:
213
raise AssertionError(
214
'hook %s returned None' % Command.hooks.get_hook_name(hook))
218
94
def builtin_command_names():
219
"""Return list of builtin command names.
95
"""Return list of builtin command names."""
96
return _builtin_commands().keys()
221
Use of all_command_names() is encouraged rather than builtin_command_names
222
and/or plugin_command_names.
224
_register_builtin_commands()
225
return builtin_command_registry.keys()
228
99
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
100
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():
233
117
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
118
"""Return the canonical name and command class for a command.
237
121
If true, plugin commands can override builtins.
240
return _get_cmd_object(cmd_name, plugins_override)
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
# We want only 'ascii' command names, but the user may have typed
256
# in a Unicode name. In that case, they should just get a
257
# 'command not found' error later.
258
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
278
if getattr(cmd, 'invoked_as', None) is None:
279
cmd.invoked_as = cmd_name
283
def _try_plugin_provider(cmd_name):
284
"""Probe for a plugin provider having cmd_name."""
286
plugin_metadata, provider = probe_for_provider(cmd_name)
287
raise errors.CommandAvailableInPlugin(cmd_name,
288
plugin_metadata, provider)
289
except errors.NoPluginAvailable:
293
def probe_for_provider(cmd_name):
294
"""Look for a provider for cmd_name.
296
:param cmd_name: The command name.
297
:return: plugin_metadata, provider for getting cmd_name.
298
:raises NoPluginAvailable: When no provider can supply the plugin.
300
# look for providers that provide this command but aren't installed
301
for provider in command_providers_registry:
303
return provider.plugin_for_command(cmd_name), provider
304
except errors.NoPluginAvailable:
306
raise errors.NoPluginAvailable(cmd_name)
309
def _get_bzr_command(cmd_or_None, cmd_name):
310
"""Get a command from bzr's core."""
312
cmd_class = builtin_command_registry.get(cmd_name)
320
def _get_external_command(cmd_or_None, cmd_name):
321
"""Lookup a command that is a shell script."""
322
# Only do external command lookups when no command is found so far.
323
if cmd_or_None is not None:
325
123
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:
326
139
cmd_obj = ExternalCommand.find_command(cmd_name)
331
def _get_plugin_command(cmd_or_None, cmd_name):
332
"""Get a command from bzr's plugins."""
334
return plugin_cmds.get(cmd_name)()
337
for key in plugin_cmds.keys():
338
info = plugin_cmds.get_info(key)
339
if cmd_name in info.aliases:
340
return plugin_cmds.get(key)()
143
raise BzrCommandError("unknown command %r" % cmd_name)
344
146
class Command(object):
359
161
summary, then a complete description of the command. A grammar
360
162
description will be inserted.
362
:cvar aliases: Other accepted names for this command.
364
:cvar takes_args: List of argument forms, marked with whether they are
365
optional, repeated, etc. Examples::
367
['to_location', 'from_branch?', 'file*']
369
* 'to_location' is required
370
* 'from_branch' is optional
371
* 'file' can be specified 0 or more times
373
:cvar takes_options: List of options that may be given for this command.
374
These can be either strings, referring to globally-defined options, or
375
option objects. Retrieve through options().
377
:cvar hidden: If true, this command isn't advertised. This is typically
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
378
186
for commands intended for expert users.
380
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
381
been setup to properly handle encoding of unicode strings.
382
encoding_type determines what will happen when characters cannot be
385
* strict - abort if we cannot decode
386
* replace - put in a bogus character (typically '?')
387
* exact - do not encode sys.stdout
389
NOTE: by default on Windows, sys.stdout is opened as a text stream,
390
therefore LF line-endings are converted to CRLF. When a command uses
391
encoding_type = 'exact', then sys.stdout is forced to be a binary
392
stream, and line-endings will not mangled.
395
A string indicating the real name under which this command was
396
invoked, before expansion of aliases.
397
(This may be None if the command was constructed and run in-process.)
399
:cvar hooks: An instance of CommandHooks.
401
:cvar __doc__: The help shown by 'bzr help command' for this command.
402
This is set by assigning explicitly to __doc__ so that -OO can
406
__doc__ = "My help goes here"
410
190
takes_options = []
411
encoding_type = 'strict'
417
194
def __init__(self):
418
195
"""Construct an instance of this command."""
419
# List of standard options directly supported
420
self.supported_std_options = []
423
def add_cleanup(self, cleanup_func, *args, **kwargs):
424
"""Register a function to call after self.run returns or raises.
426
Functions will be called in LIFO order.
428
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
430
def cleanup_now(self):
431
"""Execute and empty pending cleanup functions immediately.
433
After cleanup_now all registered cleanups are forgotten. add_cleanup
434
may be called again after cleanup_now; these cleanups will be called
435
after self.run returns or raises (or when cleanup_now is next called).
437
This is useful for releasing expensive or contentious resources (such
438
as write locks) before doing further work that does not require those
439
resources (such as writing results to self.outf). Note though, that
440
as it releases all resources, this may release locks that the command
441
wants to hold, so use should be done with care.
443
self._operation.cleanup_now()
445
@deprecated_method(deprecated_in((2, 1, 0)))
446
def _maybe_expand_globs(self, file_list):
447
"""Glob expand file_list if the platform does not do that itself.
449
Not used anymore, now that the bzr command-line parser globs on
452
:return: A possibly empty list of unicode paths.
454
Introduced in bzrlib 0.18.
459
"""Return single-line grammar for this command.
461
Only describes arguments, not options.
463
s = 'bzr ' + self.name() + ' '
464
for aname in self.takes_args:
465
aname = aname.upper()
466
if aname[-1] in ['$', '+']:
467
aname = aname[:-1] + '...'
468
elif aname[-1] == '?':
469
aname = '[' + aname[:-1] + ']'
470
elif aname[-1] == '*':
471
aname = '[' + aname[:-1] + '...]'
473
s = s[:-1] # remove last space
476
def get_help_text(self, additional_see_also=None, plain=True,
477
see_also_as_links=False, verbose=True):
478
"""Return a text string with help for this command.
480
:param additional_see_also: Additional help topics to be
482
:param plain: if False, raw help (reStructuredText) is
483
returned instead of plain text.
484
:param see_also_as_links: if True, convert items in 'See also'
485
list to internal links (used by bzr_man rstx generator)
486
:param verbose: if True, display the full help, otherwise
487
leave out the descriptive sections and just display
488
usage help (e.g. Purpose, Usage, Options) with a
489
message explaining how to obtain full help.
491
if self.l10n and not i18n.installed():
492
i18n.install() # Install i18n only for get_help_text for now.
495
# Note: If self.gettext() translates ':Usage:\n', the section will
496
# be shown after "Description" section and we don't want to
497
# translate the usage string.
498
# Though, bzr export-pot don't exports :Usage: section and it must
500
doc = self.gettext(doc)
502
doc = gettext("No help for this command.")
504
# Extract the summary (purpose) and sections out from the text
505
purpose,sections,order = self._get_help_parts(doc)
507
# If a custom usage section was provided, use it
508
if sections.has_key('Usage'):
509
usage = sections.pop('Usage')
511
usage = self._usage()
513
# The header is the purpose and usage
515
result += gettext(':Purpose: %s\n') % (purpose,)
516
if usage.find('\n') >= 0:
517
result += gettext(':Usage:\n%s\n') % (usage,)
519
result += gettext(':Usage: %s\n') % (usage,)
524
# XXX: optparse implicitly rewraps the help, and not always perfectly,
525
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
527
parser = option.get_optparser(self.options())
528
options = parser.format_option_help()
529
# FIXME: According to the spec, ReST option lists actually don't
530
# support options like --1.14 so that causes syntax errors (in Sphinx
531
# at least). As that pattern always appears in the commands that
532
# break, we trap on that and then format that block of 'format' options
533
# as a literal block. We use the most recent format still listed so we
534
# don't have to do that too often -- vila 20110514
535
if not plain and options.find(' --1.14 ') != -1:
536
options = options.replace(' format:\n', ' format::\n\n', 1)
537
if options.startswith('Options:'):
538
result += gettext(':Options:%s') % (options[len('options:'):],)
544
# Add the description, indenting it 2 spaces
545
# to match the indentation of the options
546
if sections.has_key(None):
547
text = sections.pop(None)
548
text = '\n '.join(text.splitlines())
549
result += gettext(':Description:\n %s\n\n') % (text,)
551
# Add the custom sections (e.g. Examples). Note that there's no need
552
# to indent these as they must be indented already in the source.
555
if label in sections:
556
result += ':%s:\n%s\n' % (label, sections[label])
559
result += (gettext("See bzr help %s for more details and examples.\n\n")
562
# Add the aliases, source (plug-in) and see also links, if any
564
result += gettext(':Aliases: ')
565
result += ', '.join(self.aliases) + '\n'
566
plugin_name = self.plugin_name()
567
if plugin_name is not None:
568
result += gettext(':From: plugin "%s"\n') % plugin_name
569
see_also = self.get_see_also(additional_see_also)
571
if not plain and see_also_as_links:
573
for item in see_also:
575
# topics doesn't have an independent section
576
# so don't create a real link
577
see_also_links.append(item)
579
# Use a Sphinx link for this entry
580
link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
581
see_also_links.append(link_text)
582
see_also = see_also_links
583
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
585
# If this will be rendered as plain text, convert it
587
import bzrlib.help_topics
588
result = bzrlib.help_topics.help_as_plain_text(result)
592
def _get_help_parts(text):
593
"""Split help text into a summary and named sections.
595
:return: (summary,sections,order) where summary is the top line and
596
sections is a dictionary of the rest indexed by section name.
597
order is the order the section appear in the text.
598
A section starts with a heading line of the form ":xxx:".
599
Indented text on following lines is the section value.
600
All text found outside a named section is assigned to the
601
default section which is given the key of None.
603
def save_section(sections, order, label, section):
605
if sections.has_key(label):
606
sections[label] += '\n' + section
609
sections[label] = section
611
lines = text.rstrip().splitlines()
612
summary = lines.pop(0)
615
label,section = None,''
617
if line.startswith(':') and line.endswith(':') and len(line) > 2:
618
save_section(sections, order, label, section)
619
label,section = line[1:-1],''
620
elif (label is not None) and len(line) > 1 and not line[0].isspace():
621
save_section(sections, order, label, section)
622
label,section = None,line
625
section += '\n' + line
628
save_section(sections, order, label, section)
629
return summary, sections, order
631
def get_help_topic(self):
632
"""Return the commands help topic - its name."""
635
def get_see_also(self, additional_terms=None):
636
"""Return a list of help topics that are related to this command.
638
The list is derived from the content of the _see_also attribute. Any
639
duplicates are removed and the result is in lexical order.
640
:param additional_terms: Additional help topics to cross-reference.
641
:return: A list of help topics.
643
see_also = set(getattr(self, '_see_also', []))
645
see_also.update(additional_terms)
646
return sorted(see_also)
196
if self.__doc__ == Command.__doc__:
197
warn("No help message set for %r" % self)
648
199
def options(self):
649
200
"""Return dict of valid options for this command.
651
202
Maps from long option name to option object."""
652
r = Option.STD_OPTIONS.copy()
204
r['help'] = Option.OPTIONS['help']
654
205
for o in self.takes_options:
655
if isinstance(o, basestring):
656
o = option.Option.OPTIONS[o]
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
658
if o.name in std_names:
659
self.supported_std_options.append(o.name)
662
def _setup_outf(self):
663
"""Return a file linked to stdout, which has proper encoding."""
664
self.outf = ui.ui_factory.make_output_stream(
665
encoding_type=self.encoding_type)
667
def run_argv_aliases(self, argv, alias_argv=None):
668
"""Parse the command line and run with extra aliases in alias_argv."""
669
args, opts = parse_args(self, argv, alias_argv)
672
# Process the standard options
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
673
214
if 'help' in opts: # e.g. bzr add --help
674
self.outf.write(self.get_help_text())
676
if 'usage' in opts: # e.g. bzr add --usage
677
self.outf.write(self.get_help_text(verbose=False))
679
trace.set_verbosity_level(option._verbosity_level)
680
if 'verbose' in self.supported_std_options:
681
opts['verbose'] = trace.is_verbose()
682
elif opts.has_key('verbose'):
684
if 'quiet' in self.supported_std_options:
685
opts['quiet'] = trace.is_quiet()
686
elif opts.has_key('quiet'):
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()))
689
224
# mix arguments and options into one dictionary
690
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
737
241
Return 0 or None if the command was successful, or a non-zero
738
242
shell error code if not. It's OK for this method to allow
739
243
an exception to raise up.
741
This method is automatically wrapped by Command.__init__ with a
742
cleanup operation, stored as self._operation. This can be used
743
via self.add_cleanup to perform automatic cleanups at the end of
746
The argument for run are assembled by introspection. So for instance,
747
if your command takes an argument files, you would declare::
749
def run(self, files=None):
752
raise NotImplementedError('no implementation of command %r'
245
raise NotImplementedError()
756
249
"""Return help message for this class."""
757
from inspect import getdoc
758
250
if self.__doc__ is Command.__doc__:
760
252
return getdoc(self)
762
def gettext(self, message):
763
"""Returns the gettext function used to translate this command's help.
765
Commands provided by plugins should override this to use their
768
return i18n.gettext_per_paragraph(message)
771
"""Return the canonical name for this command.
773
The name under which it was actually invoked is available in invoked_as.
775
255
return _unsquish_command_name(self.__class__.__name__)
777
def plugin_name(self):
778
"""Get the name of the plugin that provides this command.
780
:return: The name of the plugin or None if the command is builtin.
782
mod_parts = self.__module__.split('.')
783
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
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
789
class CommandHooks(Hooks):
790
"""Hooks related to Command object creation/enumeration."""
793
"""Create the default hooks.
795
These are all empty initially, because by default nothing should get
798
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
799
self.add_hook('extend_command',
800
"Called after creating a command object to allow modifications "
801
"such as adding or removing options, docs etc. Called with the "
802
"new bzrlib.commands.Command object.", (1, 13))
803
self.add_hook('get_command',
804
"Called when creating a single command. Called with "
805
"(cmd_or_None, command_name). get_command should either return "
806
"the cmd_or_None parameter, or a replacement Command object that "
807
"should be used for the command. Note that the Command.hooks "
808
"hooks are core infrastructure. Many users will prefer to use "
809
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
811
self.add_hook('get_missing_command',
812
"Called when creating a single command if no command could be "
813
"found. Called with (command_name). get_missing_command should "
814
"either return None, or a Command object to be used for the "
816
self.add_hook('list_commands',
817
"Called when enumerating commands. Called with a set of "
818
"cmd_name strings for all the commands found so far. This set "
819
" is safe to mutate - e.g. to remove a command. "
820
"list_commands should return the updated set of command names.",
823
Command.hooks = CommandHooks()
826
def parse_args(command, argv, alias_argv=None):
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):
827
290
"""Parse command line.
829
292
Arguments and options are parsed at this level before being passed
830
293
down to specific command handlers. This routine knows, from a
831
294
lookup table, something about the available options, what optargs
832
295
they take, and which commands will accept them.
834
# TODO: make it a method of the Command?
835
parser = option.get_optparser(command.options())
836
if alias_argv is not None:
837
args = alias_argv + argv
841
# for python 2.5 and later, optparse raises this exception if a non-ascii
842
# option name is given. See http://bugs.python.org/issue2931
844
options, args = parser.parse_args(args)
845
except UnicodeEncodeError,e:
846
raise errors.BzrCommandError('Only ASCII permitted in option names')
848
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
849
v is not option.OptionParser.DEFAULT_VALUE])
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)
850
379
return args, opts
935
447
os.remove(pfname)
938
def exception_to_return_code(the_callable, *args, **kwargs):
939
"""UI level helper for profiling and coverage.
941
This transforms exceptions into a return value of 3. As such its only
942
relevant to the UI layer, and should never be called where catching
943
exceptions may be desirable.
946
return the_callable(*args, **kwargs)
947
except (KeyboardInterrupt, Exception), e:
948
# used to handle AssertionError and KeyboardInterrupt
949
# specially here, but hopefully they're handled ok by the logger now
950
exc_info = sys.exc_info()
951
exitcode = trace.report_exception(exc_info, sys.stderr)
952
if os.environ.get('BZR_PDB'):
953
print '**** entering debugger'
956
if sys.version_info[:2] < (2, 6):
958
# pdb.post_mortem(tb)
959
# but because pdb.post_mortem gives bad results for tracebacks
960
# from inside generators, we do it manually.
961
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
963
# Setup pdb on the traceback
966
p.setup(tb.tb_frame, tb)
967
# Point the debugger at the deepest frame of the stack
968
p.curindex = len(p.stack) - 1
969
p.curframe = p.stack[p.curindex][0]
970
# Start the pdb prompt.
971
p.print_stack_entry(p.stack[p.curindex])
979
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
980
from bzrlib.lsprof import profile
981
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
987
trace.note('Profile data written to "%s".', filename)
991
@deprecated_function(deprecated_in((2, 2, 0)))
992
def shlex_split_unicode(unsplit):
993
return cmdline.split(unsplit)
996
def get_alias(cmd, config=None):
997
"""Return an expanded alias, or None if no alias exists.
1000
Command to be checked for an alias.
1002
Used to specify an alternative config to use,
1003
which is especially useful for testing.
1004
If it is unspecified, the global config will be used.
1007
import bzrlib.config
1008
config = bzrlib.config.GlobalConfig()
1009
alias = config.get_alias(cmd)
1011
return cmdline.split(alias)
1015
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1016
451
"""Execute a command.
1018
:param argv: The command-line arguments, without the program name from
1019
argv[0] These should already be decoded. All library/test code calling
1020
run_bzr should be passing valid strings (don't need decoding).
1021
:param load_plugins: What function to call when triggering plugin loading.
1022
This function should take no arguments and cause all plugins to be
1024
:param disable_plugins: What function to call when disabling plugin
1025
loading. This function should take no arguments and cause all plugin
1026
loading to be prohibited (so that code paths in your application that
1027
know about some plugins possibly being present will fail to import
1028
those plugins even if they are installed.)
1029
:return: Returns a command exit code or raises an exception.
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.
1031
461
Special master options: these must come before the command because
1032
462
they control how the command is interpreted.
1035
465
Do not load plugin modules at all
1038
Do not allow aliases
1041
468
Only use builtin commands. (Plugins are still allowed to change
1042
469
other behaviour.)
1045
Run under the Python hotshot profiler.
1048
Run under the Python lsprof profiler.
1051
Generate line coverage report in the specified directory.
1054
Specify the number of processes that can be run concurrently (selftest).
472
Run under the Python profiler.
1056
trace.mutter("bazaar version: " + bzrlib.__version__)
1057
argv = _specified_or_unicode_argv(argv)
1058
trace.mutter("bzr arguments: %r", argv)
474
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1060
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1061
opt_no_l10n = opt_no_aliases = False
1062
opt_lsprof_file = opt_coverage_dir = None
476
opt_profile = opt_no_plugins = opt_builtin = False
1064
478
# --no-plugins is handled specially at a very early stage. We need
1065
479
# to load plugins before doing other command parsing so that they
1066
480
# can override commands, but this needs to happen first.
1070
while i < len(argv):
1072
483
if a == '--profile':
1073
484
opt_profile = True
1074
elif a == '--lsprof':
1076
elif a == '--lsprof-file':
1078
opt_lsprof_file = argv[i + 1]
1080
485
elif a == '--no-plugins':
1081
486
opt_no_plugins = True
1082
elif a == '--no-aliases':
1083
opt_no_aliases = True
1084
elif a == '--no-l10n':
1086
487
elif a == '--builtin':
1087
488
opt_builtin = True
1088
elif a == '--concurrency':
1089
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1091
elif a == '--coverage':
1092
opt_coverage_dir = argv[i + 1]
1094
elif a == '--profile-imports':
1095
pass # already handled in startup script Bug #588277
1096
elif a.startswith('-D'):
1097
debug.debug_flags.add(a[2:])
1102
debug.set_debug_flags_from_config()
489
elif a in ('--quiet', '-q'):
495
if (not argv) or (argv[0] == '--help'):
496
from bzrlib.help import help
503
if argv[0] == '--version':
504
from bzrlib.builtins import show_version
1104
508
if not opt_no_plugins:
509
from bzrlib.plugin import load_plugins
1111
get_cmd_object('help').run_argv_aliases([])
1114
if argv[0] == '--version':
1115
get_cmd_object('version').run_argv_aliases([])
1120
if not opt_no_aliases:
1121
alias_argv = get_alias(argv[0])
1123
argv[0] = alias_argv.pop(0)
512
cmd = str(argv.pop(0))
1126
514
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1129
run = cmd_obj.run_argv_aliases
1130
run_argv = [argv, alias_argv]
1133
# We can be called recursively (tests for example), but we don't want
1134
# the verbosity level to propagate.
1135
saved_verbosity_level = option._verbosity_level
1136
option._verbosity_level = 0
1138
if opt_coverage_dir:
1140
'--coverage ignored, because --lsprof is in use.')
1141
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1143
if opt_coverage_dir:
1145
'--coverage ignored, because --profile is in use.')
1146
ret = apply_profiled(run, *run_argv)
1147
elif opt_coverage_dir:
1148
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
518
ret = apply_profiled(cmd_obj.run_argv, argv)
1150
ret = run(*run_argv)
520
ret = cmd_obj.run_argv(argv)
1153
# reset, in case we may do other commands later within the same
1154
# process. Commands that want to execute sub-commands must propagate
1155
# --verbose in their own way.
1156
if 'memory' in debug.debug_flags:
1157
trace.debug_memory('Process status after command:', short=False)
1158
option._verbosity_level = saved_verbosity_level
523
# reset, in case we may do other commands later within the same process
1161
526
def display_command(func):
1162
527
"""Decorator that suppresses pipe/interrupt errors."""
1166
531
sys.stdout.flush()
1168
533
except IOError, e:
1169
if getattr(e, 'errno', None) is None:
534
if not hasattr(e, 'errno'):
1171
536
if e.errno != errno.EPIPE:
1172
# Win32 raises IOError with errno=0 on a broken pipe
1173
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1176
539
except KeyboardInterrupt:
1178
541
return ignore_pipe
1181
def install_bzr_command_hooks():
1182
"""Install the hooks to supply bzr's own commands."""
1183
if _list_bzr_commands in Command.hooks["list_commands"]:
1185
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1187
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1189
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1190
"bzr plugin commands")
1191
Command.hooks.install_named_hook("get_command", _get_external_command,
1192
"bzr external command lookup")
1193
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1194
"bzr plugin-provider-db check")
1198
def _specified_or_unicode_argv(argv):
1199
# For internal or testing use, argv can be passed. Otherwise, get it from
1200
# the process arguments in a unicode-safe way.
1202
return osutils.get_unicode_argv()
1206
# ensure all arguments are unicode strings
1208
if isinstance(a, unicode):
1211
new_argv.append(a.decode('ascii'))
1212
except UnicodeDecodeError:
1213
raise errors.BzrError("argv should be list of unicode strings.")
1217
def main(argv=None):
1218
"""Main entry point of command-line interface.
1220
Typically `bzrlib.initialize` should be called first.
1222
:param argv: list of unicode command-line arguments similar to sys.argv.
1223
argv[0] is script name usually, it will be ignored.
1224
Don't pass here sys.argv because this list contains plain strings
1225
and not unicode; pass None instead.
1227
:return: exit code of bzr command.
1229
if argv is not None:
1231
_register_builtin_commands()
1232
ret = run_bzr_catch_errors(argv)
1233
trace.mutter("return code %d", ret)
546
from bzrlib.ui.text import TextUIFactory
547
## bzrlib.trace.enable_default_logging()
548
bzrlib.trace.log_startup(argv)
549
bzrlib.ui.ui_factory = TextUIFactory()
550
ret = run_bzr_catch_errors(argv[1:])
551
mutter("return code %d", ret)
1237
555
def run_bzr_catch_errors(argv):
1238
"""Run a bzr command with parameters as described by argv.
1240
This function assumed that that UI layer is setup, that symbol deprecations
1241
are already applied, and that unicode decoding has already been performed on argv.
1243
# done here so that they're covered for every test run
1244
install_bzr_command_hooks()
1245
return exception_to_return_code(run_bzr, argv)
1248
def run_bzr_catch_user_errors(argv):
1249
"""Run bzr and report user errors, but let internal errors propagate.
1251
This is used for the test suite, and might be useful for other programs
1252
that want to wrap the commandline interface.
1254
# done here so that they're covered for every test run
1255
install_bzr_command_hooks()
1257
return run_bzr(argv)
560
# do this here inside the exception wrappers to catch EPIPE
1258
562
except Exception, e:
1259
if (isinstance(e, (OSError, IOError))
1260
or not getattr(e, 'internal_error', True)):
1261
trace.report_exception(sys.exc_info(), sys.stderr)
1267
class HelpCommandIndex(object):
1268
"""A index for bzr help that returns commands."""
1271
self.prefix = 'commands/'
1273
def get_topics(self, topic):
1274
"""Search for topic amongst commands.
1276
:param topic: A topic to search for.
1277
:return: A list which is either empty or contains a single
1280
if topic and topic.startswith(self.prefix):
1281
topic = topic[len(self.prefix):]
1283
cmd = _get_cmd_object(topic, check_missing=False)
1290
class Provider(object):
1291
"""Generic class to be overriden by plugins"""
1293
def plugin_for_command(self, cmd_name):
1294
"""Takes a command and returns the information for that plugin
1296
:return: A dictionary with all the available information
1297
for the requested plugin
1299
raise NotImplementedError
1302
class ProvidersRegistry(registry.Registry):
1303
"""This registry exists to allow other providers to exist"""
1306
for key, provider in self.iteritems():
1309
command_providers_registry = ProvidersRegistry()
563
# used to handle AssertionError and KeyboardInterrupt
564
# specially here, but hopefully they're handled ok by the logger now
566
if (isinstance(e, IOError)
567
and hasattr(e, 'errno')
568
and e.errno == errno.EPIPE):
569
bzrlib.trace.note('broken pipe')
572
bzrlib.trace.log_exception()
573
if os.environ.get('BZR_PDB'):
574
print '**** entering debugger'
576
pdb.post_mortem(sys.exc_traceback)
579
if __name__ == '__main__':
580
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
