240
225
"""Construct an instance of this command."""
241
226
if self.__doc__ == Command.__doc__:
242
227
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)
420
229
def options(self):
421
230
"""Return dict of valid options for this command.
423
232
Maps from long option name to option object."""
424
r = Option.STD_OPTIONS.copy()
234
r['help'] = option.Option.OPTIONS['help']
426
235
for o in self.takes_options:
427
236
if isinstance(o, basestring):
428
237
o = option.Option.OPTIONS[o]
430
if o.name in std_names:
431
self.supported_std_options.append(o.name)
434
241
def _setup_outf(self):
438
245
# Originally I was using self.stdout, but that looks
439
246
# *way* too much like sys.stdout
440
247
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
248
self.outf = sys.stdout
450
251
output_encoding = osutils.get_terminal_encoding()
452
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
453
errors=self.encoding_type)
253
# use 'replace' so that we don't abort if trying to write out
254
# in e.g. the default C locale.
255
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
454
256
# For whatever reason codecs.getwriter() does not advertise its encoding
455
257
# it just returns the encoding of the wrapped file, which is completely
456
258
# bogus. So set the attribute, so we can find the correct encoding later.
457
259
self.outf.encoding = output_encoding
261
@deprecated_method(zero_eight)
262
def run_argv(self, argv):
263
"""Parse command line and run.
265
See run_argv_aliases for the 0.8 and beyond api.
267
return self.run_argv_aliases(argv)
459
269
def run_argv_aliases(self, argv, alias_argv=None):
460
270
"""Parse the command line and run with extra aliases in alias_argv."""
462
warn("Passing None for [] is deprecated from bzrlib 0.10",
272
warn("Passing None for [] is deprecated from bzrlib 0.10",
463
273
DeprecationWarning, stacklevel=2)
465
275
args, opts = parse_args(self, argv, alias_argv)
467
# Process the standard options
468
276
if 'help' in opts: # e.g. bzr add --help
469
sys.stdout.write(self.get_help_text())
277
from bzrlib.help import help_on_command
278
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'):
481
280
# mix arguments and options into one dictionary
482
281
cmdargs = _match_argform(self.name(), self.takes_args, args)
632
451
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
633
452
from bzrlib.lsprof import profile
634
454
ret, stats = profile(the_callable, *args, **kwargs)
636
456
if filename is None:
640
trace.note('Profile data written to "%s".', filename)
460
cPickle.dump(stats, open(filename, 'w'), 2)
461
print 'Profile data written to %r.' % filename
644
def shlex_split_unicode(unsplit):
646
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
649
def get_alias(cmd, config=None):
650
"""Return an expanded alias, or None if no alias exists.
653
Command to be checked for an alias.
655
Used to specify an alternative config to use,
656
which is especially useful for testing.
657
If it is unspecified, the global config will be used.
661
config = bzrlib.config.GlobalConfig()
662
alias = config.get_alias(cmd)
466
"""Return an expanded alias, or None if no alias exists"""
468
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
664
return shlex_split_unicode(alias)
470
return alias.split(' ')
770
569
# 'command not found' error later.
772
571
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
773
run = cmd_obj.run_argv_aliases
774
run_argv = [argv, alias_argv]
572
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
573
run = cmd_obj.run_argv
576
run = cmd_obj.run_argv_aliases
577
run_argv = [argv, alias_argv]
780
'--coverage ignored, because --lsprof is in use.')
781
581
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
782
582
elif opt_profile:
785
'--coverage ignored, because --profile is in use.')
786
583
ret = apply_profiled(run, *run_argv)
787
elif opt_coverage_dir:
788
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
790
585
ret = run(*run_argv)
793
588
# reset, in case we may do other commands later within the same process
794
option._verbosity_level = 0
589
trace.be_quiet(False)
796
591
def display_command(func):
797
592
"""Decorator that suppresses pipe/interrupt errors."""
818
613
from bzrlib.ui.text import TextUIFactory
819
614
bzrlib.ui.ui_factory = TextUIFactory()
821
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
822
except UnicodeDecodeError:
823
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
615
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
825
616
ret = run_bzr_catch_errors(argv)
826
617
trace.mutter("return code %d", ret)
830
621
def run_bzr_catch_errors(argv):
831
# Note: The except clause logic below should be kept in sync with the
832
# profile() routine in lsprof.py.
834
623
return run_bzr(argv)
624
# do this here inside the exception wrappers to catch EPIPE
835
626
except (KeyboardInterrupt, Exception), e:
836
627
# used to handle AssertionError and KeyboardInterrupt
837
628
# specially here, but hopefully they're handled ok by the logger now
838
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
629
trace.report_exception(sys.exc_info(), sys.stderr)
839
630
if os.environ.get('BZR_PDB'):
840
631
print '**** entering debugger'
842
633
pdb.post_mortem(sys.exc_traceback)
846
def run_bzr_catch_user_errors(argv):
847
"""Run bzr and report user errors, but let internal errors propagate.
849
This is used for the test suite, and might be useful for other programs
850
that want to wrap the commandline interface.
855
if (isinstance(e, (OSError, IOError))
856
or not getattr(e, 'internal_error', True)):
857
trace.report_exception(sys.exc_info(), sys.stderr)
863
class HelpCommandIndex(object):
864
"""A index for bzr help that returns commands."""
867
self.prefix = 'commands/'
869
def get_topics(self, topic):
870
"""Search for topic amongst commands.
872
:param topic: A topic to search for.
873
:return: A list which is either empty or contains a single
876
if topic and topic.startswith(self.prefix):
877
topic = topic[len(self.prefix):]
879
cmd = _get_cmd_object(topic)
886
636
if __name__ == '__main__':
887
637
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
