( )⚙ D7419 help: port to ResourceReader API

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7419

help: port to ResourceReader API
Changes PlannedPublic

Authored by indygreg on Nov 14 2019, 10:58 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Summary

Previous commits introduced a mechanism to obtain an
importlib.abc.ResourceReader for Mercurial resource data.

This commit ports I/O in the help system to use this API.
By doing so, we abstract I/O away from the help system and
allow help files to be served from something that isn't
a traditional filesystem.

Diff Detail

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

Event Timeline

indygreg created this revision.Nov 14 2019, 10:58 PM
indygreg planned changes to this revision.Nov 14 2019, 11:03 PM

I have other patches to attempt to do similar things for templating and rc.d files if there is interest in reviving this series.

Revision Contents
Changeset List

PathPackages
Mmercurial/help.py (18 lines)

Diff 18142

mercurial/help.py

# help.py - help data for mercurial # help.py - help data for mercurial
# #
# Copyright 2006 Matt Mackall <mpm@selenic.com> # Copyright 2006 Matt Mackall <mpm@selenic.com>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import itertools import itertools
import os
import re import re
import textwrap import textwrap
from .i18n import ( from .i18n import (
_, _,
gettext, gettext,
) )
from . import ( from . import (
templatefuncs, templatefuncs,
templatekw, templatekw,
ui as uimod, ui as uimod,
util, util,
) )
from .hgweb import ( from .hgweb import (
webcommands, webcommands,
) )
from .utils import (
procutil,
)
_exclkeywords = { _exclkeywords = {
"(ADVANCED)", "(ADVANCED)",
"(DEPRECATED)", "(DEPRECATED)",
"(EXPERIMENTAL)", "(EXPERIMENTAL)",
# i18n: "(ADVANCED)" is a keyword, must be translated consistently # i18n: "(ADVANCED)" is a keyword, must be translated consistently
_("(ADVANCED)"), _("(ADVANCED)"),
# i18n: "(DEPRECATED)" is a keyword, must be translated consistently # i18n: "(DEPRECATED)" is a keyword, must be translated consistently
continue continue
results['extensioncommands'].append((cmdname, cmddoc)) results['extensioncommands'].append((cmdname, cmddoc))
return results return results
def loaddoc(topic, subdir=None): def loaddoc(topic, subdir=None):
"""Return a delayed loader for help/topic.txt.""" """Return a delayed loader for help/topic.txt."""
def loader(ui): def loader(ui):
docdir = os.path.join(util.datapath, 'help') reader = procutil.resourcereader('mercurial')
if subdir: if subdir:
docdir = os.path.join(docdir, subdir) resource = b'help/%s/%s.txt' % (subdir, topic)
path = os.path.join(docdir, topic + ".txt") else:
doc = gettext(util.readfile(path)) resource = b'help/%s.txt' % topic
with reader.open_resource(resource) as fh:
doc = gettext(fh.read())
for rewriter in helphooks.get(topic, []): for rewriter in helphooks.get(topic, []):
doc = rewriter(ui, topic, doc) doc = rewriter(ui, topic, doc)
return doc return doc
return loader return loader
internalstable = sorted([ internalstable = sorted([
(['bundle2'], _('Bundle2'), (['bundle2'], _('Bundle2'),
loaddoc('bundle2', subdir='internals')), loaddoc('bundle2', subdir='internals')),
(['bundles'], _('Bundles'), (['bundles'], _('Bundles'),