This is an archive of the discontinued Mercurial Phabricator instance.

Differential D12407

help: use new function for getting first line of string
ClosedPublic

Authored by martinvonz on Mar 25 2022, 1:38 AM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG7bd5f862b249: help: use new function for getting first line of string

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Revision Contents
Changeset List

PathPackages
Mmercurial/help.py (16 lines)

Diff 32704

mercurial/help.py

templatekw, templatekw,
ui as uimod, ui as uimod,
util, util,
) )
from .hgweb import webcommands from .hgweb import webcommands
from .utils import ( from .utils import (
compression, compression,
resourceutil, resourceutil,
stringutil,
) )
_exclkeywords = { _exclkeywords = {
b"(ADVANCED)", b"(ADVANCED)",
b"(DEPRECATED)", b"(DEPRECATED)",
b"(EXPERIMENTAL)", b"(EXPERIMENTAL)",
# i18n: "(ADVANCED)" is a keyword, must be translated consistently # i18n: "(ADVANCED)" is a keyword, must be translated consistently
_(b"(ADVANCED)"), _(b"(ADVANCED)"),
if len(entry) == 3: if len(entry) == 3:
summary = entry[2] summary = entry[2]
else: else:
summary = b'' summary = b''
# translate docs *before* searching there # translate docs *before* searching there
func = entry[0] func = entry[0]
docs = _(pycompat.getdoc(func)) or b'' docs = _(pycompat.getdoc(func)) or b''
if kw in cmd or lowercontains(summary) or lowercontains(docs): if kw in cmd or lowercontains(summary) or lowercontains(docs):
doclines = docs.splitlines() if docs:
if doclines: summary = stringutil.firstline(docs)
summary = doclines[0]
cmdname = cmdutil.parsealiases(cmd)[0] cmdname = cmdutil.parsealiases(cmd)[0]
if filtercmd(ui, cmdname, func, kw, docs): if filtercmd(ui, cmdname, func, kw, docs):
continue continue
results[b'commands'].append((cmdname, summary)) results[b'commands'].append((cmdname, summary))
for name, docs in itertools.chain( for name, docs in itertools.chain(
extensions.enabled(False).items(), extensions.enabled(False).items(),
extensions.disabled().items(), extensions.disabled().items(),
): ):
if not docs: if not docs:
continue continue
name = name.rpartition(b'.')[-1] name = name.rpartition(b'.')[-1]
if lowercontains(name) or lowercontains(docs): if lowercontains(name) or lowercontains(docs):
# extension docs are already translated # extension docs are already translated
results[b'extensions'].append((name, docs.splitlines()[0])) results[b'extensions'].append((name, stringutil.firstline(docs)))
try: try:
mod = extensions.load(ui, name, b'') mod = extensions.load(ui, name, b'')
except ImportError: except ImportError:
# debug message would be printed in extensions.load() # debug message would be printed in extensions.load()
continue continue
for cmd, entry in getattr(mod, 'cmdtable', {}).items(): for cmd, entry in getattr(mod, 'cmdtable', {}).items():
if kw in cmd or (len(entry) > 2 and lowercontains(entry[2])): if kw in cmd or (len(entry) > 2 and lowercontains(entry[2])):
cmdname = cmdutil.parsealiases(cmd)[0] cmdname = cmdutil.parsealiases(cmd)[0]
func = entry[0] func = entry[0]
cmddoc = pycompat.getdoc(func) cmddoc = pycompat.getdoc(func)
if cmddoc: if cmddoc:
cmddoc = gettext(cmddoc).splitlines()[0] cmddoc = stringutil.firstline(gettext(cmddoc))
else: else:
cmddoc = _(b'(no help text available)') cmddoc = _(b'(no help text available)')
if filtercmd(ui, cmdname, func, kw, cmddoc): if filtercmd(ui, cmdname, func, kw, cmddoc):
continue continue
results[b'extensioncommands'].append((cmdname, cmddoc)) results[b'extensioncommands'].append((cmdname, cmddoc))
return results return results
text = (pycompat.getdoc(items[name]) or b'').rstrip() text = (pycompat.getdoc(items[name]) or b'').rstrip()
if not text or not ui.verbose and any(w in text for w in _exclkeywords): if not text or not ui.verbose and any(w in text for w in _exclkeywords):
continue continue
text = gettext(text) text = gettext(text)
if dedent: if dedent:
# Abuse latin1 to use textwrap.dedent() on bytes. # Abuse latin1 to use textwrap.dedent() on bytes.
text = textwrap.dedent(text.decode('latin1')).encode('latin1') text = textwrap.dedent(text.decode('latin1')).encode('latin1')
lines = text.splitlines() lines = text.splitlines()
doclines = [(lines[0])] doclines = [lines[0]]
for l in lines[1:]: for l in lines[1:]:
# Stop once we find some Python doctest # Stop once we find some Python doctest
if l.strip().startswith(b'>>>'): if l.strip().startswith(b'>>>'):
break break
if dedent: if dedent:
doclines.append(l.rstrip()) doclines.append(l.rstrip())
else: else:
doclines.append(b' ' + l.strip()) doclines.append(b' ' + l.strip())
if select and not select(f): if select and not select(f):
continue continue
doc = pycompat.getdoc(func) doc = pycompat.getdoc(func)
if filtercmd(ui, f, func, name, doc): if filtercmd(ui, f, func, name, doc):
continue continue
doc = gettext(doc) doc = gettext(doc)
if not doc: if not doc:
doc = _(b"(no help text available)") doc = _(b"(no help text available)")
h[f] = doc.splitlines()[0].rstrip() h[f] = stringutil.firstline(doc).rstrip()
cat = getattr(func, 'helpcategory', None) or ( cat = getattr(func, 'helpcategory', None) or (
registrar.command.CATEGORY_NONE registrar.command.CATEGORY_NONE
) )
cats.setdefault(cat, []).append(f) cats.setdefault(cat, []).append(f)
return cats, h, syns return cats, h, syns
) )
) )
return rst return rst
def helpextcmd(name, subtopic=None): def helpextcmd(name, subtopic=None):
cmd, ext, doc = extensions.disabledcmd( cmd, ext, doc = extensions.disabledcmd(
ui, name, ui.configbool(b'ui', b'strict') ui, name, ui.configbool(b'ui', b'strict')
) )
doc = doc.splitlines()[0] doc = stringutil.firstline(doc)
rst = listexts( rst = listexts(
_(b"'%s' is provided by the following extension:") % cmd, _(b"'%s' is provided by the following extension:") % cmd,
{ext: doc}, {ext: doc},
indent=4, indent=4,
showdeprecated=True, showdeprecated=True,
) )
rst.append(b'\n') rst.append(b'\n')