23
26
# 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?
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
33
from warnings import warn
33
from warnings import warn
49
from bzrlib.hooks import HookPoint, Hooks
50
# Compatibility - Option used to be in commands.
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError,
51
43
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
61
class CommandInfo(object):
62
"""Information about a command."""
64
def __init__(self, aliases):
65
"""The list of aliases for the command."""
66
self.aliases = aliases
69
def from_command(klass, command):
70
"""Factory to construct a CommandInfo from a command."""
71
return klass(command.aliases)
74
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
def _get_name(command_name):
94
if command_name.startswith("cmd_"):
95
return _unsquish_command_name(command_name)
99
def register(self, cmd, decorate=False):
100
"""Utility function to help register a command
102
:param cmd: Command subclass to register
103
:param decorate: If true, allow overriding an existing command
104
of the same name; the old command is returned by this function.
105
Otherwise it is an error to try to override an existing command.
108
k_unsquished = self._get_name(k)
110
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
118
info = CommandInfo.from_command(cmd)
120
registry.Registry.register(self, k_unsquished, cmd,
121
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
132
def register_lazy(self, command_name, aliases, module_name):
133
"""Register a command without loading its module.
135
:param command_name: The primary name of the command.
136
:param aliases: A list of aliases for the command.
137
:module_name: The module that the command lives in.
139
key = self._get_name(command_name)
140
registry.Registry.register_lazy(self, key, module_name, command_name,
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
45
from bzrlib.revisionspec import RevisionSpec
46
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
48
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
151
53
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
54
"""Utility function to help register a command
154
Should generally be avoided in favor of lazy registration.
56
:param cmd: Command subclass to register
57
:param decorate: If true, allow overriding an existing command
58
of the same name; the old command is returned by this function.
59
Otherwise it is an error to try to override an existing command.
156
61
global plugin_cmds
157
return plugin_cmds.register(cmd, decorate)
63
if k.startswith("cmd_"):
64
k_unsquished = _unsquish_command_name(k)
67
if not plugin_cmds.has_key(k_unsquished):
68
plugin_cmds[k_unsquished] = cmd
69
mutter('registered plugin command %s', k_unsquished)
70
if decorate and k_unsquished in builtin_command_names():
71
return _builtin_commands()[k_unsquished]
73
result = plugin_cmds[k_unsquished]
74
plugin_cmds[k_unsquished] = cmd
77
log_error('Two plugins defined the same command: %r' % k)
78
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
160
81
def _squish_command_name(cmd):
164
85
def _unsquish_command_name(cmd):
86
assert cmd.startswith("cmd_")
165
87
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
90
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
91
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
93
builtins = bzrlib.builtins.__dict__
191
95
if name.startswith("cmd_"):
192
96
real_name = _unsquish_command_name(name)
97
r[real_name] = builtins[name]
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
101
def builtin_command_names():
220
"""Return list of builtin command names.
102
"""Return list of builtin command names."""
103
return _builtin_commands().keys()
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
_register_builtin_commands()
226
return builtin_command_registry.keys()
229
106
def plugin_command_names():
230
"""Returns command names from commands registered by plugins."""
231
107
return plugin_cmds.keys()
110
def _get_cmd_dict(plugins_override=True):
111
"""Return name->class mapping for all commands."""
112
d = _builtin_commands()
114
d.update(plugin_cmds)
118
def get_all_cmds(plugins_override=True):
119
"""Return canonical name and class for all registered commands."""
120
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
234
124
def get_cmd_object(cmd_name, plugins_override=True):
235
"""Return the command object for a command.
125
"""Return the canonical name and command class for a command.
238
128
If true, plugin commands can override builtins.
241
return _get_cmd_object(cmd_name, plugins_override)
243
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
246
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
247
"""Get a command object.
249
:param cmd_name: The name of the command.
250
:param plugins_override: Allow plugins to override builtins.
251
:param check_missing: Look up commands not found in the regular index via
252
the get_missing_command hook.
253
:return: A Command object instance
254
:raises KeyError: If no command is found.
256
# We want only 'ascii' command names, but the user may have typed
257
# in a Unicode name. In that case, they should just get a
258
# 'command not found' error later.
259
# In the future, we may actually support Unicode command names.
262
for hook in Command.hooks['get_command']:
263
cmd = hook(cmd, cmd_name)
264
if cmd is not None and not plugins_override and not cmd.plugin_name():
265
# We've found a non-plugin command, don't permit it to be
268
if cmd is None and check_missing:
269
for hook in Command.hooks['get_missing_command']:
276
# Allow plugins to extend commands
277
for hook in Command.hooks['extend_command']:
282
def _try_plugin_provider(cmd_name):
283
"""Probe for a plugin provider having cmd_name."""
285
plugin_metadata, provider = probe_for_provider(cmd_name)
286
raise errors.CommandAvailableInPlugin(cmd_name,
287
plugin_metadata, provider)
288
except errors.NoPluginAvailable:
292
def probe_for_provider(cmd_name):
293
"""Look for a provider for cmd_name.
295
:param cmd_name: The command name.
296
:return: plugin_metadata, provider for getting cmd_name.
297
:raises NoPluginAvailable: When no provider can supply the plugin.
299
# look for providers that provide this command but aren't installed
300
for provider in command_providers_registry:
302
return provider.plugin_for_command(cmd_name), provider
303
except errors.NoPluginAvailable:
305
raise errors.NoPluginAvailable(cmd_name)
308
def _get_bzr_command(cmd_or_None, cmd_name):
309
"""Get a command from bzr's core."""
311
cmd_class = builtin_command_registry.get(cmd_name)
319
def _get_external_command(cmd_or_None, cmd_name):
320
"""Lookup a command that is a shell script."""
321
# Only do external command lookups when no command is found so far.
322
if cmd_or_None is not None:
324
130
from bzrlib.externalcommand import ExternalCommand
132
cmd_name = str(cmd_name) # not unicode
134
# first look up this command under the specified name
135
cmds = _get_cmd_dict(plugins_override=plugins_override)
137
return cmds[cmd_name]()
141
# look for any command which claims this as an alias
142
for real_cmd_name, cmd_class in cmds.iteritems():
143
if cmd_name in cmd_class.aliases:
325
146
cmd_obj = ExternalCommand.find_command(cmd_name)
330
def _get_plugin_command(cmd_or_None, cmd_name):
331
"""Get a command from bzr's plugins."""
333
return plugin_cmds.get(cmd_name)()
336
for key in plugin_cmds.keys():
337
info = plugin_cmds.get_info(key)
338
if cmd_name in info.aliases:
339
return plugin_cmds.get(key)()
150
raise BzrCommandError('unknown command "%s"' % cmd_name)
343
153
class Command(object):
411
208
encoding_type = 'strict'
415
212
def __init__(self):
416
213
"""Construct an instance of this command."""
417
# List of standard options directly supported
418
self.supported_std_options = []
421
def add_cleanup(self, cleanup_func, *args, **kwargs):
422
"""Register a function to call after self.run returns or raises.
424
Functions will be called in LIFO order.
426
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
428
def cleanup_now(self):
429
"""Execute and empty pending cleanup functions immediately.
431
After cleanup_now all registered cleanups are forgotten. add_cleanup
432
may be called again after cleanup_now; these cleanups will be called
433
after self.run returns or raises (or when cleanup_now is next called).
435
This is useful for releasing expensive or contentious resources (such
436
as write locks) before doing further work that does not require those
437
resources (such as writing results to self.outf). Note though, that
438
as it releases all resources, this may release locks that the command
439
wants to hold, so use should be done with care.
441
self._operation.cleanup_now()
443
@deprecated_method(deprecated_in((2, 1, 0)))
444
def _maybe_expand_globs(self, file_list):
445
"""Glob expand file_list if the platform does not do that itself.
447
Not used anymore, now that the bzr command-line parser globs on
450
:return: A possibly empty list of unicode paths.
452
Introduced in bzrlib 0.18.
457
"""Return single-line grammar for this command.
459
Only describes arguments, not options.
461
s = 'bzr ' + self.name() + ' '
462
for aname in self.takes_args:
463
aname = aname.upper()
464
if aname[-1] in ['$', '+']:
465
aname = aname[:-1] + '...'
466
elif aname[-1] == '?':
467
aname = '[' + aname[:-1] + ']'
468
elif aname[-1] == '*':
469
aname = '[' + aname[:-1] + '...]'
471
s = s[:-1] # remove last space
474
def get_help_text(self, additional_see_also=None, plain=True,
475
see_also_as_links=False, verbose=True):
476
"""Return a text string with help for this command.
478
:param additional_see_also: Additional help topics to be
480
:param plain: if False, raw help (reStructuredText) is
481
returned instead of plain text.
482
:param see_also_as_links: if True, convert items in 'See also'
483
list to internal links (used by bzr_man rstx generator)
484
:param verbose: if True, display the full help, otherwise
485
leave out the descriptive sections and just display
486
usage help (e.g. Purpose, Usage, Options) with a
487
message explaining how to obtain full help.
491
doc = "No help for this command."
493
# Extract the summary (purpose) and sections out from the text
494
purpose,sections,order = self._get_help_parts(doc)
496
# If a custom usage section was provided, use it
497
if sections.has_key('Usage'):
498
usage = sections.pop('Usage')
500
usage = self._usage()
502
# The header is the purpose and usage
504
result += ':Purpose: %s\n' % purpose
505
if usage.find('\n') >= 0:
506
result += ':Usage:\n%s\n' % usage
508
result += ':Usage: %s\n' % usage
513
# XXX: optparse implicitly rewraps the help, and not always perfectly,
514
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
516
options = option.get_optparser(self.options()).format_option_help()
517
# XXX: According to the spec, ReST option lists actually don't support
518
# options like --1.9 so that causes syntax errors (in Sphinx at least).
519
# As that pattern always appears in the commands that break, we trap
520
# on that and then format that block of 'format' options as a literal
522
if not plain and options.find(' --1.9 ') != -1:
523
options = options.replace(' format:\n', ' format::\n\n', 1)
524
if options.startswith('Options:'):
525
result += ':' + options
526
elif options.startswith('options:'):
527
# Python 2.4 version of optparse
528
result += ':Options:' + options[len('options:'):]
534
# Add the description, indenting it 2 spaces
535
# to match the indentation of the options
536
if sections.has_key(None):
537
text = sections.pop(None)
538
text = '\n '.join(text.splitlines())
539
result += ':%s:\n %s\n\n' % ('Description',text)
541
# Add the custom sections (e.g. Examples). Note that there's no need
542
# to indent these as they must be indented already in the source.
545
if sections.has_key(label):
546
result += ':%s:\n%s\n' % (label,sections[label])
549
result += ("See bzr help %s for more details and examples.\n\n"
552
# Add the aliases, source (plug-in) and see also links, if any
554
result += ':Aliases: '
555
result += ', '.join(self.aliases) + '\n'
556
plugin_name = self.plugin_name()
557
if plugin_name is not None:
558
result += ':From: plugin "%s"\n' % plugin_name
559
see_also = self.get_see_also(additional_see_also)
561
if not plain and see_also_as_links:
563
for item in see_also:
565
# topics doesn't have an independent section
566
# so don't create a real link
567
see_also_links.append(item)
569
# Use a Sphinx link for this entry
570
link_text = ":doc:`%s <%s-help>`" % (item, item)
571
see_also_links.append(link_text)
572
see_also = see_also_links
573
result += ':See also: '
574
result += ', '.join(see_also) + '\n'
576
# If this will be rendered as plain text, convert it
578
import bzrlib.help_topics
579
result = bzrlib.help_topics.help_as_plain_text(result)
583
def _get_help_parts(text):
584
"""Split help text into a summary and named sections.
586
:return: (summary,sections,order) where summary is the top line and
587
sections is a dictionary of the rest indexed by section name.
588
order is the order the section appear in the text.
589
A section starts with a heading line of the form ":xxx:".
590
Indented text on following lines is the section value.
591
All text found outside a named section is assigned to the
592
default section which is given the key of None.
594
def save_section(sections, order, label, section):
596
if sections.has_key(label):
597
sections[label] += '\n' + section
600
sections[label] = section
602
lines = text.rstrip().splitlines()
603
summary = lines.pop(0)
606
label,section = None,''
608
if line.startswith(':') and line.endswith(':') and len(line) > 2:
609
save_section(sections, order, label, section)
610
label,section = line[1:-1],''
611
elif (label is not None) and len(line) > 1 and not line[0].isspace():
612
save_section(sections, order, label, section)
613
label,section = None,line
616
section += '\n' + line
619
save_section(sections, order, label, section)
620
return summary, sections, order
622
def get_help_topic(self):
623
"""Return the commands help topic - its name."""
626
def get_see_also(self, additional_terms=None):
627
"""Return a list of help topics that are related to this command.
629
The list is derived from the content of the _see_also attribute. Any
630
duplicates are removed and the result is in lexical order.
631
:param additional_terms: Additional help topics to cross-reference.
632
:return: A list of help topics.
634
see_also = set(getattr(self, '_see_also', []))
636
see_also.update(additional_terms)
637
return sorted(see_also)
214
if self.__doc__ == Command.__doc__:
215
warn("No help message set for %r" % self)
639
217
def options(self):
640
218
"""Return dict of valid options for this command.
642
220
Maps from long option name to option object."""
643
r = Option.STD_OPTIONS.copy()
222
r['help'] = Option.OPTIONS['help']
645
223
for o in self.takes_options:
646
if isinstance(o, basestring):
647
o = option.Option.OPTIONS[o]
224
if not isinstance(o, Option):
225
o = Option.OPTIONS[o]
649
if o.name in std_names:
650
self.supported_std_options.append(o.name)
653
229
def _setup_outf(self):
654
230
"""Return a file linked to stdout, which has proper encoding."""
655
self.outf = ui.ui_factory.make_output_stream(
656
encoding_type=self.encoding_type)
231
assert self.encoding_type in ['strict', 'exact', 'replace']
233
# Originally I was using self.stdout, but that looks
234
# *way* too much like sys.stdout
235
if self.encoding_type == 'exact':
236
self.outf = sys.stdout
239
output_encoding = bzrlib.osutils.get_terminal_encoding()
241
# use 'replace' so that we don't abort if trying to write out
242
# in e.g. the default C locale.
243
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
244
# For whatever reason codecs.getwriter() does not advertise its encoding
245
# it just returns the encoding of the wrapped file, which is completely
246
# bogus. So set the attribute, so we can find the correct encoding later.
247
self.outf.encoding = output_encoding
249
@deprecated_method(zero_eight)
250
def run_argv(self, argv):
251
"""Parse command line and run.
253
See run_argv_aliases for the 0.8 and beyond api.
255
return self.run_argv_aliases(argv)
658
257
def run_argv_aliases(self, argv, alias_argv=None):
659
258
"""Parse the command line and run with extra aliases in alias_argv."""
660
259
args, opts = parse_args(self, argv, alias_argv)
662
# Process the standard options
663
260
if 'help' in opts: # e.g. bzr add --help
664
sys.stdout.write(self.get_help_text())
666
if 'usage' in opts: # e.g. bzr add --usage
667
sys.stdout.write(self.get_help_text(verbose=False))
669
trace.set_verbosity_level(option._verbosity_level)
670
if 'verbose' in self.supported_std_options:
671
opts['verbose'] = trace.is_verbose()
672
elif opts.has_key('verbose'):
674
if 'quiet' in self.supported_std_options:
675
opts['quiet'] = trace.is_quiet()
676
elif opts.has_key('quiet'):
261
from bzrlib.help import help_on_command
262
help_on_command(self.name())
264
# XXX: This should be handled by the parser
265
allowed_names = self.options().keys()
267
if oname not in allowed_names:
268
raise BzrOptionError("option '--%s' is not allowed for"
269
" command %r" % (oname, self.name()))
679
270
# mix arguments and options into one dictionary
680
271
cmdargs = _match_argform(self.name(), self.takes_args, args)
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
771
self.create_hook(HookPoint('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), None))
775
self.create_hook(HookPoint('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.create_hook(HookPoint('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 "
787
"command.", (1, 17), None))
788
self.create_hook(HookPoint('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()
318
def parse_spec(spec):
324
>>> parse_spec("../@")
326
>>> parse_spec("../f/@35")
328
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
329
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
334
parsed = spec.split('/@')
335
assert len(parsed) == 2
340
parsed[1] = int(parsed[1])
342
pass # We can allow stuff like ./@revid:blahblahblah
346
parsed = [spec, None]
798
349
def parse_args(command, argv, alias_argv=None):
799
350
"""Parse command line.
801
352
Arguments and options are parsed at this level before being passed
802
353
down to specific command handlers. This routine knows, from a
803
354
lookup table, something about the available options, what optargs
804
355
they take, and which commands will accept them.
806
# TODO: make it a method of the Command?
807
parser = option.get_optparser(command.options())
808
if alias_argv is not None:
809
args = alias_argv + argv
813
options, args = parser.parse_args(args)
814
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
815
v is not option.OptionParser.DEFAULT_VALUE])
357
# TODO: chop up this beast; make it a method of the Command
362
cmd_options = command.options()
364
proc_aliasarg = True # Are we processing alias_argv now?
365
for proc_argv in alias_argv, argv:
375
# We've received a standalone -- No more flags
379
# option names must not be unicode
383
mutter(" got option %r", a)
385
optname, optarg = a[2:].split('=', 1)
388
if optname not in cmd_options:
389
raise BzrCommandError('unknown option "%s"' % a)
392
if shortopt in Option.SHORT_OPTIONS:
393
# Multi-character options must have a space to delimit
395
# ^^^ what does this mean? mbp 20051014
396
optname = Option.SHORT_OPTIONS[shortopt].name
398
# Single character short options, can be chained,
399
# and have their value appended to their name
401
if shortopt not in Option.SHORT_OPTIONS:
402
# We didn't find the multi-character name, and we
403
# didn't find the single char name
404
raise BzrCommandError('unknown option "%s"' % a)
405
optname = Option.SHORT_OPTIONS[shortopt].name
408
# There are extra things on this option
409
# see if it is the value, or if it is another
411
optargfn = Option.OPTIONS[optname].type
413
# This option does not take an argument, so the
414
# next entry is another short option, pack it
416
proc_argv.insert(0, '-' + a[2:])
418
# This option takes an argument, so pack it
421
if optname not in cmd_options:
422
raise BzrCommandError('unknown option "%s"' % shortopt)
424
# XXX: Do we ever want to support this, e.g. for -r?
426
raise BzrCommandError('repeated option %r' % a)
427
elif optname in alias_opts:
428
# Replace what's in the alias with what's in the real
430
del alias_opts[optname]
432
proc_argv.insert(0, a)
435
raise BzrCommandError('repeated option %r' % a)
437
option_obj = cmd_options[optname]
438
optargfn = option_obj.type
442
raise BzrCommandError('option %r needs an argument' % a)
444
optarg = proc_argv.pop(0)
445
opts[optname] = optargfn(optarg)
447
alias_opts[optname] = optargfn(optarg)
450
raise BzrCommandError('option %r takes no argument' % optname)
453
alias_opts[optname] = True
456
proc_aliasarg = False # Done with alias argv
816
457
return args, opts
901
525
os.remove(pfname)
904
def exception_to_return_code(the_callable, *args, **kwargs):
905
"""UI level helper for profiling and coverage.
907
This transforms exceptions into a return value of 3. As such its only
908
relevant to the UI layer, and should never be called where catching
909
exceptions may be desirable.
912
return the_callable(*args, **kwargs)
913
except (KeyboardInterrupt, Exception), e:
914
# used to handle AssertionError and KeyboardInterrupt
915
# specially here, but hopefully they're handled ok by the logger now
916
exc_info = sys.exc_info()
917
exitcode = trace.report_exception(exc_info, sys.stderr)
918
if os.environ.get('BZR_PDB'):
919
print '**** entering debugger'
922
if sys.version_info[:2] < (2, 6):
924
# pdb.post_mortem(tb)
925
# but because pdb.post_mortem gives bad results for tracebacks
926
# from inside generators, we do it manually.
927
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
929
# Setup pdb on the traceback
932
p.setup(tb.tb_frame, tb)
933
# Point the debugger at the deepest frame of the stack
934
p.curindex = len(p.stack) - 1
935
p.curframe = p.stack[p.curindex][0]
936
# Start the pdb prompt.
937
p.print_stack_entry(p.stack[p.curindex])
945
528
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
946
529
from bzrlib.lsprof import profile
947
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
531
ret, stats = profile(the_callable, *args, **kwargs)
949
533
if filename is None:
953
trace.note('Profile data written to "%s".', filename)
537
cPickle.dump(stats, open(filename, 'w'), 2)
538
print 'Profile data written to %r.' % filename
957
@deprecated_function(deprecated_in((2, 2, 0)))
958
def shlex_split_unicode(unsplit):
959
return cmdline.split(unsplit)
962
def get_alias(cmd, config=None):
963
"""Return an expanded alias, or None if no alias exists.
966
Command to be checked for an alias.
968
Used to specify an alternative config to use,
969
which is especially useful for testing.
970
If it is unspecified, the global config will be used.
974
config = bzrlib.config.GlobalConfig()
975
alias = config.get_alias(cmd)
543
"""Return an expanded alias, or None if no alias exists"""
545
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
977
return cmdline.split(alias)
547
return alias.split(' ')
981
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
982
552
"""Execute a command.
984
:param argv: The command-line arguments, without the program name from
985
argv[0] These should already be decoded. All library/test code calling
986
run_bzr should be passing valid strings (don't need decoding).
987
:param load_plugins: What function to call when triggering plugin loading.
988
This function should take no arguments and cause all plugins to be
990
:param disable_plugins: What function to call when disabling plugin
991
loading. This function should take no arguments and cause all plugin
992
loading to be prohibited (so that code paths in your application that
993
know about some plugins possibly being present will fail to import
994
those plugins even if they are installed.)
995
:return: Returns a command exit code or raises an exception.
554
This is similar to main(), but without all the trappings for
555
logging and error handling.
558
The command-line arguments, without the program name from argv[0]
559
These should already be decoded. All library/test code calling
560
run_bzr should be passing valid strings (don't need decoding).
562
Returns a command status or raises an exception.
997
564
Special master options: these must come before the command because
998
565
they control how the command is interpreted.
1049
608
opt_no_aliases = True
1050
609
elif a == '--builtin':
1051
610
opt_builtin = True
1052
elif a == '--concurrency':
1053
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1055
elif a == '--coverage':
1056
opt_coverage_dir = argv[i + 1]
1058
elif a == '--profile-imports':
1059
pass # already handled in startup script Bug #588277
1060
elif a.startswith('-D'):
1061
debug.debug_flags.add(a[2:])
611
elif a in ('--quiet', '-q'):
1063
614
argv_copy.append(a)
1066
debug.set_debug_flags_from_config()
619
from bzrlib.builtins import cmd_help
620
cmd_help().run_argv_aliases([])
623
if argv[0] == '--version':
624
from bzrlib.builtins import show_version
1068
628
if not opt_no_plugins:
629
from bzrlib.plugin import load_plugins
632
from bzrlib.plugin import disable_plugins
1071
633
disable_plugins()
1075
get_cmd_object('help').run_argv_aliases([])
1078
if argv[0] == '--version':
1079
get_cmd_object('version').run_argv_aliases([])
1082
635
alias_argv = None
1084
637
if not opt_no_aliases:
1085
638
alias_argv = get_alias(argv[0])
640
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1087
641
argv[0] = alias_argv.pop(0)
643
cmd = str(argv.pop(0))
1090
645
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1091
run = cmd_obj.run_argv_aliases
1092
run_argv = [argv, alias_argv]
646
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
647
run = cmd_obj.run_argv
650
run = cmd_obj.run_argv_aliases
651
run_argv = [argv, alias_argv]
1095
# We can be called recursively (tests for example), but we don't want
1096
# the verbosity level to propagate.
1097
saved_verbosity_level = option._verbosity_level
1098
option._verbosity_level = 0
1100
if opt_coverage_dir:
1102
'--coverage ignored, because --lsprof is in use.')
1103
655
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1104
656
elif opt_profile:
1105
if opt_coverage_dir:
1107
'--coverage ignored, because --profile is in use.')
1108
657
ret = apply_profiled(run, *run_argv)
1109
elif opt_coverage_dir:
1110
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1112
659
ret = run(*run_argv)
1115
# reset, in case we may do other commands later within the same
1116
# process. Commands that want to execute sub-commands must propagate
1117
# --verbose in their own way.
1118
if 'memory' in debug.debug_flags:
1119
trace.debug_memory('Process status after command:', short=False)
1120
option._verbosity_level = saved_verbosity_level
662
# reset, in case we may do other commands later within the same process
1123
665
def display_command(func):
1124
666
"""Decorator that suppresses pipe/interrupt errors."""
1140
682
return ignore_pipe
1143
def install_bzr_command_hooks():
1144
"""Install the hooks to supply bzr's own commands."""
1145
if _list_bzr_commands in Command.hooks["list_commands"]:
1147
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1149
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1151
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1152
"bzr plugin commands")
1153
Command.hooks.install_named_hook("get_command", _get_external_command,
1154
"bzr external command lookup")
1155
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1156
"bzr plugin-provider-db check")
1160
def _specified_or_unicode_argv(argv):
1161
# For internal or testing use, argv can be passed. Otherwise, get it from
1162
# the process arguments in a unicode-safe way.
1164
return osutils.get_unicode_argv()
1168
# ensure all arguments are unicode strings
1170
if isinstance(a, unicode):
1173
new_argv.append(a.decode('ascii'))
1174
except UnicodeDecodeError:
1175
raise errors.BzrError("argv should be list of unicode strings.")
1179
def main(argv=None):
1180
"""Main entry point of command-line interface.
1182
Typically `bzrlib.initialize` should be called first.
1184
:param argv: list of unicode command-line arguments similar to sys.argv.
1185
argv[0] is script name usually, it will be ignored.
1186
Don't pass here sys.argv because this list contains plain strings
1187
and not unicode; pass None instead.
1189
:return: exit code of bzr command.
1191
argv = _specified_or_unicode_argv(argv)
1192
_register_builtin_commands()
687
from bzrlib.ui.text import TextUIFactory
688
bzrlib.ui.ui_factory = TextUIFactory()
689
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
1193
690
ret = run_bzr_catch_errors(argv)
1194
bzrlib.ui.ui_factory.log_transport_activity(
1195
display=('bytes' in debug.debug_flags))
1196
trace.mutter("return code %d", ret)
691
mutter("return code %d", ret)
1200
695
def run_bzr_catch_errors(argv):
1201
"""Run a bzr command with parameters as described by argv.
1203
This function assumed that that UI layer is setup, that symbol deprecations
1204
are already applied, and that unicode decoding has already been performed on argv.
1206
# done here so that they're covered for every test run
1207
install_bzr_command_hooks()
1208
return exception_to_return_code(run_bzr, argv)
1211
def run_bzr_catch_user_errors(argv):
1212
"""Run bzr and report user errors, but let internal errors propagate.
1214
This is used for the test suite, and might be useful for other programs
1215
that want to wrap the commandline interface.
1217
# done here so that they're covered for every test run
1218
install_bzr_command_hooks()
1220
697
return run_bzr(argv)
698
# do this here inside the exception wrappers to catch EPIPE
1221
700
except Exception, e:
1222
if (isinstance(e, (OSError, IOError))
1223
or not getattr(e, 'internal_error', True)):
1224
trace.report_exception(sys.exc_info(), sys.stderr)
1230
class HelpCommandIndex(object):
1231
"""A index for bzr help that returns commands."""
1234
self.prefix = 'commands/'
1236
def get_topics(self, topic):
1237
"""Search for topic amongst commands.
1239
:param topic: A topic to search for.
1240
:return: A list which is either empty or contains a single
1243
if topic and topic.startswith(self.prefix):
1244
topic = topic[len(self.prefix):]
1246
cmd = _get_cmd_object(topic, check_missing=False)
1253
class Provider(object):
1254
'''Generic class to be overriden by plugins'''
1256
def plugin_for_command(self, cmd_name):
1257
'''Takes a command and returns the information for that plugin
1259
:return: A dictionary with all the available information
1260
for the requested plugin
1262
raise NotImplementedError
1265
class ProvidersRegistry(registry.Registry):
1266
'''This registry exists to allow other providers to exist'''
1269
for key, provider in self.iteritems():
1272
command_providers_registry = ProvidersRegistry()
701
# used to handle AssertionError and KeyboardInterrupt
702
# specially here, but hopefully they're handled ok by the logger now
703
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
704
if os.environ.get('BZR_PDB'):
705
print '**** entering debugger'
707
pdb.post_mortem(sys.exc_traceback)
710
if __name__ == '__main__':
711
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
