Fix: Using --import-mode=importlib, a directory with the same name …

…in the namespace package causes a KeyError.（pytest-dev#12592）

changelog/12592.bugfix.rst

@@ -0,0 +1 @@
+Fixed the issue of  causes ``KeyError`` when using the parameter ``--import-mode=importlib`` in pytest>=8.2 .

src/_pytest/pathlib.py

@@ -614,6 +614,71 @@ def _import_module_using_spec(
     Tries to import a module by its canonical name, path to the .py file, and its
     parent location.
 
+    :param insert_modules:
+        If True, will call insert_missing_modules to create empty intermediate modules
+        for made-up module names (when importing test files not reachable from sys.path).
+    """
+    # Attempt to import the parent module, seems is our responsibility:
+    # https://github.com/python/cpython/blob/73906d5c908c1e0b73c5436faeff7d93698fc074/Lib/importlib/_bootstrap.py#L1308-L1311
+    parent_module_name, _, name = module_name.rpartition(".")
+    parent_module: ModuleType | None = None
+    if parent_module_name:
+        parent_module = sys.modules.get(parent_module_name)
+        if parent_module is None:
+            if (module_path.parent / "__init__.py").is_file():
+                parent_module_location = module_location
+            else:
+                parent_module_location = module_location.parent
+
+            if module_path.name == "__init__.py":
+                parent_module_path = module_path.parent.parent
+            else:
+                parent_module_path = module_path.parent
+
+            # Consider the parent module path as its __init__.py file, if it has one.
+            if (parent_module_path / "__init__.py").is_file():
+                parent_module_path = parent_module_path / "__init__.py"
+
+            parent_module = _import_module_using_spec(
+                parent_module_name,
+                parent_module_path,
+                parent_module_location,
+                insert_modules=insert_modules,
+            )
+
+    # Checking with sys.meta_path first in case one of its hooks can import this module,
+    # such as our own assertion-rewrite hook.
+    for meta_importer in sys.meta_path:
+        spec = meta_importer.find_spec(module_name, [str(module_location)])
+        if spec_matches_module_path(spec, module_path):
+            break
+    else:
+        spec = importlib.util.spec_from_file_location(module_name, str(module_path))
+
+    if spec_matches_module_path(spec, module_path):
+        assert spec is not None
+        # Find spec and import this module.
+        mod = importlib.util.module_from_spec(spec)
+        sys.modules[module_name] = mod
+        spec.loader.exec_module(mod)  # type: ignore[union-attr]
+
+        # Set this module as an attribute of the parent module (#12194).
+        if parent_module is not None:
+            setattr(parent_module, name, mod)
+
+        if insert_modules:
+            insert_missing_modules(sys.modules, module_name)
+        return mod
+    return None
+
+
+def _import_module_using_spec_origin(
+    module_name: str, module_path: Path, module_location: Path, *, insert_modules: bool
+) -> ModuleType | None:
+    """
+    Tries to import a module by its canonical name, path to the .py file, and its
+    parent location.
+
     :param insert_modules:
         If True, will call insert_missing_modules to create empty intermediate modules
         for made-up module names (when importing test files not reachable from sys.path).
@@ -629,6 +694,15 @@ def _import_module_using_spec(
 
     if spec_matches_module_path(spec, module_path):
         assert spec is not None
+
+        # Find spec and import this module.
+        mod = importlib.util.module_from_spec(spec)
+        sys.modules[module_name] = mod
+        spec.loader.exec_module(mod)  # type: ignore[union-attr]
+
+        if insert_modules:
+            insert_missing_modules(sys.modules, module_name)
+
         # Attempt to import the parent module, seems is our responsibility:
         # https://github.com/python/cpython/blob/73906d5c908c1e0b73c5436faeff7d93698fc074/Lib/importlib/_bootstrap.py#L1308-L1311
         parent_module_name, _, name = module_name.rpartition(".")
@@ -655,28 +729,30 @@ def _import_module_using_spec(
                     insert_modules=insert_modules,
                 )
 
-        # Find spec and import this module.
-        mod = importlib.util.module_from_spec(spec)
-        sys.modules[module_name] = mod
-        spec.loader.exec_module(mod)  # type: ignore[union-attr]
-
         # Set this module as an attribute of the parent module (#12194).
         if parent_module is not None:
             setattr(parent_module, name, mod)
-
-        if insert_modules:
-            insert_missing_modules(sys.modules, module_name)
         return mod
 
     return None
 
 
 def spec_matches_module_path(module_spec: ModuleSpec | None, module_path: Path) -> bool:
     """Return true if the given ModuleSpec can be used to import the given module path."""
-    if module_spec is None or module_spec.origin is None:
+    if module_spec is None:
         return False
 
-    return Path(module_spec.origin) == module_path
+    if module_spec.origin:
+        return Path(module_spec.origin) == module_path
+
+    # If this is a namespace package, compare the path with the `module_spec.submodule_Search_Locations`
+    # https://docs.python.org/zh-cn/3/library/importlib.html#importlib.machinery.ModuleSpec.submodule_search_locations
+    if module_spec.submodule_search_locations:
+        for _path in module_spec.submodule_search_locations:
+            if Path(_path) == module_path:
+                return True
+
+    return False
 
 
 # Implement a special _is_same function on Windows which returns True if the two filenames

testing/test_pathlib.py

@@ -1505,6 +1505,44 @@ def test_full_ns_packages_without_init_files(
             tmp_path / "src/dist2/ns/a/core/foo/m.py", consider_namespace_packages=True
         ) == (tmp_path / "src/dist2", "ns.a.core.foo.m")
 
+    def test_ns_multiple_levels_import_same_name_directory(
+        self,
+        tmp_path: Path,
+        monkeypatch: MonkeyPatch,
+        pytester: Pytester,
+    ) -> None:
+        """Check KeyError with `--import-mode=importlib` (#12592)."""
+        self.setup_directories(tmp_path, monkeypatch, pytester)
+        code = dedent("""
+        def test():
+            assert "four lights" == "five lights"
+        """)
+
+        # a subdirectories with the same name in the namespace package,
+        # along with a tests file
+        test_base_path = tmp_path / "src/dist2/com/company"
+        test_py = test_base_path / "a/b/c/test_demo.py"
+        test_dir = test_base_path / "a/b/c/c"
+
+        test_dir.mkdir(parents=True)
+        test_py.write_text(code, encoding="UTF-8")
+
+        pkg_root, module_name = resolve_pkg_root_and_module_name(
+            test_py, consider_namespace_packages=True
+        )
+        assert (pkg_root, module_name) == (
+            tmp_path / "src/dist2",
+            "com.company.a.b.c.test_demo",
+        )
+
+        result = pytester.runpytest("--import-mode=importlib", test_py)
+
+        result.stdout.no_fnmatch_line(
+            "E   KeyError: 'test_ns_multiple_levels_import1.src.dist2.com.company.a.b'"
+        )
+
+        assert "KeyError" not in result.stdout.str()
+
 
 def test_is_importable(pytester: Pytester) -> None:
     pytester.syspathinsert()