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.symbol_versioning import (
56
from bzrlib.option import Option
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
62
def register_command(cmd, decorate=False):
63
"""Utility function to help register a command
65
:param cmd: Command subclass to register
66
:param decorate: If true, allow overriding an existing command
67
of the same name; the old command is returned by this function.
68
Otherwise it is an error to try to override an existing command.
44
def register_command(cmd):
45
"Utility function to help register a command"
72
48
if k.startswith("cmd_"):
73
49
k_unsquished = _unsquish_command_name(k)
76
if k_unsquished not in plugin_cmds:
77
plugin_cmds[k_unsquished] = cmd
78
## trace.mutter('registered plugin command %s', k_unsquished)
79
if decorate and k_unsquished in builtin_command_names():
80
return _builtin_commands()[k_unsquished]
82
result = plugin_cmds[k_unsquished]
83
plugin_cmds[k_unsquished] = cmd
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
86
trace.log_error('Two plugins defined the same command: %r' % k)
87
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
90
60
def _squish_command_name(cmd):
96
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)
99
167
def _builtin_commands():
100
168
import bzrlib.builtins
102
170
builtins = bzrlib.builtins.__dict__
103
171
for name in builtins:
104
172
if name.startswith("cmd_"):
105
real_name = _unsquish_command_name(name)
173
real_name = _unsquish_command_name(name)
106
174
r[real_name] = builtins[name]
110
179
def builtin_command_names():
239
272
if self.__doc__ == Command.__doc__:
240
273
warn("No help message set for %r" % self)
242
def _maybe_expand_globs(self, file_list):
243
"""Glob expand file_list if the platform does not do that itself.
245
:return: A possibly empty list of unicode paths.
247
Introduced in bzrlib 0.18.
251
if sys.platform == 'win32':
252
file_list = win32utils.glob_expand(file_list)
253
return list(file_list)
256
"""Return single-line grammar for this command.
258
Only describes arguments, not options.
260
s = 'bzr ' + self.name() + ' '
261
for aname in self.takes_args:
262
aname = aname.upper()
263
if aname[-1] in ['$', '+']:
264
aname = aname[:-1] + '...'
265
elif aname[-1] == '?':
266
aname = '[' + aname[:-1] + ']'
267
elif aname[-1] == '*':
268
aname = '[' + aname[:-1] + '...]'
275
def get_help_text(self, additional_see_also=None, plain=True,
276
see_also_as_links=False):
277
"""Return a text string with help for this command.
279
:param additional_see_also: Additional help topics to be
281
:param plain: if False, raw help (reStructuredText) is
282
returned instead of plain text.
283
:param see_also_as_links: if True, convert items in 'See also'
284
list to internal links (used by bzr_man rstx generator)
288
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
290
# Extract the summary (purpose) and sections out from the text
291
purpose,sections = self._get_help_parts(doc)
293
# If a custom usage section was provided, use it
294
if sections.has_key('Usage'):
295
usage = sections.pop('Usage')
297
usage = self._usage()
299
# The header is the purpose and usage
301
result += ':Purpose: %s\n' % purpose
302
if usage.find('\n') >= 0:
303
result += ':Usage:\n%s\n' % usage
305
result += ':Usage: %s\n' % usage
309
options = option.get_optparser(self.options()).format_option_help()
310
if options.startswith('Options:'):
311
result += ':' + options
312
elif options.startswith('options:'):
313
# Python 2.4 version of optparse
314
result += ':Options:' + options[len('options:'):]
319
# Add the description, indenting it 2 spaces
320
# to match the indentation of the options
321
if sections.has_key(None):
322
text = sections.pop(None)
323
text = '\n '.join(text.splitlines())
324
result += ':%s:\n %s\n\n' % ('Description',text)
326
# Add the custom sections (e.g. Examples). Note that there's no need
327
# to indent these as they must be indented already in the source.
329
labels = sorted(sections.keys())
331
result += ':%s:\n%s\n\n' % (label,sections[label])
333
# Add the aliases, source (plug-in) and see also links, if any
335
result += ':Aliases: '
336
result += ', '.join(self.aliases) + '\n'
337
plugin_name = self.plugin_name()
338
if plugin_name is not None:
339
result += ':From: plugin "%s"\n' % plugin_name
340
see_also = self.get_see_also(additional_see_also)
342
if not plain and see_also_as_links:
344
for item in see_also:
346
# topics doesn't have an independent section
347
# so don't create a real link
348
see_also_links.append(item)
350
# Use a reST link for this entry
351
see_also_links.append("`%s`_" % (item,))
352
see_also = see_also_links
353
result += ':See also: '
354
result += ', '.join(see_also) + '\n'
356
# If this will be rendered as plan text, convert it
358
import bzrlib.help_topics
359
result = bzrlib.help_topics.help_as_plain_text(result)
363
def _get_help_parts(text):
364
"""Split help text into a summary and named sections.
366
:return: (summary,sections) where summary is the top line and
367
sections is a dictionary of the rest indexed by section name.
368
A section starts with a heading line of the form ":xxx:".
369
Indented text on following lines is the section value.
370
All text found outside a named section is assigned to the
371
default section which is given the key of None.
373
def save_section(sections, label, section):
375
if sections.has_key(label):
376
sections[label] += '\n' + section
378
sections[label] = section
380
lines = text.rstrip().splitlines()
381
summary = lines.pop(0)
383
label,section = None,''
385
if line.startswith(':') and line.endswith(':') and len(line) > 2:
386
save_section(sections, label, section)
387
label,section = line[1:-1],''
388
elif label != None and len(line) > 1 and not line[0].isspace():
389
save_section(sections, label, section)
390
label,section = None,line
393
section += '\n' + line
396
save_section(sections, label, section)
397
return summary, sections
399
def get_help_topic(self):
400
"""Return the commands help topic - its name."""
403
def get_see_also(self, additional_terms=None):
404
"""Return a list of help topics that are related to this command.
406
The list is derived from the content of the _see_also attribute. Any
407
duplicates are removed and the result is in lexical order.
408
:param additional_terms: Additional help topics to cross-reference.
409
:return: A list of help topics.
411
see_also = set(getattr(self, '_see_also', []))
413
see_also.update(additional_terms)
414
return sorted(see_also)
417
"""Return dict of valid options for this command.
419
Maps from long option name to option object."""
421
r['help'] = option._help_option
422
for o in self.takes_options:
423
if isinstance(o, basestring):
424
o = option.Option.OPTIONS[o]
428
def _setup_outf(self):
429
"""Return a file linked to stdout, which has proper encoding."""
430
assert self.encoding_type in ['strict', 'exact', 'replace']
432
# Originally I was using self.stdout, but that looks
433
# *way* too much like sys.stdout
434
if self.encoding_type == 'exact':
435
# force sys.stdout to be binary stream on win32
436
if sys.platform == 'win32':
437
fileno = getattr(sys.stdout, 'fileno', None)
440
msvcrt.setmode(fileno(), os.O_BINARY)
441
self.outf = sys.stdout
444
output_encoding = osutils.get_terminal_encoding()
446
# use 'replace' so that we don't abort if trying to write out
447
# in e.g. the default C locale.
448
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
449
# For whatever reason codecs.getwriter() does not advertise its encoding
450
# it just returns the encoding of the wrapped file, which is completely
451
# bogus. So set the attribute, so we can find the correct encoding later.
452
self.outf.encoding = output_encoding
454
def run_argv_aliases(self, argv, alias_argv=None):
455
"""Parse the command line and run with extra aliases in alias_argv."""
457
warn("Passing None for [] is deprecated from bzrlib 0.10",
458
DeprecationWarning, stacklevel=2)
460
args, opts = parse_args(self, argv, alias_argv)
276
def run_argv(self, argv):
277
"""Parse command line and run."""
278
args, opts = parse_args(argv)
461
280
if 'help' in opts: # e.g. bzr add --help
462
sys.stdout.write(self.get_help_text())
281
from bzrlib.help import help_on_command
282
help_on_command(self.name())
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()))
464
292
# mix arguments and options into one dictionary
465
293
cmdargs = _match_argform(self.name(), self.takes_args, args)
498
324
return _unsquish_command_name(self.__class__.__name__)
500
def plugin_name(self):
501
"""Get the name of the plugin that provides this command.
503
:return: The name of the plugin or None if the command is builtin.
505
mod_parts = self.__module__.split('.')
506
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
512
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):
513
402
"""Parse command line.
515
404
Arguments and options are parsed at this level before being passed
516
405
down to specific command handlers. This routine knows, from a
517
406
lookup table, something about the available options, what optargs
518
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]})
520
# TODO: make it a method of the Command?
521
parser = option.get_optparser(command.options())
522
if alias_argv is not None:
523
args = alias_argv + argv
527
options, args = parser.parse_args(args)
528
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
529
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)
530
500
return args, opts
533
505
def _match_argform(cmd, takes_args, args):
650
590
Do not load plugin modules at all
656
593
Only use builtin commands. (Plugins are still allowed to change
657
594
other behaviour.)
660
Run under the Python hotshot profiler.
663
Run under the Python lsprof profiler.
597
Run under the Python profiler.
666
trace.mutter("bzr arguments: %r", argv)
600
argv = [a.decode(bzrlib.user_encoding) for a in argv]
668
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
669
opt_no_aliases = False
670
opt_lsprof_file = None
602
opt_profile = opt_no_plugins = opt_builtin = False
672
604
# --no-plugins is handled specially at a very early stage. We need
673
605
# to load plugins before doing other command parsing so that they
674
606
# can override commands, but this needs to happen first.
680
609
if a == '--profile':
681
610
opt_profile = True
682
elif a == '--lsprof':
684
elif a == '--lsprof-file':
686
opt_lsprof_file = argv[i + 1]
688
611
elif a == '--no-plugins':
689
612
opt_no_plugins = True
690
elif a == '--no-aliases':
691
opt_no_aliases = True
692
613
elif a == '--builtin':
693
614
opt_builtin = True
694
elif a in ('--quiet', '-q'):
696
elif a.startswith('-D'):
697
debug.debug_flags.add(a[2:])
704
from bzrlib.builtins import cmd_help
705
cmd_help().run_argv_aliases([])
619
if (not argv) or (argv[0] == '--help'):
620
from bzrlib.help import help
708
627
if argv[0] == '--version':
709
from bzrlib.version import show_version
628
from bzrlib.builtins import show_version
713
632
if not opt_no_plugins:
714
633
from bzrlib.plugin import load_plugins
717
from bzrlib.plugin import disable_plugins
722
if not opt_no_aliases:
723
alias_argv = get_alias(argv[0])
725
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
726
argv[0] = alias_argv.pop(0)
729
# We want only 'ascii' command names, but the user may have typed
730
# in a Unicode name. In that case, they should just get a
731
# 'command not found' error later.
636
cmd = str(argv.pop(0))
733
638
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
734
run = cmd_obj.run_argv_aliases
735
run_argv = [argv, alias_argv]
739
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
741
ret = apply_profiled(run, *run_argv)
746
# reset, in case we may do other commands later within the same process
747
trace.be_quiet(False)
749
def display_command(func):
750
"""Decorator that suppresses pipe/interrupt errors."""
751
def ignore_pipe(*args, **kwargs):
753
result = func(*args, **kwargs)
757
if getattr(e, 'errno', None) is None:
759
if e.errno != errno.EPIPE:
760
# Win32 raises IOError with errno=0 on a broken pipe
761
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
764
except KeyboardInterrupt:
641
ret = apply_profiled(cmd_obj.run_argv, argv)
643
ret = cmd_obj.run_argv(argv)
771
from bzrlib.ui.text import TextUIFactory
772
bzrlib.ui.ui_factory = TextUIFactory()
774
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
775
except UnicodeDecodeError:
776
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
778
ret = run_bzr_catch_errors(argv)
779
trace.mutter("return code %d", ret)
783
def run_bzr_catch_errors(argv):
786
except (KeyboardInterrupt, Exception), e:
787
# used to handle AssertionError and KeyboardInterrupt
788
# specially here, but hopefully they're handled ok by the logger now
789
trace.report_exception(sys.exc_info(), sys.stderr)
790
if os.environ.get('BZR_PDB'):
791
print '**** entering debugger'
793
pdb.post_mortem(sys.exc_traceback)
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))
797
class HelpCommandIndex(object):
798
"""A index for bzr help that returns commands."""
801
self.prefix = 'commands/'
803
def get_topics(self, topic):
804
"""Search for topic amongst commands.
806
:param topic: A topic to search for.
807
:return: A list which is either empty or contains a single
810
if topic and topic.startswith(self.prefix):
811
topic = topic[len(self.prefix):]
813
cmd = _get_cmd_object(topic)
668
except KeyboardInterrupt, e:
669
bzrlib.trace.note('interrupted')
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()
820
683
if __name__ == '__main__':
added
removed
bzrlib/commands.py
