Merge pull request #2 from python-project-templates/tkp/t

Add defaults from copier templates

Author: timkpaine

check_dist/__init__.py

@@ -7,11 +7,13 @@
     check_present,
     check_sdist_vs_vcs,
     check_wrong_platform_extensions,
+    copier_defaults,
     find_dist_files,
     get_vcs_files,
     list_sdist_files,
     list_wheel_files,
     load_config,
+    load_copier_config,
     load_hatch_config,
     matches_pattern,
     translate_extension,

check_dist/_core.py

@@ -4,13 +4,16 @@
 
 import fnmatch
 import os
+import re
 import subprocess
 import sys
 import tarfile
 import tempfile
 import zipfile
 from pathlib import Path
 
+import yaml
+
 if sys.version_info >= (3, 11):
     import tomllib
 else:
@@ -65,20 +68,42 @@ def _wrong_platform_extensions() -> list[str]:
     return list(mapping.keys())
 
 
-def load_config(pyproject_path: str | Path = "pyproject.toml") -> dict:
-    """Load ``[tool.check-dist]`` configuration from *pyproject.toml*."""
+def load_config(pyproject_path: str | Path = "pyproject.toml", *, source_dir: str | Path | None = None) -> dict:
+    """Load ``[tool.check-dist]`` configuration from *pyproject.toml*.
+
+    If no ``[tool.check-dist]`` section exists and *source_dir* contains a
+    ``.copier-answers.yaml`` with an ``add_extension`` key, sensible
+    defaults are derived from the copier template answers.
+    """
     path = Path(pyproject_path)
+    empty = {
+        "sdist": {"present": [], "absent": []},
+        "wheel": {"present": [], "absent": []},
+    }
     if not path.exists():
-        return {
-            "all": {"present": [], "absent": []},
-            "sdist": {"present": [], "absent": []},
-            "wheel": {"present": [], "absent": []},
-        }
+        # No pyproject.toml at all — try copier defaults
+        if source_dir is not None:
+            copier_cfg = load_copier_config(source_dir)
+            defaults = copier_defaults(copier_cfg)
+            if defaults is not None:
+                return defaults
+        return empty
 
     with open(path, "rb") as f:
         config = tomllib.load(f)
 
     cd = config.get("tool", {}).get("check-dist", {})
+
+    # If there's no [tool.check-dist] section at all, try copier defaults
+    if not cd:
+        if source_dir is None:
+            source_dir = path.parent
+        copier_cfg = load_copier_config(source_dir)
+        defaults = copier_defaults(copier_cfg)
+        if defaults is not None:
+            return defaults
+        return empty
+
     base_present = cd.get("present", [])
     base_absent = cd.get("absent", [])
     sdist_cfg = cd.get("sdist", {})
@@ -108,6 +133,118 @@ def load_hatch_config(pyproject_path: str | Path = "pyproject.toml") -> dict:
     return config.get("tool", {}).get("hatch", {}).get("build", {})
 
 
