26
23
# 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
28
from bzrlib.lazy_import import lazy_import
35
29
lazy_import(globals(), """
38
from warnings import warn
41
34
from bzrlib import (
47
from bzrlib.hooks import Hooks
48
from bzrlib.i18n import gettext
49
# Compatibility - Option used to be in commands.
50
from bzrlib.option import Option
51
from bzrlib.plugin import disable_plugins, load_plugins
52
from bzrlib import registry
50
53
from bzrlib.symbol_versioning import (
51
54
deprecated_function,
57
from bzrlib.option import Option
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
63
150
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
151
"""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.
153
Should generally be avoided in favor of lazy registration.
71
155
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__])
156
return plugin_cmds.register(cmd, decorate)
91
159
def _squish_command_name(cmd):
95
163
def _unsquish_command_name(cmd):
96
assert cmd.startswith("cmd_")
97
164
return cmd[4:].replace('_','-')
100
def _builtin_commands():
167
def _register_builtin_commands():
168
if builtin_command_registry.keys():
101
171
import bzrlib.builtins
172
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
173
builtin_command_registry.register(cmd_class)
174
bzrlib.builtins._register_lazy_builtins()
177
def _scan_module_for_commands(module):
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
179
for name, obj in module.__dict__.iteritems():
105
180
if name.startswith("cmd_"):
106
181
real_name = _unsquish_command_name(name)
107
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))
111
208
def builtin_command_names():
112
"""Return list of builtin command names."""
113
return _builtin_commands().keys()
209
"""Return list of builtin command names.
211
Use of all_command_names() is encouraged rather than builtin_command_names
212
and/or plugin_command_names.
214
_register_builtin_commands()
215
return builtin_command_registry.keys()
116
218
def plugin_command_names():
219
"""Returns command names from commands registered by plugins."""
117
220
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
223
def get_cmd_object(cmd_name, plugins_override=True):
135
"""Return the canonical name and command class for a command.
224
"""Return the command object for a command.
138
227
If true, plugin commands can override builtins.
141
230
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."""
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:
148
315
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
316
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)()
173
334
class Command(object):
188
349
summary, then a complete description of the command. A grammar
189
350
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
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
213
368
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
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"
233
400
takes_options = []
234
401
encoding_type = 'strict'
238
407
def __init__(self):
239
408
"""Construct an instance of this command."""
240
if self.__doc__ == Command.__doc__:
241
warn("No help message set for %r" % self)
409
# List of standard options directly supported
410
self.supported_std_options = []
413
def add_cleanup(self, cleanup_func, *args, **kwargs):
414
"""Register a function to call after self.run returns or raises.
416
Functions will be called in LIFO order.
418
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
420
def cleanup_now(self):
421
"""Execute and empty pending cleanup functions immediately.
423
After cleanup_now all registered cleanups are forgotten. add_cleanup
424
may be called again after cleanup_now; these cleanups will be called
425
after self.run returns or raises (or when cleanup_now is next called).
427
This is useful for releasing expensive or contentious resources (such
428
as write locks) before doing further work that does not require those
429
resources (such as writing results to self.outf). Note though, that
430
as it releases all resources, this may release locks that the command
431
wants to hold, so use should be done with care.
433
self._operation.cleanup_now()
243
435
def _usage(self):
244
436
"""Return single-line grammar for this command.
255
447
elif aname[-1] == '*':
256
448
aname = '[' + aname[:-1] + '...]'
450
s = s[:-1] # remove last space
263
def get_help_text(self, additional_see_also=None):
453
def get_help_text(self, additional_see_also=None, plain=True,
454
see_also_as_links=False, verbose=True):
264
455
"""Return a text string with help for this command.
266
457
:param additional_see_also: Additional help topics to be
267
458
cross-referenced.
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.
269
470
doc = self.help()
271
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
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
274
result += 'usage: %s\n' % self._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
277
result += 'aliases: '
541
result += gettext(':Aliases: ')
278
542
result += ', '.join(self.aliases) + '\n'
282
543
plugin_name = self.plugin_name()
283
544
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()
545
result += gettext(':From: plugin "%s"\n') % plugin_name
292
546
see_also = self.get_see_also(additional_see_also)
294
result += '\nSee also: '
295
result += ', '.join(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
299
609
def get_help_topic(self):
300
610
"""Return the commands help topic - its name."""
301
611
return self.name()
303
613
def get_see_also(self, additional_terms=None):
304
"""Return a list of help topics that are related to this ommand.
614
"""Return a list of help topics that are related to this command.
306
616
The list is derived from the content of the _see_also attribute. Any
307
617
duplicates are removed and the result is in lexical order.
308
618
:param additional_terms: Additional help topics to cross-reference.
317
627
"""Return dict of valid options for this command.
319
629
Maps from long option name to option object."""
321
r['help'] = option.Option.OPTIONS['help']
630
r = Option.STD_OPTIONS.copy()
322
632
for o in self.takes_options:
323
633
if isinstance(o, basestring):
324
634
o = option.Option.OPTIONS[o]
636
if o.name in std_names:
637
self.supported_std_options.append(o.name)
328
640
def _setup_outf(self):
329
641
"""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
642
self.outf = ui.ui_factory.make_output_stream(
643
encoding_type=self.encoding_type)
354
645
def run_argv_aliases(self, argv, alias_argv=None):
355
646
"""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
647
args, opts = parse_args(self, argv, alias_argv)
650
# Process the standard options
361
651
if 'help' in opts: # e.g. bzr add --help
362
sys.stdout.write(self.get_help_text())
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'):
364
666
# mix arguments and options into one dictionary
365
667
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]
761
class CommandHooks(Hooks):
762
"""Hooks related to Command object creation/enumeration."""
765
"""Create the default hooks.
767
These are all empty initially, because by default nothing should get
770
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
771
self.add_hook('extend_command',
772
"Called after creating a command object to allow modifications "
773
"such as adding or removing options, docs etc. Called with the "
774
"new bzrlib.commands.Command object.", (1, 13))
775
self.add_hook('get_command',
776
"Called when creating a single command. Called with "
777
"(cmd_or_None, command_name). get_command should either return "
778
"the cmd_or_None parameter, or a replacement Command object that "
779
"should be used for the command. Note that the Command.hooks "
780
"hooks are core infrastructure. Many users will prefer to use "
781
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
783
self.add_hook('get_missing_command',
784
"Called when creating a single command if no command could be "
785
"found. Called with (command_name). get_missing_command should "
786
"either return None, or a Command object to be used for the "
788
self.add_hook('list_commands',
789
"Called when enumerating commands. Called with a set of "
790
"cmd_name strings for all the commands found so far. This set "
791
" is safe to mutate - e.g. to remove a command. "
792
"list_commands should return the updated set of command names.",
795
Command.hooks = CommandHooks()
446
798
def parse_args(command, argv, alias_argv=None):
447
799
"""Parse command line.
449
801
Arguments and options are parsed at this level before being passed
450
802
down to specific command handlers. This routine knows, from a
451
803
lookup table, something about the available options, what optargs
481
840
argdict[argname + '_list'] = None
482
841
elif ap[-1] == '+':
484
raise errors.BzrCommandError("command %r needs one or more %s"
485
% (cmd, argname.upper()))
843
raise errors.BzrCommandError(gettext(
844
"command {0!r} needs one or more {1}").format(
845
cmd, argname.upper()))
487
847
argdict[argname + '_list'] = args[:]
489
849
elif ap[-1] == '$': # all but one
490
850
if len(args) < 2:
491
raise errors.BzrCommandError("command %r needs one or more %s"
492
% (cmd, argname.upper()))
851
raise errors.BzrCommandError(
852
gettext("command {0!r} needs one or more {1}").format(
853
cmd, argname.upper()))
493
854
argdict[argname + '_list'] = args[:-1]
496
857
# just a plain arg
499
raise errors.BzrCommandError("command %r requires argument %s"
500
% (cmd, argname.upper()))
860
raise errors.BzrCommandError(
861
gettext("command {0!r} requires argument {1}").format(
862
cmd, argname.upper()))
502
864
argdict[argname] = args.pop(0)
505
raise errors.BzrCommandError("extra argument to command %s: %s"
867
raise errors.BzrCommandError( gettext(
868
"extra argument to command {0}: {1}").format(
873
def apply_coveraged(dirname, the_callable, *args, **kwargs):
874
# Cannot use "import trace", as that would import bzrlib.trace instead of
875
# the standard library's trace.
876
trace = __import__('trace')
878
tracer = trace.Trace(count=1, trace=0)
879
sys.settrace(tracer.globaltrace)
880
threading.settrace(tracer.globaltrace)
883
return exception_to_return_code(the_callable, *args, **kwargs)
886
results = tracer.results()
887
results.write_results(show_missing=1, summary=False,
512
891
def apply_profiled(the_callable, *args, **kwargs):
532
912
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])
535
956
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
536
957
from bzrlib.lsprof import profile
537
ret, stats = profile(the_callable, *args, **kwargs)
958
ret, stats = profile(exception_to_return_code, the_callable,
539
961
if filename is None:
542
964
stats.save(filename)
543
trace.note('Profile data written to "%s".', filename)
965
trace.note(gettext('Profile data written to "%s".'), filename)
559
981
config = bzrlib.config.GlobalConfig()
560
982
alias = config.get_alias(cmd)
563
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
984
return cmdline.split(alias)
988
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
568
989
"""Execute a command.
570
This is similar to main(), but without all the trappings for
571
logging and error handling.
574
The command-line arguments, without the program name from argv[0]
575
These should already be decoded. All library/test code calling
576
run_bzr should be passing valid strings (don't need decoding).
578
Returns a command status or raises an exception.
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.
580
1004
Special master options: these must come before the command because
581
1005
they control how the command is interpreted.
623
1055
opt_no_plugins = True
624
1056
elif a == '--no-aliases':
625
1057
opt_no_aliases = True
1058
elif a == '--no-l10n':
626
1060
elif a == '--builtin':
627
1061
opt_builtin = True
628
elif a in ('--quiet', '-q'):
1062
elif a == '--concurrency':
1063
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1065
elif a == '--coverage':
1066
opt_coverage_dir = argv[i + 1]
1068
elif a == '--profile-imports':
1069
pass # already handled in startup script Bug #588277
630
1070
elif a.startswith('-D'):
631
1071
debug.debug_flags.add(a[2:])
1072
elif a.startswith('-O'):
1073
override_config.append(a[2:])
633
1075
argv_copy.append(a)
1078
bzrlib.global_state.cmdline_overrides._from_cmdline(override_config)
1080
debug.set_debug_flags_from_config()
1082
if not opt_no_plugins:
636
1087
argv = argv_copy
638
from bzrlib.builtins import cmd_help
639
cmd_help().run_argv_aliases([])
1089
get_cmd_object('help').run_argv_aliases([])
642
1092
if argv[0] == '--version':
643
from bzrlib.version import show_version
1093
get_cmd_object('version').run_argv_aliases([])
647
if not opt_no_plugins:
648
from bzrlib.plugin import load_plugins
651
from bzrlib.plugin import disable_plugins
654
1096
alias_argv = None
656
1098
if not opt_no_aliases:
657
1099
alias_argv = get_alias(argv[0])
659
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
660
1101
argv[0] = alias_argv.pop(0)
662
1103
cmd = argv.pop(0)
663
# We want only 'ascii' command names, but the user may have typed
664
# in a Unicode name. In that case, they should just get a
665
# 'command not found' error later.
667
1104
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
668
1107
run = cmd_obj.run_argv_aliases
669
1108
run_argv = [argv, alias_argv]
1111
# We can be called recursively (tests for example), but we don't want
1112
# the verbosity level to propagate.
1113
saved_verbosity_level = option._verbosity_level
1114
option._verbosity_level = 0
1116
if opt_coverage_dir:
1118
'--coverage ignored, because --lsprof is in use.')
673
1119
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
674
1120
elif opt_profile:
1121
if opt_coverage_dir:
1123
'--coverage ignored, because --profile is in use.')
675
1124
ret = apply_profiled(run, *run_argv)
1125
elif opt_coverage_dir:
1126
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
677
1128
ret = run(*run_argv)
680
# reset, in case we may do other commands later within the same process
681
trace.be_quiet(False)
1131
# reset, in case we may do other commands later within the same
1132
# process. Commands that want to execute sub-commands must propagate
1133
# --verbose in their own way.
1134
if 'memory' in debug.debug_flags:
1135
trace.debug_memory('Process status after command:', short=False)
1136
option._verbosity_level = saved_verbosity_level
1137
# Reset the overrides
1138
bzrlib.global_state.cmdline_overrides._reset()
683
1141
def display_command(func):
684
1142
"""Decorator that suppresses pipe/interrupt errors."""
700
1158
return ignore_pipe
705
from bzrlib.ui.text import TextUIFactory
706
bzrlib.ui.ui_factory = TextUIFactory()
707
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
1161
def install_bzr_command_hooks():
1162
"""Install the hooks to supply bzr's own commands."""
1163
if _list_bzr_commands in Command.hooks["list_commands"]:
1165
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1167
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1169
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1170
"bzr plugin commands")
1171
Command.hooks.install_named_hook("get_command", _get_external_command,
1172
"bzr external command lookup")
1173
Command.hooks.install_named_hook("get_missing_command",
1174
_try_plugin_provider,
1175
"bzr plugin-provider-db check")
1179
def _specified_or_unicode_argv(argv):
1180
# For internal or testing use, argv can be passed. Otherwise, get it from
1181
# the process arguments in a unicode-safe way.
1183
return osutils.get_unicode_argv()
1187
# ensure all arguments are unicode strings
1189
if isinstance(a, unicode):
1192
new_argv.append(a.decode('ascii'))
1193
except UnicodeDecodeError:
1194
raise errors.BzrError("argv should be list of unicode strings.")
1198
def main(argv=None):
1199
"""Main entry point of command-line interface.
1201
Typically `bzrlib.initialize` should be called first.
1203
:param argv: list of unicode command-line arguments similar to sys.argv.
1204
argv[0] is script name usually, it will be ignored.
1205
Don't pass here sys.argv because this list contains plain strings
1206
and not unicode; pass None instead.
1208
:return: exit code of bzr command.
1210
if argv is not None:
1212
_register_builtin_commands()
708
1213
ret = run_bzr_catch_errors(argv)
709
1214
trace.mutter("return code %d", ret)
713
1218
def run_bzr_catch_errors(argv):
1219
"""Run a bzr command with parameters as described by argv.
1221
This function assumed that that UI layer is setup, that symbol deprecations
1222
are already applied, and that unicode decoding has already been performed on argv.
1224
# done here so that they're covered for every test run
1225
install_bzr_command_hooks()
1226
return exception_to_return_code(run_bzr, argv)
1229
def run_bzr_catch_user_errors(argv):
1230
"""Run bzr and report user errors, but let internal errors propagate.
1232
This is used for the test suite, and might be useful for other programs
1233
that want to wrap the commandline interface.
1235
# done here so that they're covered for every test run
1236
install_bzr_command_hooks()
715
1238
return run_bzr(argv)
716
except (KeyboardInterrupt, Exception), e:
717
# used to handle AssertionError and KeyboardInterrupt
718
# specially here, but hopefully they're handled ok by the logger now
719
trace.report_exception(sys.exc_info(), sys.stderr)
720
if os.environ.get('BZR_PDB'):
721
print '**** entering debugger'
723
pdb.post_mortem(sys.exc_traceback)
1239
except Exception, e:
1240
if (isinstance(e, (OSError, IOError))
1241
or not getattr(e, 'internal_error', True)):
1242
trace.report_exception(sys.exc_info(), sys.stderr)
727
1248
class HelpCommandIndex(object):
added
removed
bzrlib/commands.py
