lib-detect-testenv 3.0.5__tar.gz → 3.0.6__tar.gz

{lib_detect_testenv-3.0.5 → lib_detect_testenv-3.0.6}/CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.6] 2026-10-15 16:35:25
+
+### Fixed
+
+- The source distribution ships only the package, its tests, its docs, `README.md`, `LICENSE`,
+  `CHANGELOG.md` and `pyproject.toml` (an include list). Earlier sdists also carried every other
+  root file and, in a local build, anything hidden only through `.git/info/exclude` or a nested
+  `.gitignore`. `tests/test_packaging.py` builds the sdist and wheel and checks both; `hatchling`
+  joins the dev extra for it.
+
+### Changed
+
+- Ruff selects `C90` (mccabe), so a function over cyclomatic complexity 10, the house hard limit,
+  now fails `make test`; before, nothing enforced it.
+
+### Tests
+
+- The `os_windows`, `os_macos`, `os_linux` and `os_posix` markers now skip a test off its platform
+  (`pytest_runtest_setup` in `tests/conftest.py`); registered in `pyproject.toml` alone they skipped
+  nothing, so a test trusting its marker ran everywhere. `tests/test_platform_markers.py` pins it.
+
 ## [3.0.5] 2026-10-15 14:11:33
 
 ### Added

