Make sure docstub generated stubs are ignored

when walking a source package.

Author: lagru

src/docstub/_path_utils.py

@@ -222,9 +222,15 @@ def _walk_source_package(path, *, ignore_regex):
 
     elif is_python_or_stub_file(path):
         stub_path = path.with_suffix(".pyi")
-        if stub_path == path or not stub_path.is_file():
-            # If `path` is a stub file return it. If it is a regular Python
-            # file, only return it if no corresponding stub file exists.
+        # We check if a corresponding stub exists (even if  `path` is a stub),
+        # one that isn't generated by docstub itself
+        is_valid_stub = stub_path.is_file() and not is_docstub_generated(stub_path)
+
+        if path != stub_path and not is_valid_stub:
+            # `path` isn't stub and no a stub exists that should take precedence
+            yield path
+        elif path == stub_path and is_valid_stub:
+            # `path` is stub and not generated by docstub
             yield path
 
     elif path.is_dir():

tests/test_path_utils.py

@@ -1,6 +1,6 @@
 import pytest
 
-from docstub._path_utils import walk_source_package
+from docstub._path_utils import STUB_HEADER_COMMENT, walk_source_package
 
 
 class Test_walk_source_package:
@@ -47,6 +47,26 @@ def test_not_a_package(self, tmp_path):
         with pytest.raises(TypeError, match=".* must be a Python file or package"):
             next(walk_source_package(tmp_path))
 
+    def test_single_with_docstub_generated_stub(self, tmp_path):
+        script_py = tmp_path / "script.py"
+        script_py.touch()
+        script_stub = tmp_path / "script.pyi"
+        with script_stub.open("w") as io:
+            io.write(STUB_HEADER_COMMENT)
+
+        paths = sorted(walk_source_package(script_py))
+        assert paths == [script_py]
+
+    def test_package_with_docstub_generated_stub(self, tmp_path):
+        init_py = tmp_path / "__init__.py"
+        init_py.touch()
+        init_stub = tmp_path / "__init__.pyi"
+        with init_stub.open("w") as io:
+            io.write(STUB_HEADER_COMMENT)
+
+        paths = sorted(walk_source_package(tmp_path))
+        assert paths == [init_py]
+
     @pytest.mark.parametrize("name", ["script.py", "script.pyi"])
     def test_ignore_single_file(self, tmp_path, name):
         top_stub = tmp_path / name