26
24
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
33
from warnings import warn
29
from bzrlib.lazy_import import lazy_import
30
lazy_import(globals(), """
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError,
49
from bzrlib.hooks import Hooks
50
from bzrlib.i18n import gettext
51
# Compatibility - Option used to be in commands.
43
52
from bzrlib.option import Option
45
from bzrlib.revisionspec import RevisionSpec
46
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
47
from bzrlib import trace
48
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
53
from bzrlib.plugin import disable_plugins, load_plugins
54
from bzrlib import registry
57
class CommandInfo(object):
58
"""Information about a command."""
60
def __init__(self, aliases):
61
"""The list of aliases for the command."""
62
self.aliases = aliases
65
def from_command(klass, command):
66
"""Factory to construct a CommandInfo from a command."""
67
return klass(command.aliases)
70
class CommandRegistry(registry.Registry):
71
"""Special registry mapping command names to command classes.
73
:ivar overridden_registry: Look in this registry for commands being
74
overridden by this registry. This can be used to tell plugin commands
75
about the builtin they're decorating.
79
registry.Registry.__init__(self)
80
self.overridden_registry = None
81
# map from aliases to the real command that implements the name
84
def get(self, command_name):
85
real_name = self._alias_dict.get(command_name, command_name)
86
return registry.Registry.get(self, real_name)
89
def _get_name(command_name):
90
if command_name.startswith("cmd_"):
91
return _unsquish_command_name(command_name)
95
def register(self, cmd, decorate=False):
96
"""Utility function to help register a command
98
:param cmd: Command subclass to register
99
:param decorate: If true, allow overriding an existing command
100
of the same name; the old command is returned by this function.
101
Otherwise it is an error to try to override an existing command.
104
k_unsquished = self._get_name(k)
106
previous = self.get(k_unsquished)
109
if self.overridden_registry:
111
previous = self.overridden_registry.get(k_unsquished)
114
info = CommandInfo.from_command(cmd)
116
registry.Registry.register(self, k_unsquished, cmd,
117
override_existing=decorate, info=info)
119
trace.warning('Two plugins defined the same command: %r' % k)
120
trace.warning('Not loading the one in %r' %
121
sys.modules[cmd.__module__])
122
trace.warning('Previously this command was registered from %r' %
123
sys.modules[previous.__module__])
124
for a in cmd.aliases:
125
self._alias_dict[a] = k_unsquished
128
def register_lazy(self, command_name, aliases, module_name):
129
"""Register a command without loading its module.
131
:param command_name: The primary name of the command.
132
:param aliases: A list of aliases for the command.
133
:module_name: The module that the command lives in.
135
key = self._get_name(command_name)
136
registry.Registry.register_lazy(self, key, module_name, command_name,
137
info=CommandInfo(aliases))
139
self._alias_dict[a] = key
142
plugin_cmds = CommandRegistry()
143
builtin_command_registry = CommandRegistry()
144
plugin_cmds.overridden_registry = builtin_command_registry
53
147
def register_command(cmd, decorate=False):
54
"""Utility function to help register a command
148
"""Register a plugin command.
56
:param cmd: Command subclass to register
57
:param decorate: If true, allow overriding an existing command
58
of the same name; the old command is returned by this function.
59
Otherwise it is an error to try to override an existing command.
150
Should generally be avoided in favor of lazy registration.
61
152
global plugin_cmds
63
if k.startswith("cmd_"):
64
k_unsquished = _unsquish_command_name(k)
67
if not plugin_cmds.has_key(k_unsquished):
68
plugin_cmds[k_unsquished] = cmd
69
mutter('registered plugin command %s', k_unsquished)
70
if decorate and k_unsquished in builtin_command_names():
71
return _builtin_commands()[k_unsquished]
73
result = plugin_cmds[k_unsquished]
74
plugin_cmds[k_unsquished] = cmd
77
log_error('Two plugins defined the same command: %r' % k)
78
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
153
return plugin_cmds.register(cmd, decorate)
81
156
def _squish_command_name(cmd):
85
160
def _unsquish_command_name(cmd):
86
assert cmd.startswith("cmd_")
87
161
return cmd[4:].replace('_','-')
90
def _builtin_commands():
164
def _register_builtin_commands():
165
if builtin_command_registry.keys():
91
168
import bzrlib.builtins
169
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
170
builtin_command_registry.register(cmd_class)
171
bzrlib.builtins._register_lazy_builtins()
174
def _scan_module_for_commands(module):
93
builtins = bzrlib.builtins.__dict__
176
for name, obj in module.__dict__.iteritems():
95
177
if name.startswith("cmd_"):
96
178
real_name = _unsquish_command_name(name)
97
r[real_name] = builtins[name]
183
def _list_bzr_commands(names):
184
"""Find commands from bzr's core and plugins.
186
This is not the public interface, just the default hook called by all_command_names.
188
# to eliminate duplicates
189
names.update(builtin_command_names())
190
names.update(plugin_command_names())
194
def all_command_names():
195
"""Return a set of all command names."""
197
for hook in Command.hooks['list_commands']:
200
raise AssertionError(
201
'hook %s returned None' % Command.hooks.get_hook_name(hook))
101
205
def builtin_command_names():
102
"""Return list of builtin command names."""
103
return _builtin_commands().keys()
206
"""Return list of builtin command names.
208
Use of all_command_names() is encouraged rather than builtin_command_names
209
and/or plugin_command_names.
211
_register_builtin_commands()
212
return builtin_command_registry.keys()
106
215
def plugin_command_names():
216
"""Returns command names from commands registered by plugins."""
107
217
return plugin_cmds.keys()
110
def _get_cmd_dict(plugins_override=True):
111
"""Return name->class mapping for all commands."""
112
d = _builtin_commands()
114
d.update(plugin_cmds)
118
def get_all_cmds(plugins_override=True):
119
"""Return canonical name and class for all registered commands."""
120
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
124
220
def get_cmd_object(cmd_name, plugins_override=True):
125
"""Return the canonical name and command class for a command.
221
"""Return the command object for a command.
128
224
If true, plugin commands can override builtins.
227
return _get_cmd_object(cmd_name, plugins_override)
229
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
232
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
233
"""Get a command object.
235
:param cmd_name: The name of the command.
236
:param plugins_override: Allow plugins to override builtins.
237
:param check_missing: Look up commands not found in the regular index via
238
the get_missing_command hook.
239
:return: A Command object instance
240
:raises KeyError: If no command is found.
242
# We want only 'ascii' command names, but the user may have typed
243
# in a Unicode name. In that case, they should just get a
244
# 'command not found' error later.
245
# In the future, we may actually support Unicode command names.
248
for hook in Command.hooks['get_command']:
249
cmd = hook(cmd, cmd_name)
250
if cmd is not None and not plugins_override and not cmd.plugin_name():
251
# We've found a non-plugin command, don't permit it to be
254
if cmd is None and check_missing:
255
for hook in Command.hooks['get_missing_command']:
262
# Allow plugins to extend commands
263
for hook in Command.hooks['extend_command']:
265
if getattr(cmd, 'invoked_as', None) is None:
266
cmd.invoked_as = cmd_name
270
def _try_plugin_provider(cmd_name):
271
"""Probe for a plugin provider having cmd_name."""
273
plugin_metadata, provider = probe_for_provider(cmd_name)
274
raise errors.CommandAvailableInPlugin(cmd_name,
275
plugin_metadata, provider)
276
except errors.NoPluginAvailable:
280
def probe_for_provider(cmd_name):
281
"""Look for a provider for cmd_name.
283
:param cmd_name: The command name.
284
:return: plugin_metadata, provider for getting cmd_name.
285
:raises NoPluginAvailable: When no provider can supply the plugin.
287
# look for providers that provide this command but aren't installed
288
for provider in command_providers_registry:
290
return provider.plugin_for_command(cmd_name), provider
291
except errors.NoPluginAvailable:
293
raise errors.NoPluginAvailable(cmd_name)
296
def _get_bzr_command(cmd_or_None, cmd_name):
297
"""Get a command from bzr's core."""
299
cmd_class = builtin_command_registry.get(cmd_name)
307
def _get_external_command(cmd_or_None, cmd_name):
308
"""Lookup a command that is a shell script."""
309
# Only do external command lookups when no command is found so far.
310
if cmd_or_None is not None:
130
312
from bzrlib.externalcommand import ExternalCommand
132
cmd_name = str(cmd_name) # not unicode
134
# first look up this command under the specified name
135
cmds = _get_cmd_dict(plugins_override=plugins_override)
137
return cmds[cmd_name]()
141
# look for any command which claims this as an alias
142
for real_cmd_name, cmd_class in cmds.iteritems():
143
if cmd_name in cmd_class.aliases:
146
313
cmd_obj = ExternalCommand.find_command(cmd_name)
150
raise BzrCommandError('unknown command "%s"' % cmd_name)
318
def _get_plugin_command(cmd_or_None, cmd_name):
319
"""Get a command from bzr's plugins."""
321
return plugin_cmds.get(cmd_name)()
324
for key in plugin_cmds.keys():
325
info = plugin_cmds.get_info(key)
326
if cmd_name in info.aliases:
327
return plugin_cmds.get(key)()
153
331
class Command(object):
168
346
summary, then a complete description of the command. A grammar
169
347
description will be inserted.
172
Other accepted names for this command.
175
List of argument forms, marked with whether they are optional,
180
['to_location', 'from_branch?', 'file*']
182
'to_location' is required
183
'from_branch' is optional
184
'file' can be specified 0 or more times
187
List of options that may be given for this command. These can
188
be either strings, referring to globally-defined options,
189
or option objects. Retrieve through options().
192
If true, this command isn't advertised. This is typically
349
:cvar aliases: Other accepted names for this command.
351
:cvar takes_args: List of argument forms, marked with whether they are
352
optional, repeated, etc. Examples::
354
['to_location', 'from_branch?', 'file*']
356
* 'to_location' is required
357
* 'from_branch' is optional
358
* 'file' can be specified 0 or more times
360
:cvar takes_options: List of options that may be given for this command.
361
These can be either strings, referring to globally-defined options, or
362
option objects. Retrieve through options().
364
:cvar hidden: If true, this command isn't advertised. This is typically
193
365
for commands intended for expert users.
196
Command objects will get a 'outf' attribute, which has been
197
setup to properly handle encoding of unicode strings.
198
encoding_type determines what will happen when characters cannot
200
strict - abort if we cannot decode
201
replace - put in a bogus character (typically '?')
202
exact - do not encode sys.stdout
367
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
368
been setup to properly handle encoding of unicode strings.
369
encoding_type determines what will happen when characters cannot be
372
* strict - abort if we cannot decode
373
* replace - put in a bogus character (typically '?')
374
* exact - do not encode sys.stdout
376
NOTE: by default on Windows, sys.stdout is opened as a text stream,
377
therefore LF line-endings are converted to CRLF. When a command uses
378
encoding_type = 'exact', then sys.stdout is forced to be a binary
379
stream, and line-endings will not mangled.
382
A string indicating the real name under which this command was
383
invoked, before expansion of aliases.
384
(This may be None if the command was constructed and run in-process.)
386
:cvar hooks: An instance of CommandHooks.
388
:cvar __doc__: The help shown by 'bzr help command' for this command.
389
This is set by assigning explicitly to __doc__ so that -OO can
393
__doc__ = "My help goes here"
207
397
takes_options = []
208
398
encoding_type = 'strict'
212
404
def __init__(self):
213
405
"""Construct an instance of this command."""
214
if self.__doc__ == Command.__doc__:
215
warn("No help message set for %r" % self)
406
# List of standard options directly supported
407
self.supported_std_options = []
410
def add_cleanup(self, cleanup_func, *args, **kwargs):
411
"""Register a function to call after self.run returns or raises.
413
Functions will be called in LIFO order.
415
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
417
def cleanup_now(self):
418
"""Execute and empty pending cleanup functions immediately.
420
After cleanup_now all registered cleanups are forgotten. add_cleanup
421
may be called again after cleanup_now; these cleanups will be called
422
after self.run returns or raises (or when cleanup_now is next called).
424
This is useful for releasing expensive or contentious resources (such
425
as write locks) before doing further work that does not require those
426
resources (such as writing results to self.outf). Note though, that
427
as it releases all resources, this may release locks that the command
428
wants to hold, so use should be done with care.
430
self._operation.cleanup_now()
433
"""Return single-line grammar for this command.
435
Only describes arguments, not options.
437
s = 'bzr ' + self.name() + ' '
438
for aname in self.takes_args:
439
aname = aname.upper()
440
if aname[-1] in ['$', '+']:
441
aname = aname[:-1] + '...'
442
elif aname[-1] == '?':
443
aname = '[' + aname[:-1] + ']'
444
elif aname[-1] == '*':
445
aname = '[' + aname[:-1] + '...]'
447
s = s[:-1] # remove last space
450
def get_help_text(self, additional_see_also=None, plain=True,
451
see_also_as_links=False, verbose=True):
452
"""Return a text string with help for this command.
454
:param additional_see_also: Additional help topics to be
456
:param plain: if False, raw help (reStructuredText) is
457
returned instead of plain text.
458
:param see_also_as_links: if True, convert items in 'See also'
459
list to internal links (used by bzr_man rstx generator)
460
:param verbose: if True, display the full help, otherwise
461
leave out the descriptive sections and just display
462
usage help (e.g. Purpose, Usage, Options) with a
463
message explaining how to obtain full help.
466
i18n.install() # Install i18n only for get_help_text for now.
469
# Note: If self.gettext() translates ':Usage:\n', the section will
470
# be shown after "Description" section and we don't want to
471
# translate the usage string.
472
# Though, bzr export-pot don't exports :Usage: section and it must
474
doc = self.gettext(doc)
476
doc = gettext("No help for this command.")
478
# Extract the summary (purpose) and sections out from the text
479
purpose,sections,order = self._get_help_parts(doc)
481
# If a custom usage section was provided, use it
482
if sections.has_key('Usage'):
483
usage = sections.pop('Usage')
485
usage = self._usage()
487
# The header is the purpose and usage
489
result += gettext(':Purpose: %s\n') % (purpose,)
490
if usage.find('\n') >= 0:
491
result += gettext(':Usage:\n%s\n') % (usage,)
493
result += gettext(':Usage: %s\n') % (usage,)
498
# XXX: optparse implicitly rewraps the help, and not always perfectly,
499
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
501
parser = option.get_optparser(self.options())
502
options = parser.format_option_help()
503
# FIXME: According to the spec, ReST option lists actually don't
504
# support options like --1.14 so that causes syntax errors (in Sphinx
505
# at least). As that pattern always appears in the commands that
506
# break, we trap on that and then format that block of 'format' options
507
# as a literal block. We use the most recent format still listed so we
508
# don't have to do that too often -- vila 20110514
509
if not plain and options.find(' --1.14 ') != -1:
510
options = options.replace(' format:\n', ' format::\n\n', 1)
511
if options.startswith('Options:'):
512
result += gettext(':Options:%s') % (options[len('options:'):],)
518
# Add the description, indenting it 2 spaces
519
# to match the indentation of the options
520
if sections.has_key(None):
521
text = sections.pop(None)
522
text = '\n '.join(text.splitlines())
523
result += gettext(':Description:\n %s\n\n') % (text,)
525
# Add the custom sections (e.g. Examples). Note that there's no need
526
# to indent these as they must be indented already in the source.
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
536
# Add the aliases, source (plug-in) and see also links, if any
538
result += gettext(':Aliases: ')
539
result += ', '.join(self.aliases) + '\n'
540
plugin_name = self.plugin_name()
541
if plugin_name is not None:
542
result += gettext(':From: plugin "%s"\n') % plugin_name
543
see_also = self.get_see_also(additional_see_also)
545
if not plain and see_also_as_links:
547
for item in see_also:
549
# topics doesn't have an independent section
550
# so don't create a real link
551
see_also_links.append(item)
553
# Use a Sphinx link for this entry
554
link_text = gettext(":doc:`{0} <{1}-help>`").format(
556
see_also_links.append(link_text)
557
see_also = see_also_links
558
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
560
# If this will be rendered as plain text, convert it
562
import bzrlib.help_topics
563
result = bzrlib.help_topics.help_as_plain_text(result)
567
def _get_help_parts(text):
568
"""Split help text into a summary and named sections.
570
:return: (summary,sections,order) where summary is the top line and
571
sections is a dictionary of the rest indexed by section name.
572
order is the order the section appear in the text.
573
A section starts with a heading line of the form ":xxx:".
574
Indented text on following lines is the section value.
575
All text found outside a named section is assigned to the
576
default section which is given the key of None.
578
def save_section(sections, order, label, section):
580
if sections.has_key(label):
581
sections[label] += '\n' + section
584
sections[label] = section
586
lines = text.rstrip().splitlines()
587
summary = lines.pop(0)
590
label,section = None,''
592
if line.startswith(':') and line.endswith(':') and len(line) > 2:
593
save_section(sections, order, label, section)
594
label,section = line[1:-1],''
595
elif (label is not None) and len(line) > 1 and not line[0].isspace():
596
save_section(sections, order, label, section)
597
label,section = None,line
600
section += '\n' + line
603
save_section(sections, order, label, section)
604
return summary, sections, order
606
def get_help_topic(self):
607
"""Return the commands help topic - its name."""
610
def get_see_also(self, additional_terms=None):
611
"""Return a list of help topics that are related to this command.
613
The list is derived from the content of the _see_also attribute. Any
614
duplicates are removed and the result is in lexical order.
615
:param additional_terms: Additional help topics to cross-reference.
616
:return: A list of help topics.
618
see_also = set(getattr(self, '_see_also', []))
620
see_also.update(additional_terms)
621
return sorted(see_also)
217
623
def options(self):
218
624
"""Return dict of valid options for this command.
220
626
Maps from long option name to option object."""
222
r['help'] = Option.OPTIONS['help']
627
r = Option.STD_OPTIONS.copy()
223
629
for o in self.takes_options:
224
if not isinstance(o, Option):
225
o = Option.OPTIONS[o]
630
if isinstance(o, basestring):
631
o = option.Option.OPTIONS[o]
633
if o.name in std_names:
634
self.supported_std_options.append(o.name)
229
637
def _setup_outf(self):
230
638
"""Return a file linked to stdout, which has proper encoding."""
231
assert self.encoding_type in ['strict', 'exact', 'replace']
233
# Originally I was using self.stdout, but that looks
234
# *way* too much like sys.stdout
235
if self.encoding_type == 'exact':
236
self.outf = sys.stdout
239
output_encoding = bzrlib.osutils.get_terminal_encoding()
241
# use 'replace' so that we don't abort if trying to write out
242
# in e.g. the default C locale.
243
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
244
# For whatever reason codecs.getwriter() does not advertise its encoding
245
# it just returns the encoding of the wrapped file, which is completely
246
# bogus. So set the attribute, so we can find the correct encoding later.
247
self.outf.encoding = output_encoding
249
@deprecated_method(zero_eight)
250
def run_argv(self, argv):
251
"""Parse command line and run.
253
See run_argv_aliases for the 0.8 and beyond api.
255
return self.run_argv_aliases(argv)
639
self.outf = ui.ui_factory.make_output_stream(
640
encoding_type=self.encoding_type)
257
642
def run_argv_aliases(self, argv, alias_argv=None):
258
643
"""Parse the command line and run with extra aliases in alias_argv."""
259
644
args, opts = parse_args(self, argv, alias_argv)
647
# Process the standard options
260
648
if 'help' in opts: # e.g. bzr add --help
261
from bzrlib.help import help_on_command
262
help_on_command(self.name())
264
# XXX: This should be handled by the parser
265
allowed_names = self.options().keys()
267
if oname not in allowed_names:
268
raise BzrOptionError("option '--%s' is not allowed for"
269
" command %r" % (oname, self.name()))
649
self.outf.write(self.get_help_text())
651
if 'usage' in opts: # e.g. bzr add --usage
652
self.outf.write(self.get_help_text(verbose=False))
654
trace.set_verbosity_level(option._verbosity_level)
655
if 'verbose' in self.supported_std_options:
656
opts['verbose'] = trace.is_verbose()
657
elif opts.has_key('verbose'):
659
if 'quiet' in self.supported_std_options:
660
opts['quiet'] = trace.is_quiet()
661
elif opts.has_key('quiet'):
270
663
# mix arguments and options into one dictionary
271
664
cmdargs = _match_argform(self.name(), self.takes_args, args)
318
def parse_spec(spec):
324
>>> parse_spec("../@")
326
>>> parse_spec("../f/@35")
328
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
329
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
334
parsed = spec.split('/@')
335
assert len(parsed) == 2
340
parsed[1] = int(parsed[1])
342
pass # We can allow stuff like ./@revid:blahblahblah
346
parsed = [spec, None]
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.",
795
self.add_hook('pre_command',
796
"Called prior to executing a command. Called with the command "
798
self.add_hook('post_command',
799
"Called after executing a command. Called with the command "
802
Command.hooks = CommandHooks()
349
805
def parse_args(command, argv, alias_argv=None):
350
806
"""Parse command line.
352
808
Arguments and options are parsed at this level before being passed
353
809
down to specific command handlers. This routine knows, from a
354
810
lookup table, something about the available options, what optargs
355
811
they take, and which commands will accept them.
357
# TODO: chop up this beast; make it a method of the Command
362
cmd_options = command.options()
364
proc_aliasarg = True # Are we processing alias_argv now?
365
for proc_argv in alias_argv, argv:
375
# We've received a standalone -- No more flags
379
# option names must not be unicode
383
mutter(" got option %r", a)
385
optname, optarg = a[2:].split('=', 1)
388
if optname not in cmd_options:
389
raise BzrCommandError('unknown option "%s"' % a)
392
if shortopt in Option.SHORT_OPTIONS:
393
# Multi-character options must have a space to delimit
395
# ^^^ what does this mean? mbp 20051014
396
optname = Option.SHORT_OPTIONS[shortopt].name
398
# Single character short options, can be chained,
399
# and have their value appended to their name
401
if shortopt not in Option.SHORT_OPTIONS:
402
# We didn't find the multi-character name, and we
403
# didn't find the single char name
404
raise BzrCommandError('unknown option "%s"' % a)
405
optname = Option.SHORT_OPTIONS[shortopt].name
408
# There are extra things on this option
409
# see if it is the value, or if it is another
411
optargfn = Option.OPTIONS[optname].type
413
# This option does not take an argument, so the
414
# next entry is another short option, pack it
416
proc_argv.insert(0, '-' + a[2:])
418
# This option takes an argument, so pack it
421
if optname not in cmd_options:
422
raise BzrCommandError('unknown option "%s"' % shortopt)
424
# XXX: Do we ever want to support this, e.g. for -r?
426
raise BzrCommandError('repeated option %r' % a)
427
elif optname in alias_opts:
428
# Replace what's in the alias with what's in the real
430
del alias_opts[optname]
432
proc_argv.insert(0, a)
435
raise BzrCommandError('repeated option %r' % a)
437
option_obj = cmd_options[optname]
438
optargfn = option_obj.type
442
raise BzrCommandError('option %r needs an argument' % a)
444
optarg = proc_argv.pop(0)
445
opts[optname] = optargfn(optarg)
447
alias_opts[optname] = optargfn(optarg)
450
raise BzrCommandError('option %r takes no argument' % optname)
453
alias_opts[optname] = True
456
proc_aliasarg = False # Done with alias argv
813
# TODO: make it a method of the Command?
814
parser = option.get_optparser(command.options())
815
if alias_argv is not None:
816
args = alias_argv + argv
820
# for python 2.5 and later, optparse raises this exception if a non-ascii
821
# option name is given. See http://bugs.python.org/issue2931
823
options, args = parser.parse_args(args)
824
except UnicodeEncodeError,e:
825
raise errors.BzrCommandError(
826
gettext('Only ASCII permitted in option names'))
828
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
829
v is not option.OptionParser.DEFAULT_VALUE])
457
830
return args, opts
525
919
os.remove(pfname)
922
def exception_to_return_code(the_callable, *args, **kwargs):
923
"""UI level helper for profiling and coverage.
925
This transforms exceptions into a return value of 3. As such its only
926
relevant to the UI layer, and should never be called where catching
927
exceptions may be desirable.
930
return the_callable(*args, **kwargs)
931
except (KeyboardInterrupt, Exception), e:
932
# used to handle AssertionError and KeyboardInterrupt
933
# specially here, but hopefully they're handled ok by the logger now
934
exc_info = sys.exc_info()
935
exitcode = trace.report_exception(exc_info, sys.stderr)
936
if os.environ.get('BZR_PDB'):
937
print '**** entering debugger'
939
pdb.post_mortem(exc_info[2])
528
943
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
529
944
from bzrlib.lsprof import profile
531
ret, stats = profile(the_callable, *args, **kwargs)
945
ret, stats = profile(exception_to_return_code, the_callable,
533
948
if filename is None:
537
cPickle.dump(stats, open(filename, 'w'), 2)
538
print 'Profile data written to %r.' % filename
952
trace.note(gettext('Profile data written to "%s".'), filename)
543
"""Return an expanded alias, or None if no alias exists"""
545
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
956
def get_alias(cmd, config=None):
957
"""Return an expanded alias, or None if no alias exists.
960
Command to be checked for an alias.
962
Used to specify an alternative config to use,
963
which is especially useful for testing.
964
If it is unspecified, the global config will be used.
968
config = bzrlib.config.GlobalConfig()
969
alias = config.get_alias(cmd)
547
return alias.split(' ')
971
return cmdline.split(alias)
975
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
552
976
"""Execute a command.
554
This is similar to main(), but without all the trappings for
555
logging and error handling.
558
The command-line arguments, without the program name from argv[0]
559
These should already be decoded. All library/test code calling
560
run_bzr should be passing valid strings (don't need decoding).
562
Returns a command status or raises an exception.
978
:param argv: The command-line arguments, without the program name from
979
argv[0] These should already be decoded. All library/test code calling
980
run_bzr should be passing valid strings (don't need decoding).
981
:param load_plugins: What function to call when triggering plugin loading.
982
This function should take no arguments and cause all plugins to be
984
:param disable_plugins: What function to call when disabling plugin
985
loading. This function should take no arguments and cause all plugin
986
loading to be prohibited (so that code paths in your application that
987
know about some plugins possibly being present will fail to import
988
those plugins even if they are installed.)
989
:return: Returns a command exit code or raises an exception.
564
991
Special master options: these must come before the command because
565
992
they control how the command is interpreted.
606
1042
opt_no_plugins = True
607
1043
elif a == '--no-aliases':
608
1044
opt_no_aliases = True
1045
elif a == '--no-l10n':
609
1047
elif a == '--builtin':
610
1048
opt_builtin = True
611
elif a in ('--quiet', '-q'):
1049
elif a == '--concurrency':
1050
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1052
elif a == '--coverage':
1053
opt_coverage_dir = argv[i + 1]
1055
elif a == '--profile-imports':
1056
pass # already handled in startup script Bug #588277
1057
elif a.startswith('-D'):
1058
debug.debug_flags.add(a[2:])
1059
elif a.startswith('-O'):
1060
override_config.append(a[2:])
614
1062
argv_copy.append(a)
1065
if bzrlib.global_state is None:
1066
# FIXME: Workaround for users that imported bzrlib but didn't call
1067
# bzrlib.initialize -- vila 2012-01-19
1068
cmdline_overrides = config.CommandLineStore()
1070
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1071
cmdline_overrides._from_cmdline(override_config)
1073
debug.set_debug_flags_from_config()
1075
if not opt_no_plugins:
617
1080
argv = argv_copy
619
from bzrlib.builtins import cmd_help
620
cmd_help().run_argv_aliases([])
1082
get_cmd_object('help').run_argv_aliases([])
623
1085
if argv[0] == '--version':
624
from bzrlib.builtins import show_version
1086
get_cmd_object('version').run_argv_aliases([])
628
if not opt_no_plugins:
629
from bzrlib.plugin import load_plugins
632
from bzrlib.plugin import disable_plugins
635
1089
alias_argv = None
637
1091
if not opt_no_aliases:
638
1092
alias_argv = get_alias(argv[0])
640
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
641
1094
argv[0] = alias_argv.pop(0)
643
cmd = str(argv.pop(0))
645
1097
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
646
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
647
run = cmd_obj.run_argv
650
run = cmd_obj.run_argv_aliases
651
run_argv = [argv, alias_argv]
1100
run = cmd_obj.run_argv_aliases
1101
run_argv = [argv, alias_argv]
1104
# We can be called recursively (tests for example), but we don't want
1105
# the verbosity level to propagate.
1106
saved_verbosity_level = option._verbosity_level
1107
option._verbosity_level = 0
1109
if opt_coverage_dir:
1111
'--coverage ignored, because --lsprof is in use.')
655
1112
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
656
1113
elif opt_profile:
1114
if opt_coverage_dir:
1116
'--coverage ignored, because --profile is in use.')
657
1117
ret = apply_profiled(run, *run_argv)
1118
elif opt_coverage_dir:
1119
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
659
1121
ret = run(*run_argv)
662
# reset, in case we may do other commands later within the same process
1124
# reset, in case we may do other commands later within the same
1125
# process. Commands that want to execute sub-commands must propagate
1126
# --verbose in their own way.
1127
if 'memory' in debug.debug_flags:
1128
trace.debug_memory('Process status after command:', short=False)
1129
option._verbosity_level = saved_verbosity_level
1130
# Reset the overrides
1131
cmdline_overrides._reset()
665
1134
def display_command(func):
666
1135
"""Decorator that suppresses pipe/interrupt errors."""
682
1151
return ignore_pipe
687
from bzrlib.ui.text import TextUIFactory
688
bzrlib.ui.ui_factory = TextUIFactory()
689
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
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",
1167
_try_plugin_provider,
1168
"bzr plugin-provider-db check")
1172
def _specified_or_unicode_argv(argv):
1173
# For internal or testing use, argv can be passed. Otherwise, get it from
1174
# the process arguments in a unicode-safe way.
1176
return osutils.get_unicode_argv()
1180
# ensure all arguments are unicode strings
1182
if isinstance(a, unicode):
1185
new_argv.append(a.decode('ascii'))
1186
except UnicodeDecodeError:
1187
raise errors.BzrError("argv should be list of unicode strings.")
1191
def main(argv=None):
1192
"""Main entry point of command-line interface.
1194
Typically `bzrlib.initialize` should be called first.
1196
:param argv: list of unicode command-line arguments similar to sys.argv.
1197
argv[0] is script name usually, it will be ignored.
1198
Don't pass here sys.argv because this list contains plain strings
1199
and not unicode; pass None instead.
1201
:return: exit code of bzr command.
1203
if argv is not None:
1205
_register_builtin_commands()
690
1206
ret = run_bzr_catch_errors(argv)
691
mutter("return code %d", ret)
1207
trace.mutter("return code %d", ret)
695
1211
def run_bzr_catch_errors(argv):
1212
"""Run a bzr command with parameters as described by argv.
1214
This function assumed that that UI layer is setup, that symbol deprecations
1215
are already applied, and that unicode decoding has already been performed on argv.
1217
# done here so that they're covered for every test run
1218
install_bzr_command_hooks()
1219
return exception_to_return_code(run_bzr, argv)
1222
def run_bzr_catch_user_errors(argv):
1223
"""Run bzr and report user errors, but let internal errors propagate.
1225
This is used for the test suite, and might be useful for other programs
1226
that want to wrap the commandline interface.
1228
# done here so that they're covered for every test run
1229
install_bzr_command_hooks()
697
1231
return run_bzr(argv)
698
# do this here inside the exception wrappers to catch EPIPE
700
1232
except Exception, e:
701
# used to handle AssertionError and KeyboardInterrupt
702
# specially here, but hopefully they're handled ok by the logger now
703
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
704
if os.environ.get('BZR_PDB'):
705
print '**** entering debugger'
707
pdb.post_mortem(sys.exc_traceback)
710
if __name__ == '__main__':
711
sys.exit(main(sys.argv))
1233
if (isinstance(e, (OSError, IOError))
1234
or not getattr(e, 'internal_error', True)):
1235
trace.report_exception(sys.exc_info(), sys.stderr)
1241
class HelpCommandIndex(object):
1242
"""A index for bzr help that returns commands."""
1245
self.prefix = 'commands/'
1247
def get_topics(self, topic):
1248
"""Search for topic amongst commands.
1250
:param topic: A topic to search for.
1251
:return: A list which is either empty or contains a single
1254
if topic and topic.startswith(self.prefix):
1255
topic = topic[len(self.prefix):]
1257
cmd = _get_cmd_object(topic, check_missing=False)
1264
class Provider(object):
1265
"""Generic class to be overriden by plugins"""
1267
def plugin_for_command(self, cmd_name):
1268
"""Takes a command and returns the information for that plugin
1270
:return: A dictionary with all the available information
1271
for the requested plugin
1273
raise NotImplementedError
1276
class ProvidersRegistry(registry.Registry):
1277
"""This registry exists to allow other providers to exist"""
1280
for key, provider in self.iteritems():
1283
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
