This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7772

resourceutil: don't limit resources to the `mercurial` package
ClosedPublic

Authored by mharbison72 on Dec 30 2019, 12:43 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG52f0140c2604: resourceutil: don't limit resources to the `mercurial` package
Summary

This should make things a little clearer, in that it now requires the full
package name to access a resource. But the real motivation is that
extensions._disabledpaths() walks the hgext directory looking for bundled
extensions. This in turn feeds, among other things:

  1. Listing disabled extensions in hg help extensions
  2. Indicating that an unknown command is in a non-enabled extension
  3. Displaying help for non-enabled extensions
  4. Generating documentation
  5. Announcing LFS is auto-enabled (or not) when cloning from an LFS source

The filesystem based ResourceReader will happily return *.py and *.pyc, but the
one supplied by PyOxidizer doesn't. Presumably we can change that. The only
other idea I had here is for setup.py to generate a text file containing the
list of extensions, but that doesn't seem great when running from source.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

mharbison72 created this revision.Dec 30 2019, 12:43 AM
mharbison72 added a commit: rHG52f0140c2604: resourceutil: don't limit resources to the `mercurial` package.Jan 8 2020, 2:51 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG52f0140c2604: resourceutil: don't limit resources to the `mercurial` package (authored by mharbison72). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

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

Diff 19003

mercurial/help.py

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):
package = b'helptext' package = b'mercurial.helptext'
if subdir: if subdir:
package = b'helptext' + b'.' + subdir package += b'.' + subdir
with resourceutil.open_resource(package, topic + b'.txt') as fp: with resourceutil.open_resource(package, topic + b'.txt') as fp:
doc = gettext(fp.read()) 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

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__)))
_rootpath = os.path.dirname(datapath)
try: try:
from importlib import resources from importlib import resources
# 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):
package = b'mercurial.' + package
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)
) )
except (ImportError, AttributeError): except (ImportError, AttributeError):
def _package_path(package): def _package_path(package):
return os.path.join(datapath, *package.split(b'.')) return os.path.join(_rootpath, *package.split(b'.'))
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')