+# ── Copier template defaults ─────────────────────────────────────────
+
+# Per-extension type defaults for sdist/wheel present/absent patterns.
+# Keys follow the ``add_extension`` value in ``.copier-answers.yaml``.
+_EXTENSION_DEFAULTS: dict[str, dict] = {
+    "cpp": {
+        "sdist_present_extra": ["cpp"],
+        "sdist_absent_extra": [".clang-format"],
+        "wheel_absent_extra": ["cpp"],
+    },
+    "rust": {
+        "sdist_present_extra": ["rust", "src", "Cargo.toml", "Cargo.lock"],
+        "sdist_absent_extra": [".gitattributes", "target"],
+        "wheel_absent_extra": ["rust", "src", "Cargo.toml"],
+    },
+    "js": {
+        "sdist_present_extra": ["js"],
+        "sdist_absent_extra": [".gitattributes", ".vscode"],
+        "wheel_absent_extra": ["js"],
+    },
+    "jupyter": {
+        "sdist_present_extra": ["js"],
+        "sdist_absent_extra": [".gitattributes", ".vscode"],
+        "wheel_absent_extra": ["js"],
+    },
+    "rustjswasm": {
+        "sdist_present_extra": ["js", "rust", "src", "Cargo.toml", "Cargo.lock"],
+        "sdist_absent_extra": [".gitattributes", ".vscode", "target"],
+        "wheel_absent_extra": ["js", "rust", "src", "Cargo.toml"],
+    },
+    "cppjswasm": {
+        "sdist_present_extra": ["cpp", "js"],
+        "sdist_absent_extra": [".clang-format", ".vscode"],
+        "wheel_absent_extra": ["js", "cpp"],
+    },
+    "python": {
+        "sdist_present_extra": [],
+        "sdist_absent_extra": [],
+        "wheel_absent_extra": [],
+    },
+}
+
+# Common patterns shared across all extension types.
+_COMMON_SDIST_PRESENT = ["LICENSE", "pyproject.toml", "README.md"]
+_COMMON_SDIST_ABSENT = [
+    ".copier-answers.yaml",
+    "Makefile",
+    ".github",
+    "dist",
+    "docs",
+    "examples",
+    "tests",
+]
+_COMMON_WHEEL_ABSENT = [
+    ".gitignore",
+    ".copier-answers.yaml",
+    "Makefile",
+    "pyproject.toml",
+    ".github",
+    "dist",
+    "docs",
+    "examples",
+    "tests",
+]
+
+
+def load_copier_config(source_dir: str | Path) -> dict:
+    """Load ``.copier-answers.yaml`` from *source_dir*, if it exists."""
+    path = Path(source_dir) / ".copier-answers.yaml"
+    if not path.exists():
+        return {}
+    with open(path) as f:
+        return yaml.safe_load(f) or {}
+
+
+def _module_name_from_project(project_name: str) -> str:
+    """Convert a human project name to a Python module name.
+
+    Replaces spaces and hyphens with underscores.
+    """
+    return re.sub(r"[\s-]+", "_", project_name).strip("_")
+
+
+def copier_defaults(copier_config: dict) -> dict | None:
+    """Derive default check-dist config from copier answers.
+
+    Returns a config dict with the same shape as ``load_config`` output,
+    or ``None`` if deriving defaults is not possible (no ``add_extension``
+    key, or unknown extension type).
+    """
+    extension = copier_config.get("add_extension")
+    project_name = copier_config.get("project_name")
+    if not extension or not project_name:
+        return None
+
+    ext_defaults = _EXTENSION_DEFAULTS.get(extension)
+    if ext_defaults is None:
+        return None
+
+    module = _module_name_from_project(project_name)
+
+    sdist_present = [module, *ext_defaults.get("sdist_present_extra", []), *_COMMON_SDIST_PRESENT]
+    sdist_absent = [*_COMMON_SDIST_ABSENT, *ext_defaults.get("sdist_absent_extra", [])]
+    wheel_present = [module]
+    wheel_absent = [*_COMMON_WHEEL_ABSENT, *ext_defaults.get("wheel_absent_extra", [])]
+
+    return {
+        "sdist": {"present": sdist_present, "absent": sdist_absent},
+        "wheel": {"present": wheel_present, "absent": wheel_absent},
+    }
+
+
 # ── Building ──────────────────────────────────────────────────────────
 
 
@@ -381,6 +518,7 @@ def check_sdist_vs_vcs(
     sdist_files: list[str],
     vcs_files: list[str],
     hatch_config: dict,
+    sdist_absent: list[str] | None = None,
 ) -> list[str]:
     """Compare sdist contents against VCS-tracked files."""
     errors: list[str] = []
