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 (
49
from bzrlib.hooks import Hooks
50
from bzrlib.i18n import gettext
51
# Compatibility - Option used to be in commands.
56
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
62
147
def register_command(cmd, decorate=False):
63
"""Utility function to help register a command
148
"""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.
150
Should generally be avoided in favor of lazy registration.
70
152
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__])
153
return plugin_cmds.register(cmd, decorate)
90
156
def _squish_command_name(cmd):
94
160
def _unsquish_command_name(cmd):
95
assert cmd.startswith("cmd_")
96
161
return cmd[4:].replace('_','-')
99
def _builtin_commands():
164
def _register_builtin_commands():
165
if builtin_command_registry.keys():
100
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):
102
builtins = bzrlib.builtins.__dict__
103
for name in builtins:
176
for name, obj in module.__dict__.iteritems():
104
177
if name.startswith("cmd_"):
105
178
real_name = _unsquish_command_name(name)
106
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))
110
205
def builtin_command_names():
111
"""Return list of builtin command names."""
112
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()
115
215
def plugin_command_names():
216
"""Returns command names from commands registered by plugins."""
116
217
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
220
def get_cmd_object(cmd_name, plugins_override=True):
134
"""Return the canonical name and command class for a command.
221
"""Return the command object for a command.
137
224
If true, plugin commands can override builtins.
140
227
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."""
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:
147
312
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
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)()
172
331
class Command(object):
187
346
summary, then a complete description of the command. A grammar
188
347
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
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
212
365
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
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"
232
397
takes_options = []
233
398
encoding_type = 'strict'
237
404
def __init__(self):
238
405
"""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)
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()
255
432
def _usage(self):
256
433
"""Return single-line grammar for this command.
267
444
elif aname[-1] == '*':
268
445
aname = '[' + aname[:-1] + '...]'
447
s = s[:-1] # remove last space
275
450
def get_help_text(self, additional_see_also=None, plain=True,
276
see_also_as_links=False):
451
see_also_as_links=False, verbose=True):
277
452
"""Return a text string with help for this command.
279
454
:param additional_see_also: Additional help topics to be
280
455
cross-referenced.
281
456
:param plain: if False, raw help (reStructuredText) is
282
457
returned instead of plain text.
283
458
:param see_also_as_links: if True, convert items in 'See also'
284
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.
286
467
doc = self.help()
288
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.")
290
478
# Extract the summary (purpose) and sections out from the text
291
purpose,sections = self._get_help_parts(doc)
479
purpose,sections,order = self._get_help_parts(doc)
293
481
# If a custom usage section was provided, use it
294
482
if sections.has_key('Usage'):
299
487
# The header is the purpose and usage
301
result += ':Purpose: %s\n' % purpose
489
result += gettext(':Purpose: %s\n') % (purpose,)
302
490
if usage.find('\n') >= 0:
303
result += ':Usage:\n%s\n' % usage
491
result += gettext(':Usage:\n%s\n') % (usage,)
305
result += ':Usage: %s\n' % usage
493
result += gettext(':Usage: %s\n') % (usage,)
308
496
# Add the options
309
options = option.get_optparser(self.options()).format_option_help()
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)
310
511
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:'):]
512
result += gettext(':Options:%s') % (options[len('options:'):],)
316
514
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)
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,)
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])
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")
333
536
# Add the aliases, source (plug-in) and see also links, if any
335
result += ':Aliases: '
538
result += gettext(':Aliases: ')
336
539
result += ', '.join(self.aliases) + '\n'
337
540
plugin_name = self.plugin_name()
338
541
if plugin_name is not None:
339
result += ':From: plugin "%s"\n' % plugin_name
542
result += gettext(':From: plugin "%s"\n') % plugin_name
340
543
see_also = self.get_see_also(additional_see_also)
342
545
if not plain and see_also_as_links:
363
567
def _get_help_parts(text):
364
568
"""Split help text into a summary and named sections.
366
:return: (summary,sections) where summary is the top line and
570
:return: (summary,sections,order) where summary is the top line and
367
571
sections is a dictionary of the rest indexed by section name.
572
order is the order the section appear in the text.
368
573
A section starts with a heading line of the form ":xxx:".
369
574
Indented text on following lines is the section value.
370
575
All text found outside a named section is assigned to the
371
576
default section which is given the key of None.
373
def save_section(sections, label, section):
578
def save_section(sections, order, label, section):
374
579
if len(section) > 0:
375
580
if sections.has_key(label):
376
581
sections[label] += '\n' + section
378
584
sections[label] = section
380
586
lines = text.rstrip().splitlines()
381
587
summary = lines.pop(0)
383
590
label,section = None,''
384
591
for line in lines:
385
592
if line.startswith(':') and line.endswith(':') and len(line) > 2:
386
save_section(sections, label, section)
593
save_section(sections, order, label, section)
387
594
label,section = line[1:-1],''
388
elif label != None and len(line) > 1 and not line[0].isspace():
389
save_section(sections, label, section)
595
elif (label is not None) and len(line) > 1 and not line[0].isspace():
596
save_section(sections, order, label, section)
390
597
label,section = None,line
392
599
if len(section) > 0:
393
600
section += '\n' + line
396
save_section(sections, label, section)
397
return summary, sections
603
save_section(sections, order, label, section)
604
return summary, sections, order
399
606
def get_help_topic(self):
400
607
"""Return the commands help topic - its name."""
417
624
"""Return dict of valid options for this command.
419
626
Maps from long option name to option object."""
421
r['help'] = option._help_option
627
r = Option.STD_OPTIONS.copy()
422
629
for o in self.takes_options:
423
630
if isinstance(o, basestring):
424
631
o = option.Option.OPTIONS[o]
633
if o.name in std_names:
634
self.supported_std_options.append(o.name)
428
637
def _setup_outf(self):
429
638
"""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
639
self.outf = ui.ui_factory.make_output_stream(
640
encoding_type=self.encoding_type)
454
642
def run_argv_aliases(self, argv, alias_argv=None):
455
643
"""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
644
args, opts = parse_args(self, argv, alias_argv)
647
# Process the standard options
461
648
if 'help' in opts: # e.g. bzr add --help
462
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'):
464
663
# mix arguments and options into one dictionary
465
664
cmdargs = _match_argform(self.name(), self.takes_args, args)
470
669
all_cmd_args = cmdargs.copy()
471
670
all_cmd_args.update(cmdopts)
475
return self.run(**all_cmd_args)
673
return self.run(**all_cmd_args)
675
# reset it, so that other commands run in the same process won't
676
# inherit state. Before we reset it, log any activity, so that it
677
# gets properly tracked.
678
ui.ui_factory.log_transport_activity(
679
display=('bytes' in debug.debug_flags))
680
trace.set_verbosity_level(0)
682
def _setup_run(self):
683
"""Wrap the defined run method on self with a cleanup.
685
This is called by __init__ to make the Command be able to be run
686
by just calling run(), as it could be before cleanups were added.
688
If a different form of cleanups are in use by your Command subclass,
689
you can override this method.
692
def run(*args, **kwargs):
693
for hook in Command.hooks['pre_command']:
695
self._operation = cleanup.OperationWithCleanups(class_run)
697
return self._operation.run_simple(*args, **kwargs)
700
for hook in Command.hooks['post_command']:
478
705
"""Actually run the command.
762
class CommandHooks(Hooks):
763
"""Hooks related to Command object creation/enumeration."""
766
"""Create the default hooks.
768
These are all empty initially, because by default nothing should get
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
773
"Called after creating a command object to allow modifications "
774
"such as adding or removing options, docs etc. Called with the "
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
777
"Called when creating a single command. Called with "
778
"(cmd_or_None, command_name). get_command should either return "
779
"the cmd_or_None parameter, or a replacement Command object that "
780
"should be used for the command. Note that the Command.hooks "
781
"hooks are core infrastructure. Many users will prefer to use "
782
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
784
self.add_hook('get_missing_command',
785
"Called when creating a single command if no command could be "
786
"found. Called with (command_name). get_missing_command should "
787
"either return None, or a Command object to be used for the "
789
self.add_hook('list_commands',
790
"Called when enumerating commands. Called with a set of "
791
"cmd_name strings for all the commands found so far. This set "
792
" is safe to mutate - e.g. to remove a command. "
793
"list_commands should return the updated set of command names.",
795
self.add_hook('pre_command',
796
"Called prior to executing a command. Called with the command "
798
self.add_hook('post_command',
799
"Called after executing a command. Called with the command "
802
Command.hooks = CommandHooks()
512
805
def parse_args(command, argv, alias_argv=None):
513
806
"""Parse command line.
515
808
Arguments and options are parsed at this level before being passed
516
809
down to specific command handlers. This routine knows, from a
517
810
lookup table, something about the available options, what optargs
547
847
argdict[argname + '_list'] = None
548
848
elif ap[-1] == '+':
550
raise errors.BzrCommandError("command %r needs one or more %s"
551
% (cmd, argname.upper()))
850
raise errors.BzrCommandError(gettext(
851
"command {0!r} needs one or more {1}").format(
852
cmd, argname.upper()))
553
854
argdict[argname + '_list'] = args[:]
555
856
elif ap[-1] == '$': # all but one
556
857
if len(args) < 2:
557
raise errors.BzrCommandError("command %r needs one or more %s"
558
% (cmd, argname.upper()))
858
raise errors.BzrCommandError(
859
gettext("command {0!r} needs one or more {1}").format(
860
cmd, argname.upper()))
559
861
argdict[argname + '_list'] = args[:-1]
562
864
# just a plain arg
565
raise errors.BzrCommandError("command %r requires argument %s"
566
% (cmd, argname.upper()))
867
raise errors.BzrCommandError(
868
gettext("command {0!r} requires argument {1}").format(
869
cmd, argname.upper()))
568
871
argdict[argname] = args.pop(0)
571
raise errors.BzrCommandError("extra argument to command %s: %s"
874
raise errors.BzrCommandError( gettext(
875
"extra argument to command {0}: {1}").format(
880
def apply_coveraged(dirname, the_callable, *args, **kwargs):
881
# Cannot use "import trace", as that would import bzrlib.trace instead of
882
# the standard library's trace.
883
trace = __import__('trace')
885
tracer = trace.Trace(count=1, trace=0)
886
sys.settrace(tracer.globaltrace)
887
threading.settrace(tracer.globaltrace)
890
return exception_to_return_code(the_callable, *args, **kwargs)
893
results = tracer.results()
894
results.write_results(show_missing=1, summary=False,
578
898
def apply_profiled(the_callable, *args, **kwargs):
598
919
os.remove(pfname)
922
def exception_to_return_code(the_callable, *args, **kwargs):
923
"""UI level helper for profiling and coverage.
925
This transforms exceptions into a return value of 3. As such its only
926
relevant to the UI layer, and should never be called where catching
927
exceptions may be desirable.
930
return the_callable(*args, **kwargs)
931
except (KeyboardInterrupt, Exception), e:
932
# used to handle AssertionError and KeyboardInterrupt
933
# specially here, but hopefully they're handled ok by the logger now
934
exc_info = sys.exc_info()
935
exitcode = trace.report_exception(exc_info, sys.stderr)
936
if os.environ.get('BZR_PDB'):
937
print '**** entering debugger'
940
if sys.version_info[:2] < (2, 6):
942
# pdb.post_mortem(tb)
943
# but because pdb.post_mortem gives bad results for tracebacks
944
# from inside generators, we do it manually.
945
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
947
# Setup pdb on the traceback
950
p.setup(tb.tb_frame, tb)
951
# Point the debugger at the deepest frame of the stack
952
p.curindex = len(p.stack) - 1
953
p.curframe = p.stack[p.curindex][0]
954
# Start the pdb prompt.
955
p.print_stack_entry(p.stack[p.curindex])
601
963
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
602
964
from bzrlib.lsprof import profile
603
ret, stats = profile(the_callable, *args, **kwargs)
965
ret, stats = profile(exception_to_return_code, the_callable,
605
968
if filename is None:
608
971
stats.save(filename)
609
trace.note('Profile data written to "%s".', filename)
972
trace.note(gettext('Profile data written to "%s".'), filename)
625
988
config = bzrlib.config.GlobalConfig()
626
989
alias = config.get_alias(cmd)
629
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
991
return cmdline.split(alias)
995
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
634
996
"""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.
998
:param argv: The command-line arguments, without the program name from
999
argv[0] These should already be decoded. All library/test code calling
1000
run_bzr should be passing valid strings (don't need decoding).
1001
:param load_plugins: What function to call when triggering plugin loading.
1002
This function should take no arguments and cause all plugins to be
1004
:param disable_plugins: What function to call when disabling plugin
1005
loading. This function should take no arguments and cause all plugin
1006
loading to be prohibited (so that code paths in your application that
1007
know about some plugins possibly being present will fail to import
1008
those plugins even if they are installed.)
1009
:return: Returns a command exit code or raises an exception.
646
1011
Special master options: these must come before the command because
647
1012
they control how the command is interpreted.
689
1062
opt_no_plugins = True
690
1063
elif a == '--no-aliases':
691
1064
opt_no_aliases = True
1065
elif a == '--no-l10n':
692
1067
elif a == '--builtin':
693
1068
opt_builtin = True
694
elif a in ('--quiet', '-q'):
1069
elif a == '--concurrency':
1070
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1072
elif a == '--coverage':
1073
opt_coverage_dir = argv[i + 1]
1075
elif a == '--profile-imports':
1076
pass # already handled in startup script Bug #588277
696
1077
elif a.startswith('-D'):
697
1078
debug.debug_flags.add(a[2:])
1079
elif a.startswith('-O'):
1080
override_config.append(a[2:])
699
1082
argv_copy.append(a)
1085
if bzrlib.global_state is None:
1086
# FIXME: Workaround for users that imported bzrlib but didn't call
1087
# bzrlib.initialize -- vila 2012-01-19
1088
cmdline_overrides = config.CommandLineStore()
1090
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1091
cmdline_overrides._from_cmdline(override_config)
1093
debug.set_debug_flags_from_config()
1095
if not opt_no_plugins:
702
1100
argv = argv_copy
704
from bzrlib.builtins import cmd_help
705
cmd_help().run_argv_aliases([])
1102
get_cmd_object('help').run_argv_aliases([])
708
1105
if argv[0] == '--version':
709
from bzrlib.version import show_version
1106
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
1109
alias_argv = None
722
1111
if not opt_no_aliases:
723
1112
alias_argv = get_alias(argv[0])
725
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
726
1114
argv[0] = alias_argv.pop(0)
728
1116
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
1117
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
734
1120
run = cmd_obj.run_argv_aliases
735
1121
run_argv = [argv, alias_argv]
1124
# We can be called recursively (tests for example), but we don't want
1125
# the verbosity level to propagate.
1126
saved_verbosity_level = option._verbosity_level
1127
option._verbosity_level = 0
1129
if opt_coverage_dir:
1131
'--coverage ignored, because --lsprof is in use.')
739
1132
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
740
1133
elif opt_profile:
1134
if opt_coverage_dir:
1136
'--coverage ignored, because --profile is in use.')
741
1137
ret = apply_profiled(run, *run_argv)
1138
elif opt_coverage_dir:
1139
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
743
1141
ret = run(*run_argv)
746
# reset, in case we may do other commands later within the same process
747
trace.be_quiet(False)
1144
# reset, in case we may do other commands later within the same
1145
# process. Commands that want to execute sub-commands must propagate
1146
# --verbose in their own way.
1147
if 'memory' in debug.debug_flags:
1148
trace.debug_memory('Process status after command:', short=False)
1149
option._verbosity_level = saved_verbosity_level
1150
# Reset the overrides
1151
cmdline_overrides._reset()
749
1154
def display_command(func):
750
1155
"""Decorator that suppresses pipe/interrupt errors."""
766
1171
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 "
1174
def install_bzr_command_hooks():
1175
"""Install the hooks to supply bzr's own commands."""
1176
if _list_bzr_commands in Command.hooks["list_commands"]:
1178
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1180
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1182
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1183
"bzr plugin commands")
1184
Command.hooks.install_named_hook("get_command", _get_external_command,
1185
"bzr external command lookup")
1186
Command.hooks.install_named_hook("get_missing_command",
1187
_try_plugin_provider,
1188
"bzr plugin-provider-db check")
1192
def _specified_or_unicode_argv(argv):
1193
# For internal or testing use, argv can be passed. Otherwise, get it from
1194
# the process arguments in a unicode-safe way.
1196
return osutils.get_unicode_argv()
1200
# ensure all arguments are unicode strings
1202
if isinstance(a, unicode):
1205
new_argv.append(a.decode('ascii'))
1206
except UnicodeDecodeError:
1207
raise errors.BzrError("argv should be list of unicode strings.")
1211
def main(argv=None):
1212
"""Main entry point of command-line interface.
1214
Typically `bzrlib.initialize` should be called first.
1216
:param argv: list of unicode command-line arguments similar to sys.argv.
1217
argv[0] is script name usually, it will be ignored.
1218
Don't pass here sys.argv because this list contains plain strings
1219
and not unicode; pass None instead.
1221
:return: exit code of bzr command.
1223
if argv is not None:
1225
_register_builtin_commands()
778
1226
ret = run_bzr_catch_errors(argv)
779
1227
trace.mutter("return code %d", ret)
783
1231
def run_bzr_catch_errors(argv):
1232
"""Run a bzr command with parameters as described by argv.
1234
This function assumed that that UI layer is setup, that symbol deprecations
1235
are already applied, and that unicode decoding has already been performed on argv.
1237
# done here so that they're covered for every test run
1238
install_bzr_command_hooks()
1239
return exception_to_return_code(run_bzr, argv)
1242
def run_bzr_catch_user_errors(argv):
1243
"""Run bzr and report user errors, but let internal errors propagate.
1245
This is used for the test suite, and might be useful for other programs
1246
that want to wrap the commandline interface.
1248
# done here so that they're covered for every test run
1249
install_bzr_command_hooks()
785
1251
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)
1252
except Exception, e:
1253
if (isinstance(e, (OSError, IOError))
1254
or not getattr(e, 'internal_error', True)):
1255
trace.report_exception(sys.exc_info(), sys.stderr)
797
1261
class HelpCommandIndex(object):
added
removed
bzrlib/commands.py
