mercurial-scm/hg: mercurial/utils/resourceutil.py annotate

annotate mercurial/utils/resourceutil.py @ 52106:c5d6a66092e8 stable

utils: avoid using internal _imp.is_frozen() imp has been deprecated for a long time, and were removed in Python 3.12 . As a workaround, we started using the internal _imp. That is ugly and risky. It seems less risky to get the functionality in some other way. Here, we just inspect if 'origin' of the '__main__' module is set and 'frozen'. That seems to work and do the same, and might be better than using the internal _imp directly. This way of inspecting module attributes seems to work in some test cases, but it is a risky change. This level of importlib doesn't have much documentation, a complicated implementation, and we are dealing with some odd use cases.

author	Mads Kiilerich <mads@kiilerich.com>
date	Tue, 27 Jun 2023 13:05:03 +0200
parents	d718eddf01d9
children	747a1370c598

rev	line source
43671 664e24207728 procutil: move mainfrozen() to new resourceutil.py Martin von Zweigbergk <martinvonz@google.com> parents: 43657 diff changeset	1 # resourceutil.py - utility for looking up resources
8226 8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	2 #
8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	3 # Copyright 2005 K. Thananchayan <thananck@yahoo.com>
46819 d4ba4d51f85f contributor: change mentions of mpm to olivia Rapha?l Gom?s <rgomes@octobus.net> parents: 46783 diff changeset	4 # Copyright 2005-2007 Olivia Mackall <olivia@selenic.com>
8226 8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	5 # Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	6 #
8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	7 # This software may be used and distributed according to the terms of the
10263 25e572394f5c Update license to GPLv2+ Matt Mackall <mpm@selenic.com> parents: 9996 diff changeset	8 # GNU General Public License version 2 or any later version.
1082 ce96e316278a Update util.py docstrings, fix walk test mpm@selenic.com parents: 1081 diff changeset	9
27358 ac839ee45b6a util: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27357 diff changeset	10
43672 9fb85668ee15 util: move definition of datapath to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43671 diff changeset	11 import os
27358 ac839ee45b6a util: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27357 diff changeset	12 import sys
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43019 diff changeset	13
43671 664e24207728 procutil: move mainfrozen() to new resourceutil.py Martin von Zweigbergk <martinvonz@google.com> parents: 43657 diff changeset	14 from .. import pycompat
1293 a6ffcebd3315 Enhance the file filtering capabilities. Bryan O'Sullivan <bos@serpentine.com> parents: 1292 diff changeset	15
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43019 diff changeset	16
14228 116de1da2154 rename util.main_is_frozen to mainfrozen Adrian Buehlmann <adrian@cadifra.com> parents: 14167 diff changeset	17 def mainfrozen():
6499 479847ccabe0 Added hgexecutable support for py2exe/frozen scripts "Paul Moore <p.f.moore@gmail.com>" parents: 5659 diff changeset	18 """return True if we are a frozen executable.
479847ccabe0 Added hgexecutable support for py2exe/frozen scripts "Paul Moore <p.f.moore@gmail.com>" parents: 5659 diff changeset	19
479847ccabe0 Added hgexecutable support for py2exe/frozen scripts "Paul Moore <p.f.moore@gmail.com>" parents: 5659 diff changeset	20 The code supports py2exe (most common, Windows only) and tools/freeze
479847ccabe0 Added hgexecutable support for py2exe/frozen scripts "Paul Moore <p.f.moore@gmail.com>" parents: 5659 diff changeset	21 (portable, not much used).
479847ccabe0 Added hgexecutable support for py2exe/frozen scripts "Paul Moore <p.f.moore@gmail.com>" parents: 5659 diff changeset	22 """
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 43019 diff changeset	23 return (
50925 d718eddf01d9 safehasattr: drop usage in favor of hasattr Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50753 diff changeset	24 hasattr(sys, "frozen") # new py2exe
d718eddf01d9 safehasattr: drop usage in favor of hasattr Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50753 diff changeset	25 or hasattr(sys, "importers") # old py2exe
52106 c5d6a66092e8 utils: avoid using internal _imp.is_frozen() Mads Kiilerich <mads@kiilerich.com> parents: 50925 diff changeset	26 or getattr(
c5d6a66092e8 utils: avoid using internal _imp.is_frozen() Mads Kiilerich <mads@kiilerich.com> parents: 50925 diff changeset	27 getattr(sys.modules.get('__main__'), '__spec__', None),
c5d6a66092e8 utils: avoid using internal _imp.is_frozen() Mads Kiilerich <mads@kiilerich.com> parents: 50925 diff changeset	28 'origin',
c5d6a66092e8 utils: avoid using internal _imp.is_frozen() Mads Kiilerich <mads@kiilerich.com> parents: 50925 diff changeset	29 None,
c5d6a66092e8 utils: avoid using internal _imp.is_frozen() Mads Kiilerich <mads@kiilerich.com> parents: 50925 diff changeset	30 )
c5d6a66092e8 utils: avoid using internal _imp.is_frozen() Mads Kiilerich <mads@kiilerich.com> parents: 50925 diff changeset	31 == 'frozen' # tools/freeze
44924 6c8384afbf77 resourceutil: fix location of line comments Manuel Jacob <me@manueljacob.de> parents: 44241 diff changeset	32 )
43672 9fb85668ee15 util: move definition of datapath to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43671 diff changeset	33
9fb85668ee15 util: move definition of datapath to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43671 diff changeset	34
9fb85668ee15 util: move definition of datapath to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43671 diff changeset	35 # the location of data files matching the source code
44241 aea79f41ee55 resourceutil: blacken Augie Fackler <augie@google.com> parents: 44219 diff changeset	36 if mainfrozen() and getattr(sys, "frozen", None) != "macosx_app":
43672 9fb85668ee15 util: move definition of datapath to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43671 diff changeset	37 # executable version (py2exe) doesn't support __file__
9fb85668ee15 util: move definition of datapath to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43671 diff changeset	38 datapath = os.path.dirname(pycompat.sysexecutable)
44208 9e367157a990 resourceutil: correct the root path for file based lookup under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44152 diff changeset	39 _rootpath = datapath
44219 aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	40
aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	41 # The installers store the files outside of library.zip, like
aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	42 # C:\Program Files\Mercurial\defaultrc\*.rc. This strips the
aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	43 # leading "mercurial." off of the package name, so that these
aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	44 # pseudo resources are found in their directory next to the
aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	45 # executable.
aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	46 def _package_path(package):
44241 aea79f41ee55 resourceutil: blacken Augie Fackler <augie@google.com> parents: 44219 diff changeset	47 dirs = package.split(b".")
aea79f41ee55 resourceutil: blacken Augie Fackler <augie@google.com> parents: 44219 diff changeset	48 assert dirs[0] == b"mercurial"
44219 aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	49 return os.path.join(_rootpath, *dirs[1:])
aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	50
43672 9fb85668ee15 util: move definition of datapath to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43671 diff changeset	51 else:
9fb85668ee15 util: move definition of datapath to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43671 diff changeset	52 datapath = os.path.dirname(os.path.dirname(pycompat.fsencode(__file__)))
44027 52f0140c2604 resourceutil: don't limit resources to the `mercurial` package Matt Harbison <matt_harbison@yahoo.com> parents: 43955 diff changeset	53 _rootpath = os.path.dirname(datapath)
43871 1390bb81163e help: get helptext/ data from `resources` module if available Martin von Zweigbergk <martinvonz@google.com> parents: 43862 diff changeset	54
44219 aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	55 def _package_path(package):
44241 aea79f41ee55 resourceutil: blacken Augie Fackler <augie@google.com> parents: 44219 diff changeset	56 return os.path.join(_rootpath, *package.split(b"."))
aea79f41ee55 resourceutil: blacken Augie Fackler <augie@google.com> parents: 44219 diff changeset	57
44219 aab70b540d3d resourceutil: account for the non-resource-like file hierarchy under py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 44208 diff changeset	58
43871 1390bb81163e help: get helptext/ data from `resources` module if available Martin von Zweigbergk <martinvonz@google.com> parents: 43862 diff changeset	59 try:
45452 dd9e28612468 resourceutil: document when we expect to take the importlib.resouces code path Martin von Zweigbergk <martinvonz@google.com> parents: 44924 diff changeset	60 # importlib.resources exists from Python 3.7; see fallback in except clause
dd9e28612468 resourceutil: document when we expect to take the importlib.resouces code path Martin von Zweigbergk <martinvonz@google.com> parents: 44924 diff changeset	61 # further down
48008 c0588d389c5f typing: suppress an import-error warning in `mercurial/utils/resourceutil.py` Matt Harbison <matt_harbison@yahoo.com> parents: 47860 diff changeset	62 from importlib import resources # pytype: disable=import-error
43871 1390bb81163e help: get helptext/ data from `resources` module if available Martin von Zweigbergk <martinvonz@google.com> parents: 43862 diff changeset	63
1390bb81163e help: get helptext/ data from `resources` module if available Martin von Zweigbergk <martinvonz@google.com> parents: 43862 diff changeset	64 # Force loading of the resources module
50925 d718eddf01d9 safehasattr: drop usage in favor of hasattr Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50753 diff changeset	65 if hasattr(resources, 'files'):
49943 330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	66 resources.files # pytype: disable=module-attr
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	67 else:
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	68 resources.open_binary # pytype: disable=module-attr
43871 1390bb81163e help: get helptext/ data from `resources` module if available Martin von Zweigbergk <martinvonz@google.com> parents: 43862 diff changeset	69
49074 4ba27acdea63 resourceutil: force filesystem access to resources when using py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 48875 diff changeset	70 # py2exe raises an AssertionError if uses importlib.resources
4ba27acdea63 resourceutil: force filesystem access to resources when using py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 48875 diff changeset	71 if getattr(sys, "frozen", None) in ("console_exe", "windows_exe"):
4ba27acdea63 resourceutil: force filesystem access to resources when using py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 48875 diff changeset	72 raise ImportError
4ba27acdea63 resourceutil: force filesystem access to resources when using py2exe Matt Harbison <matt_harbison@yahoo.com> parents: 48875 diff changeset	73
43955 75ec46c63657 resourceutil: use `from importlib import resources` Martin von Zweigbergk <martinvonz@google.com> parents: 43905 diff changeset	74 except (ImportError, AttributeError):
45452 dd9e28612468 resourceutil: document when we expect to take the importlib.resouces code path Martin von Zweigbergk <martinvonz@google.com> parents: 44924 diff changeset	75 # importlib.resources was not found (almost definitely because we're on a
dd9e28612468 resourceutil: document when we expect to take the importlib.resouces code path Martin von Zweigbergk <martinvonz@google.com> parents: 44924 diff changeset	76 # Python version before 3.7)
43871 1390bb81163e help: get helptext/ data from `resources` module if available Martin von Zweigbergk <martinvonz@google.com> parents: 43862 diff changeset	77
1390bb81163e help: get helptext/ data from `resources` module if available Martin von Zweigbergk <martinvonz@google.com> parents: 43862 diff changeset	78 def open_resource(package, name):
1390bb81163e help: get helptext/ data from `resources` module if available Martin von Zweigbergk <martinvonz@google.com> parents: 43862 diff changeset	79 path = os.path.join(_package_path(package), name)
44241 aea79f41ee55 resourceutil: blacken Augie Fackler <augie@google.com> parents: 44219 diff changeset	80 return open(path, "rb")
44028 42a897bf678c resourceutil: implement `is_resource()` Matt Harbison <matt_harbison@yahoo.com> parents: 44027 diff changeset	81
42a897bf678c resourceutil: implement `is_resource()` Matt Harbison <matt_harbison@yahoo.com> parents: 44027 diff changeset	82 def is_resource(package, name):
42a897bf678c resourceutil: implement `is_resource()` Matt Harbison <matt_harbison@yahoo.com> parents: 44027 diff changeset	83 path = os.path.join(_package_path(package), name)
42a897bf678c resourceutil: implement `is_resource()` Matt Harbison <matt_harbison@yahoo.com> parents: 44027 diff changeset	84
42a897bf678c resourceutil: implement `is_resource()` Matt Harbison <matt_harbison@yahoo.com> parents: 44027 diff changeset	85 try:
42a897bf678c resourceutil: implement `is_resource()` Matt Harbison <matt_harbison@yahoo.com> parents: 44027 diff changeset	86 return os.path.isfile(pycompat.fsdecode(path))
42a897bf678c resourceutil: implement `is_resource()` Matt Harbison <matt_harbison@yahoo.com> parents: 44027 diff changeset	87 except (IOError, OSError):
42a897bf678c resourceutil: implement `is_resource()` Matt Harbison <matt_harbison@yahoo.com> parents: 44027 diff changeset	88 return False
44029 bba9149adc14 resourceutil: implement `contents()` to iterate over resources in a package Matt Harbison <matt_harbison@yahoo.com> parents: 44028 diff changeset	89
bba9149adc14 resourceutil: implement `contents()` to iterate over resources in a package Matt Harbison <matt_harbison@yahoo.com> parents: 44028 diff changeset	90 def contents(package):
bba9149adc14 resourceutil: implement `contents()` to iterate over resources in a package Matt Harbison <matt_harbison@yahoo.com> parents: 44028 diff changeset	91 path = pycompat.fsdecode(_package_path(package))
bba9149adc14 resourceutil: implement `contents()` to iterate over resources in a package Matt Harbison <matt_harbison@yahoo.com> parents: 44028 diff changeset	92
bba9149adc14 resourceutil: implement `contents()` to iterate over resources in a package Matt Harbison <matt_harbison@yahoo.com> parents: 44028 diff changeset	93 for p in os.listdir(path):
bba9149adc14 resourceutil: implement `contents()` to iterate over resources in a package Matt Harbison <matt_harbison@yahoo.com> parents: 44028 diff changeset	94 yield pycompat.fsencode(p)
47860 08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	95
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	96 else:
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	97 from .. import encoding
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	98
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	99 def open_resource(package, name):
50925 d718eddf01d9 safehasattr: drop usage in favor of hasattr Pierre-Yves David <pierre-yves.david@octobus.net> parents: 50753 diff changeset	100 if hasattr(resources, 'files'):
49943 330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	101 return (
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	102 resources.files( # pytype: disable=module-attr
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	103 pycompat.sysstr(package)
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	104 )
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	105 .joinpath(pycompat.sysstr(name))
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	106 .open('rb')
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	107 )
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	108 else:
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	109 return resources.open_binary( # pytype: disable=module-attr
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	110 pycompat.sysstr(package), pycompat.sysstr(name)
330d88217b83 resourceutil: start using importlib.resources.files() when possible Anton Shestakov <av6@dwimlabs.net> parents: 49074 diff changeset	111 )
47860 08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	112
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	113 def is_resource(package, name):
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	114 return resources.is_resource( # pytype: disable=module-attr
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	115 pycompat.sysstr(package), encoding.strfromlocal(name)
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	116 )
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	117
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	118 def contents(package):
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	119 # pytype: disable=module-attr
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	120 for r in resources.contents(pycompat.sysstr(package)):
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	121 # pytype: enable=module-attr
08f16b3331df resources: narrow the try:except clause to minimum Pierre-Yves David <pierre-yves.david@octobus.net> parents: 47858 diff changeset	122 yield encoding.strtolocal(r)

Mercurial > public > mercurial-scm > hg

annotate mercurial/utils/resourceutil.py @ 52106:c5d6a66092e8 stable