@@ -404,11 +542,19 @@ def check_sdist_vs_vcs(
     missing = sorted(expected - sdist_set)
     # Filter common non-issues (dotfiles like .gitattributes)
     missing = [f for f in missing if not f.startswith(".")]
+    # Filter files that match the user's sdist absent patterns —
+    # if a file is explicitly expected to be absent, it's not "missing".
+    # Always include the common absent patterns (docs, tests, etc.) since
+    # most build systems exclude these from sdists.
+    all_absent = list(_COMMON_SDIST_ABSENT)
+    if sdist_absent:
+        all_absent.extend(sdist_absent)
+    missing = [f for f in missing if not any(matches_pattern(f, pat) for pat in all_absent)]
 
     if extra:
-        errors.append(f"sdist contains files not tracked by VCS: {', '.join(extra)}")
+        errors.append("\nsdist contains files not tracked by VCS:\n\t" + "\n\t".join(extra))
     if missing:
-        errors.append(f"VCS-tracked files missing from sdist: {', '.join(missing)}")
+        errors.append("\nVCS-tracked files missing from sdist: \n\t" + "\n\t".join(missing))
     return errors
 
 
@@ -444,7 +590,7 @@ def check_dist(
     source_dir = os.path.abspath(source_dir)
 
     pyproject_path = os.path.join(source_dir, "pyproject.toml")
-    config = load_config(pyproject_path)
+    config = load_config(pyproject_path, source_dir=source_dir)
     hatch_config = load_hatch_config(pyproject_path)
 
     if pre_built is not None:
@@ -483,7 +629,7 @@ def check_dist(
 
             try:
                 vcs_files = get_vcs_files(source_dir)
-                errors.extend(check_sdist_vs_vcs(sdist_files, vcs_files, hatch_config))
+                errors.extend(check_sdist_vs_vcs(sdist_files, vcs_files, hatch_config, sdist_absent=config["sdist"]["absent"]))
             except CheckDistError as exc:
                 messages.append(f"  Warning: could not compare against VCS: {exc}")
 

check_dist/tests/test_all.py

@@ -16,17 +16,20 @@
 from check_dist._core import (
     CheckDistError,
     _matches_hatch_pattern,
+    _module_name_from_project,
     _sdist_expected_files,
     check_absent,
     check_dist,
     check_present,
     check_sdist_vs_vcs,
     check_wrong_platform_extensions,
+    copier_defaults,
     find_dist_files,
     get_vcs_files,
     list_sdist_files,
     list_wheel_files,
     load_config,
+    load_copier_config,
     load_hatch_config,
     matches_pattern,
     translate_extension,
@@ -424,6 +427,107 @@ def test_valid_config(self, tmp_path):
         assert cfg["targets"]["sdist"]["packages"] == ["mylib"]
 
 
+# ── Copier defaults ──────────────────────────────────────────────────
+
+
+class TestModuleNameFromProject:
+    def test_spaces(self):
+        assert _module_name_from_project("python template js") == "python_template_js"
+
+    def test_hyphens(self):
+        assert _module_name_from_project("my-project") == "my_project"
+
+    def test_mixed(self):
+        assert _module_name_from_project("python template-rust") == "python_template_rust"
+
+    def test_no_change(self):
+        assert _module_name_from_project("mypkg") == "mypkg"
+
+
+class TestLoadCopierConfig:
+    def test_missing_file(self, tmp_path):
+        assert load_copier_config(tmp_path) == {}
+
+    def test_valid_file(self, tmp_path):
+        (tmp_path / ".copier-answers.yaml").write_text("add_extension: rust\nproject_name: my project\n")
+        cfg = load_copier_config(tmp_path)
+        assert cfg["add_extension"] == "rust"
+        assert cfg["project_name"] == "my project"
+
+
+class TestCopierDefaults:
+    def test_cpp(self):
+        cfg = copier_defaults({"add_extension": "cpp", "project_name": "python template cpp"})
+        assert cfg is not None
+        assert "python_template_cpp" in cfg["sdist"]["present"]
+        assert "cpp" in cfg["sdist"]["present"]
+        assert ".clang-format" in cfg["sdist"]["absent"]
+        assert "cpp" in cfg["wheel"]["absent"]
+
+    def test_rust(self):
+        cfg = copier_defaults({"add_extension": "rust", "project_name": "python template rust"})
+        assert cfg is not None
+        assert "Cargo.toml" in cfg["sdist"]["present"]
+        assert "rust" in cfg["sdist"]["present"]
+        assert "target" in cfg["sdist"]["absent"]
+
+    def test_js(self):
+        cfg = copier_defaults({"add_extension": "js", "project_name": "python template js"})
+        assert cfg is not None
+        assert "js" in cfg["sdist"]["present"]
+        assert "js" in cfg["wheel"]["absent"]
+
+    def test_unknown_extension(self):
+        assert copier_defaults({"add_extension": "unknown", "project_name": "foo"}) is None
+
+    def test_no_extension(self):
+        assert copier_defaults({"project_name": "foo"}) is None
+
+    def test_no_project_name(self):
+        assert copier_defaults({"add_extension": "cpp"}) is None
+
+    def test_common_patterns_present(self):
+        cfg = copier_defaults({"add_extension": "cpp", "project_name": "foo"})
+        assert "LICENSE" in cfg["sdist"]["present"]
+        assert "pyproject.toml" in cfg["sdist"]["present"]
+        assert ".copier-answers.yaml" in cfg["sdist"]["absent"]
+        assert ".github" in cfg["sdist"]["absent"]
+        assert ".gitignore" in cfg["wheel"]["absent"]
+        assert "pyproject.toml" in cfg["wheel"]["absent"]
+
+
+class TestLoadConfigWithCopierFallback:
+    def test_no_check_dist_section_uses_copier(self, tmp_path):
+        """When pyproject.toml has no [tool.check-dist], copier defaults apply."""
+        toml = tmp_path / "pyproject.toml"
+        toml.write_text("[project]\nname = 'foo'\n")
+        (tmp_path / ".copier-answers.yaml").write_text("add_extension: rust\nproject_name: my project\n")
+        cfg = load_config(toml, source_dir=tmp_path)
+        assert "my_project" in cfg["sdist"]["present"]
+        assert "rust" in cfg["sdist"]["present"]
+
+    def test_explicit_config_takes_precedence(self, tmp_path):
+        """When [tool.check-dist] exists, copier defaults are ignored."""
+        toml = tmp_path / "pyproject.toml"
+        toml.write_text(
+            textwrap.dedent("""\
+            [tool.check-dist.sdist]
+            present = ["custom"]
+        """)
+        )
+        (tmp_path / ".copier-answers.yaml").write_text("add_extension: rust\nproject_name: my project\n")
+        cfg = load_config(toml, source_dir=tmp_path)
+        assert cfg["sdist"]["present"] == ["custom"]
+        assert "rust" not in cfg["sdist"]["present"]
+
+    def test_no_copier_file_returns_empty(self, tmp_path):
+        toml = tmp_path / "pyproject.toml"
+        toml.write_text("[project]\nname = 'foo'\n")
+        cfg = load_config(toml, source_dir=tmp_path)
+        assert cfg["sdist"]["present"] == []
+        assert cfg["wheel"]["present"] == []
+
+
 # ── list_sdist_files ──────────────────────────────────────────────────