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 (
51
from bzrlib.symbol_versioning import (
48
from bzrlib.hooks import Hooks
49
from bzrlib.i18n import gettext
50
# Compatibility - Option used to be in commands.
56
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
56
class CommandInfo(object):
57
"""Information about a command."""
59
def __init__(self, aliases):
60
"""The list of aliases for the command."""
61
self.aliases = aliases
64
def from_command(klass, command):
65
"""Factory to construct a CommandInfo from a command."""
66
return klass(command.aliases)
69
class CommandRegistry(registry.Registry):
70
"""Special registry mapping command names to command classes.
72
:ivar overridden_registry: Look in this registry for commands being
73
overridden by this registry. This can be used to tell plugin commands
74
about the builtin they're decorating.
78
registry.Registry.__init__(self)
79
self.overridden_registry = None
80
# map from aliases to the real command that implements the name
83
def get(self, command_name):
84
real_name = self._alias_dict.get(command_name, command_name)
85
return registry.Registry.get(self, real_name)
88
def _get_name(command_name):
89
if command_name.startswith("cmd_"):
90
return _unsquish_command_name(command_name)
94
def register(self, cmd, decorate=False):
95
"""Utility function to help register a command
97
:param cmd: Command subclass to register
98
:param decorate: If true, allow overriding an existing command
99
of the same name; the old command is returned by this function.
100
Otherwise it is an error to try to override an existing command.
103
k_unsquished = self._get_name(k)
105
previous = self.get(k_unsquished)
108
if self.overridden_registry:
110
previous = self.overridden_registry.get(k_unsquished)
113
info = CommandInfo.from_command(cmd)
115
registry.Registry.register(self, k_unsquished, cmd,
116
override_existing=decorate, info=info)
118
trace.warning('Two plugins defined the same command: %r' % k)
119
trace.warning('Not loading the one in %r' %
120
sys.modules[cmd.__module__])
121
trace.warning('Previously this command was registered from %r' %
122
sys.modules[previous.__module__])
123
for a in cmd.aliases:
124
self._alias_dict[a] = k_unsquished
127
def register_lazy(self, command_name, aliases, module_name):
128
"""Register a command without loading its module.
130
:param command_name: The primary name of the command.
131
:param aliases: A list of aliases for the command.
132
:module_name: The module that the command lives in.
134
key = self._get_name(command_name)
135
registry.Registry.register_lazy(self, key, module_name, command_name,
136
info=CommandInfo(aliases))
138
self._alias_dict[a] = key
141
plugin_cmds = CommandRegistry()
142
builtin_command_registry = CommandRegistry()
143
plugin_cmds.overridden_registry = builtin_command_registry
62
146
def register_command(cmd, decorate=False):
63
"""Utility function to help register a command
147
"""Register a plugin command.
65
:param cmd: Command subclass to register
66
:param decorate: If true, allow overriding an existing command
67
of the same name; the old command is returned by this function.
68
Otherwise it is an error to try to override an existing command.
149
Should generally be avoided in favor of lazy registration.
70
151
global plugin_cmds
72
if k.startswith("cmd_"):
73
k_unsquished = _unsquish_command_name(k)
76
if k_unsquished not in plugin_cmds:
77
plugin_cmds[k_unsquished] = cmd
78
## trace.mutter('registered plugin command %s', k_unsquished)
79
if decorate and k_unsquished in builtin_command_names():
80
return _builtin_commands()[k_unsquished]
82
result = plugin_cmds[k_unsquished]
83
plugin_cmds[k_unsquished] = cmd
86
trace.log_error('Two plugins defined the same command: %r' % k)
87
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
152
return plugin_cmds.register(cmd, decorate)
90
155
def _squish_command_name(cmd):
94
159
def _unsquish_command_name(cmd):
95
assert cmd.startswith("cmd_")
96
160
return cmd[4:].replace('_','-')
99
def _builtin_commands():
163
def _register_builtin_commands():
164
if builtin_command_registry.keys():
100
167
import bzrlib.builtins
168
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
169
builtin_command_registry.register(cmd_class)
170
bzrlib.builtins._register_lazy_builtins()
173
def _scan_module_for_commands(module):
102
builtins = bzrlib.builtins.__dict__
103
for name in builtins:
175
for name, obj in module.__dict__.iteritems():
104
176
if name.startswith("cmd_"):
105
177
real_name = _unsquish_command_name(name)
106
r[real_name] = builtins[name]
182
def _list_bzr_commands(names):
183
"""Find commands from bzr's core and plugins.
185
This is not the public interface, just the default hook called by all_command_names.
187
# to eliminate duplicates
188
names.update(builtin_command_names())
189
names.update(plugin_command_names())
193
def all_command_names():
194
"""Return a set of all command names."""
196
for hook in Command.hooks['list_commands']:
199
raise AssertionError(
200
'hook %s returned None' % Command.hooks.get_hook_name(hook))
110
204
def builtin_command_names():
111
"""Return list of builtin command names."""
112
return _builtin_commands().keys()
205
"""Return list of builtin command names.
207
Use of all_command_names() is encouraged rather than builtin_command_names
208
and/or plugin_command_names.
210
_register_builtin_commands()
211
return builtin_command_registry.keys()
115
214
def plugin_command_names():
215
"""Returns command names from commands registered by plugins."""
116
216
return plugin_cmds.keys()
119
def _get_cmd_dict(plugins_override=True):
120
"""Return name->class mapping for all commands."""
121
d = _builtin_commands()
123
d.update(plugin_cmds)
127
def get_all_cmds(plugins_override=True):
128
"""Return canonical name and class for all registered commands."""
129
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
133
219
def get_cmd_object(cmd_name, plugins_override=True):
134
"""Return the canonical name and command class for a command.
220
"""Return the command object for a command.
137
223
If true, plugin commands can override builtins.
140
226
return _get_cmd_object(cmd_name, plugins_override)
142
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
145
def _get_cmd_object(cmd_name, plugins_override=True):
146
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
228
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
231
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
232
"""Get a command object.
234
:param cmd_name: The name of the command.
235
:param plugins_override: Allow plugins to override builtins.
236
:param check_missing: Look up commands not found in the regular index via
237
the get_missing_command hook.
238
:return: A Command object instance
239
:raises KeyError: If no command is found.
241
# We want only 'ascii' command names, but the user may have typed
242
# in a Unicode name. In that case, they should just get a
243
# 'command not found' error later.
244
# In the future, we may actually support Unicode command names.
247
for hook in Command.hooks['get_command']:
248
cmd = hook(cmd, cmd_name)
249
if cmd is not None and not plugins_override and not cmd.plugin_name():
250
# We've found a non-plugin command, don't permit it to be
253
if cmd is None and check_missing:
254
for hook in Command.hooks['get_missing_command']:
261
# Allow plugins to extend commands
262
for hook in Command.hooks['extend_command']:
264
if getattr(cmd, 'invoked_as', None) is None:
265
cmd.invoked_as = cmd_name
269
def _try_plugin_provider(cmd_name):
270
"""Probe for a plugin provider having cmd_name."""
272
plugin_metadata, provider = probe_for_provider(cmd_name)
273
raise errors.CommandAvailableInPlugin(cmd_name,
274
plugin_metadata, provider)
275
except errors.NoPluginAvailable:
279
def probe_for_provider(cmd_name):
280
"""Look for a provider for cmd_name.
282
:param cmd_name: The command name.
283
:return: plugin_metadata, provider for getting cmd_name.
284
:raises NoPluginAvailable: When no provider can supply the plugin.
286
# look for providers that provide this command but aren't installed
287
for provider in command_providers_registry:
289
return provider.plugin_for_command(cmd_name), provider
290
except errors.NoPluginAvailable:
292
raise errors.NoPluginAvailable(cmd_name)
295
def _get_bzr_command(cmd_or_None, cmd_name):
296
"""Get a command from bzr's core."""
298
cmd_class = builtin_command_registry.get(cmd_name)
306
def _get_external_command(cmd_or_None, cmd_name):
307
"""Lookup a command that is a shell script."""
308
# Only do external command lookups when no command is found so far.
309
if cmd_or_None is not None:
147
311
from bzrlib.externalcommand import ExternalCommand
149
# We want only 'ascii' command names, but the user may have typed
150
# in a Unicode name. In that case, they should just get a
151
# 'command not found' error later.
152
# In the future, we may actually support Unicode command names.
154
# first look up this command under the specified name
155
cmds = _get_cmd_dict(plugins_override=plugins_override)
157
return cmds[cmd_name]()
161
# look for any command which claims this as an alias
162
for real_cmd_name, cmd_class in cmds.iteritems():
163
if cmd_name in cmd_class.aliases:
166
312
cmd_obj = ExternalCommand.find_command(cmd_name)
317
def _get_plugin_command(cmd_or_None, cmd_name):
318
"""Get a command from bzr's plugins."""
320
return plugin_cmds.get(cmd_name)()
323
for key in plugin_cmds.keys():
324
info = plugin_cmds.get_info(key)
325
if cmd_name in info.aliases:
326
return plugin_cmds.get(key)()
172
330
class Command(object):
187
345
summary, then a complete description of the command. A grammar
188
346
description will be inserted.
191
Other accepted names for this command.
194
List of argument forms, marked with whether they are optional,
199
['to_location', 'from_branch?', 'file*']
201
'to_location' is required
202
'from_branch' is optional
203
'file' can be specified 0 or more times
206
List of options that may be given for this command. These can
207
be either strings, referring to globally-defined options,
208
or option objects. Retrieve through options().
211
If true, this command isn't advertised. This is typically
348
:cvar aliases: Other accepted names for this command.
350
:cvar takes_args: List of argument forms, marked with whether they are
351
optional, repeated, etc. Examples::
353
['to_location', 'from_branch?', 'file*']
355
* 'to_location' is required
356
* 'from_branch' is optional
357
* 'file' can be specified 0 or more times
359
:cvar takes_options: List of options that may be given for this command.
360
These can be either strings, referring to globally-defined options, or
361
option objects. Retrieve through options().
363
:cvar hidden: If true, this command isn't advertised. This is typically
212
364
for commands intended for expert users.
215
Command objects will get a 'outf' attribute, which has been
216
setup to properly handle encoding of unicode strings.
217
encoding_type determines what will happen when characters cannot
219
strict - abort if we cannot decode
220
replace - put in a bogus character (typically '?')
221
exact - do not encode sys.stdout
223
NOTE: by default on Windows, sys.stdout is opened as a text
224
stream, therefore LF line-endings are converted to CRLF.
225
When a command uses encoding_type = 'exact', then
226
sys.stdout is forced to be a binary stream, and line-endings
366
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
367
been setup to properly handle encoding of unicode strings.
368
encoding_type determines what will happen when characters cannot be
371
* strict - abort if we cannot decode
372
* replace - put in a bogus character (typically '?')
373
* exact - do not encode sys.stdout
375
NOTE: by default on Windows, sys.stdout is opened as a text stream,
376
therefore LF line-endings are converted to CRLF. When a command uses
377
encoding_type = 'exact', then sys.stdout is forced to be a binary
378
stream, and line-endings will not mangled.
381
A string indicating the real name under which this command was
382
invoked, before expansion of aliases.
383
(This may be None if the command was constructed and run in-process.)
385
:cvar hooks: An instance of CommandHooks.
387
:cvar __doc__: The help shown by 'bzr help command' for this command.
388
This is set by assigning explicitly to __doc__ so that -OO can
392
__doc__ = "My help goes here"
232
396
takes_options = []
233
397
encoding_type = 'strict'
237
403
def __init__(self):
238
404
"""Construct an instance of this command."""
239
if self.__doc__ == Command.__doc__:
240
warn("No help message set for %r" % self)
242
def _maybe_expand_globs(self, file_list):
243
"""Glob expand file_list if the platform does not do that itself.
245
:return: A possibly empty list of unicode paths.
247
Introduced in bzrlib 0.18.
251
if sys.platform == 'win32':
252
file_list = win32utils.glob_expand(file_list)
253
return list(file_list)
405
# List of standard options directly supported
406
self.supported_std_options = []
409
def add_cleanup(self, cleanup_func, *args, **kwargs):
410
"""Register a function to call after self.run returns or raises.
412
Functions will be called in LIFO order.
414
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
416
def cleanup_now(self):
417
"""Execute and empty pending cleanup functions immediately.
419
After cleanup_now all registered cleanups are forgotten. add_cleanup
420
may be called again after cleanup_now; these cleanups will be called
421
after self.run returns or raises (or when cleanup_now is next called).
423
This is useful for releasing expensive or contentious resources (such
424
as write locks) before doing further work that does not require those
425
resources (such as writing results to self.outf). Note though, that
426
as it releases all resources, this may release locks that the command
427
wants to hold, so use should be done with care.
429
self._operation.cleanup_now()
255
431
def _usage(self):
256
432
"""Return single-line grammar for this command.
267
443
elif aname[-1] == '*':
268
444
aname = '[' + aname[:-1] + '...]'
446
s = s[:-1] # remove last space
275
449
def get_help_text(self, additional_see_also=None, plain=True,
276
see_also_as_links=False):
450
see_also_as_links=False, verbose=True):
277
451
"""Return a text string with help for this command.
279
453
:param additional_see_also: Additional help topics to be
280
454
cross-referenced.
281
455
:param plain: if False, raw help (reStructuredText) is
282
456
returned instead of plain text.
283
457
:param see_also_as_links: if True, convert items in 'See also'
284
458
list to internal links (used by bzr_man rstx generator)
459
:param verbose: if True, display the full help, otherwise
460
leave out the descriptive sections and just display
461
usage help (e.g. Purpose, Usage, Options) with a
462
message explaining how to obtain full help.
465
i18n.install() # Install i18n only for get_help_text for now.
286
466
doc = self.help()
288
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
468
# Note: If self.gettext() translates ':Usage:\n', the section will
469
# be shown after "Description" section and we don't want to
470
# translate the usage string.
471
# Though, bzr export-pot don't exports :Usage: section and it must
473
doc = self.gettext(doc)
475
doc = gettext("No help for this command.")
290
477
# Extract the summary (purpose) and sections out from the text
291
purpose,sections = self._get_help_parts(doc)
478
purpose,sections,order = self._get_help_parts(doc)
293
480
# If a custom usage section was provided, use it
294
481
if sections.has_key('Usage'):
299
486
# The header is the purpose and usage
301
result += ':Purpose: %s\n' % purpose
488
result += gettext(':Purpose: %s\n') % (purpose,)
302
489
if usage.find('\n') >= 0:
303
result += ':Usage:\n%s\n' % usage
490
result += gettext(':Usage:\n%s\n') % (usage,)
305
result += ':Usage: %s\n' % usage
492
result += gettext(':Usage: %s\n') % (usage,)
308
495
# Add the options
309
options = option.get_optparser(self.options()).format_option_help()
497
# XXX: optparse implicitly rewraps the help, and not always perfectly,
498
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
500
parser = option.get_optparser(self.options())
501
options = parser.format_option_help()
502
# FIXME: According to the spec, ReST option lists actually don't
503
# support options like --1.14 so that causes syntax errors (in Sphinx
504
# at least). As that pattern always appears in the commands that
505
# break, we trap on that and then format that block of 'format' options
506
# as a literal block. We use the most recent format still listed so we
507
# don't have to do that too often -- vila 20110514
508
if not plain and options.find(' --1.14 ') != -1:
509
options = options.replace(' format:\n', ' format::\n\n', 1)
310
510
if options.startswith('Options:'):
311
result += ':' + options
312
elif options.startswith('options:'):
313
# Python 2.4 version of optparse
314
result += ':Options:' + options[len('options:'):]
511
result += gettext(':Options:%s') % (options[len('options:'):],)
316
513
result += options
319
# Add the description, indenting it 2 spaces
320
# to match the indentation of the options
321
if sections.has_key(None):
322
text = sections.pop(None)
323
text = '\n '.join(text.splitlines())
324
result += ':%s:\n %s\n\n' % ('Description',text)
517
# Add the description, indenting it 2 spaces
518
# to match the indentation of the options
519
if sections.has_key(None):
520
text = sections.pop(None)
521
text = '\n '.join(text.splitlines())
522
result += gettext(':Description:\n %s\n\n') % (text,)
326
# Add the custom sections (e.g. Examples). Note that there's no need
327
# to indent these as they must be indented already in the source.
329
labels = sorted(sections.keys())
331
result += ':%s:\n%s\n\n' % (label,sections[label])
524
# Add the custom sections (e.g. Examples). Note that there's no need
525
# to indent these as they must be indented already in the source.
528
if label in sections:
529
result += ':%s:\n%s\n' % (label, sections[label])
532
result += (gettext("See bzr help %s for more details and examples.\n\n")
333
535
# Add the aliases, source (plug-in) and see also links, if any
335
result += ':Aliases: '
537
result += gettext(':Aliases: ')
336
538
result += ', '.join(self.aliases) + '\n'
337
539
plugin_name = self.plugin_name()
338
540
if plugin_name is not None:
339
result += ':From: plugin "%s"\n' % plugin_name
541
result += gettext(':From: plugin "%s"\n') % plugin_name
340
542
see_also = self.get_see_also(additional_see_also)
342
544
if not plain and see_also_as_links:
363
566
def _get_help_parts(text):
364
567
"""Split help text into a summary and named sections.
366
:return: (summary,sections) where summary is the top line and
569
:return: (summary,sections,order) where summary is the top line and
367
570
sections is a dictionary of the rest indexed by section name.
571
order is the order the section appear in the text.
368
572
A section starts with a heading line of the form ":xxx:".
369
573
Indented text on following lines is the section value.
370
574
All text found outside a named section is assigned to the
371
575
default section which is given the key of None.
373
def save_section(sections, label, section):
577
def save_section(sections, order, label, section):
374
578
if len(section) > 0:
375
579
if sections.has_key(label):
376
580
sections[label] += '\n' + section
378
583
sections[label] = section
380
585
lines = text.rstrip().splitlines()
381
586
summary = lines.pop(0)
383
589
label,section = None,''
384
590
for line in lines:
385
591
if line.startswith(':') and line.endswith(':') and len(line) > 2:
386
save_section(sections, label, section)
592
save_section(sections, order, label, section)
387
593
label,section = line[1:-1],''
388
elif label != None and len(line) > 1 and not line[0].isspace():
389
save_section(sections, label, section)
594
elif (label is not None) and len(line) > 1 and not line[0].isspace():
595
save_section(sections, order, label, section)
390
596
label,section = None,line
392
598
if len(section) > 0:
393
599
section += '\n' + line
396
save_section(sections, label, section)
397
return summary, sections
602
save_section(sections, order, label, section)
603
return summary, sections, order
399
605
def get_help_topic(self):
400
606
"""Return the commands help topic - its name."""
417
623
"""Return dict of valid options for this command.
419
625
Maps from long option name to option object."""
421
r['help'] = option._help_option
626
r = Option.STD_OPTIONS.copy()
422
628
for o in self.takes_options:
423
629
if isinstance(o, basestring):
424
630
o = option.Option.OPTIONS[o]
632
if o.name in std_names:
633
self.supported_std_options.append(o.name)
428
636
def _setup_outf(self):
429
637
"""Return a file linked to stdout, which has proper encoding."""
430
assert self.encoding_type in ['strict', 'exact', 'replace']
432
# Originally I was using self.stdout, but that looks
433
# *way* too much like sys.stdout
434
if self.encoding_type == 'exact':
435
# force sys.stdout to be binary stream on win32
436
if sys.platform == 'win32':
437
fileno = getattr(sys.stdout, 'fileno', None)
440
msvcrt.setmode(fileno(), os.O_BINARY)
441
self.outf = sys.stdout
444
output_encoding = osutils.get_terminal_encoding()
446
# use 'replace' so that we don't abort if trying to write out
447
# in e.g. the default C locale.
448
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
449
# For whatever reason codecs.getwriter() does not advertise its encoding
450
# it just returns the encoding of the wrapped file, which is completely
451
# bogus. So set the attribute, so we can find the correct encoding later.
452
self.outf.encoding = output_encoding
638
self.outf = ui.ui_factory.make_output_stream(
639
encoding_type=self.encoding_type)
454
641
def run_argv_aliases(self, argv, alias_argv=None):
455
642
"""Parse the command line and run with extra aliases in alias_argv."""
457
warn("Passing None for [] is deprecated from bzrlib 0.10",
458
DeprecationWarning, stacklevel=2)
460
643
args, opts = parse_args(self, argv, alias_argv)
646
# Process the standard options
461
647
if 'help' in opts: # e.g. bzr add --help
462
sys.stdout.write(self.get_help_text())
648
self.outf.write(self.get_help_text())
650
if 'usage' in opts: # e.g. bzr add --usage
651
self.outf.write(self.get_help_text(verbose=False))
653
trace.set_verbosity_level(option._verbosity_level)
654
if 'verbose' in self.supported_std_options:
655
opts['verbose'] = trace.is_verbose()
656
elif opts.has_key('verbose'):
658
if 'quiet' in self.supported_std_options:
659
opts['quiet'] = trace.is_quiet()
660
elif opts.has_key('quiet'):
464
662
# mix arguments and options into one dictionary
465
663
cmdargs = _match_argform(self.name(), self.takes_args, args)
470
668
all_cmd_args = cmdargs.copy()
471
669
all_cmd_args.update(cmdopts)
475
return self.run(**all_cmd_args)
672
return self.run(**all_cmd_args)
674
# reset it, so that other commands run in the same process won't
675
# inherit state. Before we reset it, log any activity, so that it
676
# gets properly tracked.
677
ui.ui_factory.log_transport_activity(
678
display=('bytes' in debug.debug_flags))
679
trace.set_verbosity_level(0)
681
def _setup_run(self):
682
"""Wrap the defined run method on self with a cleanup.
684
This is called by __init__ to make the Command be able to be run
685
by just calling run(), as it could be before cleanups were added.
687
If a different form of cleanups are in use by your Command subclass,
688
you can override this method.
691
def run(*args, **kwargs):
692
self._operation = cleanup.OperationWithCleanups(class_run)
694
return self._operation.run_simple(*args, **kwargs)
478
700
"""Actually run the command.
757
class CommandHooks(Hooks):
758
"""Hooks related to Command object creation/enumeration."""
761
"""Create the default hooks.
763
These are all empty initially, because by default nothing should get
766
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
767
self.add_hook('extend_command',
768
"Called after creating a command object to allow modifications "
769
"such as adding or removing options, docs etc. Called with the "
770
"new bzrlib.commands.Command object.", (1, 13))
771
self.add_hook('get_command',
772
"Called when creating a single command. Called with "
773
"(cmd_or_None, command_name). get_command should either return "
774
"the cmd_or_None parameter, or a replacement Command object that "
775
"should be used for the command. Note that the Command.hooks "
776
"hooks are core infrastructure. Many users will prefer to use "
777
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
779
self.add_hook('get_missing_command',
780
"Called when creating a single command if no command could be "
781
"found. Called with (command_name). get_missing_command should "
782
"either return None, or a Command object to be used for the "
784
self.add_hook('list_commands',
785
"Called when enumerating commands. Called with a set of "
786
"cmd_name strings for all the commands found so far. This set "
787
" is safe to mutate - e.g. to remove a command. "
788
"list_commands should return the updated set of command names.",
791
Command.hooks = CommandHooks()
512
794
def parse_args(command, argv, alias_argv=None):
513
795
"""Parse command line.
515
797
Arguments and options are parsed at this level before being passed
516
798
down to specific command handlers. This routine knows, from a
517
799
lookup table, something about the available options, what optargs
547
836
argdict[argname + '_list'] = None
548
837
elif ap[-1] == '+':
550
raise errors.BzrCommandError("command %r needs one or more %s"
551
% (cmd, argname.upper()))
839
raise errors.BzrCommandError(gettext(
840
"command {0!r} needs one or more {1}").format(
841
cmd, argname.upper()))
553
843
argdict[argname + '_list'] = args[:]
555
845
elif ap[-1] == '$': # all but one
556
846
if len(args) < 2:
557
raise errors.BzrCommandError("command %r needs one or more %s"
558
% (cmd, argname.upper()))
847
raise errors.BzrCommandError(
848
gettext("command {0!r} needs one or more {1}").format(
849
cmd, argname.upper()))
559
850
argdict[argname + '_list'] = args[:-1]
562
853
# just a plain arg
565
raise errors.BzrCommandError("command %r requires argument %s"
566
% (cmd, argname.upper()))
856
raise errors.BzrCommandError(
857
gettext("command {0!r} requires argument {1}").format(
858
cmd, argname.upper()))
568
860
argdict[argname] = args.pop(0)
571
raise errors.BzrCommandError("extra argument to command %s: %s"
863
raise errors.BzrCommandError( gettext(
864
"extra argument to command {0}: {1}").format(
869
def apply_coveraged(dirname, the_callable, *args, **kwargs):
870
# Cannot use "import trace", as that would import bzrlib.trace instead of
871
# the standard library's trace.
872
trace = __import__('trace')
874
tracer = trace.Trace(count=1, trace=0)
875
sys.settrace(tracer.globaltrace)
876
threading.settrace(tracer.globaltrace)
879
return exception_to_return_code(the_callable, *args, **kwargs)
882
results = tracer.results()
883
results.write_results(show_missing=1, summary=False,
578
887
def apply_profiled(the_callable, *args, **kwargs):
598
908
os.remove(pfname)
911
def exception_to_return_code(the_callable, *args, **kwargs):
912
"""UI level helper for profiling and coverage.
914
This transforms exceptions into a return value of 3. As such its only
915
relevant to the UI layer, and should never be called where catching
916
exceptions may be desirable.
919
return the_callable(*args, **kwargs)
920
except (KeyboardInterrupt, Exception), e:
921
# used to handle AssertionError and KeyboardInterrupt
922
# specially here, but hopefully they're handled ok by the logger now
923
exc_info = sys.exc_info()
924
exitcode = trace.report_exception(exc_info, sys.stderr)
925
if os.environ.get('BZR_PDB'):
926
print '**** entering debugger'
929
if sys.version_info[:2] < (2, 6):
931
# pdb.post_mortem(tb)
932
# but because pdb.post_mortem gives bad results for tracebacks
933
# from inside generators, we do it manually.
934
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
936
# Setup pdb on the traceback
939
p.setup(tb.tb_frame, tb)
940
# Point the debugger at the deepest frame of the stack
941
p.curindex = len(p.stack) - 1
942
p.curframe = p.stack[p.curindex][0]
943
# Start the pdb prompt.
944
p.print_stack_entry(p.stack[p.curindex])
601
952
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
602
953
from bzrlib.lsprof import profile
603
ret, stats = profile(the_callable, *args, **kwargs)
954
ret, stats = profile(exception_to_return_code, the_callable,
605
957
if filename is None:
608
960
stats.save(filename)
609
trace.note('Profile data written to "%s".', filename)
961
trace.note(gettext('Profile data written to "%s".'), filename)
625
977
config = bzrlib.config.GlobalConfig()
626
978
alias = config.get_alias(cmd)
629
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
980
return cmdline.split(alias)
984
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
634
985
"""Execute a command.
636
This is similar to main(), but without all the trappings for
637
logging and error handling.
640
The command-line arguments, without the program name from argv[0]
641
These should already be decoded. All library/test code calling
642
run_bzr should be passing valid strings (don't need decoding).
644
Returns a command status or raises an exception.
987
:param argv: The command-line arguments, without the program name from
988
argv[0] These should already be decoded. All library/test code calling
989
run_bzr should be passing valid strings (don't need decoding).
990
:param load_plugins: What function to call when triggering plugin loading.
991
This function should take no arguments and cause all plugins to be
993
:param disable_plugins: What function to call when disabling plugin
994
loading. This function should take no arguments and cause all plugin
995
loading to be prohibited (so that code paths in your application that
996
know about some plugins possibly being present will fail to import
997
those plugins even if they are installed.)
998
:return: Returns a command exit code or raises an exception.
646
1000
Special master options: these must come before the command because
647
1001
they control how the command is interpreted.
689
1051
opt_no_plugins = True
690
1052
elif a == '--no-aliases':
691
1053
opt_no_aliases = True
1054
elif a == '--no-l10n':
692
1056
elif a == '--builtin':
693
1057
opt_builtin = True
694
elif a in ('--quiet', '-q'):
1058
elif a == '--concurrency':
1059
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1061
elif a == '--coverage':
1062
opt_coverage_dir = argv[i + 1]
1064
elif a == '--profile-imports':
1065
pass # already handled in startup script Bug #588277
696
1066
elif a.startswith('-D'):
697
1067
debug.debug_flags.add(a[2:])
1068
elif a.startswith('-O'):
1069
override_config.append(a[2:])
699
1071
argv_copy.append(a)
1074
bzrlib.global_state.cmdline_overrides._from_cmdline(override_config)
1076
debug.set_debug_flags_from_config()
1078
if not opt_no_plugins:
702
1083
argv = argv_copy
704
from bzrlib.builtins import cmd_help
705
cmd_help().run_argv_aliases([])
1085
get_cmd_object('help').run_argv_aliases([])
708
1088
if argv[0] == '--version':
709
from bzrlib.version import show_version
1089
get_cmd_object('version').run_argv_aliases([])
713
if not opt_no_plugins:
714
from bzrlib.plugin import load_plugins
717
from bzrlib.plugin import disable_plugins
720
1092
alias_argv = None
722
1094
if not opt_no_aliases:
723
1095
alias_argv = get_alias(argv[0])
725
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
726
1097
argv[0] = alias_argv.pop(0)
728
1099
cmd = argv.pop(0)
729
# We want only 'ascii' command names, but the user may have typed
730
# in a Unicode name. In that case, they should just get a
731
# 'command not found' error later.
733
1100
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
734
1103
run = cmd_obj.run_argv_aliases
735
1104
run_argv = [argv, alias_argv]
1107
# We can be called recursively (tests for example), but we don't want
1108
# the verbosity level to propagate.
1109
saved_verbosity_level = option._verbosity_level
1110
option._verbosity_level = 0
1112
if opt_coverage_dir:
1114
'--coverage ignored, because --lsprof is in use.')
739
1115
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
740
1116
elif opt_profile:
1117
if opt_coverage_dir:
1119
'--coverage ignored, because --profile is in use.')
741
1120
ret = apply_profiled(run, *run_argv)
1121
elif opt_coverage_dir:
1122
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
743
1124
ret = run(*run_argv)
746
# reset, in case we may do other commands later within the same process
747
trace.be_quiet(False)
1127
# reset, in case we may do other commands later within the same
1128
# process. Commands that want to execute sub-commands must propagate
1129
# --verbose in their own way.
1130
if 'memory' in debug.debug_flags:
1131
trace.debug_memory('Process status after command:', short=False)
1132
option._verbosity_level = saved_verbosity_level
1133
# Reset the overrides
1134
bzrlib.global_state.cmdline_overrides._reset()
749
1137
def display_command(func):
750
1138
"""Decorator that suppresses pipe/interrupt errors."""
766
1154
return ignore_pipe
771
from bzrlib.ui.text import TextUIFactory
772
bzrlib.ui.ui_factory = TextUIFactory()
774
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
775
except UnicodeDecodeError:
776
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1157
def install_bzr_command_hooks():
1158
"""Install the hooks to supply bzr's own commands."""
1159
if _list_bzr_commands in Command.hooks["list_commands"]:
1161
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1163
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1165
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1166
"bzr plugin commands")
1167
Command.hooks.install_named_hook("get_command", _get_external_command,
1168
"bzr external command lookup")
1169
Command.hooks.install_named_hook("get_missing_command",
1170
_try_plugin_provider,
1171
"bzr plugin-provider-db check")
1175
def _specified_or_unicode_argv(argv):
1176
# For internal or testing use, argv can be passed. Otherwise, get it from
1177
# the process arguments in a unicode-safe way.
1179
return osutils.get_unicode_argv()
1183
# ensure all arguments are unicode strings
1185
if isinstance(a, unicode):
1188
new_argv.append(a.decode('ascii'))
1189
except UnicodeDecodeError:
1190
raise errors.BzrError("argv should be list of unicode strings.")
1194
def main(argv=None):
1195
"""Main entry point of command-line interface.
1197
Typically `bzrlib.initialize` should be called first.
1199
:param argv: list of unicode command-line arguments similar to sys.argv.
1200
argv[0] is script name usually, it will be ignored.
1201
Don't pass here sys.argv because this list contains plain strings
1202
and not unicode; pass None instead.
1204
:return: exit code of bzr command.
1206
if argv is not None:
1208
_register_builtin_commands()
778
1209
ret = run_bzr_catch_errors(argv)
779
1210
trace.mutter("return code %d", ret)
783
1214
def run_bzr_catch_errors(argv):
1215
"""Run a bzr command with parameters as described by argv.
1217
This function assumed that that UI layer is setup, that symbol deprecations
1218
are already applied, and that unicode decoding has already been performed on argv.
1220
# done here so that they're covered for every test run
1221
install_bzr_command_hooks()
1222
return exception_to_return_code(run_bzr, argv)
1225
def run_bzr_catch_user_errors(argv):
1226
"""Run bzr and report user errors, but let internal errors propagate.
1228
This is used for the test suite, and might be useful for other programs
1229
that want to wrap the commandline interface.
1231
# done here so that they're covered for every test run
1232
install_bzr_command_hooks()
785
1234
return run_bzr(argv)
786
except (KeyboardInterrupt, Exception), e:
787
# used to handle AssertionError and KeyboardInterrupt
788
# specially here, but hopefully they're handled ok by the logger now
789
trace.report_exception(sys.exc_info(), sys.stderr)
790
if os.environ.get('BZR_PDB'):
791
print '**** entering debugger'
793
pdb.post_mortem(sys.exc_traceback)
1235
except Exception, e:
1236
if (isinstance(e, (OSError, IOError))
1237
or not getattr(e, 'internal_error', True)):
1238
trace.report_exception(sys.exc_info(), sys.stderr)
797
1244
class HelpCommandIndex(object):
added
removed
bzrlib/commands.py
