fix: setuptools support (#6)

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

.pre-commit-config.yaml

@@ -48,9 +48,10 @@ repos:
     rev: "v1.1.1"
     hooks:
       - id: mypy
-        files: src
+        files: src|tests
         args: []
-        additional_dependencies: ["tomli", "pathspec", "importlib-resources"]
+        additional_dependencies:
+          ["tomli", "pathspec", "importlib-resources", "pytest"]
 
   - repo: https://github.com/henryiii/check-sdist
     rev: "v0.1.0"

pyproject.toml

@@ -71,13 +71,20 @@ testpaths = [
 
 
 [tool.mypy]
-files = "src"
+files = ["src", "tests"]
 python_version = "3.8"
 warn_unused_configs = true
 strict = true
 show_error_codes = true
 enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
 warn_unreachable = true
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+
+[[tool.mypy.overrides]]
+module = "check_sdist.*"
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
 
 
 [tool.ruff]

src/check_sdist/__main__.py

@@ -13,7 +13,7 @@
 from .sdist import sdist_files
 
 
-def compare(source_dir: Path, isolated: bool, verbose: bool = False) -> int:
+def compare(source_dir: Path, *, isolated: bool, verbose: bool = False) -> int:
     """
     Compare the files in the SDist with the files tracked by git.
 
@@ -41,6 +41,7 @@ def compare(source_dir: Path, isolated: bool, verbose: bool = False) -> int:
     if default_ignore:
         with resources.joinpath("default-ignore.txt").open("r", encoding="utf-8") as f:
             git_only_patterns.extend(f.read().splitlines())
+        sdist_only_patterns.extend("*.dist-info")
 
     sdist_spec = pathspec.GitIgnoreSpec.from_lines(sdist_only_patterns)
     git_spec = pathspec.GitIgnoreSpec.from_lines(git_only_patterns)
@@ -99,7 +100,9 @@ def main() -> None:
         if args.inject_junk:
             stack.enter_context(inject_junk_files(args.source_dir))
 
-    raise SystemExit(compare(args.source_dir, not args.no_isolation, args.verbose))
+    raise SystemExit(
+        compare(args.source_dir, isolated=not args.no_isolation, verbose=args.verbose)
+    )
 
 
 if __name__ == "__main__":

src/check_sdist/resources/default-ignore.txt

@@ -4,3 +4,4 @@
 noxfile.py
 .coverage
 codecov.yml
+*.dist-info

src/check_sdist/sdist.py

@@ -23,7 +23,9 @@ def sdist_files(source_dir: Path, isolated: bool) -> frozenset[str]:
             if len(prefixes) != 1:
                 msg = f"malformted SDist, contains multiple packages {prefixes}"
                 raise AssertionError(msg)
-            return frozenset(n.split("/", maxsplit=1)[1] for n in tar.getnames())
+            return frozenset(
+                t.name.split("/", maxsplit=1)[1] for t in tar.getmembers() if t.isfile()
+            )
 
 
 if __name__ == "__main__":

tests/downstream.toml

@@ -0,0 +1,23 @@
+[[packages]]
+repo = "pypa/build"
+ref = "0.10.0"
+fail = 2
+
+[[packages]]
+repo = "FriedrichFroebel/pelican-youtube-thumbnails"
+ref = "0.3.2"
+fail = 2
+
+[[packages]]
+repo = "pypa/setuptools"
+ref = "v67.6.1"
+fail = 2
+
+[[packages]]
+repo = "scikit-build/scikit-build-core"
+ref = "v0.2.1"
+
+[[packages]]
+repo = "pybind/pybind11"
+ref = "v2.10.3"
+fail = 2

tests/test_downstream.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+import subprocess
+from pathlib import Path
+
+import pytest
+
+from check_sdist.__main__ import compare
+from check_sdist._compat import tomllib
+
+DIR = Path(__file__).parent.resolve()
+
+with DIR.joinpath("downstream.toml").open("rb") as f:
+    packages = tomllib.load(f)["packages"]
+
+
+@pytest.mark.parametrize(
+    ("repo", "ref", "fail"), [(x["repo"], x["ref"], x.get("fail", 0)) for x in packages]
+)
+def test_packages(repo, ref, fail, tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    subprocess.run(
+        ["git", "clone", f"https://github.com/{repo}", "--branch", ref], check=True
+    )
+    package_path = tmp_path / repo.split("/")[1]
+    assert compare(package_path, isolated=True) == fail

tests/test_package.py

@@ -16,14 +16,14 @@ def get_all_files(path: Path) -> frozenset[str]:
 
 def test_self_dir():
     start = get_all_files(DIR.parent)
-    assert compare(DIR.parent, True) == 0
+    assert compare(DIR.parent, isolated=True) == 0
     end = get_all_files(DIR.parent)
     assert start == end
 
 
 def test_self_dir_injected():
     start = get_all_files(DIR.parent)
     with inject_junk_files(DIR.parent):
-        assert compare(DIR.parent, True) == 0
+        assert compare(DIR.parent, isolated=True) == 0
     end = get_all_files(DIR.parent)
     assert start == end