This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8058

resourceutil: account for the non-resource-like file hierarchy under py2exe
ClosedPublic

Authored by mharbison72 on Jan 31 2020, 11:02 PM.

Details

Reviewers
indygreg
Group Reviewers
hg-reviewers
Commits
rHGaab70b540d3d: resourceutil: account for the non-resource-like file hierarchy under py2exe
Summary

After 9e367157a990, config files for py2exe were expected to be in
C:\Program Files\Mercurial\mercurial\defaultrc because of the implied resource
structure of 'mercurial.defaultrc.*.rc', relative to the executable.
Accomodating this would require changes to the WIX and Inno scripts (and perhaps
the script that generates the WIX script), as well as 3rd party bundlers like
TortoiseHg. But these files aren't read as resources anyway- they fall back to
the filesystem APIs. (If we really wanted to carry on the charade, the
installer would have to also sprinkle various empty __init__.py files around.)

Instead, this simply prunes the 'mercurial.' portion of the resource name when
run with py2exe. (PyOxidizer uses the resources API, not the filesystem
fallback, so it is unaffected.) Since this hack only affects the py2 Windows
installers and is less risky, I think it's reasonable. We haven't needed to
load any 3rd party resource up to this point, and would have to make packaging
changes anyway to handle that.

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

mharbison72 created this revision.Jan 31 2020, 11:02 PM
mharbison72 added a comment.Jan 31 2020, 11:06 PM

This is meant for stable. We will also need D8052 before tagging the release. I'm going to see if I can fix the version field in the the Inno installer, but that's not critical like this.

indygreg added a parent revision: D8052: wix: restore COPYING.rtf.Feb 1 2020, 6:53 PM
indygreg accepted this revision.
This revision is now accepted and ready to land.Feb 1 2020, 6:53 PM

Revision Contents
Changeset List

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

Diff 19818

mercurial/utils/resourceutil.py

) # tools/freeze ) # tools/freeze
# 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)
_rootpath = datapath _rootpath = datapath
# The installers store the files outside of library.zip, like
# C:\Program Files\Mercurial\defaultrc\*.rc. This strips the
# leading "mercurial." off of the package name, so that these
# pseudo resources are found in their directory next to the
# executable.
def _package_path(package):
dirs = package.split(b'.')
assert dirs[0] == b'mercurial'
return os.path.join(_rootpath, *dirs[1:])
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) _rootpath = os.path.dirname(datapath)
def _package_path(package):
return os.path.join(_rootpath, *package.split(b'.'))
try: try:
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 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):
def _package_path(package):
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')
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)
try: try: