This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9018

resourceutil: document when we expect to take the importlib.resouces code path
ClosedPublic

Authored by martinvonz on Sep 12 2020, 2:25 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGdd9e28612468: resourceutil: document when we expect to take the importlib.resouces code path

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.

Revision Contents
Changeset List

PathPackages
Mmercurial/utils/resourceutil.py (4 lines)

Diff 22637

mercurial/utils/resourceutil.py

datapath = os.path.dirname(os.path.dirname(pycompat.fsencode(__file__))) datapath = os.path.dirname(os.path.dirname(pycompat.fsencode(__file__)))
_rootpath = os.path.dirname(datapath) _rootpath = os.path.dirname(datapath)
def _package_path(package): def _package_path(package):
return os.path.join(_rootpath, *package.split(b".")) return os.path.join(_rootpath, *package.split(b"."))
try: try:
# importlib.resources exists from Python 3.7; see fallback in except clause
# further down
from importlib import resources from importlib import resources
from .. import encoding from .. import encoding
# Force loading of the resources module # Force loading of the resources module
resources.open_binary # pytype: disable=module-attr resources.open_binary # pytype: disable=module-attr
def open_resource(package, name): def open_resource(package, name):
return resources.open_binary( # pytype: disable=module-attr return resources.open_binary( # pytype: disable=module-attr
pycompat.sysstr(package), pycompat.sysstr(name) pycompat.sysstr(package), pycompat.sysstr(name)
) )
def is_resource(package, name): def is_resource(package, name):
return resources.is_resource( return resources.is_resource(
pycompat.sysstr(package), encoding.strfromlocal(name) pycompat.sysstr(package), encoding.strfromlocal(name)
) )
def contents(package): def contents(package):
for r in resources.contents(pycompat.sysstr(package)): for r in resources.contents(pycompat.sysstr(package)):
yield encoding.strtolocal(r) yield encoding.strtolocal(r)
except (ImportError, AttributeError): except (ImportError, AttributeError):
# importlib.resources was not found (almost definitely because we're on a
# Python version before 3.7)
def open_resource(package, name): def open_resource(package, name):
path = os.path.join(_package_path(package), name) path = os.path.join(_package_path(package), name)
return open(path, "rb") return open(path, "rb")
def is_resource(package, name): def is_resource(package, name):
path = os.path.join(_package_path(package), name) path = os.path.join(_package_path(package), name)