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.
37
from bzrlib.errors import (BzrError,
50
42
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
43
from bzrlib.revisionspec import RevisionSpec
44
from bzrlib.symbol_versioning import *
46
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
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
def _register_builtin_commands():
168
if builtin_command_registry.keys():
82
def _builtin_commands():
171
83
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):
179
for name, obj in module.__dict__.iteritems():
85
builtins = bzrlib.builtins.__dict__
180
87
if name.startswith("cmd_"):
181
real_name = _unsquish_command_name(name)
88
real_name = _unsquish_command_name(name)
89
r[real_name] = builtins[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))
208
94
def builtin_command_names():
209
"""Return list of builtin command names.
95
"""Return list of builtin command names."""
96
return _builtin_commands().keys()
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()
218
99
def plugin_command_names():
219
"""Returns command names from commands registered by plugins."""
220
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():
223
117
def get_cmd_object(cmd_name, plugins_override=True):
224
"""Return the command object for a command.
118
"""Return the canonical name and command class for a command.
227
121
If true, plugin commands can override builtins.
230
return _get_cmd_object(cmd_name, plugins_override)
232
raise errors.BzrCommandError(gettext('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:
315
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:
316
139
cmd_obj = ExternalCommand.find_command(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)()
143
raise BzrCommandError("unknown command %r" % cmd_name)
334
146
class Command(object):
349
161
summary, then a complete description of the command. A grammar
350
162
description will be inserted.
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
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
368
186
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"
400
190
takes_options = []
401
encoding_type = 'strict'
407
194
def __init__(self):
408
195
"""Construct an instance of this command."""
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.
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:`{0} <{1}-help>`").format(
559
see_also_links.append(link_text)
560
see_also = see_also_links
561
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
563
# If this will be rendered as plain text, convert it
565
import bzrlib.help_topics
566
result = bzrlib.help_topics.help_as_plain_text(result)
570
def _get_help_parts(text):
571
"""Split help text into a summary and named sections.
573
:return: (summary,sections,order) where summary is the top line and
574
sections is a dictionary of the rest indexed by section name.
575
order is the order the section appear in the text.
576
A section starts with a heading line of the form ":xxx:".
577
Indented text on following lines is the section value.
578
All text found outside a named section is assigned to the
579
default section which is given the key of None.
581
def save_section(sections, order, label, section):
583
if sections.has_key(label):
584
sections[label] += '\n' + section
587
sections[label] = section
589
lines = text.rstrip().splitlines()
590
summary = lines.pop(0)
593
label,section = None,''
595
if line.startswith(':') and line.endswith(':') and len(line) > 2:
596
save_section(sections, order, label, section)
597
label,section = line[1:-1],''
598
elif (label is not None) and len(line) > 1 and not line[0].isspace():
599
save_section(sections, order, label, section)
600
label,section = None,line
603
section += '\n' + line
606
save_section(sections, order, label, section)
607
return summary, sections, order
609
def get_help_topic(self):
610
"""Return the commands help topic - its name."""
613
def get_see_also(self, additional_terms=None):
614
"""Return a list of help topics that are related to this command.
616
The list is derived from the content of the _see_also attribute. Any
617
duplicates are removed and the result is in lexical order.
618
:param additional_terms: Additional help topics to cross-reference.
619
:return: A list of help topics.
621
see_also = set(getattr(self, '_see_also', []))
623
see_also.update(additional_terms)
624
return sorted(see_also)
196
if self.__doc__ == Command.__doc__:
197
warn("No help message set for %r" % self)
626
199
def options(self):
627
200
"""Return dict of valid options for this command.
629
202
Maps from long option name to option object."""
630
r = Option.STD_OPTIONS.copy()
204
r['help'] = Option.OPTIONS['help']
632
205
for o in self.takes_options:
633
if isinstance(o, basestring):
634
o = option.Option.OPTIONS[o]
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
636
if o.name in std_names:
637
self.supported_std_options.append(o.name)
640
def _setup_outf(self):
641
"""Return a file linked to stdout, which has proper encoding."""
642
self.outf = ui.ui_factory.make_output_stream(
643
encoding_type=self.encoding_type)
211
@deprecated_method(zero_eight)
212
def run_argv(self, argv):
213
"""Parse command line and run.
215
See run_argv_aliases for the 0.8 and beyond api.
217
return self.run_argv_aliases(argv)
645
219
def run_argv_aliases(self, argv, alias_argv=None):
646
220
"""Parse the command line and run with extra aliases in alias_argv."""
647
221
args, opts = parse_args(self, argv, alias_argv)
650
# Process the standard options
651
222
if 'help' in opts: # e.g. bzr add --help
652
self.outf.write(self.get_help_text())
654
if 'usage' in opts: # e.g. bzr add --usage
655
self.outf.write(self.get_help_text(verbose=False))
657
trace.set_verbosity_level(option._verbosity_level)
658
if 'verbose' in self.supported_std_options:
659
opts['verbose'] = trace.is_verbose()
660
elif opts.has_key('verbose'):
662
if 'quiet' in self.supported_std_options:
663
opts['quiet'] = trace.is_quiet()
664
elif opts.has_key('quiet'):
223
from bzrlib.help import help_on_command
224
help_on_command(self.name())
226
# XXX: This should be handled by the parser
227
allowed_names = self.options().keys()
229
if oname not in allowed_names:
230
raise BzrCommandError("option '--%s' is not allowed for"
231
" command %r" % (oname, self.name()))
667
232
# mix arguments and options into one dictionary
668
233
cmdargs = _match_argform(self.name(), self.takes_args, args)
710
249
Return 0 or None if the command was successful, or a non-zero
711
250
shell error code if not. It's OK for this method to allow
712
251
an exception to raise up.
714
This method is automatically wrapped by Command.__init__ with a
715
cleanup operation, stored as self._operation. This can be used
716
via self.add_cleanup to perform automatic cleanups at the end of
719
The argument for run are assembled by introspection. So for instance,
720
if your command takes an argument files, you would declare::
722
def run(self, files=None):
725
raise NotImplementedError('no implementation of command %r'
253
raise NotImplementedError()
729
257
"""Return help message for this class."""
730
from inspect import getdoc
731
258
if self.__doc__ is Command.__doc__:
733
260
return getdoc(self)
735
def gettext(self, message):
736
"""Returns the gettext function used to translate this command's help.
738
Commands provided by plugins should override this to use their
741
return i18n.gettext_per_paragraph(message)
744
"""Return the canonical name for this command.
746
The name under which it was actually invoked is available in invoked_as.
748
263
return _unsquish_command_name(self.__class__.__name__)
750
def plugin_name(self):
751
"""Get the name of the plugin that provides this command.
753
:return: The name of the plugin or None if the command is builtin.
755
mod_parts = self.__module__.split('.')
756
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
266
def parse_spec(spec):
272
>>> parse_spec("../@")
274
>>> parse_spec("../f/@35")
276
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
277
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
282
parsed = spec.split('/@')
283
assert len(parsed) == 2
762
class CommandHooks(Hooks):
763
"""Hooks related to Command object creation/enumeration."""
766
"""Create the default hooks.
768
These are all empty initially, because by default nothing should get
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
773
"Called after creating a command object to allow modifications "
774
"such as adding or removing options, docs etc. Called with the "
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
777
"Called when creating a single command. Called with "
778
"(cmd_or_None, command_name). get_command should either return "
779
"the cmd_or_None parameter, or a replacement Command object that "
780
"should be used for the command. Note that the Command.hooks "
781
"hooks are core infrastructure. Many users will prefer to use "
782
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
784
self.add_hook('get_missing_command',
785
"Called when creating a single command if no command could be "
786
"found. Called with (command_name). get_missing_command should "
787
"either return None, or a Command object to be used for the "
789
self.add_hook('list_commands',
790
"Called when enumerating commands. Called with a set of "
791
"cmd_name strings for all the commands found so far. This set "
792
" is safe to mutate - e.g. to remove a command. "
793
"list_commands should return the updated set of command names.",
796
Command.hooks = CommandHooks()
288
parsed[1] = int(parsed[1])
290
pass # We can allow stuff like ./@revid:blahblahblah
294
parsed = [spec, None]
799
297
def parse_args(command, argv, alias_argv=None):
800
298
"""Parse command line.
802
300
Arguments and options are parsed at this level before being passed
803
301
down to specific command handlers. This routine knows, from a
804
302
lookup table, something about the available options, what optargs
805
303
they take, and which commands will accept them.
807
# TODO: make it a method of the Command?
808
parser = option.get_optparser(command.options())
809
if alias_argv is not None:
810
args = alias_argv + argv
814
# for python 2.5 and later, optparse raises this exception if a non-ascii
815
# option name is given. See http://bugs.python.org/issue2931
817
options, args = parser.parse_args(args)
818
except UnicodeEncodeError,e:
819
raise errors.BzrCommandError(gettext('Only ASCII permitted in option names'))
821
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
822
v is not option.OptionParser.DEFAULT_VALUE])
305
# TODO: chop up this beast; make it a method of the Command
310
cmd_options = command.options()
312
proc_aliasarg = True # Are we processing alias_argv now?
313
for proc_argv in alias_argv, argv:
320
# We've received a standalone -- No more flags
324
# option names must not be unicode
328
mutter(" got option %r", a)
330
optname, optarg = a[2:].split('=', 1)
333
if optname not in cmd_options:
334
raise BzrOptionError('unknown long option %r for'
339
if shortopt in Option.SHORT_OPTIONS:
340
# Multi-character options must have a space to delimit
342
# ^^^ what does this mean? mbp 20051014
343
optname = Option.SHORT_OPTIONS[shortopt].name
345
# Single character short options, can be chained,
346
# and have their value appended to their name
348
if shortopt not in Option.SHORT_OPTIONS:
349
# We didn't find the multi-character name, and we
350
# didn't find the single char name
351
raise BzrError('unknown short option %r' % a)
352
optname = Option.SHORT_OPTIONS[shortopt].name
355
# There are extra things on this option
356
# see if it is the value, or if it is another
358
optargfn = Option.OPTIONS[optname].type
360
# This option does not take an argument, so the
361
# next entry is another short option, pack it
363
proc_argv.insert(0, '-' + a[2:])
365
# This option takes an argument, so pack it
369
if optname not in cmd_options:
370
raise BzrOptionError('unknown short option %r for'
372
(shortopt, command.name()))
374
# XXX: Do we ever want to support this, e.g. for -r?
376
raise BzrError('repeated option %r' % a)
377
elif optname in alias_opts:
378
# Replace what's in the alias with what's in the real
380
del alias_opts[optname]
382
proc_argv.insert(0, a)
385
raise BzrError('repeated option %r' % a)
387
option_obj = cmd_options[optname]
388
optargfn = option_obj.type
392
raise BzrError('option %r needs an argument' % a)
394
optarg = proc_argv.pop(0)
395
opts[optname] = optargfn(optarg)
397
alias_opts[optname] = optargfn(optarg)
400
raise BzrError('option %r takes no argument' % optname)
403
alias_opts[optname] = True
406
proc_aliasarg = False # Done with alias argv
823
407
return args, opts
912
475
os.remove(pfname)
915
def exception_to_return_code(the_callable, *args, **kwargs):
916
"""UI level helper for profiling and coverage.
918
This transforms exceptions into a return value of 3. As such its only
919
relevant to the UI layer, and should never be called where catching
920
exceptions may be desirable.
923
return the_callable(*args, **kwargs)
924
except (KeyboardInterrupt, Exception), e:
925
# used to handle AssertionError and KeyboardInterrupt
926
# specially here, but hopefully they're handled ok by the logger now
927
exc_info = sys.exc_info()
928
exitcode = trace.report_exception(exc_info, sys.stderr)
929
if os.environ.get('BZR_PDB'):
930
print '**** entering debugger'
933
if sys.version_info[:2] < (2, 6):
935
# pdb.post_mortem(tb)
936
# but because pdb.post_mortem gives bad results for tracebacks
937
# from inside generators, we do it manually.
938
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
940
# Setup pdb on the traceback
943
p.setup(tb.tb_frame, tb)
944
# Point the debugger at the deepest frame of the stack
945
p.curindex = len(p.stack) - 1
946
p.curframe = p.stack[p.curindex][0]
947
# Start the pdb prompt.
948
p.print_stack_entry(p.stack[p.curindex])
956
478
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
957
479
from bzrlib.lsprof import profile
958
ret, stats = profile(exception_to_return_code, the_callable,
481
ret, stats = profile(the_callable, *args, **kwargs)
961
483
if filename is None:
965
trace.note(gettext('Profile data written to "%s".'), filename)
487
cPickle.dump(stats, open(filename, 'w'), 2)
488
print 'Profile data written to %r.' % filename
969
def get_alias(cmd, config=None):
970
"""Return an expanded alias, or None if no alias exists.
973
Command to be checked for an alias.
975
Used to specify an alternative config to use,
976
which is especially useful for testing.
977
If it is unspecified, the global config will be used.
981
config = bzrlib.config.GlobalConfig()
982
alias = config.get_alias(cmd)
493
"""Return an expanded alias, or None if no alias exists"""
495
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
984
return cmdline.split(alias)
497
return alias.split(' ')
988
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
989
502
"""Execute a command.
991
:param argv: The command-line arguments, without the program name from
992
argv[0] These should already be decoded. All library/test code calling
993
run_bzr should be passing valid strings (don't need decoding).
994
:param load_plugins: What function to call when triggering plugin loading.
995
This function should take no arguments and cause all plugins to be
997
:param disable_plugins: What function to call when disabling plugin
998
loading. This function should take no arguments and cause all plugin
999
loading to be prohibited (so that code paths in your application that
1000
know about some plugins possibly being present will fail to import
1001
those plugins even if they are installed.)
1002
:return: Returns a command exit code or raises an exception.
504
This is similar to main(), but without all the trappings for
505
logging and error handling.
508
The command-line arguments, without the program name from argv[0]
510
Returns a command status or raises an exception.
1004
512
Special master options: these must come before the command because
1005
513
they control how the command is interpreted.
1047
547
elif a == '--lsprof':
1048
548
opt_lsprof = True
1049
549
elif a == '--lsprof-file':
1051
550
opt_lsprof_file = argv[i + 1]
1053
552
elif a == '--no-plugins':
1054
553
opt_no_plugins = True
1055
554
elif a == '--no-aliases':
1056
555
opt_no_aliases = True
1057
elif a == '--no-l10n':
1059
556
elif a == '--builtin':
1060
557
opt_builtin = True
1061
elif a == '--concurrency':
1062
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1064
elif a == '--coverage':
1065
opt_coverage_dir = argv[i + 1]
1067
elif a == '--profile-imports':
1068
pass # already handled in startup script Bug #588277
1069
elif a.startswith('-D'):
1070
debug.debug_flags.add(a[2:])
558
elif a in ('--quiet', '-q'):
1072
561
argv_copy.append(a)
1075
debug.set_debug_flags_from_config()
565
if (not argv) or (argv[0] == '--help'):
566
from bzrlib.help import help
573
if argv[0] == '--version':
574
from bzrlib.builtins import show_version
1077
578
if not opt_no_plugins:
579
from bzrlib.plugin import load_plugins
582
from bzrlib.plugin import disable_plugins
1080
583
disable_plugins()
1084
get_cmd_object('help').run_argv_aliases([])
1087
if argv[0] == '--version':
1088
get_cmd_object('version').run_argv_aliases([])
1091
585
alias_argv = None
1093
587
if not opt_no_aliases:
1094
588
alias_argv = get_alias(argv[0])
590
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1096
591
argv[0] = alias_argv.pop(0)
593
cmd = str(argv.pop(0))
1099
595
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1102
run = cmd_obj.run_argv_aliases
1103
run_argv = [argv, alias_argv]
596
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
597
run = cmd_obj.run_argv
600
run = cmd_obj.run_argv_aliases
601
run_argv = [argv, alias_argv]
1106
# We can be called recursively (tests for example), but we don't want
1107
# the verbosity level to propagate.
1108
saved_verbosity_level = option._verbosity_level
1109
option._verbosity_level = 0
1111
if opt_coverage_dir:
1113
'--coverage ignored, because --lsprof is in use.')
1114
605
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1115
606
elif opt_profile:
1116
if opt_coverage_dir:
1118
'--coverage ignored, because --profile is in use.')
1119
607
ret = apply_profiled(run, *run_argv)
1120
elif opt_coverage_dir:
1121
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1123
609
ret = run(*run_argv)
1126
# reset, in case we may do other commands later within the same
1127
# process. Commands that want to execute sub-commands must propagate
1128
# --verbose in their own way.
1129
if 'memory' in debug.debug_flags:
1130
trace.debug_memory('Process status after command:', short=False)
1131
option._verbosity_level = saved_verbosity_level
612
# reset, in case we may do other commands later within the same process
1134
615
def display_command(func):
1135
616
"""Decorator that suppresses pipe/interrupt errors."""
1139
620
sys.stdout.flush()
1141
622
except IOError, e:
1142
if getattr(e, 'errno', None) is None:
623
if not hasattr(e, 'errno'):
1144
625
if e.errno != errno.EPIPE:
1145
# Win32 raises IOError with errno=0 on a broken pipe
1146
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1149
628
except KeyboardInterrupt:
1151
630
return ignore_pipe
1154
def install_bzr_command_hooks():
1155
"""Install the hooks to supply bzr's own commands."""
1156
if _list_bzr_commands in Command.hooks["list_commands"]:
1158
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1160
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1162
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1163
"bzr plugin commands")
1164
Command.hooks.install_named_hook("get_command", _get_external_command,
1165
"bzr external command lookup")
1166
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1167
"bzr plugin-provider-db check")
1171
def _specified_or_unicode_argv(argv):
1172
# For internal or testing use, argv can be passed. Otherwise, get it from
1173
# the process arguments in a unicode-safe way.
1175
return osutils.get_unicode_argv()
1179
# ensure all arguments are unicode strings
1181
if isinstance(a, unicode):
1184
new_argv.append(a.decode('ascii'))
1185
except UnicodeDecodeError:
1186
raise errors.BzrError("argv should be list of unicode strings.")
1190
def main(argv=None):
1191
"""Main entry point of command-line interface.
1193
Typically `bzrlib.initialize` should be called first.
1195
:param argv: list of unicode command-line arguments similar to sys.argv.
1196
argv[0] is script name usually, it will be ignored.
1197
Don't pass here sys.argv because this list contains plain strings
1198
and not unicode; pass None instead.
1200
:return: exit code of bzr command.
1202
if argv is not None:
1204
_register_builtin_commands()
1205
ret = run_bzr_catch_errors(argv)
1206
trace.mutter("return code %d", ret)
635
from bzrlib.ui.text import TextUIFactory
636
## bzrlib.trace.enable_default_logging()
637
bzrlib.trace.log_startup(argv)
638
bzrlib.ui.ui_factory = TextUIFactory()
639
ret = run_bzr_catch_errors(argv[1:])
640
mutter("return code %d", ret)
1210
644
def run_bzr_catch_errors(argv):
1211
"""Run a bzr command with parameters as described by argv.
1213
This function assumed that that UI layer is setup, that symbol deprecations
1214
are already applied, and that unicode decoding has already been performed on argv.
1216
# done here so that they're covered for every test run
1217
install_bzr_command_hooks()
1218
return exception_to_return_code(run_bzr, argv)
1221
def run_bzr_catch_user_errors(argv):
1222
"""Run bzr and report user errors, but let internal errors propagate.
1224
This is used for the test suite, and might be useful for other programs
1225
that want to wrap the commandline interface.
1227
# done here so that they're covered for every test run
1228
install_bzr_command_hooks()
1230
return run_bzr(argv)
649
# do this here inside the exception wrappers to catch EPIPE
1231
651
except Exception, e:
1232
if (isinstance(e, (OSError, IOError))
1233
or not getattr(e, 'internal_error', True)):
1234
trace.report_exception(sys.exc_info(), sys.stderr)
1240
class HelpCommandIndex(object):
1241
"""A index for bzr help that returns commands."""
1244
self.prefix = 'commands/'
1246
def get_topics(self, topic):
1247
"""Search for topic amongst commands.
1249
:param topic: A topic to search for.
1250
:return: A list which is either empty or contains a single
1253
if topic and topic.startswith(self.prefix):
1254
topic = topic[len(self.prefix):]
1256
cmd = _get_cmd_object(topic, check_missing=False)
1263
class Provider(object):
1264
"""Generic class to be overriden by plugins"""
1266
def plugin_for_command(self, cmd_name):
1267
"""Takes a command and returns the information for that plugin
1269
:return: A dictionary with all the available information
1270
for the requested plugin
1272
raise NotImplementedError
1275
class ProvidersRegistry(registry.Registry):
1276
"""This registry exists to allow other providers to exist"""
1279
for key, provider in self.iteritems():
1282
command_providers_registry = ProvidersRegistry()
652
# used to handle AssertionError and KeyboardInterrupt
653
# specially here, but hopefully they're handled ok by the logger now
655
if (isinstance(e, IOError)
656
and hasattr(e, 'errno')
657
and e.errno == errno.EPIPE):
658
bzrlib.trace.note('broken pipe')
661
bzrlib.trace.log_exception()
662
if os.environ.get('BZR_PDB'):
663
print '**** entering debugger'
665
pdb.post_mortem(sys.exc_traceback)
668
if __name__ == '__main__':
669
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
