help.py
535 lines
| 19.1 KiB
| text/x-python
|
PythonLexer
/ mercurial / help.py
|
r3795 | # help.py - help data for mercurial | ||
# | ||||
# Copyright 2006 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r3795 | |||
|
r9539 | from i18n import gettext, _ | ||
|
r24098 | import itertools, os, textwrap | ||
|
r20034 | import error | ||
|
r16126 | import extensions, revset, fileset, templatekw, templatefilters, filemerge | ||
|
r24587 | import templater | ||
|
r16781 | import encoding, util, minirst | ||
|
r18746 | import cmdutil | ||
|
r24080 | import hgweb.webcommands as webcommands | ||
|
r8863 | |||
|
r26369 | _exclkeywords = [ | ||
|
r26370 | "(DEPRECATED)", | ||
"(EXPERIMENTAL)", | ||||
# i18n: "(DEPRECATED)" is a keyword, must be translated consistently | ||||
_("(DEPRECATED)"), | ||||
# i18n: "(EXPERIMENTAL)" is a keyword, must be translated consistently | ||||
_("(EXPERIMENTAL)"), | ||||
|
r26369 | ] | ||
|
r20582 | def listexts(header, exts, indent=1, showdeprecated=False): | ||
|
r8879 | '''return a text listing of the given extensions''' | ||
|
r16852 | rst = [] | ||
if exts: | ||||
rst.append('\n%s\n\n' % header) | ||||
for name, desc in sorted(exts.iteritems()): | ||||
|
r26371 | if not showdeprecated and any(w in desc for w in _exclkeywords): | ||
|
r20582 | continue | ||
|
r16852 | rst.append('%s:%s: %s\n' % (' ' * indent, name, desc)) | ||
return rst | ||||
|
r8864 | |||
|
r26413 | def extshelp(ui): | ||
rst = loaddoc('extensions')(ui).splitlines(True) | ||||
|
r20582 | rst.extend(listexts( | ||
_('enabled extensions:'), extensions.enabled(), showdeprecated=True)) | ||||
|
r16852 | rst.extend(listexts(_('disabled extensions:'), extensions.disabled())) | ||
doc = ''.join(rst) | ||||
|
r8863 | return doc | ||
|
r7013 | |||
|
r22116 | def optrst(header, options, verbose): | ||
|
r16781 | data = [] | ||
multioccur = False | ||||
for option in options: | ||||
if len(option) == 5: | ||||
shortopt, longopt, default, desc, optlabel = option | ||||
else: | ||||
shortopt, longopt, default, desc = option | ||||
optlabel = _("VALUE") # default label | ||||
|
r26369 | if not verbose and any(w in desc for w in _exclkeywords): | ||
|
r16781 | continue | ||
so = '' | ||||
if shortopt: | ||||
so = '-' + shortopt | ||||
lo = '--' + longopt | ||||
if default: | ||||
desc += _(" (default: %s)") % default | ||||
if isinstance(default, list): | ||||
lo += " %s [+]" % optlabel | ||||
multioccur = True | ||||
elif (default is not None) and not isinstance(default, bool): | ||||
lo += " %s" % optlabel | ||||
data.append((so, lo, desc)) | ||||
|
r22117 | if multioccur: | ||
header += (_(" ([+] can be repeated)")) | ||||
|
r16781 | |||
|
r22116 | rst = ['\n%s:\n\n' % header] | ||
rst.extend(minirst.maketable(data, 1)) | ||||
|
r16781 | |||
|
r16815 | return ''.join(rst) | ||
|
r16781 | |||
|
r17837 | def indicateomitted(rst, omitted, notomitted=None): | ||
rst.append('\n\n.. container:: omitted\n\n %s\n\n' % omitted) | ||||
if notomitted: | ||||
rst.append('\n\n.. container:: notomitted\n\n %s\n\n' % notomitted) | ||||
|
r26413 | def topicmatch(ui, kw): | ||
|
r16710 | """Return help topics matching kw. | ||
Returns {'section': [(name, summary), ...], ...} where section is | ||||
one of topics, commands, extensions, or extensioncommands. | ||||
""" | ||||
kw = encoding.lower(kw) | ||||
def lowercontains(container): | ||||
|
r16845 | return kw in encoding.lower(container) # translated in helptable | ||
|
r16710 | results = {'topics': [], | ||
'commands': [], | ||||
'extensions': [], | ||||
'extensioncommands': [], | ||||
} | ||||
for names, header, doc in helptable: | ||||
|
r22322 | # Old extensions may use a str as doc. | ||
|
r16710 | if (sum(map(lowercontains, names)) | ||
or lowercontains(header) | ||||
|
r26413 | or (callable(doc) and lowercontains(doc(ui)))): | ||
|
r16710 | results['topics'].append((names[0], header)) | ||
import commands # avoid cycle | ||||
for cmd, entry in commands.table.iteritems(): | ||||
if len(entry) == 3: | ||||
summary = entry[2] | ||||
else: | ||||
summary = '' | ||||
|
r16845 | # translate docs *before* searching there | ||
docs = _(getattr(entry[0], '__doc__', None)) or '' | ||||
|
r16710 | if kw in cmd or lowercontains(summary) or lowercontains(docs): | ||
|
r16845 | doclines = docs.splitlines() | ||
|
r16710 | if doclines: | ||
summary = doclines[0] | ||||
r26845 | cmdname = cmd.partition('|')[0].lstrip('^') | |||
|
r16710 | results['commands'].append((cmdname, summary)) | ||
for name, docs in itertools.chain( | ||||
|
r19769 | extensions.enabled(False).iteritems(), | ||
|
r16710 | extensions.disabled().iteritems()): | ||
# extensions.load ignores the UI argument | ||||
mod = extensions.load(None, name, '') | ||||
r26845 | name = name.rpartition('.')[-1] | |||
|
r16710 | if lowercontains(name) or lowercontains(docs): | ||
|
r16845 | # extension docs are already translated | ||
results['extensions'].append((name, docs.splitlines()[0])) | ||||
|
r16710 | for cmd, entry in getattr(mod, 'cmdtable', {}).iteritems(): | ||
|
r16711 | if kw in cmd or (len(entry) > 2 and lowercontains(entry[2])): | ||
r26845 | cmdname = cmd.partition('|')[0].lstrip('^') | |||
|
r16942 | if entry[0].__doc__: | ||
cmddoc = gettext(entry[0].__doc__).splitlines()[0] | ||||
|
r16884 | else: | ||
cmddoc = _('(no help text available)') | ||||
results['extensioncommands'].append((cmdname, cmddoc)) | ||||
|
r16710 | return results | ||
|
r9539 | def loaddoc(topic): | ||
"""Return a delayed loader for help/topic.txt.""" | ||||
|
r3798 | |||
|
r26413 | def loader(ui): | ||
|
r22637 | docdir = os.path.join(util.datapath, 'help') | ||
|
r9539 | path = os.path.join(docdir, topic + ".txt") | ||
|
r14168 | doc = gettext(util.readfile(path)) | ||
|
r12820 | for rewriter in helphooks.get(topic, []): | ||
|
r26414 | doc = rewriter(ui, topic, doc) | ||
|
r12820 | return doc | ||
|
r9539 | return loader | ||
|
r7677 | |||
|
r13888 | helptable = sorted([ | ||
|
r12145 | (["config", "hgrc"], _("Configuration Files"), loaddoc('config')), | ||
|
r9539 | (["dates"], _("Date Formats"), loaddoc('dates')), | ||
(["patterns"], _("File Name Patterns"), loaddoc('patterns')), | ||||
|
r10282 | (['environment', 'env'], _('Environment Variables'), | ||
loaddoc('environment')), | ||||
|
r17322 | (['revisions', 'revs'], _('Specifying Single Revisions'), | ||
|
r10282 | loaddoc('revisions')), | ||
|
r17322 | (['multirevs', 'mrevs'], _('Specifying Multiple Revisions'), | ||
|
r10282 | loaddoc('multirevs')), | ||
|
r17322 | (['revsets', 'revset'], _("Specifying Revision Sets"), loaddoc('revsets')), | ||
(['filesets', 'fileset'], _("Specifying File Sets"), loaddoc('filesets')), | ||||
|
r9539 | (['diffs'], _('Diff Formats'), loaddoc('diffs')), | ||
|
r17323 | (['merge-tools', 'mergetools'], _('Merge Tools'), loaddoc('merge-tools')), | ||
|
r16568 | (['templating', 'templates', 'template', 'style'], _('Template Usage'), | ||
|
r10282 | loaddoc('templates')), | ||
|
r9539 | (['urls'], _('URL Paths'), loaddoc('urls')), | ||
|
r16547 | (["extensions"], _("Using Additional Features"), extshelp), | ||
|
r17322 | (["subrepos", "subrepo"], _("Subrepositories"), loaddoc('subrepos')), | ||
|
r17321 | (["hgweb"], _("Configuring hgweb"), loaddoc('hgweb')), | ||
(["glossary"], _("Glossary"), loaddoc('glossary')), | ||||
(["hgignore", "ignore"], _("Syntax for Mercurial Ignore Files"), | ||||
loaddoc('hgignore')), | ||||
(["phases"], _("Working with Phases"), loaddoc('phases')), | ||||
|
r25881 | (['scripting'], _('Using Mercurial from scripts and automation'), | ||
loaddoc('scripting')), | ||||
|
r13888 | ]) | ||
|
r12820 | |||
# Map topics to lists of callable taking the current topic help and | ||||
# returning the updated version | ||||
|
r14318 | helphooks = {} | ||
|
r12820 | |||
def addtopichook(topic, rewriter): | ||||
helphooks.setdefault(topic, []).append(rewriter) | ||||
|
r13593 | |||
|
r26414 | def makeitemsdoc(ui, topic, doc, marker, items, dedent=False): | ||
|
r13593 | """Extract docstring from the items key to function mapping, build a | ||
|
r26196 | single documentation block and use it to overwrite the marker in doc. | ||
|
r13593 | """ | ||
entries = [] | ||||
for name in sorted(items): | ||||
text = (items[name].__doc__ or '').rstrip() | ||||
|
r26415 | if (not text | ||
or not ui.verbose and any(w in text for w in _exclkeywords)): | ||||
|
r13593 | continue | ||
text = gettext(text) | ||||
|
r24098 | if dedent: | ||
text = textwrap.dedent(text) | ||||
|
r13593 | lines = text.splitlines() | ||
|
r16250 | doclines = [(lines[0])] | ||
for l in lines[1:]: | ||||
# Stop once we find some Python doctest | ||||
if l.strip().startswith('>>>'): | ||||
break | ||||
|
r24098 | if dedent: | ||
doclines.append(l.rstrip()) | ||||
else: | ||||
doclines.append(' ' + l.strip()) | ||||
|
r16250 | entries.append('\n'.join(doclines)) | ||
|
r13593 | entries = '\n\n'.join(entries) | ||
return doc.replace(marker, entries) | ||||
|
r14318 | |||
|
r24098 | def addtopicsymbols(topic, marker, symbols, dedent=False): | ||
|
r26414 | def add(ui, topic, doc): | ||
return makeitemsdoc(ui, topic, doc, marker, symbols, dedent=dedent) | ||||
|
r14318 | addtopichook(topic, add) | ||
|
r14686 | addtopicsymbols('filesets', '.. predicatesmarker', fileset.symbols) | ||
|
r24099 | addtopicsymbols('merge-tools', '.. internaltoolsmarker', | ||
filemerge.internalsdoc) | ||||
|
r14318 | addtopicsymbols('revsets', '.. predicatesmarker', revset.symbols) | ||
|
r26436 | addtopicsymbols('templates', '.. keywordsmarker', templatekw.keywords) | ||
|
r14318 | addtopicsymbols('templates', '.. filtersmarker', templatefilters.filters) | ||
|
r24587 | addtopicsymbols('templates', '.. functionsmarker', templater.funcs) | ||
|
r24098 | addtopicsymbols('hgweb', '.. webcommandsmarker', webcommands.commands, | ||
dedent=True) | ||||
|
r18746 | |||
def help_(ui, name, unknowncmd=False, full=True, **opts): | ||||
''' | ||||
Generate the help for 'name' as unformatted restructured text. If | ||||
'name' is None, describe the commands available. | ||||
''' | ||||
import commands # avoid cycle | ||||
def helpcmd(name): | ||||
try: | ||||
aliases, entry = cmdutil.findcmd(name, commands.table, | ||||
strict=unknowncmd) | ||||
|
r25660 | except error.AmbiguousCommand as inst: | ||
|
r18746 | # py3k fix: except vars can't be used outside the scope of the | ||
# except block, nor can be used inside a lambda. python issue4617 | ||||
prefix = inst.args[0] | ||||
select = lambda c: c.lstrip('^').startswith(prefix) | ||||
rst = helplist(select) | ||||
return rst | ||||
rst = [] | ||||
# check if it's an invalid alias and display its error if it is | ||||
|
r22160 | if getattr(entry[0], 'badalias', None): | ||
|
r22162 | rst.append(entry[0].badalias + '\n') | ||
if entry[0].unknowncmd: | ||||
try: | ||||
rst.extend(helpextcmd(entry[0].cmdname)) | ||||
except error.UnknownCommand: | ||||
pass | ||||
|
r18746 | return rst | ||
# synopsis | ||||
if len(entry) > 2: | ||||
if entry[2].startswith('hg'): | ||||
rst.append("%s\n" % entry[2]) | ||||
else: | ||||
rst.append('hg %s %s\n' % (aliases[0], entry[2])) | ||||
else: | ||||
rst.append('hg %s\n' % aliases[0]) | ||||
# aliases | ||||
if full and not ui.quiet and len(aliases) > 1: | ||||
rst.append(_("\naliases: %s\n") % ', '.join(aliases[1:])) | ||||
rst.append('\n') | ||||
# description | ||||
doc = gettext(entry[0].__doc__) | ||||
if not doc: | ||||
doc = _("(no help text available)") | ||||
if util.safehasattr(entry[0], 'definition'): # aliased command | ||||
if entry[0].definition.startswith('!'): # shell alias | ||||
doc = _('shell alias for::\n\n %s') % entry[0].definition[1:] | ||||
else: | ||||
doc = _('alias for: hg %s\n\n%s') % (entry[0].definition, doc) | ||||
doc = doc.splitlines(True) | ||||
if ui.quiet or not full: | ||||
rst.append(doc[0]) | ||||
else: | ||||
rst.extend(doc) | ||||
rst.append('\n') | ||||
# check if this command shadows a non-trivial (multi-line) | ||||
# extension help text | ||||
try: | ||||
mod = extensions.find(name) | ||||
doc = gettext(mod.__doc__) or '' | ||||
if '\n' in doc.strip(): | ||||
|
r22112 | msg = _('(use "hg help -e %s" to show help for ' | ||
'the %s extension)') % (name, name) | ||||
|
r18746 | rst.append('\n%s\n' % msg) | ||
except KeyError: | ||||
pass | ||||
# options | ||||
if not ui.quiet and entry[1]: | ||||
|
r22116 | rst.append(optrst(_("options"), entry[1], ui.verbose)) | ||
|
r18746 | |||
if ui.verbose: | ||||
|
r22116 | rst.append(optrst(_("global options"), | ||
commands.globalopts, ui.verbose)) | ||||
|
r18746 | |||
if not ui.verbose: | ||||
if not full: | ||||
|
r22111 | rst.append(_('\n(use "hg %s -h" to show more help)\n') | ||
|
r18746 | % name) | ||
elif not ui.quiet: | ||||
|
r22110 | rst.append(_('\n(some details hidden, use --verbose ' | ||
'to show complete help)')) | ||||
|
r18746 | |||
return rst | ||||
def helplist(select=None): | ||||
# list of commands | ||||
if name == "shortlist": | ||||
header = _('basic commands:\n\n') | ||||
|
r20822 | elif name == "debug": | ||
header = _('debug commands (internal and unsupported):\n\n') | ||||
|
r18746 | else: | ||
header = _('list of commands:\n\n') | ||||
h = {} | ||||
cmds = {} | ||||
for c, e in commands.table.iteritems(): | ||||
r26845 | f = c.partition("|")[0] | |||
|
r18746 | if select and not select(f): | ||
continue | ||||
if (not select and name != 'shortlist' and | ||||
e[0].__module__ != commands.__name__): | ||||
continue | ||||
if name == "shortlist" and not f.startswith("^"): | ||||
continue | ||||
f = f.lstrip("^") | ||||
|
r20822 | if not ui.debugflag and f.startswith("debug") and name != "debug": | ||
|
r18746 | continue | ||
doc = e[0].__doc__ | ||||
|
r26371 | if not ui.verbose and doc and any(w in doc for w in _exclkeywords): | ||
|
r18746 | continue | ||
doc = gettext(doc) | ||||
if not doc: | ||||
doc = _("(no help text available)") | ||||
h[f] = doc.splitlines()[0].rstrip() | ||||
cmds[f] = c.lstrip("^") | ||||
rst = [] | ||||
if not h: | ||||
if not ui.quiet: | ||||
rst.append(_('no commands defined\n')) | ||||
return rst | ||||
if not ui.quiet: | ||||
rst.append(header) | ||||
fns = sorted(h) | ||||
for f in fns: | ||||
if ui.verbose: | ||||
commacmds = cmds[f].replace("|",", ") | ||||
rst.append(" :%s: %s\n" % (commacmds, h[f])) | ||||
else: | ||||
rst.append(' :%s: %s\n' % (f, h[f])) | ||||
if not name: | ||||
exts = listexts(_('enabled extensions:'), extensions.enabled()) | ||||
if exts: | ||||
rst.append('\n') | ||||
rst.extend(exts) | ||||
rst.append(_("\nadditional help topics:\n\n")) | ||||
topics = [] | ||||
for names, header, doc in helptable: | ||||
topics.append((names[0], header)) | ||||
for t, desc in topics: | ||||
rst.append(" :%s: %s\n" % (t, desc)) | ||||
|
r22115 | if ui.quiet: | ||
pass | ||||
elif ui.verbose: | ||||
|
r22116 | rst.append('\n%s\n' % optrst(_("global options"), | ||
commands.globalopts, ui.verbose)) | ||||
|
r22115 | if name == 'shortlist': | ||
|
r22118 | rst.append(_('\n(use "hg help" for the full list ' | ||
'of commands)\n')) | ||||
|
r22115 | else: | ||
if name == 'shortlist': | ||||
|
r22118 | rst.append(_('\n(use "hg help" for the full list of commands ' | ||
'or "hg -v" for details)\n')) | ||||
|
r22115 | elif name and not full: | ||
|
r22118 | rst.append(_('\n(use "hg help %s" to show the full help ' | ||
'text)\n') % name) | ||||
|
r23624 | elif name and cmds and name in cmds.keys(): | ||
rst.append(_('\n(use "hg help -v -e %s" to show built-in ' | ||||
'aliases and global options)\n') % name) | ||||
|
r18746 | else: | ||
|
r22118 | rst.append(_('\n(use "hg help -v%s" to show built-in aliases ' | ||
'and global options)\n') | ||||
% (name and " " + name or "")) | ||||
|
r18746 | return rst | ||
def helptopic(name): | ||||
for names, header, doc in helptable: | ||||
if name in names: | ||||
break | ||||
else: | ||||
raise error.UnknownCommand(name) | ||||
|
r18748 | rst = [minirst.section(header)] | ||
|
r18746 | # description | ||
if not doc: | ||||
rst.append(" %s\n" % _("(no help text available)")) | ||||
|
r21796 | if callable(doc): | ||
|
r26413 | rst += [" %s\n" % l for l in doc(ui).splitlines()] | ||
|
r18746 | |||
if not ui.verbose: | ||||
|
r22114 | omitted = _('(some details hidden, use --verbose' | ||
' to show complete help)') | ||||
|
r18746 | indicateomitted(rst, omitted) | ||
try: | ||||
cmdutil.findcmd(name, commands.table) | ||||
rst.append(_('\nuse "hg help -c %s" to see help for ' | ||||
'the %s command\n') % (name, name)) | ||||
except error.UnknownCommand: | ||||
pass | ||||
return rst | ||||
def helpext(name): | ||||
try: | ||||
mod = extensions.find(name) | ||||
doc = gettext(mod.__doc__) or _('no help text available') | ||||
except KeyError: | ||||
mod = None | ||||
doc = extensions.disabledext(name) | ||||
if not doc: | ||||
raise error.UnknownCommand(name) | ||||
if '\n' not in doc: | ||||
head, tail = doc, "" | ||||
else: | ||||
head, tail = doc.split('\n', 1) | ||||
r26845 | rst = [_('%s extension - %s\n\n') % (name.rpartition('.')[-1], head)] | |||
|
r18746 | if tail: | ||
rst.extend(tail.splitlines(True)) | ||||
rst.append('\n') | ||||
if not ui.verbose: | ||||
|
r22114 | omitted = _('(some details hidden, use --verbose' | ||
' to show complete help)') | ||||
|
r18746 | indicateomitted(rst, omitted) | ||
if mod: | ||||
try: | ||||
ct = mod.cmdtable | ||||
except AttributeError: | ||||
ct = {} | ||||
r26845 | modcmds = set([c.partition('|')[0] for c in ct]) | |||
|
r18746 | rst.extend(helplist(modcmds.__contains__)) | ||
else: | ||||
|
r22113 | rst.append(_('(use "hg help extensions" for information on enabling' | ||
' extensions)\n')) | ||||
|
r18746 | return rst | ||
def helpextcmd(name): | ||||
cmd, ext, mod = extensions.disabledcmd(ui, name, | ||||
ui.configbool('ui', 'strict')) | ||||
doc = gettext(mod.__doc__).splitlines()[0] | ||||
rst = listexts(_("'%s' is provided by the following " | ||||
"extension:") % cmd, {ext: doc}, indent=4) | ||||
rst.append('\n') | ||||
|
r22113 | rst.append(_('(use "hg help extensions" for information on enabling ' | ||
'extensions)\n')) | ||||
|
r18746 | return rst | ||
rst = [] | ||||
kw = opts.get('keyword') | ||||
if kw: | ||||
|
r26413 | matches = topicmatch(ui, name) | ||
|
r26238 | helpareas = [] | ||
if opts.get('extension'): | ||||
helpareas += [('extensions', _('Extensions'))] | ||||
if opts.get('command'): | ||||
helpareas += [('commands', _('Commands'))] | ||||
if not helpareas: | ||||
helpareas = [('topics', _('Topics')), | ||||
|
r18746 | ('commands', _('Commands')), | ||
('extensions', _('Extensions')), | ||||
|
r26238 | ('extensioncommands', _('Extension Commands'))] | ||
for t, title in helpareas: | ||||
|
r18746 | if matches[t]: | ||
rst.append('%s:\n\n' % title) | ||||
rst.extend(minirst.maketable(sorted(matches[t]), 1)) | ||||
rst.append('\n') | ||||
|
r21288 | if not rst: | ||
msg = _('no matches') | ||||
hint = _('try "hg help" for a list of topics') | ||||
|
r26587 | raise error.Abort(msg, hint=hint) | ||
|
r18746 | elif name and name != 'shortlist': | ||
|
r26238 | queries = [] | ||
|
r18746 | if unknowncmd: | ||
|
r26238 | queries += [helpextcmd] | ||
if opts.get('extension'): | ||||
queries += [helpext] | ||||
if opts.get('command'): | ||||
queries += [helpcmd] | ||||
if not queries: | ||||
|
r18746 | queries = (helptopic, helpcmd, helpext, helpextcmd) | ||
for f in queries: | ||||
try: | ||||
rst = f(name) | ||||
break | ||||
|
r21289 | except error.UnknownCommand: | ||
pass | ||||
else: | ||||
if unknowncmd: | ||||
raise error.UnknownCommand(name) | ||||
else: | ||||
msg = _('no such help topic: %s') % name | ||||
hint = _('try "hg help --keyword %s"') % name | ||||
|
r26587 | raise error.Abort(msg, hint=hint) | ||
|
r18746 | else: | ||
# program name | ||||
if not ui.quiet: | ||||
rst = [_("Mercurial Distributed SCM\n"), '\n'] | ||||
rst.extend(helplist()) | ||||
return ''.join(rst) | ||||