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.
23
21
# TODO: Define arguments by objects, rather than just using names.
24
22
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
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.
27
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
28
29
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
32
38
from warnings import warn
33
from inspect import getdoc
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib import BZRDIR
51
from bzrlib.symbol_versioning import (
46
56
from bzrlib.option import Option
51
62
def register_command(cmd, decorate=False):
52
"Utility function to help register a command"
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.
55
72
if k.startswith("cmd_"):
56
73
k_unsquished = _unsquish_command_name(k)
59
if not plugin_cmds.has_key(k_unsquished):
76
if k_unsquished not in plugin_cmds:
60
77
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
78
## trace.mutter('registered plugin command %s', k_unsquished)
62
79
if decorate and k_unsquished in builtin_command_names():
63
80
return _builtin_commands()[k_unsquished]
195
240
"""Construct an instance of this command."""
196
241
if self.__doc__ == Command.__doc__:
197
242
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)
199
420
def options(self):
200
421
"""Return dict of valid options for this command.
202
423
Maps from long option name to option object."""
204
r['help'] = Option.OPTIONS['help']
424
r = Option.STD_OPTIONS.copy()
205
426
for o in self.takes_options:
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
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)
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
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
214
468
if 'help' in opts: # e.g. bzr add --help
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
469
sys.stdout.write(self.get_help_text())
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, 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'):
224
481
# mix arguments and options into one dictionary
225
482
cmdargs = _match_argform(self.name(), self.takes_args, args)
294
534
lookup table, something about the available options, what optargs
295
535
they take, and which commands will accept them.
297
# TODO: chop up this beast; make it a method of the Command
301
cmd_options = command.options()
309
# We've received a standalone -- No more flags
313
# option names must not be unicode
317
mutter(" got option %r", a)
319
optname, optarg = a[2:].split('=', 1)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
327
if shortopt in Option.SHORT_OPTIONS:
328
# Multi-character options must have a space to delimit
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
333
# Single character short options, can be chained,
334
# and have their value appended to their name
336
if shortopt not in Option.SHORT_OPTIONS:
337
# We didn't find the multi-character name, and we
338
# didn't find the single char name
339
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
343
# There are extra things on this option
344
# see if it is the value, or if it is another
346
optargfn = Option.OPTIONS[optname].type
348
# This option does not take an argument, so the
349
# next entry is another short option, pack it back
351
argv.insert(0, '-' + a[2:])
353
# This option takes an argument, so pack it
357
if optname not in cmd_options:
358
raise BzrOptionError('unknown short option %r for command'
359
' %s' % (shortopt, command.name()))
361
# XXX: Do we ever want to support this, e.g. for -r?
362
raise BzrError('repeated option %r' % a)
364
option_obj = cmd_options[optname]
365
optargfn = option_obj.type
369
raise BzrError('option %r needs an argument' % a)
372
opts[optname] = optargfn(optarg)
375
raise BzrError('option %r takes no argument' % optname)
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])
379
547
return args, opts
482
680
Run under the Python lsprof profiler.
484
argv = [a.decode(bzrlib.user_encoding) for a in argv]
683
trace.mutter("bzr arguments: %r", argv)
486
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = False
685
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
686
opt_no_aliases = False
687
opt_lsprof_file = None
488
689
# --no-plugins is handled specially at a very early stage. We need
489
690
# to load plugins before doing other command parsing so that they
490
691
# can override commands, but this needs to happen first.
493
697
if a == '--profile':
494
698
opt_profile = True
495
699
elif a == '--lsprof':
496
700
opt_lsprof = True
701
elif a == '--lsprof-file':
703
opt_lsprof_file = argv[i + 1]
497
705
elif a == '--no-plugins':
498
706
opt_no_plugins = True
707
elif a == '--no-aliases':
708
opt_no_aliases = True
499
709
elif a == '--builtin':
500
710
opt_builtin = True
501
elif a in ('--quiet', '-q'):
711
elif a.startswith('-D'):
712
debug.debug_flags.add(a[2:])
507
if (not argv) or (argv[0] == '--help'):
508
from bzrlib.help import help
719
from bzrlib.builtins import cmd_help
720
cmd_help().run_argv_aliases([])
515
723
if argv[0] == '--version':
516
from bzrlib.builtins import show_version
724
from bzrlib.builtins import cmd_version
725
cmd_version().run_argv_aliases([])
520
728
if not opt_no_plugins:
521
729
from bzrlib.plugin import load_plugins
524
cmd = str(argv.pop(0))
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.
526
748
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
749
run = cmd_obj.run_argv_aliases
750
run_argv = [argv, alias_argv]
530
ret = apply_lsprofiled(cmd_obj.run_argv, argv)
754
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
531
755
elif opt_profile:
532
ret = apply_profiled(cmd_obj.run_argv, argv)
756
ret = apply_profiled(run, *run_argv)
534
ret = cmd_obj.run_argv(argv)
537
761
# reset, in case we may do other commands later within the same process
762
option._verbosity_level = 0
540
764
def display_command(func):
541
765
"""Decorator that suppresses pipe/interrupt errors."""
560
786
from bzrlib.ui.text import TextUIFactory
561
## bzrlib.trace.enable_default_logging()
562
bzrlib.trace.log_startup(argv)
563
787
bzrlib.ui.ui_factory = TextUIFactory()
564
ret = run_bzr_catch_errors(argv[1:])
565
mutter("return code %d", ret)
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)
569
798
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.
574
# do this here inside the exception wrappers to catch EPIPE
803
except (KeyboardInterrupt, Exception), e:
577
804
# used to handle AssertionError and KeyboardInterrupt
578
805
# specially here, but hopefully they're handled ok by the logger now
580
if (isinstance(e, IOError)
581
and hasattr(e, 'errno')
582
and e.errno == errno.EPIPE):
583
bzrlib.trace.note('broken pipe')
586
bzrlib.trace.log_exception()
587
if os.environ.get('BZR_PDB'):
588
print '**** entering debugger'
590
pdb.post_mortem(sys.exc_traceback)
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.
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)
593
854
if __name__ == '__main__':
594
855
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
