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?
34
29
from bzrlib.lazy_import import lazy_import
35
30
lazy_import(globals(), """
38
from warnings import warn
41
35
from bzrlib import (
50
from bzrlib.symbol_versioning import (
49
from bzrlib.hooks import Hooks
50
from bzrlib.i18n import gettext
51
# Compatibility - Option used to be in commands.
57
52
from bzrlib.option import Option
53
from bzrlib.plugin import disable_plugins, load_plugins
54
from bzrlib import registry
57
class CommandInfo(object):
58
"""Information about a command."""
60
def __init__(self, aliases):
61
"""The list of aliases for the command."""
62
self.aliases = aliases
65
def from_command(klass, command):
66
"""Factory to construct a CommandInfo from a command."""
67
return klass(command.aliases)
70
class CommandRegistry(registry.Registry):
71
"""Special registry mapping command names to command classes.
73
:ivar overridden_registry: Look in this registry for commands being
74
overridden by this registry. This can be used to tell plugin commands
75
about the builtin they're decorating.
79
registry.Registry.__init__(self)
80
self.overridden_registry = None
81
# map from aliases to the real command that implements the name
84
def get(self, command_name):
85
real_name = self._alias_dict.get(command_name, command_name)
86
return registry.Registry.get(self, real_name)
89
def _get_name(command_name):
90
if command_name.startswith("cmd_"):
91
return _unsquish_command_name(command_name)
95
def register(self, cmd, decorate=False):
96
"""Utility function to help register a command
98
:param cmd: Command subclass to register
99
:param decorate: If true, allow overriding an existing command
100
of the same name; the old command is returned by this function.
101
Otherwise it is an error to try to override an existing command.
104
k_unsquished = self._get_name(k)
106
previous = self.get(k_unsquished)
109
if self.overridden_registry:
111
previous = self.overridden_registry.get(k_unsquished)
114
info = CommandInfo.from_command(cmd)
116
registry.Registry.register(self, k_unsquished, cmd,
117
override_existing=decorate, info=info)
119
trace.warning('Two plugins defined the same command: %r' % k)
120
trace.warning('Not loading the one in %r' %
121
sys.modules[cmd.__module__])
122
trace.warning('Previously this command was registered from %r' %
123
sys.modules[previous.__module__])
124
for a in cmd.aliases:
125
self._alias_dict[a] = k_unsquished
128
def register_lazy(self, command_name, aliases, module_name):
129
"""Register a command without loading its module.
131
:param command_name: The primary name of the command.
132
:param aliases: A list of aliases for the command.
133
:module_name: The module that the command lives in.
135
key = self._get_name(command_name)
136
registry.Registry.register_lazy(self, key, module_name, command_name,
137
info=CommandInfo(aliases))
139
self._alias_dict[a] = key
142
plugin_cmds = CommandRegistry()
143
builtin_command_registry = CommandRegistry()
144
plugin_cmds.overridden_registry = builtin_command_registry
63
147
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
148
"""Register a plugin command.
66
:param cmd: Command subclass to register
67
:param decorate: If true, allow overriding an existing command
68
of the same name; the old command is returned by this function.
69
Otherwise it is an error to try to override an existing command.
150
Should generally be avoided in favor of lazy registration.
71
152
global plugin_cmds
73
if k.startswith("cmd_"):
74
k_unsquished = _unsquish_command_name(k)
77
if k_unsquished not in plugin_cmds:
78
plugin_cmds[k_unsquished] = cmd
79
## trace.mutter('registered plugin command %s', k_unsquished)
80
if decorate and k_unsquished in builtin_command_names():
81
return _builtin_commands()[k_unsquished]
83
result = plugin_cmds[k_unsquished]
84
plugin_cmds[k_unsquished] = cmd
87
trace.log_error('Two plugins defined the same command: %r' % k)
88
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
153
return plugin_cmds.register(cmd, decorate)
91
156
def _squish_command_name(cmd):
95
160
def _unsquish_command_name(cmd):
96
assert cmd.startswith("cmd_")
97
161
return cmd[4:].replace('_','-')
100
def _builtin_commands():
164
def _register_builtin_commands():
165
if builtin_command_registry.keys():
101
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):
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
176
for name, obj in module.__dict__.iteritems():
105
177
if name.startswith("cmd_"):
106
178
real_name = _unsquish_command_name(name)
107
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))
111
205
def builtin_command_names():
112
"""Return list of builtin command names."""
113
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()
116
215
def plugin_command_names():
216
"""Returns command names from commands registered by plugins."""
117
217
return plugin_cmds.keys()
120
def _get_cmd_dict(plugins_override=True):
121
"""Return name->class mapping for all commands."""
122
d = _builtin_commands()
124
d.update(plugin_cmds)
128
def get_all_cmds(plugins_override=True):
129
"""Return canonical name and class for all registered commands."""
130
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
134
220
def get_cmd_object(cmd_name, plugins_override=True):
135
"""Return the canonical name and command class for a command.
221
"""Return the command object for a command.
138
224
If true, plugin commands can override builtins.
141
227
return _get_cmd_object(cmd_name, plugins_override)
143
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
146
def _get_cmd_object(cmd_name, plugins_override=True):
147
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
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:
148
312
from bzrlib.externalcommand import ExternalCommand
150
# We want only 'ascii' command names, but the user may have typed
151
# in a Unicode name. In that case, they should just get a
152
# 'command not found' error later.
153
# In the future, we may actually support Unicode command names.
155
# first look up this command under the specified name
156
cmds = _get_cmd_dict(plugins_override=plugins_override)
158
return cmds[cmd_name]()
162
# look for any command which claims this as an alias
163
for real_cmd_name, cmd_class in cmds.iteritems():
164
if cmd_name in cmd_class.aliases:
167
313
cmd_obj = ExternalCommand.find_command(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)()
173
331
class Command(object):
188
346
summary, then a complete description of the command. A grammar
189
347
description will be inserted.
192
Other accepted names for this command.
195
List of argument forms, marked with whether they are optional,
200
['to_location', 'from_branch?', 'file*']
202
'to_location' is required
203
'from_branch' is optional
204
'file' can be specified 0 or more times
207
List of options that may be given for this command. These can
208
be either strings, referring to globally-defined options,
209
or option objects. Retrieve through options().
212
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
213
365
for commands intended for expert users.
216
Command objects will get a 'outf' attribute, which has been
217
setup to properly handle encoding of unicode strings.
218
encoding_type determines what will happen when characters cannot
220
strict - abort if we cannot decode
221
replace - put in a bogus character (typically '?')
222
exact - do not encode sys.stdout
224
NOTE: by default on Windows, sys.stdout is opened as a text
225
stream, therefore LF line-endings are converted to CRLF.
226
When a command uses encoding_type = 'exact', then
227
sys.stdout is forced to be a binary stream, and line-endings
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"
233
397
takes_options = []
234
398
encoding_type = 'strict'
238
404
def __init__(self):
239
405
"""Construct an instance of this command."""
240
if self.__doc__ == Command.__doc__:
241
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()
243
432
def _usage(self):
244
433
"""Return single-line grammar for this command.
255
444
elif aname[-1] == '*':
256
445
aname = '[' + aname[:-1] + '...]'
447
s = s[:-1] # remove last space
263
def get_help_text(self, additional_see_also=None):
450
def get_help_text(self, additional_see_also=None, plain=True,
451
see_also_as_links=False, verbose=True):
264
452
"""Return a text string with help for this command.
266
454
:param additional_see_also: Additional help topics to be
267
455
cross-referenced.
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.
269
467
doc = self.help()
271
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
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
274
result += 'usage: %s\n' % self._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
277
result += 'aliases: '
538
result += gettext(':Aliases: ')
278
539
result += ', '.join(self.aliases) + '\n'
282
540
plugin_name = self.plugin_name()
283
541
if plugin_name is not None:
284
result += '(From plugin "%s")' % plugin_name
288
if result[-1] != '\n':
291
result += option.get_optparser(self.options()).format_option_help()
542
result += gettext(':From: plugin "%s"\n') % plugin_name
292
543
see_also = self.get_see_also(additional_see_also)
294
result += '\nSee also: '
295
result += ', '.join(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
299
606
def get_help_topic(self):
300
607
"""Return the commands help topic - its name."""
301
608
return self.name()
303
610
def get_see_also(self, additional_terms=None):
304
"""Return a list of help topics that are related to this ommand.
611
"""Return a list of help topics that are related to this command.
306
613
The list is derived from the content of the _see_also attribute. Any
307
614
duplicates are removed and the result is in lexical order.
308
615
:param additional_terms: Additional help topics to cross-reference.
317
624
"""Return dict of valid options for this command.
319
626
Maps from long option name to option object."""
321
r['help'] = option.Option.OPTIONS['help']
627
r = Option.STD_OPTIONS.copy()
322
629
for o in self.takes_options:
323
630
if isinstance(o, basestring):
324
631
o = option.Option.OPTIONS[o]
633
if o.name in std_names:
634
self.supported_std_options.append(o.name)
328
637
def _setup_outf(self):
329
638
"""Return a file linked to stdout, which has proper encoding."""
330
assert self.encoding_type in ['strict', 'exact', 'replace']
332
# Originally I was using self.stdout, but that looks
333
# *way* too much like sys.stdout
334
if self.encoding_type == 'exact':
335
# force sys.stdout to be binary stream on win32
336
if sys.platform == 'win32':
337
fileno = getattr(sys.stdout, 'fileno', None)
340
msvcrt.setmode(fileno(), os.O_BINARY)
341
self.outf = sys.stdout
344
output_encoding = osutils.get_terminal_encoding()
346
# use 'replace' so that we don't abort if trying to write out
347
# in e.g. the default C locale.
348
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
349
# For whatever reason codecs.getwriter() does not advertise its encoding
350
# it just returns the encoding of the wrapped file, which is completely
351
# bogus. So set the attribute, so we can find the correct encoding later.
352
self.outf.encoding = output_encoding
639
self.outf = ui.ui_factory.make_output_stream(
640
encoding_type=self.encoding_type)
354
642
def run_argv_aliases(self, argv, alias_argv=None):
355
643
"""Parse the command line and run with extra aliases in alias_argv."""
357
warn("Passing None for [] is deprecated from bzrlib 0.10",
358
DeprecationWarning, stacklevel=2)
360
644
args, opts = parse_args(self, argv, alias_argv)
647
# Process the standard options
361
648
if 'help' in opts: # e.g. bzr add --help
362
sys.stdout.write(self.get_help_text())
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'):
364
663
# mix arguments and options into one dictionary
365
664
cmdargs = _match_argform(self.name(), self.takes_args, args)
412
# Technically, this function hasn't been use in a *really* long time
413
# but we are only deprecating it now.
414
@deprecated_function(zero_eleven)
415
def parse_spec(spec):
421
>>> parse_spec("../@")
423
>>> parse_spec("../f/@35")
425
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
426
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
431
parsed = spec.split('/@')
432
assert len(parsed) == 2
437
parsed[1] = int(parsed[1])
439
pass # We can allow stuff like ./@revid:blahblahblah
443
parsed = [spec, None]
758
class CommandHooks(Hooks):
759
"""Hooks related to Command object creation/enumeration."""
762
"""Create the default hooks.
764
These are all empty initially, because by default nothing should get
767
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
768
self.add_hook('extend_command',
769
"Called after creating a command object to allow modifications "
770
"such as adding or removing options, docs etc. Called with the "
771
"new bzrlib.commands.Command object.", (1, 13))
772
self.add_hook('get_command',
773
"Called when creating a single command. Called with "
774
"(cmd_or_None, command_name). get_command should either return "
775
"the cmd_or_None parameter, or a replacement Command object that "
776
"should be used for the command. Note that the Command.hooks "
777
"hooks are core infrastructure. Many users will prefer to use "
778
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
780
self.add_hook('get_missing_command',
781
"Called when creating a single command if no command could be "
782
"found. Called with (command_name). get_missing_command should "
783
"either return None, or a Command object to be used for the "
785
self.add_hook('list_commands',
786
"Called when enumerating commands. Called with a set of "
787
"cmd_name strings for all the commands found so far. This set "
788
" is safe to mutate - e.g. to remove a command. "
789
"list_commands should return the updated set of command names.",
792
Command.hooks = CommandHooks()
446
795
def parse_args(command, argv, alias_argv=None):
447
796
"""Parse command line.
449
798
Arguments and options are parsed at this level before being passed
450
799
down to specific command handlers. This routine knows, from a
451
800
lookup table, something about the available options, what optargs
481
837
argdict[argname + '_list'] = None
482
838
elif ap[-1] == '+':
484
raise errors.BzrCommandError("command %r needs one or more %s"
485
% (cmd, argname.upper()))
840
raise errors.BzrCommandError(gettext(
841
"command {0!r} needs one or more {1}").format(
842
cmd, argname.upper()))
487
844
argdict[argname + '_list'] = args[:]
489
846
elif ap[-1] == '$': # all but one
490
847
if len(args) < 2:
491
raise errors.BzrCommandError("command %r needs one or more %s"
492
% (cmd, argname.upper()))
848
raise errors.BzrCommandError(
849
gettext("command {0!r} needs one or more {1}").format(
850
cmd, argname.upper()))
493
851
argdict[argname + '_list'] = args[:-1]
496
854
# just a plain arg
499
raise errors.BzrCommandError("command %r requires argument %s"
500
% (cmd, argname.upper()))
857
raise errors.BzrCommandError(
858
gettext("command {0!r} requires argument {1}").format(
859
cmd, argname.upper()))
502
861
argdict[argname] = args.pop(0)
505
raise errors.BzrCommandError("extra argument to command %s: %s"
864
raise errors.BzrCommandError( gettext(
865
"extra argument to command {0}: {1}").format(
870
def apply_coveraged(dirname, the_callable, *args, **kwargs):
871
# Cannot use "import trace", as that would import bzrlib.trace instead of
872
# the standard library's trace.
873
trace = __import__('trace')
875
tracer = trace.Trace(count=1, trace=0)
876
sys.settrace(tracer.globaltrace)
877
threading.settrace(tracer.globaltrace)
880
return exception_to_return_code(the_callable, *args, **kwargs)
883
results = tracer.results()
884
results.write_results(show_missing=1, summary=False,
512
888
def apply_profiled(the_callable, *args, **kwargs):
532
909
os.remove(pfname)
912
def exception_to_return_code(the_callable, *args, **kwargs):
913
"""UI level helper for profiling and coverage.
915
This transforms exceptions into a return value of 3. As such its only
916
relevant to the UI layer, and should never be called where catching
917
exceptions may be desirable.
920
return the_callable(*args, **kwargs)
921
except (KeyboardInterrupt, Exception), e:
922
# used to handle AssertionError and KeyboardInterrupt
923
# specially here, but hopefully they're handled ok by the logger now
924
exc_info = sys.exc_info()
925
exitcode = trace.report_exception(exc_info, sys.stderr)
926
if os.environ.get('BZR_PDB'):
927
print '**** entering debugger'
930
if sys.version_info[:2] < (2, 6):
932
# pdb.post_mortem(tb)
933
# but because pdb.post_mortem gives bad results for tracebacks
934
# from inside generators, we do it manually.
935
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
937
# Setup pdb on the traceback
940
p.setup(tb.tb_frame, tb)
941
# Point the debugger at the deepest frame of the stack
942
p.curindex = len(p.stack) - 1
943
p.curframe = p.stack[p.curindex][0]
944
# Start the pdb prompt.
945
p.print_stack_entry(p.stack[p.curindex])
535
953
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
536
954
from bzrlib.lsprof import profile
538
ret, stats = profile(the_callable, *args, **kwargs)
955
ret, stats = profile(exception_to_return_code, the_callable,
540
958
if filename is None:
544
cPickle.dump(stats, open(filename, 'w'), 2)
545
print 'Profile data written to %r.' % filename
962
trace.note(gettext('Profile data written to "%s".'), filename)
561
978
config = bzrlib.config.GlobalConfig()
562
979
alias = config.get_alias(cmd)
565
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
981
return cmdline.split(alias)
985
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
570
986
"""Execute a command.
572
This is similar to main(), but without all the trappings for
573
logging and error handling.
576
The command-line arguments, without the program name from argv[0]
577
These should already be decoded. All library/test code calling
578
run_bzr should be passing valid strings (don't need decoding).
580
Returns a command status or raises an exception.
988
:param argv: The command-line arguments, without the program name from
989
argv[0] These should already be decoded. All library/test code calling
990
run_bzr should be passing valid strings (don't need decoding).
991
:param load_plugins: What function to call when triggering plugin loading.
992
This function should take no arguments and cause all plugins to be
994
:param disable_plugins: What function to call when disabling plugin
995
loading. This function should take no arguments and cause all plugin
996
loading to be prohibited (so that code paths in your application that
997
know about some plugins possibly being present will fail to import
998
those plugins even if they are installed.)
999
:return: Returns a command exit code or raises an exception.
582
1001
Special master options: these must come before the command because
583
1002
they control how the command is interpreted.
625
1052
opt_no_plugins = True
626
1053
elif a == '--no-aliases':
627
1054
opt_no_aliases = True
1055
elif a == '--no-l10n':
628
1057
elif a == '--builtin':
629
1058
opt_builtin = True
630
elif a in ('--quiet', '-q'):
1059
elif a == '--concurrency':
1060
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1062
elif a == '--coverage':
1063
opt_coverage_dir = argv[i + 1]
1065
elif a == '--profile-imports':
1066
pass # already handled in startup script Bug #588277
632
1067
elif a.startswith('-D'):
633
1068
debug.debug_flags.add(a[2:])
1069
elif a.startswith('-O'):
1070
override_config.append(a[2:])
635
1072
argv_copy.append(a)
1075
if bzrlib.global_state is None:
1076
# FIXME: Workaround for users that imported bzrlib but didn't call
1077
# bzrlib.initialize -- vila 2012-01-19
1078
cmdline_overrides = config.CommandLineStore()
1080
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1081
cmdline_overrides._from_cmdline(override_config)
1083
debug.set_debug_flags_from_config()
1085
if not opt_no_plugins:
638
1090
argv = argv_copy
640
from bzrlib.builtins import cmd_help
641
cmd_help().run_argv_aliases([])
1092
get_cmd_object('help').run_argv_aliases([])
644
1095
if argv[0] == '--version':
645
from bzrlib.version import show_version
1096
get_cmd_object('version').run_argv_aliases([])
649
if not opt_no_plugins:
650
from bzrlib.plugin import load_plugins
653
from bzrlib.plugin import disable_plugins
656
1099
alias_argv = None
658
1101
if not opt_no_aliases:
659
1102
alias_argv = get_alias(argv[0])
661
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
662
1104
argv[0] = alias_argv.pop(0)
664
1106
cmd = argv.pop(0)
665
# We want only 'ascii' command names, but the user may have typed
666
# in a Unicode name. In that case, they should just get a
667
# 'command not found' error later.
669
1107
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
670
1110
run = cmd_obj.run_argv_aliases
671
1111
run_argv = [argv, alias_argv]
1114
# We can be called recursively (tests for example), but we don't want
1115
# the verbosity level to propagate.
1116
saved_verbosity_level = option._verbosity_level
1117
option._verbosity_level = 0
1119
if opt_coverage_dir:
1121
'--coverage ignored, because --lsprof is in use.')
675
1122
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
676
1123
elif opt_profile:
1124
if opt_coverage_dir:
1126
'--coverage ignored, because --profile is in use.')
677
1127
ret = apply_profiled(run, *run_argv)
1128
elif opt_coverage_dir:
1129
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
679
1131
ret = run(*run_argv)
682
# reset, in case we may do other commands later within the same process
683
trace.be_quiet(False)
1134
# reset, in case we may do other commands later within the same
1135
# process. Commands that want to execute sub-commands must propagate
1136
# --verbose in their own way.
1137
if 'memory' in debug.debug_flags:
1138
trace.debug_memory('Process status after command:', short=False)
1139
option._verbosity_level = saved_verbosity_level
1140
# Reset the overrides
1141
cmdline_overrides._reset()
685
1144
def display_command(func):
686
1145
"""Decorator that suppresses pipe/interrupt errors."""
702
1161
return ignore_pipe
707
from bzrlib.ui.text import TextUIFactory
708
bzrlib.ui.ui_factory = TextUIFactory()
709
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
1164
def install_bzr_command_hooks():
1165
"""Install the hooks to supply bzr's own commands."""
1166
if _list_bzr_commands in Command.hooks["list_commands"]:
1168
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1170
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1172
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1173
"bzr plugin commands")
1174
Command.hooks.install_named_hook("get_command", _get_external_command,
1175
"bzr external command lookup")
1176
Command.hooks.install_named_hook("get_missing_command",
1177
_try_plugin_provider,
1178
"bzr plugin-provider-db check")
1182
def _specified_or_unicode_argv(argv):
1183
# For internal or testing use, argv can be passed. Otherwise, get it from
1184
# the process arguments in a unicode-safe way.
1186
return osutils.get_unicode_argv()
1190
# ensure all arguments are unicode strings
1192
if isinstance(a, unicode):
1195
new_argv.append(a.decode('ascii'))
1196
except UnicodeDecodeError:
1197
raise errors.BzrError("argv should be list of unicode strings.")
1201
def main(argv=None):
1202
"""Main entry point of command-line interface.
1204
Typically `bzrlib.initialize` should be called first.
1206
:param argv: list of unicode command-line arguments similar to sys.argv.
1207
argv[0] is script name usually, it will be ignored.
1208
Don't pass here sys.argv because this list contains plain strings
1209
and not unicode; pass None instead.
1211
:return: exit code of bzr command.
1213
if argv is not None:
1215
_register_builtin_commands()
710
1216
ret = run_bzr_catch_errors(argv)
711
1217
trace.mutter("return code %d", ret)
715
1221
def run_bzr_catch_errors(argv):
1222
"""Run a bzr command with parameters as described by argv.
1224
This function assumed that that UI layer is setup, that symbol deprecations
1225
are already applied, and that unicode decoding has already been performed on argv.
1227
# done here so that they're covered for every test run
1228
install_bzr_command_hooks()
1229
return exception_to_return_code(run_bzr, argv)
1232
def run_bzr_catch_user_errors(argv):
1233
"""Run bzr and report user errors, but let internal errors propagate.
1235
This is used for the test suite, and might be useful for other programs
1236
that want to wrap the commandline interface.
1238
# done here so that they're covered for every test run
1239
install_bzr_command_hooks()
720
# do this here inside the exception wrappers to catch EPIPE
722
except (KeyboardInterrupt, Exception), e:
723
# used to handle AssertionError and KeyboardInterrupt
724
# specially here, but hopefully they're handled ok by the logger now
725
trace.report_exception(sys.exc_info(), sys.stderr)
726
if os.environ.get('BZR_PDB'):
727
print '**** entering debugger'
729
pdb.post_mortem(sys.exc_traceback)
1241
return run_bzr(argv)
1242
except Exception, e:
1243
if (isinstance(e, (OSError, IOError))
1244
or not getattr(e, 'internal_error', True)):
1245
trace.report_exception(sys.exc_info(), sys.stderr)
733
1251
class HelpCommandIndex(object):
added
removed
bzrlib/commands.py
