28
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
29
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
33
from warnings import warn
39
from warnings import warn
52
from bzrlib.hooks import HookPoint, Hooks
53
# Compatibility - Option used to be in commands.
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError,
54
43
from bzrlib.option import Option
55
from bzrlib import registry
56
from bzrlib.symbol_versioning import (
59
suppress_deprecation_warnings,
63
class CommandInfo(object):
64
"""Information about a command."""
66
def __init__(self, aliases):
67
"""The list of aliases for the command."""
68
self.aliases = aliases
71
def from_command(klass, command):
72
"""Factory to construct a CommandInfo from a command."""
73
return klass(command.aliases)
76
class CommandRegistry(registry.Registry):
79
def _get_name(command_name):
80
if command_name.startswith("cmd_"):
81
return _unsquish_command_name(command_name)
85
def register(self, cmd, decorate=False):
86
"""Utility function to help register a command
88
:param cmd: Command subclass to register
89
:param decorate: If true, allow overriding an existing command
90
of the same name; the old command is returned by this function.
91
Otherwise it is an error to try to override an existing command.
94
k_unsquished = self._get_name(k)
96
previous = self.get(k_unsquished)
98
previous = _builtin_commands().get(k_unsquished)
99
info = CommandInfo.from_command(cmd)
101
registry.Registry.register(self, k_unsquished, cmd,
102
override_existing=decorate, info=info)
104
trace.log_error('Two plugins defined the same command: %r' % k)
105
trace.log_error('Not loading the one in %r' %
106
sys.modules[cmd.__module__])
107
trace.log_error('Previously this command was registered from %r' %
108
sys.modules[previous.__module__])
111
def register_lazy(self, command_name, aliases, module_name):
112
"""Register a command without loading its module.
114
:param command_name: The primary name of the command.
115
:param aliases: A list of aliases for the command.
116
:module_name: The module that the command lives in.
118
key = self._get_name(command_name)
119
registry.Registry.register_lazy(self, key, module_name, command_name,
120
info=CommandInfo(aliases))
123
plugin_cmds = CommandRegistry()
45
from bzrlib.revisionspec import RevisionSpec
46
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
47
from bzrlib import trace
48
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
126
53
def register_command(cmd, decorate=False):
54
"""Utility function to help register a command
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.
127
61
global plugin_cmds
128
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__])
131
81
def _squish_command_name(cmd):
135
85
def _unsquish_command_name(cmd):
86
assert cmd.startswith("cmd_")
136
87
return cmd[4:].replace('_','-')
139
90
def _builtin_commands():
140
91
import bzrlib.builtins
141
return _scan_module_for_commands(bzrlib.builtins)
144
def _scan_module_for_commands(module):
146
for name, obj in module.__dict__.iteritems():
93
builtins = bzrlib.builtins.__dict__
147
95
if name.startswith("cmd_"):
148
96
real_name = _unsquish_command_name(name)
97
r[real_name] = builtins[name]
153
def _list_bzr_commands(names):
154
"""Find commands from bzr's core and plugins."""
155
# to eliminate duplicates
156
names.update(builtin_command_names())
157
names.update(plugin_command_names())
161
def all_command_names():
162
"""Return a set of all command names."""
164
for hook in Command.hooks['list_commands']:
167
raise AssertionError(
168
'hook %s returned None' % Command.hooks.get_hook_name(hook))
172
101
def builtin_command_names():
173
"""Return list of builtin command names.
175
Use of all_command_names() is encouraged rather than builtin_command_names
176
and/or plugin_command_names.
102
"""Return list of builtin command names."""
178
103
return _builtin_commands().keys()
181
106
def plugin_command_names():
182
"""Returns command names from commands registered by plugins."""
183
107
return plugin_cmds.keys()
186
@deprecated_function(deprecated_in((1, 17, 0)))
187
def get_all_cmds(plugins_override=False):
188
"""Return canonical name and class for most commands.
190
NB: This does not return all commands since the introduction of
191
command hooks, and returning the class is not sufficient to
192
get correctly setup commands, which is why it is deprecated.
194
Use 'all_command_names' + 'get_cmd_object' instead.
110
def _get_cmd_dict(plugins_override=True):
111
"""Return name->class mapping for all commands."""
196
112
d = _builtin_commands()
197
113
if plugins_override:
198
d.update(plugin_cmds.iteritems())
199
for k, v in d.iteritems():
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():
203
124
def get_cmd_object(cmd_name, plugins_override=True):
204
"""Return the command object for a command.
125
"""Return the canonical name and command class for a command.
207
128
If true, plugin commands can override builtins.
210
return _get_cmd_object(cmd_name, plugins_override)
212
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
215
def _get_cmd_object(cmd_name, plugins_override=True):
216
"""Get a command object.
218
:param cmd_name: The name of the command.
219
:param plugins_override: Allow plugins to override builtins.
220
:return: A Command object instance
221
:raises KeyError: If no command is found.
223
# We want only 'ascii' command names, but the user may have typed
224
# in a Unicode name. In that case, they should just get a
225
# 'command not found' error later.
226
# In the future, we may actually support Unicode command names.
229
for hook in Command.hooks['get_command']:
230
cmd = hook(cmd, cmd_name)
231
if cmd is not None and not plugins_override and not cmd.plugin_name():
232
# We've found a non-plugin command, don't permit it to be
236
for hook in Command.hooks['get_missing_command']:
243
# Allow plugins to extend commands
244
for hook in Command.hooks['extend_command']:
249
def _try_plugin_provider(cmd_name):
250
"""Probe for a plugin provider having cmd_name."""
252
plugin_metadata, provider = probe_for_provider(cmd_name)
253
raise errors.CommandAvailableInPlugin(cmd_name,
254
plugin_metadata, provider)
255
except errors.NoPluginAvailable:
259
def probe_for_provider(cmd_name):
260
"""Look for a provider for cmd_name.
262
:param cmd_name: The command name.
263
:return: plugin_metadata, provider for getting cmd_name.
264
:raises NoPluginAvailable: When no provider can supply the plugin.
266
# look for providers that provide this command but aren't installed
267
for provider in command_providers_registry:
269
return provider.plugin_for_command(cmd_name), provider
270
except errors.NoPluginAvailable:
272
raise errors.NoPluginAvailable(cmd_name)
275
def _get_bzr_command(cmd_or_None, cmd_name):
276
"""Get a command from bzr's core."""
277
cmds = _builtin_commands()
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)
279
137
return cmds[cmd_name]()
282
141
# look for any command which claims this as an alias
283
142
for real_cmd_name, cmd_class in cmds.iteritems():
284
143
if cmd_name in cmd_class.aliases:
285
144
return cmd_class()
289
def _get_external_command(cmd_or_None, cmd_name):
290
"""Lookup a command that is a shell script."""
291
# Only do external command lookups when no command is found so far.
292
if cmd_or_None is not None:
294
from bzrlib.externalcommand import ExternalCommand
295
146
cmd_obj = ExternalCommand.find_command(cmd_name)
300
def _get_plugin_command(cmd_or_None, cmd_name):
301
"""Get a command from bzr's plugins."""
303
return plugin_cmds.get(cmd_name)()
306
for key in plugin_cmds.keys():
307
info = plugin_cmds.get_info(key)
308
if cmd_name in info.aliases:
309
return plugin_cmds.get(key)()
150
raise BzrCommandError('unknown command "%s"' % cmd_name)
313
153
class Command(object):
375
208
encoding_type = 'strict'
379
212
def __init__(self):
380
213
"""Construct an instance of this command."""
381
214
if self.__doc__ == Command.__doc__:
382
215
warn("No help message set for %r" % self)
383
# List of standard options directly supported
384
self.supported_std_options = []
386
def _maybe_expand_globs(self, file_list):
387
"""Glob expand file_list if the platform does not do that itself.
389
:return: A possibly empty list of unicode paths.
391
Introduced in bzrlib 0.18.
395
if sys.platform == 'win32':
396
file_list = win32utils.glob_expand(file_list)
397
return list(file_list)
400
"""Return single-line grammar for this command.
402
Only describes arguments, not options.
404
s = 'bzr ' + self.name() + ' '
405
for aname in self.takes_args:
406
aname = aname.upper()
407
if aname[-1] in ['$', '+']:
408
aname = aname[:-1] + '...'
409
elif aname[-1] == '?':
410
aname = '[' + aname[:-1] + ']'
411
elif aname[-1] == '*':
412
aname = '[' + aname[:-1] + '...]'
414
s = s[:-1] # remove last space
417
def get_help_text(self, additional_see_also=None, plain=True,
418
see_also_as_links=False, verbose=True):
419
"""Return a text string with help for this command.
421
:param additional_see_also: Additional help topics to be
423
:param plain: if False, raw help (reStructuredText) is
424
returned instead of plain text.
425
:param see_also_as_links: if True, convert items in 'See also'
426
list to internal links (used by bzr_man rstx generator)
427
:param verbose: if True, display the full help, otherwise
428
leave out the descriptive sections and just display
429
usage help (e.g. Purpose, Usage, Options) with a
430
message explaining how to obtain full help.
434
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
436
# Extract the summary (purpose) and sections out from the text
437
purpose,sections,order = self._get_help_parts(doc)
439
# If a custom usage section was provided, use it
440
if sections.has_key('Usage'):
441
usage = sections.pop('Usage')
443
usage = self._usage()
445
# The header is the purpose and usage
447
result += ':Purpose: %s\n' % purpose
448
if usage.find('\n') >= 0:
449
result += ':Usage:\n%s\n' % usage
451
result += ':Usage: %s\n' % usage
456
# XXX: optparse implicitly rewraps the help, and not always perfectly,
457
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
459
options = option.get_optparser(self.options()).format_option_help()
460
if options.startswith('Options:'):
461
result += ':' + options
462
elif options.startswith('options:'):
463
# Python 2.4 version of optparse
464
result += ':Options:' + options[len('options:'):]
470
# Add the description, indenting it 2 spaces
471
# to match the indentation of the options
472
if sections.has_key(None):
473
text = sections.pop(None)
474
text = '\n '.join(text.splitlines())
475
result += ':%s:\n %s\n\n' % ('Description',text)
477
# Add the custom sections (e.g. Examples). Note that there's no need
478
# to indent these as they must be indented already in the source.
481
if sections.has_key(label):
482
result += ':%s:\n%s\n' % (label,sections[label])
485
result += ("See bzr help %s for more details and examples.\n\n"
488
# Add the aliases, source (plug-in) and see also links, if any
490
result += ':Aliases: '
491
result += ', '.join(self.aliases) + '\n'
492
plugin_name = self.plugin_name()
493
if plugin_name is not None:
494
result += ':From: plugin "%s"\n' % plugin_name
495
see_also = self.get_see_also(additional_see_also)
497
if not plain and see_also_as_links:
499
for item in see_also:
501
# topics doesn't have an independent section
502
# so don't create a real link
503
see_also_links.append(item)
505
# Use a reST link for this entry
506
see_also_links.append("`%s`_" % (item,))
507
see_also = see_also_links
508
result += ':See also: '
509
result += ', '.join(see_also) + '\n'
511
# If this will be rendered as plain text, convert it
513
import bzrlib.help_topics
514
result = bzrlib.help_topics.help_as_plain_text(result)
518
def _get_help_parts(text):
519
"""Split help text into a summary and named sections.
521
:return: (summary,sections,order) where summary is the top line and
522
sections is a dictionary of the rest indexed by section name.
523
order is the order the section appear in the text.
524
A section starts with a heading line of the form ":xxx:".
525
Indented text on following lines is the section value.
526
All text found outside a named section is assigned to the
527
default section which is given the key of None.
529
def save_section(sections, order, label, section):
531
if sections.has_key(label):
532
sections[label] += '\n' + section
535
sections[label] = section
537
lines = text.rstrip().splitlines()
538
summary = lines.pop(0)
541
label,section = None,''
543
if line.startswith(':') and line.endswith(':') and len(line) > 2:
544
save_section(sections, order, label, section)
545
label,section = line[1:-1],''
546
elif (label is not None) and len(line) > 1 and not line[0].isspace():
547
save_section(sections, order, label, section)
548
label,section = None,line
551
section += '\n' + line
554
save_section(sections, order, label, section)
555
return summary, sections, order
557
def get_help_topic(self):
558
"""Return the commands help topic - its name."""
561
def get_see_also(self, additional_terms=None):
562
"""Return a list of help topics that are related to this command.
564
The list is derived from the content of the _see_also attribute. Any
565
duplicates are removed and the result is in lexical order.
566
:param additional_terms: Additional help topics to cross-reference.
567
:return: A list of help topics.
569
see_also = set(getattr(self, '_see_also', []))
571
see_also.update(additional_terms)
572
return sorted(see_also)
574
217
def options(self):
575
218
"""Return dict of valid options for this command.
577
220
Maps from long option name to option object."""
578
r = Option.STD_OPTIONS.copy()
222
r['help'] = Option.OPTIONS['help']
580
223
for o in self.takes_options:
581
if isinstance(o, basestring):
582
o = option.Option.OPTIONS[o]
224
if not isinstance(o, Option):
225
o = Option.OPTIONS[o]
584
if o.name in std_names:
585
self.supported_std_options.append(o.name)
588
229
def _setup_outf(self):
589
230
"""Return a file linked to stdout, which has proper encoding."""
231
assert self.encoding_type in ['strict', 'exact', 'replace']
590
233
# Originally I was using self.stdout, but that looks
591
234
# *way* too much like sys.stdout
592
235
if self.encoding_type == 'exact':
593
# force sys.stdout to be binary stream on win32
594
if sys.platform == 'win32':
595
fileno = getattr(sys.stdout, 'fileno', None)
598
msvcrt.setmode(fileno(), os.O_BINARY)
599
236
self.outf = sys.stdout
602
output_encoding = osutils.get_terminal_encoding()
239
output_encoding = bzrlib.osutils.get_terminal_encoding()
604
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
605
errors=self.encoding_type)
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)
606
244
# For whatever reason codecs.getwriter() does not advertise its encoding
607
245
# it just returns the encoding of the wrapped file, which is completely
608
246
# bogus. So set the attribute, so we can find the correct encoding later.
609
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)
611
257
def run_argv_aliases(self, argv, alias_argv=None):
612
258
"""Parse the command line and run with extra aliases in alias_argv."""
614
warn("Passing None for [] is deprecated from bzrlib 0.10",
615
DeprecationWarning, stacklevel=2)
617
259
args, opts = parse_args(self, argv, alias_argv)
619
# Process the standard options
620
260
if 'help' in opts: # e.g. bzr add --help
621
sys.stdout.write(self.get_help_text())
623
if 'usage' in opts: # e.g. bzr add --usage
624
sys.stdout.write(self.get_help_text(verbose=False))
626
trace.set_verbosity_level(option._verbosity_level)
627
if 'verbose' in self.supported_std_options:
628
opts['verbose'] = trace.is_verbose()
629
elif opts.has_key('verbose'):
631
if 'quiet' in self.supported_std_options:
632
opts['quiet'] = trace.is_quiet()
633
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()))
636
270
# mix arguments and options into one dictionary
637
271
cmdargs = _match_argform(self.name(), self.takes_args, args)
684
class CommandHooks(Hooks):
685
"""Hooks related to Command object creation/enumeration."""
688
"""Create the default hooks.
690
These are all empty initially, because by default nothing should get
694
self.create_hook(HookPoint('extend_command',
695
"Called after creating a command object to allow modifications "
696
"such as adding or removing options, docs etc. Called with the "
697
"new bzrlib.commands.Command object.", (1, 13), None))
698
self.create_hook(HookPoint('get_command',
699
"Called when creating a single command. Called with "
700
"(cmd_or_None, command_name). get_command should either return "
701
"the cmd_or_None parameter, or a replacement Command object that "
702
"should be used for the command. Note that the Command.hooks "
703
"hooks are core infrastructure. Many users will prefer to use "
704
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
706
self.create_hook(HookPoint('get_missing_command',
707
"Called when creating a single command if no command could be "
708
"found. Called with (command_name). get_missing_command should "
709
"either return None, or a Command object to be used for the "
710
"command.", (1, 17), None))
711
self.create_hook(HookPoint('list_commands',
712
"Called when enumerating commands. Called with a set of "
713
"cmd_name strings for all the commands found so far. This set "
714
" is safe to mutate - e.g. to remove a command. "
715
"list_commands should return the updated set of command names.",
718
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]
721
349
def parse_args(command, argv, alias_argv=None):
722
350
"""Parse command line.
724
352
Arguments and options are parsed at this level before being passed
725
353
down to specific command handlers. This routine knows, from a
726
354
lookup table, something about the available options, what optargs
727
355
they take, and which commands will accept them.
729
# TODO: make it a method of the Command?
730
parser = option.get_optparser(command.options())
731
if alias_argv is not None:
732
args = alias_argv + argv
736
options, args = parser.parse_args(args)
737
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
738
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:
372
# We've received a standalone -- No more flags
376
# option names must not be unicode
380
mutter(" got option %r", a)
382
optname, optarg = a[2:].split('=', 1)
385
if optname not in cmd_options:
386
raise BzrCommandError('unknown option "%s"' % a)
389
if shortopt in Option.SHORT_OPTIONS:
390
# Multi-character options must have a space to delimit
392
# ^^^ what does this mean? mbp 20051014
393
optname = Option.SHORT_OPTIONS[shortopt].name
395
# Single character short options, can be chained,
396
# and have their value appended to their name
398
if shortopt not in Option.SHORT_OPTIONS:
399
# We didn't find the multi-character name, and we
400
# didn't find the single char name
401
raise BzrCommandError('unknown option "%s"' % a)
402
optname = Option.SHORT_OPTIONS[shortopt].name
405
# There are extra things on this option
406
# see if it is the value, or if it is another
408
optargfn = Option.OPTIONS[optname].type
410
# This option does not take an argument, so the
411
# next entry is another short option, pack it
413
proc_argv.insert(0, '-' + a[2:])
415
# This option takes an argument, so pack it
418
if optname not in cmd_options:
419
raise BzrCommandError('unknown option "%s"' % shortopt)
421
# XXX: Do we ever want to support this, e.g. for -r?
423
raise BzrCommandError('repeated option %r' % a)
424
elif optname in alias_opts:
425
# Replace what's in the alias with what's in the real
427
del alias_opts[optname]
429
proc_argv.insert(0, a)
432
raise BzrCommandError('repeated option %r' % a)
434
option_obj = cmd_options[optname]
435
optargfn = option_obj.type
439
raise BzrCommandError('option %r needs an argument' % a)
441
optarg = proc_argv.pop(0)
442
opts[optname] = optargfn(optarg)
444
alias_opts[optname] = optargfn(optarg)
447
raise BzrCommandError('option %r takes no argument' % optname)
450
alias_opts[optname] = True
453
proc_aliasarg = False # Done with alias argv
739
454
return args, opts
756
471
argdict[argname + '_list'] = None
757
472
elif ap[-1] == '+':
759
raise errors.BzrCommandError("command %r needs one or more %s"
760
% (cmd, argname.upper()))
474
raise BzrCommandError("command %r needs one or more %s"
475
% (cmd, argname.upper()))
762
477
argdict[argname + '_list'] = args[:]
764
479
elif ap[-1] == '$': # all but one
765
480
if len(args) < 2:
766
raise errors.BzrCommandError("command %r needs one or more %s"
767
% (cmd, argname.upper()))
481
raise BzrCommandError("command %r needs one or more %s"
482
% (cmd, argname.upper()))
768
483
argdict[argname + '_list'] = args[:-1]
771
486
# just a plain arg
774
raise errors.BzrCommandError("command %r requires argument %s"
775
% (cmd, argname.upper()))
489
raise BzrCommandError("command %r requires argument %s"
490
% (cmd, argname.upper()))
777
492
argdict[argname] = args.pop(0)
780
raise errors.BzrCommandError("extra argument to command %s: %s"
495
raise BzrCommandError("extra argument to command %s: %s"
785
def apply_coveraged(dirname, the_callable, *args, **kwargs):
786
# Cannot use "import trace", as that would import bzrlib.trace instead of
787
# the standard library's trace.
788
trace = __import__('trace')
790
tracer = trace.Trace(count=1, trace=0)
791
sys.settrace(tracer.globaltrace)
792
threading.settrace(tracer.globaltrace)
795
return exception_to_return_code(the_callable, *args, **kwargs)
798
results = tracer.results()
799
results.write_results(show_missing=1, summary=False,
803
502
def apply_profiled(the_callable, *args, **kwargs):
824
522
os.remove(pfname)
827
def exception_to_return_code(the_callable, *args, **kwargs):
828
"""UI level helper for profiling and coverage.
830
This transforms exceptions into a return value of 3. As such its only
831
relevant to the UI layer, and should never be called where catching
832
exceptions may be desirable.
835
return the_callable(*args, **kwargs)
836
except (KeyboardInterrupt, Exception), e:
837
# used to handle AssertionError and KeyboardInterrupt
838
# specially here, but hopefully they're handled ok by the logger now
839
exc_info = sys.exc_info()
840
exitcode = trace.report_exception(exc_info, sys.stderr)
841
if os.environ.get('BZR_PDB'):
842
print '**** entering debugger'
845
if sys.version_info[:2] < (2, 6):
847
# pdb.post_mortem(tb)
848
# but because pdb.post_mortem gives bad results for tracebacks
849
# from inside generators, we do it manually.
850
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
852
# Setup pdb on the traceback
855
p.setup(tb.tb_frame, tb)
856
# Point the debugger at the deepest frame of the stack
857
p.curindex = len(p.stack) - 1
858
p.curframe = p.stack[p.curindex][0]
859
# Start the pdb prompt.
860
p.print_stack_entry(p.stack[p.curindex])
868
525
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
869
526
from bzrlib.lsprof import profile
870
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
528
ret, stats = profile(the_callable, *args, **kwargs)
872
530
if filename is None:
876
trace.note('Profile data written to "%s".', filename)
534
cPickle.dump(stats, open(filename, 'w'), 2)
535
print 'Profile data written to %r.' % filename
880
def shlex_split_unicode(unsplit):
882
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
885
def get_alias(cmd, config=None):
886
"""Return an expanded alias, or None if no alias exists.
889
Command to be checked for an alias.
891
Used to specify an alternative config to use,
892
which is especially useful for testing.
893
If it is unspecified, the global config will be used.
897
config = bzrlib.config.GlobalConfig()
898
alias = config.get_alias(cmd)
540
"""Return an expanded alias, or None if no alias exists"""
542
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
900
return shlex_split_unicode(alias)
544
return alias.split(' ')
904
548
def run_bzr(argv):
905
549
"""Execute a command.
551
This is similar to main(), but without all the trappings for
552
logging and error handling.
908
555
The command-line arguments, without the program name from argv[0]
909
556
These should already be decoded. All library/test code calling
910
557
run_bzr should be passing valid strings (don't need decoding).
912
559
Returns a command status or raises an exception.
914
561
Special master options: these must come before the command because
996
633
if not opt_no_aliases:
997
634
alias_argv = get_alias(argv[0])
999
user_encoding = osutils.get_user_encoding()
1000
alias_argv = [a.decode(user_encoding) for a in alias_argv]
636
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1001
637
argv[0] = alias_argv.pop(0)
1004
# We want only 'ascii' command names, but the user may have typed
1005
# in a Unicode name. In that case, they should just get a
1006
# 'command not found' error later.
639
cmd = str(argv.pop(0))
1008
641
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1009
run = cmd_obj.run_argv_aliases
1010
run_argv = [argv, alias_argv]
642
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
643
run = cmd_obj.run_argv
646
run = cmd_obj.run_argv_aliases
647
run_argv = [argv, alias_argv]
1013
# We can be called recursively (tests for example), but we don't want
1014
# the verbosity level to propagate.
1015
saved_verbosity_level = option._verbosity_level
1016
option._verbosity_level = 0
1018
if opt_coverage_dir:
1020
'--coverage ignored, because --lsprof is in use.')
1021
651
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1022
652
elif opt_profile:
1023
if opt_coverage_dir:
1025
'--coverage ignored, because --profile is in use.')
1026
653
ret = apply_profiled(run, *run_argv)
1027
elif opt_coverage_dir:
1028
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1030
655
ret = run(*run_argv)
1031
if 'memory' in debug.debug_flags:
1032
trace.debug_memory('Process status after command:', short=False)
1035
# reset, in case we may do other commands later within the same
1036
# process. Commands that want to execute sub-commands must propagate
1037
# --verbose in their own way.
1038
option._verbosity_level = saved_verbosity_level
658
# reset, in case we may do other commands later within the same process
1041
661
def display_command(func):
1042
662
"""Decorator that suppresses pipe/interrupt errors."""
1046
666
sys.stdout.flush()
1048
668
except IOError, e:
1049
if getattr(e, 'errno', None) is None:
669
if not hasattr(e, 'errno'):
1051
671
if e.errno != errno.EPIPE:
1052
# Win32 raises IOError with errno=0 on a broken pipe
1053
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1056
674
except KeyboardInterrupt:
1058
676
return ignore_pipe
1061
def install_bzr_command_hooks():
1062
"""Install the hooks to supply bzr's own commands."""
1063
if _list_bzr_commands in Command.hooks["list_commands"]:
1065
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1067
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1069
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1070
"bzr plugin commands")
1071
Command.hooks.install_named_hook("get_command", _get_external_command,
1072
"bzr external command lookup")
1073
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1074
"bzr plugin-provider-db check")
1077
def main(argv=None):
1078
"""Main entry point of command-line interface.
1080
:param argv: list of unicode command-line arguments similar to sys.argv.
1081
argv[0] is script name usually, it will be ignored.
1082
Don't pass here sys.argv because this list contains plain strings
1083
and not unicode; pass None instead.
1085
:return: exit code of bzr command.
1087
680
import bzrlib.ui
1088
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1089
sys.stdin, sys.stdout, sys.stderr)
1091
# Is this a final release version? If so, we should suppress warnings
1092
if bzrlib.version_info[3] == 'final':
1093
suppress_deprecation_warnings(override=False)
1095
argv = osutils.get_unicode_argv()
1099
# ensure all arguments are unicode strings
1101
if isinstance(a, unicode):
1104
new_argv.append(a.decode('ascii'))
1105
except UnicodeDecodeError:
1106
raise errors.BzrError("argv should be list of unicode strings.")
681
from bzrlib.ui.text import TextUIFactory
682
bzrlib.ui.ui_factory = TextUIFactory()
683
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
1108
684
ret = run_bzr_catch_errors(argv)
1109
trace.mutter("return code %d", ret)
685
mutter("return code %d", ret)
1113
689
def run_bzr_catch_errors(argv):
1114
"""Run a bzr command with parameters as described by argv.
1116
This function assumed that that UI layer is setup, that symbol deprecations
1117
are already applied, and that unicode decoding has already been performed on argv.
1119
install_bzr_command_hooks()
1120
return exception_to_return_code(run_bzr, argv)
1123
def run_bzr_catch_user_errors(argv):
1124
"""Run bzr and report user errors, but let internal errors propagate.
1126
This is used for the test suite, and might be useful for other programs
1127
that want to wrap the commandline interface.
1129
install_bzr_command_hooks()
1131
return run_bzr(argv)
694
# do this here inside the exception wrappers to catch EPIPE
1132
696
except Exception, e:
1133
if (isinstance(e, (OSError, IOError))
1134
or not getattr(e, 'internal_error', True)):
1135
trace.report_exception(sys.exc_info(), sys.stderr)
1141
class HelpCommandIndex(object):
1142
"""A index for bzr help that returns commands."""
1145
self.prefix = 'commands/'
1147
def get_topics(self, topic):
1148
"""Search for topic amongst commands.
1150
:param topic: A topic to search for.
1151
:return: A list which is either empty or contains a single
1154
if topic and topic.startswith(self.prefix):
1155
topic = topic[len(self.prefix):]
1157
cmd = _get_cmd_object(topic)
1164
class Provider(object):
1165
'''Generic class to be overriden by plugins'''
1167
def plugin_for_command(self, cmd_name):
1168
'''Takes a command and returns the information for that plugin
1170
:return: A dictionary with all the available information
1171
for the requested plugin
1173
raise NotImplementedError
1176
class ProvidersRegistry(registry.Registry):
1177
'''This registry exists to allow other providers to exist'''
1180
for key, provider in self.iteritems():
1183
command_providers_registry = ProvidersRegistry()
697
# used to handle AssertionError and KeyboardInterrupt
698
# specially here, but hopefully they're handled ok by the logger now
699
bzrlib.trace.report_exception(sys.exc_info(), sys.stderr)
700
if os.environ.get('BZR_PDB'):
701
print '**** entering debugger'
703
pdb.post_mortem(sys.exc_traceback)
1186
706
if __name__ == '__main__':
1187
707
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
