251
232
"""Construct an instance of this command."""
252
233
if self.__doc__ == Command.__doc__:
253
234
warn("No help message set for %r" % self)
254
# List of standard options directly supported
255
self.supported_std_options = []
257
def _maybe_expand_globs(self, file_list):
258
"""Glob expand file_list if the platform does not do that itself.
260
:return: A possibly empty list of unicode paths.
262
Introduced in bzrlib 0.18.
266
if sys.platform == 'win32':
267
file_list = win32utils.glob_expand(file_list)
268
return list(file_list)
271
"""Return single-line grammar for this command.
273
Only describes arguments, not options.
275
s = 'bzr ' + self.name() + ' '
276
for aname in self.takes_args:
277
aname = aname.upper()
278
if aname[-1] in ['$', '+']:
279
aname = aname[:-1] + '...'
280
elif aname[-1] == '?':
281
aname = '[' + aname[:-1] + ']'
282
elif aname[-1] == '*':
283
aname = '[' + aname[:-1] + '...]'
285
s = s[:-1] # remove last space
288
def get_help_text(self, additional_see_also=None, plain=True,
289
see_also_as_links=False):
290
"""Return a text string with help for this command.
292
:param additional_see_also: Additional help topics to be
294
:param plain: if False, raw help (reStructuredText) is
295
returned instead of plain text.
296
:param see_also_as_links: if True, convert items in 'See also'
297
list to internal links (used by bzr_man rstx generator)
301
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
303
# Extract the summary (purpose) and sections out from the text
304
purpose,sections = self._get_help_parts(doc)
306
# If a custom usage section was provided, use it
307
if sections.has_key('Usage'):
308
usage = sections.pop('Usage')
310
usage = self._usage()
312
# The header is the purpose and usage
314
result += ':Purpose: %s\n' % purpose
315
if usage.find('\n') >= 0:
316
result += ':Usage:\n%s\n' % usage
318
result += ':Usage: %s\n' % usage
322
options = option.get_optparser(self.options()).format_option_help()
323
if options.startswith('Options:'):
324
result += ':' + options
325
elif options.startswith('options:'):
326
# Python 2.4 version of optparse
327
result += ':Options:' + options[len('options:'):]
332
# Add the description, indenting it 2 spaces
333
# to match the indentation of the options
334
if sections.has_key(None):
335
text = sections.pop(None)
336
text = '\n '.join(text.splitlines())
337
result += ':%s:\n %s\n\n' % ('Description',text)
339
# Add the custom sections (e.g. Examples). Note that there's no need
340
# to indent these as they must be indented already in the source.
342
labels = sorted(sections.keys())
344
result += ':%s:\n%s\n\n' % (label,sections[label])
346
# Add the aliases, source (plug-in) and see also links, if any
348
result += ':Aliases: '
349
result += ', '.join(self.aliases) + '\n'
350
plugin_name = self.plugin_name()
351
if plugin_name is not None:
352
result += ':From: plugin "%s"\n' % plugin_name
353
see_also = self.get_see_also(additional_see_also)
355
if not plain and see_also_as_links:
357
for item in see_also:
359
# topics doesn't have an independent section
360
# so don't create a real link
361
see_also_links.append(item)
363
# Use a reST link for this entry
364
see_also_links.append("`%s`_" % (item,))
365
see_also = see_also_links
366
result += ':See also: '
367
result += ', '.join(see_also) + '\n'
369
# If this will be rendered as plan text, convert it
371
import bzrlib.help_topics
372
result = bzrlib.help_topics.help_as_plain_text(result)
376
def _get_help_parts(text):
377
"""Split help text into a summary and named sections.
379
:return: (summary,sections) where summary is the top line and
380
sections is a dictionary of the rest indexed by section name.
381
A section starts with a heading line of the form ":xxx:".
382
Indented text on following lines is the section value.
383
All text found outside a named section is assigned to the
384
default section which is given the key of None.
386
def save_section(sections, label, section):
388
if sections.has_key(label):
389
sections[label] += '\n' + section
391
sections[label] = section
393
lines = text.rstrip().splitlines()
394
summary = lines.pop(0)
396
label,section = None,''
398
if line.startswith(':') and line.endswith(':') and len(line) > 2:
399
save_section(sections, label, section)
400
label,section = line[1:-1],''
401
elif (label is not None) and len(line) > 1 and not line[0].isspace():
402
save_section(sections, label, section)
403
label,section = None,line
406
section += '\n' + line
409
save_section(sections, label, section)
410
return summary, sections
412
def get_help_topic(self):
413
"""Return the commands help topic - its name."""
416
def get_see_also(self, additional_terms=None):
417
"""Return a list of help topics that are related to this command.
419
The list is derived from the content of the _see_also attribute. Any
420
duplicates are removed and the result is in lexical order.
421
:param additional_terms: Additional help topics to cross-reference.
422
:return: A list of help topics.
424
see_also = set(getattr(self, '_see_also', []))
426
see_also.update(additional_terms)
427
return sorted(see_also)
429
236
def options(self):
430
237
"""Return dict of valid options for this command.
432
239
Maps from long option name to option object."""
433
r = Option.STD_OPTIONS.copy()
241
r['help'] = option.Option.OPTIONS['help']
435
242
for o in self.takes_options:
436
243
if isinstance(o, basestring):
437
244
o = option.Option.OPTIONS[o]
439
if o.name in std_names:
440
self.supported_std_options.append(o.name)
443
248
def _setup_outf(self):
444
249
"""Return a file linked to stdout, which has proper encoding."""
250
assert self.encoding_type in ['strict', 'exact', 'replace']
445
252
# Originally I was using self.stdout, but that looks
446
253
# *way* too much like sys.stdout
447
254
if self.encoding_type == 'exact':
777
596
# 'command not found' error later.
779
598
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
780
run = cmd_obj.run_argv_aliases
781
run_argv = [argv, alias_argv]
599
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
600
run = cmd_obj.run_argv
603
run = cmd_obj.run_argv_aliases
604
run_argv = [argv, alias_argv]
787
'--coverage ignored, because --lsprof is in use.')
788
608
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
789
609
elif opt_profile:
792
'--coverage ignored, because --profile is in use.')
793
610
ret = apply_profiled(run, *run_argv)
794
elif opt_coverage_dir:
795
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
797
612
ret = run(*run_argv)
798
if 'memory' in debug.debug_flags:
800
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
804
status = status_file.read()
806
trace.note("Process status after command:")
807
for line in status.splitlines():
811
615
# reset, in case we may do other commands later within the same process
812
option._verbosity_level = 0
616
trace.be_quiet(False)
814
618
def display_command(func):
815
619
"""Decorator that suppresses pipe/interrupt errors."""
836
640
from bzrlib.ui.text import TextUIFactory
837
641
bzrlib.ui.ui_factory = TextUIFactory()
839
# Is this a final release version? If so, we should suppress warnings
840
if bzrlib.version_info[3] == 'final':
841
from bzrlib import symbol_versioning
842
symbol_versioning.suppress_deprecation_warnings(override=False)
844
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
845
except UnicodeDecodeError:
846
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
642
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
848
643
ret = run_bzr_catch_errors(argv)
849
644
trace.mutter("return code %d", ret)
853
648
def run_bzr_catch_errors(argv):
854
# Note: The except clause logic below should be kept in sync with the
855
# profile() routine in lsprof.py.
857
650
return run_bzr(argv)
651
# do this here inside the exception wrappers to catch EPIPE
858
653
except (KeyboardInterrupt, Exception), e:
859
654
# used to handle AssertionError and KeyboardInterrupt
860
655
# specially here, but hopefully they're handled ok by the logger now
861
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
656
trace.report_exception(sys.exc_info(), sys.stderr)
862
657
if os.environ.get('BZR_PDB'):
863
658
print '**** entering debugger'
865
660
pdb.post_mortem(sys.exc_traceback)
869
def run_bzr_catch_user_errors(argv):
870
"""Run bzr and report user errors, but let internal errors propagate.
872
This is used for the test suite, and might be useful for other programs
873
that want to wrap the commandline interface.
878
if (isinstance(e, (OSError, IOError))
879
or not getattr(e, 'internal_error', True)):
880
trace.report_exception(sys.exc_info(), sys.stderr)
886
class HelpCommandIndex(object):
887
"""A index for bzr help that returns commands."""
890
self.prefix = 'commands/'
892
def get_topics(self, topic):
893
"""Search for topic amongst commands.
895
:param topic: A topic to search for.
896
:return: A list which is either empty or contains a single
899
if topic and topic.startswith(self.prefix):
900
topic = topic[len(self.prefix):]
902
cmd = _get_cmd_object(topic)
909
class Provider(object):
910
'''Generic class to be overriden by plugins'''
912
def plugin_for_command(self, cmd_name):
913
'''Takes a command and returns the information for that plugin
915
:return: A dictionary with all the available information
916
for the requested plugin
918
raise NotImplementedError
921
class ProvidersRegistry(registry.Registry):
922
'''This registry exists to allow other providers to exist'''
925
for key, provider in self.iteritems():
928
command_providers_registry = ProvidersRegistry()
931
663
if __name__ == '__main__':
932
664
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
