Skip to content

Commit

Permalink
pythongh-114763: Protect lazy loading modules from attribute access race
Browse files Browse the repository at this point in the history
  • Loading branch information
effigies committed Feb 5, 2024
1 parent 87cd20a commit d57f4eb
Showing 1 changed file with 47 additions and 30 deletions.
77 changes: 47 additions & 30 deletions Lib/importlib/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,36 +171,49 @@ class _LazyModule(types.ModuleType):

def __getattribute__(self, attr):
"""Trigger the load of the module and return the attribute."""
# All module metadata must be garnered from __spec__ in order to avoid
# using mutated values.
# Stop triggering this method.
self.__class__ = types.ModuleType
# Get the original name to make sure no object substitution occurred
# in sys.modules.
original_name = self.__spec__.name
# Figure out exactly what attributes were mutated between the creation
# of the module and now.
attrs_then = self.__spec__.loader_state['__dict__']
attrs_now = self.__dict__
attrs_updated = {}
for key, value in attrs_now.items():
# Code that set the attribute may have kept a reference to the
# assigned object, making identity more important than equality.
if key not in attrs_then:
attrs_updated[key] = value
elif id(attrs_now[key]) != id(attrs_then[key]):
attrs_updated[key] = value
self.__spec__.loader.exec_module(self)
# If exec_module() was used directly there is no guarantee the module
# object was put into sys.modules.
if original_name in sys.modules:
if id(self) != id(sys.modules[original_name]):
raise ValueError(f"module object for {original_name!r} "
"substituted in sys.modules during a lazy "
"load")
# Update after loading since that's what would happen in an eager
# loading situation.
self.__dict__.update(attrs_updated)
__spec__ = object.__getattribute__(self, '__spec__')
loader_state = __spec__.loader_state
with loader_state['lock']:
if object.__getattribute__(self, '__class__') is _LazyModule:
# exec_module() will access dunder attributes, so we use a reentrant
# lock and an event to prevent infinite recursion.
if loader_state['is_loading'].is_set() and attr[:2] == attr[-2:] == '__':
return object.__getattribute__(self, attr)
loader_state['is_loading'].set()

__dict__ = object.__getattribute__(self, '__dict__')

# All module metadata must be garnered from __spec__ in order to avoid
# using mutated values.
# Get the original name to make sure no object substitution occurred
# in sys.modules.
original_name = __spec__.name
# Figure out exactly what attributes were mutated between the creation
# of the module and now.
attrs_then = loader_state['__dict__']
attrs_now = __dict__
attrs_updated = {}
for key, value in attrs_now.items():
# Code that set the attribute may have kept a reference to the
# assigned object, making identity more important than equality.
if key not in attrs_then:
attrs_updated[key] = value
elif id(attrs_now[key]) != id(attrs_then[key]):
attrs_updated[key] = value
__spec__.loader.exec_module(self)
# If exec_module() was used directly there is no guarantee the module
# object was put into sys.modules.
if original_name in sys.modules:
if id(self) != id(sys.modules[original_name]):
raise ValueError(f"module object for {original_name!r} "
"substituted in sys.modules during a lazy "
"load")
# Update after loading since that's what would happen in an eager
# loading situation.
__dict__.update(attrs_updated)
# Finally, stop triggering this method.
self.__class__ = types.ModuleType

return getattr(self, attr)

def __delattr__(self, attr):
Expand Down Expand Up @@ -235,6 +248,8 @@ def create_module(self, spec):

def exec_module(self, module):
"""Make the module load lazily."""
import threading

module.__spec__.loader = self.loader
module.__loader__ = self.loader
# Don't need to worry about deep-copying as trying to set an attribute
Expand All @@ -244,5 +259,7 @@ def exec_module(self, module):
loader_state = {}
loader_state['__dict__'] = module.__dict__.copy()
loader_state['__class__'] = module.__class__
loader_state['lock'] = threading.RLock()
loader_state['is_loading'] = threading.Event()
module.__spec__.loader_state = loader_state
module.__class__ = _LazyModule

0 comments on commit d57f4eb

Please # to comment.