{lib_detect_testenv-3.0.5 → lib_detect_testenv-3.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lib_detect_testenv
-Version: 3.0.5
+Version: 3.0.6
 Summary: Detect test environment - pytest, doctest, unittest, or regular execution
 Project-URL: Homepage, https://github.com/bitranox/lib_detect_testenv
 Project-URL: Repository, https://github.com/bitranox/lib_detect_testenv.git
@@ -28,6 +28,7 @@ Requires-Dist: bandit<1.9,>=1.8.6; (python_version < '3.10') and extra == 'dev'
 Requires-Dist: bandit>=1.9.4; (python_version >= '3.10') and extra == 'dev'
 Requires-Dist: build>=1.6.1; extra == 'dev'
 Requires-Dist: click>=8.5.0; extra == 'dev'
+Requires-Dist: hatchling>=1.32.4; extra == 'dev'
 Requires-Dist: import-linter<2.6,>=2.5.2; (python_version < '3.10') and extra == 'dev'
 Requires-Dist: import-linter>=2.15; (python_version >= '3.10') and extra == 'dev'
 Requires-Dist: pip-audit>=2.10.1; extra == 'dev'

{lib_detect_testenv-3.0.5 → lib_detect_testenv-3.0.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lib_detect_testenv"
-version = "3.0.5"
+version = "3.0.6"
 description = "Detect test environment - pytest, doctest, unittest, or regular execution"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -40,6 +40,7 @@ dev = [
   "bandit>=1.8.6,<1.9; python_version<'3.10'",
   "bandit>=1.9.4; python_version>='3.10'",
   "build>=1.6.1",
+  "hatchling>=1.32.4",
   "twine>=7.0.0",
   # codecov-cli is disabled, not dropped: it requires click<8.3.0, which drags click back to
   # 8.2.1 - the version with CVE-2026-7246 (command injection in click.edit(), fixed in 8.3.3).
@@ -71,6 +72,21 @@ build-backend = "hatchling.build"
 packages = ["src/lib_detect_testenv"]
 include = ["src/lib_detect_testenv/py.typed"]
 
+# An allowlist, never a denylist: hatchling reads only the root .gitignore, so tracked working
+# files and files hidden through .git/info/exclude or a nested .gitignore (session records,
+# review notes, helper scripts) would ship. tests/test_packaging.py builds the sdist and
+# refuses any other top-level entry.
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src/lib_detect_testenv",
+    "/tests/*.py",
+    "/docs",
+    "/README.md",
+    "/LICENSE",
+    "/CHANGELOG.md",
+    "/pyproject.toml",
+]
+
 [tool.ruff]
 line-length = 160
 target-version = "py39"
@@ -85,6 +101,7 @@ select = [
   "B",           # bugbear
   "A",           # builtins shadowing
   "C4",          # comprehension simplification
+  "C90",         # mccabe: cyclomatic complexity <= 10 (the house hard limit)
   "SIM",         # simplification
   "TCH",         # type-checking imports
   "RUF",         # ruff-specific

{lib_detect_testenv-3.0.5 → lib_detect_testenv-3.0.6}/src/lib_detect_testenv/__init__conf__.py

@@ -26,7 +26,7 @@ name = "lib_detect_testenv"
 #: Human-readable summary shown in CLI help output.
 title = "Detect test environment - pytest, doctest, unittest, or regular execution"
 #: Current release version pulled from ``pyproject.toml`` by automation.
-version = "3.0.5"
+version = "3.0.6"
 #: Repository homepage presented to users.
 homepage = "https://github.com/bitranox/lib_detect_testenv"
 #: Author attribution surfaced in CLI output.

{lib_detect_testenv-3.0.5 → lib_detect_testenv-3.0.6}/tests/conftest.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import re
+import sys
 from typing import TYPE_CHECKING
 
 import pytest
@@ -48,3 +49,20 @@ def strip_ansi() -> Callable[[str], str]:
         return _remove_ansi_codes(value)
 
     return _strip
+
+
+#: Which platforms each ``os_*`` marker lets a test run on. Registering a marker in pyproject only
+#: silences pytest's unknown-marker warning; without this table a marked test runs everywhere.
+_PLATFORM_MARKERS: dict[str, Callable[[str], bool]] = {
+    "os_windows": lambda platform: platform == "win32",
+    "os_macos": lambda platform: platform == "darwin",
+    "os_linux": lambda platform: platform.startswith("linux"),
+    "os_posix": lambda platform: platform != "win32",
+}
+
+
+def pytest_runtest_setup(item: pytest.Item) -> None:
+    """Skip a test whose ``os_*`` marker names a platform other than the running one."""
+    for name, runs_on in _PLATFORM_MARKERS.items():
+        if item.get_closest_marker(name) is not None and not runs_on(sys.platform):
+            pytest.skip(f"marked {name}; this is {sys.platform}")

lib_detect_testenv-3.0.6/tests/test_packaging.py

@@ -0,0 +1,127 @@
+"""The source distribution carries the package, its tests and its docs, and nothing else.
+
+A working tree holds files that must never be published: session records, backlogs, scratch
+review notes and helper scripts. Some are tracked, some are hidden only through
+``.git/info/exclude`` or a nested ``.gitignore``, which hatchling does not read. The sdist is
+therefore built from an allowlist, and this test builds one from a copy of the tree that also
+holds such decoys. The wheel must still carry the package data the runtime loads.
+"""
+
+from __future__ import annotations
+
+import shutil
+import tarfile
+import zipfile
+from pathlib import Path
+
+import pytest
+from hatchling.builders.sdist import SdistBuilder
+from hatchling.builders.wheel import WheelBuilder
+
+PROJECT_ROOT = Path(__file__).resolve().parent.parent
+PACKAGE = "lib_detect_testenv"
+
+# hatchling force-includes the root .gitignore into every sdist (so a build from the unpacked
+# sdist applies the same exclusions); no include/exclude setting removes it.
+ALLOWED_TOP_LEVEL = frozenset(
+    {
+        "PKG-INFO",
+        "pyproject.toml",
+        "README.md",
+        "LICENSE",
+        "CHANGELOG.md",
+        ".gitignore",
+        "src",
+        "tests",
+        "docs",
+    }
+)
+REQUIRED_TOP_LEVEL = frozenset({"PKG-INFO", "pyproject.toml", "src", "tests"})
+
+# Files and directories that exist in working trees and must never ship. Tracked ones are
+# named in the repository; the others are hidden locally through .git/info/exclude.
+DECOY_FILES = ("handover.md", "OPEN-WORK.md", "EXECUTION-USER-REVIEW.md", "reset_git_history.sh", ".private/notes.txt")
+
+REQUIRED_WHEEL_DATA = ("lib_detect_testenv/py.typed",)
+
+
+def _copy_tree_with_decoys(destination: Path) -> Path:
+    """Copy the buildable tree and plant the files a working tree carries but must not ship."""
+    root = destination / "tree"
+    root.mkdir()
+    for name in ("pyproject.toml", "README.md", "LICENSE", "CHANGELOG.md", ".gitignore"):
+        shutil.copy2(PROJECT_ROOT / name, root / name)
+    for name in ("src", "docs", "tests"):
+        shutil.copytree(PROJECT_ROOT / name, root / name, ignore=shutil.ignore_patterns("__pycache__", "*.pyc"))
+    for decoy in DECOY_FILES:
+        path = root / decoy
+        path.parent.mkdir(parents=True, exist_ok=True)
+        path.write_text("decoy\n", encoding="utf-8")
+    return root
+
+
+def _build_sdist(root: Path, directory: Path) -> Path:
+    built = list(SdistBuilder(str(root)).build(directory=str(directory), versions=["standard"]))
+    assert len(built) == 1, f"expected one sdist, got {built}"
+    return Path(built[0])
+
+
+def _strip_root(names: list[str]) -> list[str]:
+    """Drop the ``<name>-<version>/`` prefix every member carries."""
+    return [name.split("/", 1)[1] for name in names if "/" in name]
+
+
+@pytest.fixture(scope="module")
+def built_tree(tmp_path_factory: pytest.TempPathFactory) -> Path:
+    return _copy_tree_with_decoys(tmp_path_factory.mktemp("packaging"))
+
+
+@pytest.fixture(scope="module")
+def sdist_members(built_tree: Path, tmp_path_factory: pytest.TempPathFactory) -> list[str]:
+    sdist = _build_sdist(built_tree, tmp_path_factory.mktemp("sdist"))
+    with tarfile.open(sdist, "r:gz") as archive:
+        members = _strip_root(archive.getnames())
+    assert members, "the sdist is empty, so nothing below would be judged"
+    return members
+
+
+@pytest.fixture(scope="module")
+def wheel_members(built_tree: Path, tmp_path_factory: pytest.TempPathFactory) -> list[str]:
+    built = list(WheelBuilder(str(built_tree)).build(directory=str(tmp_path_factory.mktemp("wheel")), versions=["standard"]))
+    assert len(built) == 1, f"expected one wheel, got {built}"
+    with zipfile.ZipFile(built[0]) as archive:
+        members = archive.namelist()
+    assert members, "the wheel is empty, so nothing below would be judged"
+    return members
+
+
+@pytest.mark.os_agnostic
+def test_the_sdist_holds_only_allowlisted_top_level_entries(sdist_members: list[str]) -> None:
+    top_level = {member.split("/", 1)[0] for member in sdist_members}
+
+    unexpected = sorted(top_level - ALLOWED_TOP_LEVEL)
+    missing = sorted(REQUIRED_TOP_LEVEL - top_level)
+
+    assert not unexpected, f"the sdist ships files outside the allowlist: {unexpected}"
+    assert not missing, f"the sdist lacks required entries: {missing}"
+
+
+@pytest.mark.os_agnostic
+def test_the_sdist_ships_only_the_package_under_src(sdist_members: list[str]) -> None:
+    under_src = {member.split("/")[1] for member in sdist_members if member.startswith("src/") and member.count("/") >= 1}
+
+    assert under_src == {PACKAGE}
+
+
+@pytest.mark.os_agnostic
+def test_the_sdist_carries_no_compiled_bytecode(sdist_members: list[str]) -> None:
+    compiled = [member for member in sdist_members if "__pycache__" in member or member.endswith(".pyc")]
+
+    assert not compiled, f"the sdist ships bytecode: {compiled[:5]}"
+
+
+@pytest.mark.os_agnostic
+def test_the_wheel_carries_the_package_data_the_runtime_loads(wheel_members: list[str]) -> None:
+    missing = [name for name in REQUIRED_WHEEL_DATA if name not in wheel_members]
+
+    assert not missing, f"the wheel lacks package data: {missing}"

lib_detect_testenv-3.0.6/tests/test_platform_markers.py

@@ -0,0 +1,31 @@
+"""The ``os_*`` markers skip a test off its platform; registering them alone would skip nothing.
+
+Each test asserts the platform its own marker names, so it fails wherever conftest lets it run by
+mistake, and passes where the marker lets it run.
+"""
+
+from __future__ import annotations
+
+import sys
+
+import pytest
+
+
+@pytest.mark.os_windows
+def test_an_os_windows_test_runs_only_on_windows() -> None:
+    assert sys.platform == "win32"
+
+
+@pytest.mark.os_macos
+def test_an_os_macos_test_runs_only_on_macos() -> None:
+    assert sys.platform == "darwin"
+
+
+@pytest.mark.os_linux
+def test_an_os_linux_test_runs_only_on_linux() -> None:
+    assert sys.platform.startswith("linux")
+
+
+@pytest.mark.os_posix
+def test_an_os_posix_test_never_runs_on_windows() -> None:
+    assert sys.platform != "win32"

lib_detect_testenv-3.0.5/.devcontainer/devcontainer.json

@@ -1,22 +0,0 @@
-{
-  "image": "mcr.microsoft.com/devcontainers/python:3.13",
-
-  "postCreateCommand": "bash -lc '\nPY=/usr/local/bin/python;\n$PY -m pip install -U pip && \\\n$PY -m pip install ipykernel && \\\n$PY -m pip install -e . && \\\n# register kernel using this exact interpreter\n$PY -m ipykernel install --name=python3 --display-name=\"Python 3 (3.13)\" --user && \\\n# patch the notebook to point to the python3 kernelspec (VS Code will bind to /usr/local/bin/python)\n$PY - <<\"PY\"\nimport json, pathlib\np = pathlib.Path(\"notebooks/Quickstart.ipynb\")\nif p.exists():\n    nb = json.loads(p.read_text(encoding=\"utf-8\"))\n    md = nb.setdefault(\"metadata\", {})\n    md[\"kernelspec\"] = {\n        \"name\": \"python3\",\n        \"display_name\": \"Python 3 (3.13)\",\n        \"language\": \"python\"\n    }\n    md[\"language_info\"] = {\"name\": \"python\"}\n    p.write_text(json.dumps(nb, ensure_ascii=False, indent=1), encoding=\"utf-8\")\n    print(\"Pinned kernelspec to python3 in\", p)\nelse:\n    print(\"Notebook not found:\", p)\nPY'\n",
-
-  "customizations": {
-    "vscode": {
-      "extensions": ["ms-toolsai.jupyter", "ms-python.python"],
-      "settings": {
-        "workbench.startupEditor": "none",
-        "jupyter.alwaysTrustNotebooks": true,
-        "jupyter.kernelPickerType": "OnlyRecommended",
-        "python.defaultInterpreterPath": "/usr/local/bin/python"
-      }
-    },
-    "codespaces": {
-      "openFiles": ["README.md"]
-    }
-  },
-
-  "postAttachCommand": "bash -lc 'if [ -f notebooks/Quickstart.ipynb ]; then code -r notebooks/Quickstart.ipynb; fi'"
-}

lib_detect_testenv-3.0.5/.devcontainer/settings.json

@@ -1,6 +0,0 @@
-{
-  "python.defaultInterpreterPath": "/usr/local/bin/python3.13",
-  "jupyter.alwaysTrustNotebooks": true,
-  "jupyter.kernelPickerType": "OnlyRecommended",
-  "jupyter.askForKernelRestart": false
-}

lib_detect_testenv-3.0.5/.env.example

@@ -1,11 +0,0 @@
-# Copy to .env and fill values as needed.
-
-# Codecov upload token (required for private repos; optional for public repos)
-CODECOV_TOKEN=
-
-# PyPI API token for release workflow (.github/workflows/release.yml)
-# Format: pypi-AgENdGVzdC5weXBpLm9yZwIk...
-PYPI_API_TOKEN=
-
-# Optional: GitHub token for API-limited tasks
-GITHUB_TOKEN=

lib_detect_testenv-3.0.5/.github/actions/extract-metadata/action.yml

@@ -1,108 +0,0 @@
-name: Extract project metadata
-description: >-
-  Parse pyproject.toml and expose project metadata as step outputs.
-  Requires Python to be available in the runner environment.
-  Auto-installs rtoml if not already present.
-
-outputs:
-  PACKAGE_MODULE:
-    description: Python-importable module name (underscored)
-    value: ${{ steps.meta.outputs.PACKAGE_MODULE }}
-  PROJECT_NAME:
-    description: Project name from pyproject.toml
-    value: ${{ steps.meta.outputs.PROJECT_NAME }}
-  CLI_BIN:
-    description: CLI entry-point binary name
-    value: ${{ steps.meta.outputs.CLI_BIN }}
-  SRC_PATH:
-    description: Source directory path (e.g. "src")
-    value: ${{ steps.meta.outputs.SRC_PATH }}
-  COV_FAIL_UNDER:
-    description: Minimum coverage percentage from tool.coverage.report.fail_under
-    value: ${{ steps.meta.outputs.COV_FAIL_UNDER }}
-  COV_REPORT_FILE:
-    description: Coverage report filename (e.g. "coverage.xml")
-    value: ${{ steps.meta.outputs.COV_REPORT_FILE }}
-  PYTEST_VERBOSITY:
-    description: Pytest verbosity flag (e.g. "-vv")
-    value: ${{ steps.meta.outputs.PYTEST_VERBOSITY }}
-  BANDIT_SKIP_FLAG:
-    description: Bandit skip flag string (e.g. "-s B101,B601") or empty
-    value: ${{ steps.meta.outputs.BANDIT_SKIP_FLAG }}
-  PYTEST_MARKER_EXPR:
-    description: >-
-      Marker expression for the CI test run (e.g. "not local_only and not integration"),
-      built from tool.ci.pytest-exclude-markers
-    value: ${{ steps.meta.outputs.PYTEST_MARKER_EXPR }}
-
-runs:
-  using: composite
-  steps:
-    - name: Extract project metadata from pyproject.toml
-      id: meta
-      shell: python
-      run: |
-        import os, subprocess, sys
-        try:
-            import rtoml
-        except ModuleNotFoundError:
-            subprocess.check_call([sys.executable, "-m", "pip", "install", "rtoml", "-q"])
-            import rtoml
-
-        from pathlib import Path
-        data = rtoml.load(Path('pyproject.toml'))
-
-        # --- [project] section ---
-        project = data['project']['name']
-        module = project.replace('-', '_')
-        dash = project.replace('_', '-')
-        scripts = list(data['project'].get('scripts', {}).keys())
-        cli_bin = scripts[0] if scripts else dash
-
-        # --- [tool.scripts.test] section ---
-        scripts_test = data.get('tool', {}).get('scripts', {}).get('test', {})
-        src_path = scripts_test.get('src-path', 'src')
-        pytest_verbosity = scripts_test.get('pytest-verbosity', '-vv')
-        cov_report_file = scripts_test.get('coverage-report-file', 'coverage.xml')
-
-        # --- [tool.coverage.report] section ---
-        cov_fail_under = (
-            data.get('tool', {}).get('coverage', {}).get('report', {}).get('fail_under', 90)
-        )
-
-        # --- [tool.bandit] section ---
-        bandit_skips = data.get('tool', {}).get('bandit', {}).get('skips', [])
-        bandit_skip_flag = f"-s {','.join(bandit_skips)}" if bandit_skips else ""
-
-        # --- [tool.ci] section ---
-        # CI always skips local_only (those tests need a dev box). A project whose
-        # suite also carries markers CI cannot satisfy - integration tests needing a
-        # container that a separate workflow starts - names them here, rather than
-        # every such repo forking this workflow to edit one -m expression.
-        ci_config = data.get('tool', {}).get('ci', {})
-        exclude_markers = ['local_only', *ci_config.get('pytest-exclude-markers', [])]
-        pytest_marker_expr = ' and '.join(f'not {m}' for m in exclude_markers)
-
-        # Write to GITHUB_OUTPUT for composite action outputs
-        with open(os.environ['GITHUB_OUTPUT'], 'a', encoding='utf-8') as out:
-            out.write(f"PROJECT_NAME={project}\n")
-            out.write(f"PACKAGE_MODULE={module}\n")
-            out.write(f"CLI_BIN={cli_bin}\n")
-            out.write(f"SRC_PATH={src_path}\n")
-            out.write(f"PYTEST_VERBOSITY={pytest_verbosity}\n")
-            out.write(f"COV_REPORT_FILE={cov_report_file}\n")
-            out.write(f"COV_FAIL_UNDER={cov_fail_under}\n")
-            out.write(f"BANDIT_SKIP_FLAG={bandit_skip_flag}\n")
-            out.write(f"PYTEST_MARKER_EXPR={pytest_marker_expr}\n")
-
-        # Also write to GITHUB_ENV so subsequent steps can use ${{ env.VAR }}
-        with open(os.environ['GITHUB_ENV'], 'a', encoding='utf-8') as env:
-            env.write(f"PROJECT_NAME={project}\n")
-            env.write(f"PACKAGE_MODULE={module}\n")
-            env.write(f"CLI_BIN={cli_bin}\n")
-            env.write(f"SRC_PATH={src_path}\n")
-            env.write(f"PYTEST_VERBOSITY={pytest_verbosity}\n")
-            env.write(f"COV_REPORT_FILE={cov_report_file}\n")
-            env.write(f"COV_FAIL_UNDER={cov_fail_under}\n")
-            env.write(f"BANDIT_SKIP_FLAG={bandit_skip_flag}\n")
-            env.write(f"PYTEST_MARKER_EXPR={pytest_marker_expr}\n")

lib_detect_testenv-3.0.5/.github/dependabot.yml

@@ -1,22 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "pip"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    allow:
-      - dependency-type: "direct"
-    labels:
-      - "dependencies"
-    commit-message:
-      prefix: "deps"
-      include: "scope"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    labels:
-      - "dependencies"
-    commit-message:
-      prefix: "deps"
-      include: "scope"

lib_detect_testenv-3.0.5/.github/workflows/codeql.yml

@@ -1,39 +0,0 @@
-name: CodeQL
-
-on:
-  push:
-    branches: [ main, master ]
-  pull_request:
-    branches: [ main, master ]
-  schedule:
-    - cron: '0 8 * * 1'
-
-jobs:
-  analyze:
-    name: CodeQL Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'python' ]
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v7
-
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v4
-        with:
-          languages: ${{ matrix.language }}
-
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v4
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v4
-        with:
-          category: "/language:${{ matrix.language }}"