This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7622

help: get helptext/ data from `resources` module if available
ClosedPublic

Authored by martinvonz on Dec 12 2019, 6:44 PM.

Details

Reviewers
indygreg
Group Reviewers
hg-reviewers
Commits
rHG1390bb81163e: help: get helptext/ data from `resources` module if available
Summary

For PyOxidizer, we need to read configs using the resources
module. This patch makes it so we use that module if available
(i.e. Python >= 3.7). It does that by adding a new open_resource()
function to our resourceutil module.

Tested by running $PYTHON ./hg help pager for each $PYTHON in
{python2, python3.6, python3.7}.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

martinvonz created this revision.Dec 12 2019, 6:44 PM
mharbison72 added a subscriber: mharbison72.Dec 12 2019, 11:35 PM
mharbison72 added inline comments.
mercurial/utils/resourceutil.py
45

s/open_resouce/open_resource/

martinvonz updated this revision to Diff 18684.Dec 13 2019, 3:01 AM
martinvonz marked an inline comment as done.Dec 13 2019, 3:01 AM
martinvonz added inline comments.
mercurial/utils/resourceutil.py
45

Oops, done.

indygreg accepted this revision.Dec 14 2019, 7:34 PM

This seems like a reasonable and lightweight implementation of resource reading!

This revision is now accepted and ready to land.Dec 14 2019, 7:34 PM
martinvonz marked an inline comment as done.Dec 14 2019, 10:11 PM
martinvonz added a commit: rHG1390bb81163e: help: get helptext/ data from `resources` module if available.
Closed by commit rHG1390bb81163e: help: get helptext/ data from `resources` module if available (authored by martinvonz). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 18731

mercurial/defaultrc/__init__.py

  • This file was added.

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 .pycompat import getattr from .pycompat import getattr
results[b'extensioncommands'].append((cmdname, cmddoc)) results[b'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(resourceutil.datapath, b'helptext') package = b'helptext'
if subdir: if subdir:
docdir = os.path.join(docdir, subdir) package = b'helptext' + b'.' + subdir
path = os.path.join(docdir, topic + b".txt") with resourceutil.open_resource(package, topic + b'.txt') as fp:
doc = gettext(util.readfile(path)) doc = gettext(fp.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(

mercurial/utils/resourceutil.py

# the location of data files matching the source code # the location of data files matching the source code
if mainfrozen() and getattr(sys, 'frozen', None) != 'macosx_app': if mainfrozen() and getattr(sys, 'frozen', None) != 'macosx_app':
# executable version (py2exe) doesn't support __file__ # executable version (py2exe) doesn't support __file__
datapath = os.path.dirname(pycompat.sysexecutable) datapath = os.path.dirname(pycompat.sysexecutable)
else: else:
datapath = os.path.dirname(os.path.dirname(pycompat.fsencode(__file__))) datapath = os.path.dirname(os.path.dirname(pycompat.fsencode(__file__)))
try:
import importlib
# Force loading of the resources module
importlib.resources.open_binary
def open_resource(package, name):
mharbison72Unsubmitted
Done

s/open_resouce/open_resource/

mharbison72: s/open_resouce/open_resource/
martinvonzAuthorUnsubmitted
Done

Oops, done.

martinvonz: Oops, done.
package = b'mercurial.' + package
return importlib.resources.open_binary(
pycompat.sysstr(package), pycompat.sysstr(name)
)
except AttributeError:
def _package_path(package):
return os.path.join(datapath, *package.split(b'.'))
def open_resource(package, name):
path = os.path.join(_package_path(package), name)
return open(path, 'rb')