18
18
# TODO: probably should say which arguments are candidates for glob
19
19
# expansion on windows and do that at the command level.
21
# TODO: Help messages for options.
21
23
# TODO: Define arguments by objects, rather than just using names.
22
24
# Those objects can specify the expected type of the argument, which
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
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?
25
# would help with validation and shell completion.
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
38
31
from warnings import warn
32
from inspect import getdoc
51
from bzrlib import registry
53
from bzrlib.hooks import Hooks
54
from bzrlib.option import Option
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):
73
def _get_name(command_name):
74
if command_name.startswith("cmd_"):
75
return _unsquish_command_name(command_name)
79
def register(self, cmd, decorate=False):
80
"""Utility function to help register a command
82
:param cmd: Command subclass to register
83
:param decorate: If true, allow overriding an existing command
84
of the same name; the old command is returned by this function.
85
Otherwise it is an error to try to override an existing command.
88
k_unsquished = self._get_name(k)
90
previous = self.get(k_unsquished)
92
previous = _builtin_commands().get(k_unsquished)
93
info = CommandInfo.from_command(cmd)
95
registry.Registry.register(self, k_unsquished, cmd,
96
override_existing=decorate, info=info)
98
trace.log_error('Two plugins defined the same command: %r' % k)
99
trace.log_error('Not loading the one in %r' %
100
sys.modules[cmd.__module__])
101
trace.log_error('Previously this command was registered from %r' %
102
sys.modules[previous.__module__])
105
def register_lazy(self, command_name, aliases, module_name):
106
"""Register a command without loading its module.
108
:param command_name: The primary name of the command.
109
:param aliases: A list of aliases for the command.
110
:module_name: The module that the command lives in.
112
key = self._get_name(command_name)
113
registry.Registry.register_lazy(self, key, module_name, command_name,
114
info=CommandInfo(aliases))
117
plugin_cmds = CommandRegistry()
120
def register_command(cmd, decorate=False):
36
from bzrlib.trace import mutter, note, log_error, warning
37
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
from bzrlib.branch import find_branch
39
from bzrlib import BZRDIR
44
def register_command(cmd):
45
"Utility function to help register a command"
121
46
global plugin_cmds
122
return plugin_cmds.register(cmd, decorate)
48
if k.startswith("cmd_"):
49
k_unsquished = _unsquish_command_name(k)
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
125
60
def _squish_command_name(cmd):
129
64
def _unsquish_command_name(cmd):
65
assert cmd.startswith("cmd_")
130
66
return cmd[4:].replace('_','-')
69
def _parse_revision_str(revstr):
70
"""This handles a revision string -> revno.
72
This always returns a list. The list will have one element for
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
77
>>> _parse_revision_str('234')
79
>>> _parse_revision_str('234..567')
81
>>> _parse_revision_str('..')
83
>>> _parse_revision_str('..234')
85
>>> _parse_revision_str('234..')
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
89
>>> _parse_revision_str('234....789') # Error?
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
107
>>> _parse_revision_str('-5')
109
>>> _parse_revision_str('123a')
111
>>> _parse_revision_str('abc')
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
118
warning('Colon separator for revision numbers is deprecated.'
121
for rev in revstr.split(':'):
123
revs.append(int(rev))
128
for x in revstr.split('..'):
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
143
return merge_types[typestring][0]
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
153
def get_merge_type(typestring):
154
"""Attempt to find the merge class/factory associated with a string."""
155
from merge import merge_types
157
return merge_types[typestring][0]
159
templ = '%s%%7s: %%s' % (' '*12)
160
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
161
type_list = '\n'.join(lines)
162
msg = "No known merge type %s. Supported types are:\n%s" %\
163
(typestring, type_list)
164
raise BzrCommandError(msg)
133
167
def _builtin_commands():
134
168
import bzrlib.builtins
136
170
builtins = bzrlib.builtins.__dict__
137
171
for name in builtins:
138
172
if name.startswith("cmd_"):
139
real_name = _unsquish_command_name(name)
173
real_name = _unsquish_command_name(name)
140
174
r[real_name] = builtins[name]
144
179
def builtin_command_names():
296
271
"""Construct an instance of this command."""
297
272
if self.__doc__ == Command.__doc__:
298
273
warn("No help message set for %r" % self)
299
# List of standard options directly supported
300
self.supported_std_options = []
302
def _maybe_expand_globs(self, file_list):
303
"""Glob expand file_list if the platform does not do that itself.
305
:return: A possibly empty list of unicode paths.
307
Introduced in bzrlib 0.18.
311
if sys.platform == 'win32':
312
file_list = win32utils.glob_expand(file_list)
313
return list(file_list)
316
"""Return single-line grammar for this command.
318
Only describes arguments, not options.
320
s = 'bzr ' + self.name() + ' '
321
for aname in self.takes_args:
322
aname = aname.upper()
323
if aname[-1] in ['$', '+']:
324
aname = aname[:-1] + '...'
325
elif aname[-1] == '?':
326
aname = '[' + aname[:-1] + ']'
327
elif aname[-1] == '*':
328
aname = '[' + aname[:-1] + '...]'
330
s = s[:-1] # remove last space
333
def get_help_text(self, additional_see_also=None, plain=True,
334
see_also_as_links=False):
335
"""Return a text string with help for this command.
337
:param additional_see_also: Additional help topics to be
339
:param plain: if False, raw help (reStructuredText) is
340
returned instead of plain text.
341
:param see_also_as_links: if True, convert items in 'See also'
342
list to internal links (used by bzr_man rstx generator)
346
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
348
# Extract the summary (purpose) and sections out from the text
349
purpose,sections,order = self._get_help_parts(doc)
351
# If a custom usage section was provided, use it
352
if sections.has_key('Usage'):
353
usage = sections.pop('Usage')
355
usage = self._usage()
357
# The header is the purpose and usage
359
result += ':Purpose: %s\n' % purpose
360
if usage.find('\n') >= 0:
361
result += ':Usage:\n%s\n' % usage
363
result += ':Usage: %s\n' % usage
367
options = option.get_optparser(self.options()).format_option_help()
368
if options.startswith('Options:'):
369
result += ':' + options
370
elif options.startswith('options:'):
371
# Python 2.4 version of optparse
372
result += ':Options:' + options[len('options:'):]
377
# Add the description, indenting it 2 spaces
378
# to match the indentation of the options
379
if sections.has_key(None):
380
text = sections.pop(None)
381
text = '\n '.join(text.splitlines())
382
result += ':%s:\n %s\n\n' % ('Description',text)
384
# Add the custom sections (e.g. Examples). Note that there's no need
385
# to indent these as they must be indented already in the source.
388
if sections.has_key(label):
389
result += ':%s:\n%s\n\n' % (label,sections[label])
391
# Add the aliases, source (plug-in) and see also links, if any
393
result += ':Aliases: '
394
result += ', '.join(self.aliases) + '\n'
395
plugin_name = self.plugin_name()
396
if plugin_name is not None:
397
result += ':From: plugin "%s"\n' % plugin_name
398
see_also = self.get_see_also(additional_see_also)
400
if not plain and see_also_as_links:
402
for item in see_also:
404
# topics doesn't have an independent section
405
# so don't create a real link
406
see_also_links.append(item)
408
# Use a reST link for this entry
409
see_also_links.append("`%s`_" % (item,))
410
see_also = see_also_links
411
result += ':See also: '
412
result += ', '.join(see_also) + '\n'
414
# If this will be rendered as plain text, convert it
416
import bzrlib.help_topics
417
result = bzrlib.help_topics.help_as_plain_text(result)
421
def _get_help_parts(text):
422
"""Split help text into a summary and named sections.
424
:return: (summary,sections,order) where summary is the top line and
425
sections is a dictionary of the rest indexed by section name.
426
order is the order the section appear in the text.
427
A section starts with a heading line of the form ":xxx:".
428
Indented text on following lines is the section value.
429
All text found outside a named section is assigned to the
430
default section which is given the key of None.
432
def save_section(sections, order, label, section):
434
if sections.has_key(label):
435
sections[label] += '\n' + section
438
sections[label] = section
440
lines = text.rstrip().splitlines()
441
summary = lines.pop(0)
444
label,section = None,''
446
if line.startswith(':') and line.endswith(':') and len(line) > 2:
447
save_section(sections, order, label, section)
448
label,section = line[1:-1],''
449
elif (label is not None) and len(line) > 1 and not line[0].isspace():
450
save_section(sections, order, label, section)
451
label,section = None,line
454
section += '\n' + line
457
save_section(sections, order, label, section)
458
return summary, sections, order
460
def get_help_topic(self):
461
"""Return the commands help topic - its name."""
464
def get_see_also(self, additional_terms=None):
465
"""Return a list of help topics that are related to this command.
467
The list is derived from the content of the _see_also attribute. Any
468
duplicates are removed and the result is in lexical order.
469
:param additional_terms: Additional help topics to cross-reference.
470
:return: A list of help topics.
472
see_also = set(getattr(self, '_see_also', []))
474
see_also.update(additional_terms)
475
return sorted(see_also)
478
"""Return dict of valid options for this command.
480
Maps from long option name to option object."""
481
r = Option.STD_OPTIONS.copy()
483
for o in self.takes_options:
484
if isinstance(o, basestring):
485
o = option.Option.OPTIONS[o]
487
if o.name in std_names:
488
self.supported_std_options.append(o.name)
491
def _setup_outf(self):
492
"""Return a file linked to stdout, which has proper encoding."""
493
# Originally I was using self.stdout, but that looks
494
# *way* too much like sys.stdout
495
if self.encoding_type == 'exact':
496
# force sys.stdout to be binary stream on win32
497
if sys.platform == 'win32':
498
fileno = getattr(sys.stdout, 'fileno', None)
501
msvcrt.setmode(fileno(), os.O_BINARY)
502
self.outf = sys.stdout
505
output_encoding = osutils.get_terminal_encoding()
507
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
508
errors=self.encoding_type)
509
# For whatever reason codecs.getwriter() does not advertise its encoding
510
# it just returns the encoding of the wrapped file, which is completely
511
# bogus. So set the attribute, so we can find the correct encoding later.
512
self.outf.encoding = output_encoding
514
def run_argv_aliases(self, argv, alias_argv=None):
515
"""Parse the command line and run with extra aliases in alias_argv."""
517
warn("Passing None for [] is deprecated from bzrlib 0.10",
518
DeprecationWarning, stacklevel=2)
520
args, opts = parse_args(self, argv, alias_argv)
522
# Process the standard options
276
def run_argv(self, argv):
277
"""Parse command line and run."""
278
args, opts = parse_args(argv)
523
280
if 'help' in opts: # e.g. bzr add --help
524
sys.stdout.write(self.get_help_text())
281
from bzrlib.help import help_on_command
282
help_on_command(self.name())
526
trace.set_verbosity_level(option._verbosity_level)
527
if 'verbose' in self.supported_std_options:
528
opts['verbose'] = trace.is_verbose()
529
elif opts.has_key('verbose'):
531
if 'quiet' in self.supported_std_options:
532
opts['quiet'] = trace.is_quiet()
533
elif opts.has_key('quiet'):
285
# check options are reasonable
286
allowed = self.takes_options
288
if oname not in allowed:
289
raise BzrCommandError("option '--%s' is not allowed for command %r"
290
% (oname, self.name()))
536
292
# mix arguments and options into one dictionary
537
293
cmdargs = _match_argform(self.name(), self.takes_args, args)
570
324
return _unsquish_command_name(self.__class__.__name__)
572
def plugin_name(self):
573
"""Get the name of the plugin that provides this command.
575
:return: The name of the plugin or None if the command is builtin.
577
mod_parts = self.__module__.split('.')
578
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
327
def parse_spec(spec):
333
>>> parse_spec("../@")
335
>>> parse_spec("../f/@35")
337
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
338
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
343
parsed = spec.split('/@')
344
assert len(parsed) == 2
584
class CommandHooks(Hooks):
585
"""Hooks related to Command object creation/enumeration."""
588
"""Create the default hooks.
590
These are all empty initially, because by default nothing should get
594
# Introduced in 1.13:
595
# invoked after creating a command object to allow modifications such
596
# as adding or removing options, docs etc. Invoked with the command
598
self['extend_command'] = []
600
Command.hooks = CommandHooks()
603
def parse_args(command, argv, alias_argv=None):
349
parsed[1] = int(parsed[1])
351
pass # We can allow stuff like ./@revid:blahblahblah
355
parsed = [spec, None]
361
# list of all available options; the rhs can be either None for an
362
# option that takes no argument, or a constructor function that checks
375
'revision': _parse_revision_str,
387
'merge-type': get_merge_type,
401
def parse_args(argv):
604
402
"""Parse command line.
606
404
Arguments and options are parsed at this level before being passed
607
405
down to specific command handlers. This routine knows, from a
608
406
lookup table, something about the available options, what optargs
609
407
they take, and which commands will accept them.
409
>>> parse_args('--help'.split())
411
>>> parse_args('help -- --invalidcmd'.split())
412
(['help', '--invalidcmd'], {})
413
>>> parse_args('--version'.split())
414
([], {'version': True})
415
>>> parse_args('status --all'.split())
416
(['status'], {'all': True})
417
>>> parse_args('commit --message=biter'.split())
418
(['commit'], {'message': u'biter'})
419
>>> parse_args('log -r 500'.split())
420
(['log'], {'revision': [500]})
421
>>> parse_args('log -r500..600'.split())
422
(['log'], {'revision': [500, 600]})
423
>>> parse_args('log -vr500..600'.split())
424
(['log'], {'verbose': True, 'revision': [500, 600]})
425
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
426
(['log'], {'revision': ['v500', 600]})
611
# TODO: make it a method of the Command?
612
parser = option.get_optparser(command.options())
613
if alias_argv is not None:
614
args = alias_argv + argv
618
options, args = parser.parse_args(args)
619
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
620
v is not option.OptionParser.DEFAULT_VALUE])
434
if not argsover and a[0] == '-':
435
# option names must not be unicode
440
# We've received a standalone -- No more flags
443
mutter(" got option %r" % a)
445
optname, optarg = a[2:].split('=', 1)
448
if optname not in OPTIONS:
449
raise BzrError('unknown long option %r' % a)
452
if shortopt in SHORT_OPTIONS:
453
# Multi-character options must have a space to delimit
455
optname = SHORT_OPTIONS[shortopt]
457
# Single character short options, can be chained,
458
# and have their value appended to their name
460
if shortopt not in SHORT_OPTIONS:
461
# We didn't find the multi-character name, and we
462
# didn't find the single char name
463
raise BzrError('unknown short option %r' % a)
464
optname = SHORT_OPTIONS[shortopt]
467
# There are extra things on this option
468
# see if it is the value, or if it is another
470
optargfn = OPTIONS[optname]
472
# This option does not take an argument, so the
473
# next entry is another short option, pack it back
475
argv.insert(0, '-' + a[2:])
477
# This option takes an argument, so pack it
482
# XXX: Do we ever want to support this, e.g. for -r?
483
raise BzrError('repeated option %r' % a)
485
optargfn = OPTIONS[optname]
489
raise BzrError('option %r needs an argument' % a)
492
opts[optname] = optargfn(optarg)
495
raise BzrError('option %r takes no argument' % optname)
621
500
return args, opts
624
505
def _match_argform(cmd, takes_args, args):
638
519
argdict[argname + '_list'] = None
639
520
elif ap[-1] == '+':
641
raise errors.BzrCommandError("command %r needs one or more %s"
642
% (cmd, argname.upper()))
522
raise BzrCommandError("command %r needs one or more %s"
523
% (cmd, argname.upper()))
644
525
argdict[argname + '_list'] = args[:]
646
527
elif ap[-1] == '$': # all but one
647
528
if len(args) < 2:
648
raise errors.BzrCommandError("command %r needs one or more %s"
649
% (cmd, argname.upper()))
529
raise BzrCommandError("command %r needs one or more %s"
530
% (cmd, argname.upper()))
650
531
argdict[argname + '_list'] = args[:-1]
653
534
# just a plain arg
656
raise errors.BzrCommandError("command %r requires argument %s"
657
% (cmd, argname.upper()))
537
raise BzrCommandError("command %r requires argument %s"
538
% (cmd, argname.upper()))
659
540
argdict[argname] = args.pop(0)
662
raise errors.BzrCommandError("extra argument to command %s: %s"
543
raise BzrCommandError("extra argument to command %s: %s"
667
def apply_coveraged(dirname, the_callable, *args, **kwargs):
668
# Cannot use "import trace", as that would import bzrlib.trace instead of
669
# the standard library's trace.
670
trace = __import__('trace')
672
tracer = trace.Trace(count=1, trace=0)
673
sys.settrace(tracer.globaltrace)
675
ret = the_callable(*args, **kwargs)
678
results = tracer.results()
679
results.write_results(show_missing=1, summary=False,
683
550
def apply_profiled(the_callable, *args, **kwargs):
687
553
pffileno, pfname = tempfile.mkstemp()
689
555
prof = hotshot.Profile(pfname)
691
557
ret = prof.runcall(the_callable, *args, **kwargs) or 0
694
562
stats = hotshot.stats.load(pfname)
696
stats.sort_stats('cum') # 'time'
564
stats.sort_stats('time')
697
565
## XXX: Might like to write to stderr or the trace file instead but
698
566
## print_stats seems hardcoded to stdout
699
567
stats.print_stats(20)
702
571
os.close(pffileno)
703
572
os.remove(pfname)
706
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
707
from bzrlib.lsprof import profile
708
ret, stats = profile(the_callable, *args, **kwargs)
714
trace.note('Profile data written to "%s".', filename)
718
def shlex_split_unicode(unsplit):
720
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
723
def get_alias(cmd, config=None):
724
"""Return an expanded alias, or None if no alias exists.
727
Command to be checked for an alias.
729
Used to specify an alternative config to use,
730
which is especially useful for testing.
731
If it is unspecified, the global config will be used.
735
config = bzrlib.config.GlobalConfig()
736
alias = config.get_alias(cmd)
738
return shlex_split_unicode(alias)
742
575
def run_bzr(argv):
743
576
"""Execute a command.
578
This is similar to main(), but without all the trappings for
579
logging and error handling.
746
582
The command-line arguments, without the program name from argv[0]
747
These should already be decoded. All library/test code calling
748
run_bzr should be passing valid strings (don't need decoding).
750
584
Returns a command status or raises an exception.
756
590
Do not load plugin modules at all
762
593
Only use builtin commands. (Plugins are still allowed to change
763
594
other behaviour.)
766
Run under the Python hotshot profiler.
769
Run under the Python lsprof profiler.
772
Generate line coverage report in the specified directory.
597
Run under the Python profiler.
775
trace.mutter("bzr arguments: %r", argv)
600
argv = [a.decode(bzrlib.user_encoding) for a in argv]
777
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
778
opt_no_aliases = False
779
opt_lsprof_file = opt_coverage_dir = None
602
opt_profile = opt_no_plugins = opt_builtin = False
781
604
# --no-plugins is handled specially at a very early stage. We need
782
605
# to load plugins before doing other command parsing so that they
783
606
# can override commands, but this needs to happen first.
789
609
if a == '--profile':
790
610
opt_profile = True
791
elif a == '--lsprof':
793
elif a == '--lsprof-file':
795
opt_lsprof_file = argv[i + 1]
797
611
elif a == '--no-plugins':
798
612
opt_no_plugins = True
799
elif a == '--no-aliases':
800
opt_no_aliases = True
801
613
elif a == '--builtin':
802
614
opt_builtin = True
803
elif a == '--coverage':
804
opt_coverage_dir = argv[i + 1]
806
elif a.startswith('-D'):
807
debug.debug_flags.add(a[2:])
814
from bzrlib.builtins import cmd_help
815
cmd_help().run_argv_aliases([])
619
if (not argv) or (argv[0] == '--help'):
620
from bzrlib.help import help
818
627
if argv[0] == '--version':
819
from bzrlib.builtins import cmd_version
820
cmd_version().run_argv_aliases([])
628
from bzrlib.builtins import show_version
823
632
if not opt_no_plugins:
824
633
from bzrlib.plugin import load_plugins
827
from bzrlib.plugin import disable_plugins
832
if not opt_no_aliases:
833
alias_argv = get_alias(argv[0])
835
user_encoding = osutils.get_user_encoding()
836
alias_argv = [a.decode(user_encoding) for a in alias_argv]
837
argv[0] = alias_argv.pop(0)
840
# We want only 'ascii' command names, but the user may have typed
841
# in a Unicode name. In that case, they should just get a
842
# 'command not found' error later.
636
cmd = str(argv.pop(0))
844
638
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
845
run = cmd_obj.run_argv_aliases
846
run_argv = [argv, alias_argv]
849
# We can be called recursively (tests for example), but we don't want
850
# the verbosity level to propagate.
851
saved_verbosity_level = option._verbosity_level
852
option._verbosity_level = 0
856
'--coverage ignored, because --lsprof is in use.')
857
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
861
'--coverage ignored, because --profile is in use.')
862
ret = apply_profiled(run, *run_argv)
863
elif opt_coverage_dir:
864
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
867
if 'memory' in debug.debug_flags:
868
trace.debug_memory('Process status after command:', short=False)
871
# reset, in case we may do other commands later within the same
872
# process. Commands that want to execute sub-commands must propagate
873
# --verbose in their own way.
874
option._verbosity_level = saved_verbosity_level
877
def display_command(func):
878
"""Decorator that suppresses pipe/interrupt errors."""
879
def ignore_pipe(*args, **kwargs):
881
result = func(*args, **kwargs)
885
if getattr(e, 'errno', None) is None:
887
if e.errno != errno.EPIPE:
888
# Win32 raises IOError with errno=0 on a broken pipe
889
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
892
except KeyboardInterrupt:
641
ret = apply_profiled(cmd_obj.run_argv, argv)
643
ret = cmd_obj.run_argv(argv)
899
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
900
sys.stdin, sys.stdout, sys.stderr)
902
# Is this a final release version? If so, we should suppress warnings
903
if bzrlib.version_info[3] == 'final':
904
from bzrlib import symbol_versioning
905
symbol_versioning.suppress_deprecation_warnings(override=False)
907
user_encoding = osutils.get_user_encoding()
908
argv = [a.decode(user_encoding) for a in argv[1:]]
909
except UnicodeDecodeError:
910
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
912
ret = run_bzr_catch_errors(argv)
913
trace.mutter("return code %d", ret)
917
def run_bzr_catch_errors(argv):
918
# Note: The except clause logic below should be kept in sync with the
919
# profile() routine in lsprof.py.
922
except (KeyboardInterrupt, Exception), e:
923
# used to handle AssertionError and KeyboardInterrupt
924
# specially here, but hopefully they're handled ok by the logger now
925
exc_info = sys.exc_info()
926
exitcode = trace.report_exception(exc_info, sys.stderr)
927
if os.environ.get('BZR_PDB'):
928
print '**** entering debugger'
931
if sys.version_info[:2] < (2, 6):
933
# pdb.post_mortem(tb)
934
# but because pdb.post_mortem gives bad results for tracebacks
935
# from inside generators, we do it manually.
936
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
938
# Setup pdb on the traceback
941
p.setup(tb.tb_frame, tb)
942
# Point the debugger at the deepest frame of the stack
943
p.curindex = len(p.stack) - 1
944
p.curframe = p.stack[p.curindex]
945
# Start the pdb prompt.
946
p.print_stack_entry(p.stack[p.curindex])
954
def run_bzr_catch_user_errors(argv):
955
"""Run bzr and report user errors, but let internal errors propagate.
957
This is used for the test suite, and might be useful for other programs
958
that want to wrap the commandline interface.
649
bzrlib.trace.log_startup(argv)
650
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
654
return run_bzr(argv[1:])
656
# do this here inside the exception wrappers to catch EPIPE
658
except BzrCommandError, e:
659
# command line syntax error, etc
663
bzrlib.trace.log_exception()
665
except AssertionError, e:
666
bzrlib.trace.log_exception('assertion failed: ' + str(e))
668
except KeyboardInterrupt, e:
669
bzrlib.trace.note('interrupted')
962
671
except Exception, e:
963
if (isinstance(e, (OSError, IOError))
964
or not getattr(e, 'internal_error', True)):
965
trace.report_exception(sys.exc_info(), sys.stderr)
971
class HelpCommandIndex(object):
972
"""A index for bzr help that returns commands."""
975
self.prefix = 'commands/'
977
def get_topics(self, topic):
978
"""Search for topic amongst commands.
980
:param topic: A topic to search for.
981
:return: A list which is either empty or contains a single
984
if topic and topic.startswith(self.prefix):
985
topic = topic[len(self.prefix):]
987
cmd = _get_cmd_object(topic)
994
class Provider(object):
995
'''Generic class to be overriden by plugins'''
997
def plugin_for_command(self, cmd_name):
998
'''Takes a command and returns the information for that plugin
1000
:return: A dictionary with all the available information
1001
for the requested plugin
1003
raise NotImplementedError
1006
class ProvidersRegistry(registry.Registry):
1007
'''This registry exists to allow other providers to exist'''
1010
for key, provider in self.iteritems():
1013
command_providers_registry = ProvidersRegistry()
673
if (isinstance(e, IOError)
674
and hasattr(e, 'errno')
675
and e.errno == errno.EPIPE):
676
bzrlib.trace.note('broken pipe')
679
bzrlib.trace.log_exception()
1016
683
if __name__ == '__main__':
added
removed
bzrlib/commands.py
