Skip to content

Commit

Permalink
gh-93461: Invalidate sys.path_importer_cache entries with relative pa…
Browse files Browse the repository at this point in the history
…ths (GH-93653)

(cherry picked from commit 09243b8)

Co-authored-by: Christian Heimes <christian@python.org>
  • Loading branch information
miss-islington and tiran committed Jun 13, 2022
1 parent 536af65 commit 3d1c080
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 14 deletions.
13 changes: 9 additions & 4 deletions Lib/importlib/_bootstrap_external.py
Original file line number Diff line number Diff line change
Expand Up @@ -1394,7 +1394,9 @@ def invalidate_caches():
"""Call the invalidate_caches() method on all path entry finders
stored in sys.path_importer_caches (where implemented)."""
for name, finder in list(sys.path_importer_cache.items()):
if finder is None:
# Drop entry if finder name is a relative path. The current
# working directory may have changed.
if finder is None or not _path_isabs(name):
del sys.path_importer_cache[name]
elif hasattr(finder, 'invalidate_caches'):
finder.invalidate_caches()
Expand Down Expand Up @@ -1562,9 +1564,12 @@ def __init__(self, path, *loader_details):
loaders.extend((suffix, loader) for suffix in suffixes)
self._loaders = loaders
# Base (directory) path
self.path = path or '.'
if not _path_isabs(self.path):
self.path = _path_join(_os.getcwd(), self.path)
if not path or path == '.':
self.path = _os.getcwd()
elif not _path_isabs(path):
self.path = _path_join(_os.getcwd(), path)
else:
self.path = path
self._path_mtime = -1
self._path_cache = set()
self._relaxed_path_cache = set()
Expand Down
14 changes: 7 additions & 7 deletions Lib/test/test_import/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -927,15 +927,15 @@ def test_missing_source_legacy(self):
m = __import__(TESTFN)
try:
self.assertEqual(m.__file__,
os.path.join(os.getcwd(), os.curdir, os.path.relpath(pyc_file)))
os.path.join(os.getcwd(), os.path.relpath(pyc_file)))
finally:
os.remove(pyc_file)

def test___cached__(self):
# Modules now also have an __cached__ that points to the pyc file.
m = __import__(TESTFN)
pyc_file = importlib.util.cache_from_source(TESTFN + '.py')
self.assertEqual(m.__cached__, os.path.join(os.getcwd(), os.curdir, pyc_file))
self.assertEqual(m.__cached__, os.path.join(os.getcwd(), pyc_file))

@skip_if_dont_write_bytecode
def test___cached___legacy_pyc(self):
Expand All @@ -951,7 +951,7 @@ def test___cached___legacy_pyc(self):
importlib.invalidate_caches()
m = __import__(TESTFN)
self.assertEqual(m.__cached__,
os.path.join(os.getcwd(), os.curdir, os.path.relpath(pyc_file)))
os.path.join(os.getcwd(), os.path.relpath(pyc_file)))

@skip_if_dont_write_bytecode
def test_package___cached__(self):
Expand All @@ -971,10 +971,10 @@ def cleanup():
m = __import__('pep3147.foo')
init_pyc = importlib.util.cache_from_source(
os.path.join('pep3147', '__init__.py'))
self.assertEqual(m.__cached__, os.path.join(os.getcwd(), os.curdir, init_pyc))
self.assertEqual(m.__cached__, os.path.join(os.getcwd(), init_pyc))
foo_pyc = importlib.util.cache_from_source(os.path.join('pep3147', 'foo.py'))
self.assertEqual(sys.modules['pep3147.foo'].__cached__,
os.path.join(os.getcwd(), os.curdir, foo_pyc))
os.path.join(os.getcwd(), foo_pyc))

def test_package___cached___from_pyc(self):
# Like test___cached__ but ensuring __cached__ when imported from a
Expand All @@ -998,10 +998,10 @@ def cleanup():
m = __import__('pep3147.foo')
init_pyc = importlib.util.cache_from_source(
os.path.join('pep3147', '__init__.py'))
self.assertEqual(m.__cached__, os.path.join(os.getcwd(), os.curdir, init_pyc))
self.assertEqual(m.__cached__, os.path.join(os.getcwd(), init_pyc))
foo_pyc = importlib.util.cache_from_source(os.path.join('pep3147', 'foo.py'))
self.assertEqual(sys.modules['pep3147.foo'].__cached__,
os.path.join(os.getcwd(), os.curdir, foo_pyc))
os.path.join(os.getcwd(), foo_pyc))

def test_recompute_pyc_same_second(self):
# Even when the source file doesn't change timestamp, a change in
Expand Down
15 changes: 13 additions & 2 deletions Lib/test/test_importlib/import_/test_path.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,10 +202,11 @@ def __init__(self):
def invalidate_caches(self):
self.called = True

cache = {'leave_alone': object(), 'finder_to_invalidate': FakeFinder()}
key = os.path.abspath('finder_to_invalidate')
cache = {'leave_alone': object(), key: FakeFinder()}
with util.import_state(path_importer_cache=cache):
self.machinery.PathFinder.invalidate_caches()
self.assertTrue(cache['finder_to_invalidate'].called)
self.assertTrue(cache[key].called)

def test_invalidate_caches_clear_out_None(self):
# Clear out None in sys.path_importer_cache() when invalidating caches.
Expand All @@ -214,6 +215,16 @@ def test_invalidate_caches_clear_out_None(self):
self.machinery.PathFinder.invalidate_caches()
self.assertEqual(len(cache), 0)

def test_invalidate_caches_clear_out_relative_path(self):
class FakeFinder:
def invalidate_caches(self):
pass

cache = {'relative_path': FakeFinder()}
with util.import_state(path_importer_cache=cache):
self.machinery.PathFinder.invalidate_caches()
self.assertEqual(cache, {})


class FindModuleTests(FinderTests):
def find(self, *args, **kwargs):
Expand Down
2 changes: 1 addition & 1 deletion Lib/test/test_importlib/test_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ def find_module(self, *args):
def invalidate_caches(self):
self.called = True

key = 'gobledeegook'
key = os.path.abspath('gobledeegook')
meta_ins = InvalidatingNullFinder()
path_ins = InvalidatingNullFinder()
sys.meta_path.insert(0, meta_ins)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:func:`importlib.invalidate_caches` now drops entries from
:data:`sys.path_importer_cache` with a relative path as name. This solves a
caching issue when a process changes its current working directory.

``FileFinder`` no longer inserts a dot in the path, e.g.
``/egg/./spam`` is now ``/egg/spam``.

0 comments on commit 3d1c080

Please sign in to comment.