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: Define arguments by objects, rather than just using names.
22
# 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?
21
# TODO: Help messages for options.
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
28
# TODO: Help messages for options.
30
# TODO: Define arguments by objects, rather than just using names.
31
# Those objects can specify the expected type of the argument, which
32
# would help with validation and shell completion.
35
# TODO: Help messages for options.
37
# TODO: Define arguments by objects, rather than just using names.
38
# Those objects can specify the expected type of the argument, which
39
# would help with validation and shell completion.
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
38
45
from warnings import warn
46
from inspect import getdoc
51
from bzrlib.symbol_versioning import (
56
from bzrlib.option import Option
50
from bzrlib.trace import mutter, note, log_error, warning
51
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
52
from bzrlib.revisionspec import RevisionSpec
53
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.
58
def register_command(cmd):
59
"Utility function to help register a command"
72
62
if k.startswith("cmd_"):
73
63
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
66
if not plugin_cmds.has_key(k_unsquished):
67
plugin_cmds[k_unsquished] = cmd
68
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__])
88
trace.log_error('Previously this command was registered from %r' %
89
sys.modules[plugin_cmds[k_unsquished].__module__])
70
log_error('Two plugins defined the same command: %r' % k)
71
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
92
74
def _squish_command_name(cmd):
98
80
return cmd[4:].replace('_','-')
83
def _parse_revision_str(revstr):
84
"""This handles a revision string -> revno.
86
This always returns a list. The list will have one element for
89
>>> _parse_revision_str('234')
90
[<RevisionSpec_int 234>]
91
>>> _parse_revision_str('234..567')
92
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
93
>>> _parse_revision_str('..')
94
[<RevisionSpec None>, <RevisionSpec None>]
95
>>> _parse_revision_str('..234')
96
[<RevisionSpec None>, <RevisionSpec_int 234>]
97
>>> _parse_revision_str('234..')
98
[<RevisionSpec_int 234>, <RevisionSpec None>]
99
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
100
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
101
>>> _parse_revision_str('234....789') # Error?
102
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
103
>>> _parse_revision_str('revid:test@other.com-234234')
104
[<RevisionSpec_revid revid:test@other.com-234234>]
105
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
106
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
107
>>> _parse_revision_str('revid:test@other.com-234234..23')
108
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
109
>>> _parse_revision_str('date:2005-04-12')
110
[<RevisionSpec_date date:2005-04-12>]
111
>>> _parse_revision_str('date:2005-04-12 12:24:33')
112
[<RevisionSpec_date date:2005-04-12 12:24:33>]
113
>>> _parse_revision_str('date:2005-04-12T12:24:33')
114
[<RevisionSpec_date date:2005-04-12T12:24:33>]
115
>>> _parse_revision_str('date:2005-04-12,12:24:33')
116
[<RevisionSpec_date date:2005-04-12,12:24:33>]
117
>>> _parse_revision_str('-5..23')
118
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
119
>>> _parse_revision_str('-5')
120
[<RevisionSpec_int -5>]
121
>>> _parse_revision_str('123a')
122
Traceback (most recent call last):
124
BzrError: No namespace registered for string: '123a'
125
>>> _parse_revision_str('abc')
126
Traceback (most recent call last):
128
BzrError: No namespace registered for string: 'abc'
131
old_format_re = re.compile('\d*:\d*')
132
m = old_format_re.match(revstr)
135
warning('Colon separator for revision numbers is deprecated.'
137
for rev in revstr.split(':'):
139
revs.append(RevisionSpec(int(rev)))
141
revs.append(RevisionSpec(None))
143
for x in revstr.split('..'):
145
revs.append(RevisionSpec(None))
147
revs.append(RevisionSpec(x))
151
def get_merge_type(typestring):
152
"""Attempt to find the merge class/factory associated with a string."""
153
from merge import merge_types
155
return merge_types[typestring][0]
157
templ = '%s%%7s: %%s' % (' '*12)
158
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
159
type_list = '\n'.join(lines)
160
msg = "No known merge type %s. Supported types are:\n%s" %\
161
(typestring, type_list)
162
raise BzrCommandError(msg)
101
165
def _builtin_commands():
102
166
import bzrlib.builtins
104
168
builtins = bzrlib.builtins.__dict__
105
169
for name in builtins:
106
170
if name.startswith("cmd_"):
107
real_name = _unsquish_command_name(name)
171
real_name = _unsquish_command_name(name)
108
172
r[real_name] = builtins[name]
112
177
def builtin_command_names():
240
269
"""Construct an instance of this command."""
241
270
if self.__doc__ == Command.__doc__:
242
271
warn("No help message set for %r" % self)
243
# List of standard options directly supported
244
self.supported_std_options = []
246
def _maybe_expand_globs(self, file_list):
247
"""Glob expand file_list if the platform does not do that itself.
249
:return: A possibly empty list of unicode paths.
251
Introduced in bzrlib 0.18.
255
if sys.platform == 'win32':
256
file_list = win32utils.glob_expand(file_list)
257
return list(file_list)
260
"""Return single-line grammar for this command.
262
Only describes arguments, not options.
264
s = 'bzr ' + self.name() + ' '
265
for aname in self.takes_args:
266
aname = aname.upper()
267
if aname[-1] in ['$', '+']:
268
aname = aname[:-1] + '...'
269
elif aname[-1] == '?':
270
aname = '[' + aname[:-1] + ']'
271
elif aname[-1] == '*':
272
aname = '[' + aname[:-1] + '...]'
279
def get_help_text(self, additional_see_also=None, plain=True,
280
see_also_as_links=False):
281
"""Return a text string with help for this command.
283
:param additional_see_also: Additional help topics to be
285
:param plain: if False, raw help (reStructuredText) is
286
returned instead of plain text.
287
:param see_also_as_links: if True, convert items in 'See also'
288
list to internal links (used by bzr_man rstx generator)
292
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
294
# Extract the summary (purpose) and sections out from the text
295
purpose,sections = self._get_help_parts(doc)
297
# If a custom usage section was provided, use it
298
if sections.has_key('Usage'):
299
usage = sections.pop('Usage')
301
usage = self._usage()
303
# The header is the purpose and usage
305
result += ':Purpose: %s\n' % purpose
306
if usage.find('\n') >= 0:
307
result += ':Usage:\n%s\n' % usage
309
result += ':Usage: %s\n' % usage
313
options = option.get_optparser(self.options()).format_option_help()
314
if options.startswith('Options:'):
315
result += ':' + options
316
elif options.startswith('options:'):
317
# Python 2.4 version of optparse
318
result += ':Options:' + options[len('options:'):]
323
# Add the description, indenting it 2 spaces
324
# to match the indentation of the options
325
if sections.has_key(None):
326
text = sections.pop(None)
327
text = '\n '.join(text.splitlines())
328
result += ':%s:\n %s\n\n' % ('Description',text)
330
# Add the custom sections (e.g. Examples). Note that there's no need
331
# to indent these as they must be indented already in the source.
333
labels = sorted(sections.keys())
335
result += ':%s:\n%s\n\n' % (label,sections[label])
337
# Add the aliases, source (plug-in) and see also links, if any
339
result += ':Aliases: '
340
result += ', '.join(self.aliases) + '\n'
341
plugin_name = self.plugin_name()
342
if plugin_name is not None:
343
result += ':From: plugin "%s"\n' % plugin_name
344
see_also = self.get_see_also(additional_see_also)
346
if not plain and see_also_as_links:
348
for item in see_also:
350
# topics doesn't have an independent section
351
# so don't create a real link
352
see_also_links.append(item)
354
# Use a reST link for this entry
355
see_also_links.append("`%s`_" % (item,))
356
see_also = see_also_links
357
result += ':See also: '
358
result += ', '.join(see_also) + '\n'
360
# If this will be rendered as plan text, convert it
362
import bzrlib.help_topics
363
result = bzrlib.help_topics.help_as_plain_text(result)
367
def _get_help_parts(text):
368
"""Split help text into a summary and named sections.
370
:return: (summary,sections) where summary is the top line and
371
sections is a dictionary of the rest indexed by section name.
372
A section starts with a heading line of the form ":xxx:".
373
Indented text on following lines is the section value.
374
All text found outside a named section is assigned to the
375
default section which is given the key of None.
377
def save_section(sections, label, section):
379
if sections.has_key(label):
380
sections[label] += '\n' + section
382
sections[label] = section
384
lines = text.rstrip().splitlines()
385
summary = lines.pop(0)
387
label,section = None,''
389
if line.startswith(':') and line.endswith(':') and len(line) > 2:
390
save_section(sections, label, section)
391
label,section = line[1:-1],''
392
elif label != None and len(line) > 1 and not line[0].isspace():
393
save_section(sections, label, section)
394
label,section = None,line
397
section += '\n' + line
400
save_section(sections, label, section)
401
return summary, sections
403
def get_help_topic(self):
404
"""Return the commands help topic - its name."""
407
def get_see_also(self, additional_terms=None):
408
"""Return a list of help topics that are related to this command.
410
The list is derived from the content of the _see_also attribute. Any
411
duplicates are removed and the result is in lexical order.
412
:param additional_terms: Additional help topics to cross-reference.
413
:return: A list of help topics.
415
see_also = set(getattr(self, '_see_also', []))
417
see_also.update(additional_terms)
418
return sorted(see_also)
421
"""Return dict of valid options for this command.
423
Maps from long option name to option object."""
424
r = Option.STD_OPTIONS.copy()
426
for o in self.takes_options:
427
if isinstance(o, basestring):
428
o = option.Option.OPTIONS[o]
430
if o.name in std_names:
431
self.supported_std_options.append(o.name)
434
def _setup_outf(self):
435
"""Return a file linked to stdout, which has proper encoding."""
436
assert self.encoding_type in ['strict', 'exact', 'replace']
438
# Originally I was using self.stdout, but that looks
439
# *way* too much like sys.stdout
440
if self.encoding_type == 'exact':
441
# force sys.stdout to be binary stream on win32
442
if sys.platform == 'win32':
443
fileno = getattr(sys.stdout, 'fileno', None)
446
msvcrt.setmode(fileno(), os.O_BINARY)
447
self.outf = sys.stdout
450
output_encoding = osutils.get_terminal_encoding()
452
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
453
errors=self.encoding_type)
454
# For whatever reason codecs.getwriter() does not advertise its encoding
455
# it just returns the encoding of the wrapped file, which is completely
456
# bogus. So set the attribute, so we can find the correct encoding later.
457
self.outf.encoding = output_encoding
459
def run_argv_aliases(self, argv, alias_argv=None):
460
"""Parse the command line and run with extra aliases in alias_argv."""
462
warn("Passing None for [] is deprecated from bzrlib 0.10",
463
DeprecationWarning, stacklevel=2)
465
args, opts = parse_args(self, argv, alias_argv)
467
# Process the standard options
274
def run_argv(self, argv):
275
"""Parse command line and run."""
276
args, opts = parse_args(argv)
468
278
if 'help' in opts: # e.g. bzr add --help
469
sys.stdout.write(self.get_help_text())
279
from bzrlib.help import help_on_command
280
help_on_command(self.name())
471
trace.set_verbosity_level(option._verbosity_level)
472
if 'verbose' in self.supported_std_options:
473
opts['verbose'] = trace.is_verbose()
474
elif opts.has_key('verbose'):
476
if 'quiet' in self.supported_std_options:
477
opts['quiet'] = trace.is_quiet()
478
elif opts.has_key('quiet'):
283
# check options are reasonable
284
allowed = self.takes_options
286
if oname not in allowed:
287
raise BzrCommandError("option '--%s' is not allowed for command %r"
288
% (oname, self.name()))
481
290
# mix arguments and options into one dictionary
482
291
cmdargs = _match_argform(self.name(), self.takes_args, args)
515
322
return _unsquish_command_name(self.__class__.__name__)
517
def plugin_name(self):
518
"""Get the name of the plugin that provides this command.
520
:return: The name of the plugin or None if the command is builtin.
522
mod_parts = self.__module__.split('.')
523
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
325
def parse_spec(spec):
331
>>> parse_spec("../@")
333
>>> parse_spec("../f/@35")
335
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
336
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
341
parsed = spec.split('/@')
342
assert len(parsed) == 2
529
def parse_args(command, argv, alias_argv=None):
347
parsed[1] = int(parsed[1])
349
pass # We can allow stuff like ./@revid:blahblahblah
353
parsed = [spec, None]
357
# list of all available options; the rhs can be either None for an
358
# option that takes no argument, or a constructor function that checks
372
'revision': _parse_revision_str,
384
'merge-type': get_merge_type,
398
def parse_args(argv):
530
399
"""Parse command line.
532
401
Arguments and options are parsed at this level before being passed
533
402
down to specific command handlers. This routine knows, from a
534
403
lookup table, something about the available options, what optargs
535
404
they take, and which commands will accept them.
406
>>> parse_args('--help'.split())
408
>>> parse_args('help -- --invalidcmd'.split())
409
(['help', '--invalidcmd'], {})
410
>>> parse_args('--version'.split())
411
([], {'version': True})
412
>>> parse_args('status --all'.split())
413
(['status'], {'all': True})
414
>>> parse_args('commit --message=biter'.split())
415
(['commit'], {'message': u'biter'})
416
>>> parse_args('log -r 500'.split())
417
(['log'], {'revision': [<RevisionSpec_int 500>]})
418
>>> parse_args('log -r500..600'.split())
419
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
420
>>> parse_args('log -vr500..600'.split())
421
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
422
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
423
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
537
# TODO: make it a method of the Command?
538
parser = option.get_optparser(command.options())
539
if alias_argv is not None:
540
args = alias_argv + argv
544
options, args = parser.parse_args(args)
545
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
546
v is not option.OptionParser.DEFAULT_VALUE])
431
if not argsover and a[0] == '-':
432
# option names must not be unicode
437
# We've received a standalone -- No more flags
440
mutter(" got option %r" % a)
442
optname, optarg = a[2:].split('=', 1)
445
if optname not in OPTIONS:
446
raise BzrError('unknown long option %r' % a)
449
if shortopt in SHORT_OPTIONS:
450
# Multi-character options must have a space to delimit
452
optname = SHORT_OPTIONS[shortopt]
454
# Single character short options, can be chained,
455
# and have their value appended to their name
457
if shortopt not in SHORT_OPTIONS:
458
# We didn't find the multi-character name, and we
459
# didn't find the single char name
460
raise BzrError('unknown short option %r' % a)
461
optname = SHORT_OPTIONS[shortopt]
464
# There are extra things on this option
465
# see if it is the value, or if it is another
467
optargfn = OPTIONS[optname]
469
# This option does not take an argument, so the
470
# next entry is another short option, pack it back
472
argv.insert(0, '-' + a[2:])
474
# This option takes an argument, so pack it
479
# XXX: Do we ever want to support this, e.g. for -r?
480
raise BzrError('repeated option %r' % a)
482
optargfn = OPTIONS[optname]
486
raise BzrError('option %r needs an argument' % a)
489
opts[optname] = optargfn(optarg)
492
raise BzrError('option %r takes no argument' % optname)
547
497
return args, opts
550
502
def _match_argform(cmd, takes_args, args):
667
587
Do not load plugin modules at all
673
590
Only use builtin commands. (Plugins are still allowed to change
674
591
other behaviour.)
677
Run under the Python hotshot profiler.
680
Run under the Python lsprof profiler.
594
Run under the Python profiler.
683
trace.mutter("bzr arguments: %r", argv)
597
argv = [a.decode(bzrlib.user_encoding) for a in argv]
685
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
686
opt_no_aliases = False
687
opt_lsprof_file = None
599
opt_profile = opt_no_plugins = opt_builtin = False
689
601
# --no-plugins is handled specially at a very early stage. We need
690
602
# to load plugins before doing other command parsing so that they
691
603
# can override commands, but this needs to happen first.
697
606
if a == '--profile':
698
607
opt_profile = True
699
elif a == '--lsprof':
701
elif a == '--lsprof-file':
703
opt_lsprof_file = argv[i + 1]
705
608
elif a == '--no-plugins':
706
609
opt_no_plugins = True
707
elif a == '--no-aliases':
708
opt_no_aliases = True
709
610
elif a == '--builtin':
710
611
opt_builtin = True
711
elif a.startswith('-D'):
712
debug.debug_flags.add(a[2:])
719
from bzrlib.builtins import cmd_help
720
cmd_help().run_argv_aliases([])
616
if (not argv) or (argv[0] == '--help'):
617
from bzrlib.help import help
723
624
if argv[0] == '--version':
724
from bzrlib.builtins import cmd_version
725
cmd_version().run_argv_aliases([])
625
from bzrlib.builtins import show_version
728
629
if not opt_no_plugins:
729
630
from bzrlib.plugin import load_plugins
732
from bzrlib.plugin import disable_plugins
737
if not opt_no_aliases:
738
alias_argv = get_alias(argv[0])
740
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
741
argv[0] = alias_argv.pop(0)
744
# We want only 'ascii' command names, but the user may have typed
745
# in a Unicode name. In that case, they should just get a
746
# 'command not found' error later.
633
cmd = str(argv.pop(0))
748
635
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
749
run = cmd_obj.run_argv_aliases
750
run_argv = [argv, alias_argv]
754
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
756
ret = apply_profiled(run, *run_argv)
761
# reset, in case we may do other commands later within the same process
762
option._verbosity_level = 0
764
def display_command(func):
765
"""Decorator that suppresses pipe/interrupt errors."""
766
def ignore_pipe(*args, **kwargs):
768
result = func(*args, **kwargs)
772
if getattr(e, 'errno', None) is None:
774
if e.errno != errno.EPIPE:
775
# Win32 raises IOError with errno=0 on a broken pipe
776
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
779
except KeyboardInterrupt:
638
ret = apply_profiled(cmd_obj.run_argv, argv)
640
ret = cmd_obj.run_argv(argv)
786
from bzrlib.ui.text import TextUIFactory
787
bzrlib.ui.ui_factory = TextUIFactory()
789
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
790
except UnicodeDecodeError:
791
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
793
ret = run_bzr_catch_errors(argv)
794
trace.mutter("return code %d", ret)
646
bzrlib.trace.log_startup(argv)
647
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
649
return run_bzr_catch_errors(argv[1:])
798
652
def run_bzr_catch_errors(argv):
799
# Note: The except clause logic below should be kept in sync with the
800
# profile() routine in lsprof.py.
803
except (KeyboardInterrupt, Exception), e:
804
# used to handle AssertionError and KeyboardInterrupt
805
# specially here, but hopefully they're handled ok by the logger now
806
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
807
if os.environ.get('BZR_PDB'):
808
print '**** entering debugger'
810
pdb.post_mortem(sys.exc_traceback)
814
def run_bzr_catch_user_errors(argv):
815
"""Run bzr and report user errors, but let internal errors propagate.
817
This is used for the test suite, and might be useful for other programs
818
that want to wrap the commandline interface.
658
# do this here inside the exception wrappers to catch EPIPE
660
#wrap common errors as CommandErrors.
661
except (NotBranchError,), e:
662
raise BzrCommandError(str(e))
663
except BzrCommandError, e:
664
# command line syntax error, etc
668
bzrlib.trace.log_exception()
670
except AssertionError, e:
671
bzrlib.trace.log_exception('assertion failed: ' + str(e))
673
except KeyboardInterrupt, e:
674
bzrlib.trace.note('interrupted')
822
676
except Exception, e:
823
if (isinstance(e, (OSError, IOError))
824
or not getattr(e, 'internal_error', True)):
825
trace.report_exception(sys.exc_info(), sys.stderr)
831
class HelpCommandIndex(object):
832
"""A index for bzr help that returns commands."""
835
self.prefix = 'commands/'
837
def get_topics(self, topic):
838
"""Search for topic amongst commands.
840
:param topic: A topic to search for.
841
:return: A list which is either empty or contains a single
844
if topic and topic.startswith(self.prefix):
845
topic = topic[len(self.prefix):]
847
cmd = _get_cmd_object(topic)
678
if (isinstance(e, IOError)
679
and hasattr(e, 'errno')
680
and e.errno == errno.EPIPE):
681
bzrlib.trace.note('broken pipe')
684
bzrlib.trace.log_exception()
854
688
if __name__ == '__main__':
added
removed
bzrlib/commands.py
