prepare-assignment 0.4.0__tar.gz → 0.4.1__tar.gz

{prepare_assignment-0.4.0 → prepare_assignment-0.4.1}/.github/workflows/test.yml

@@ -11,7 +11,39 @@ on:
     branches: [ "main" ]
 
 jobs:
+  # Skip the tests if a PR only changes documentation. The jobs are skipped instead of the whole workflow
+  # (paths-ignore), because a required check that never reports blocks the PR, see the 'tests' job.
+  changes:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+    outputs:
+      code: ${{ steps.filter.outputs.code }}
+    steps:
+      - id: filter
+        env:
+          GH_TOKEN: ${{ github.token }}
+          PR: ${{ github.event.pull_request.number }}
+          REPO: ${{ github.repository }}
+        run: |
+          files=$(gh pr diff "$PR" --name-only --repo "$REPO")
+          echo "Changed files:"
+          echo "$files"
+          code=false
+          # Fail safe: run the tests if the changed files cannot be determined
+          [ -z "$files" ] && code=true
+          while IFS= read -r file; do
+            case "$file" in
+              *.md|LICENSE|.github/ISSUE_TEMPLATE/*) ;;
+              *) code=true ;;
+            esac
+          done <<< "$files"
+          echo "code=$code" >> "$GITHUB_OUTPUT"
+
   test:
+    needs: changes
+    if: needs.changes.outputs.code == 'true'
     strategy:
       fail-fast: false
       matrix:
@@ -44,6 +76,8 @@ jobs:
         report_paths: tests.xml
 
   typecheck:
+    needs: changes
+    if: needs.changes.outputs.code == 'true'
     strategy:
       matrix:
         python-version: [ "3.12" ]
@@ -61,3 +95,18 @@ jobs:
         run: uv sync --locked --group test
       - name: Type checker
         run: uv run mypy prepare_assignment
+
+  # The only required check (next to the PR title): succeeds if all tests passed or were skipped because only
+  # documentation changed. Skipped matrix jobs don't report their individual checks (e.g. 'test (3.12, ...)').
+  tests:
+    if: always()
+    needs: [changes, test, typecheck]
+    runs-on: ubuntu-latest
+    steps:
+      - name: All tests passed or were skipped
+        env:
+          FAILED: ${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') }}
+          RESULTS: ${{ toJSON(needs) }}
+        run: |
+          echo "$RESULTS"
+          [ "$FAILED" = "false" ]

{prepare_assignment-0.4.0 → prepare_assignment-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: prepare-assignment
-Version: 0.4.0
+Version: 0.4.1
 Summary: Prepare assignment
 Author-email: Bonajo <m.bonajo@fontys.nl>
 License: MIT

{prepare_assignment-0.4.0 → prepare_assignment-0.4.1}/prepare_assignment/cli/main.py

@@ -1,10 +1,9 @@
 import os.path
 import sys
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import Annotated, Dict, List, Optional
 
 import typer
-from typing_extensions import Annotated
 
 from prepare_assignment import __version__
 from prepare_assignment.cli.task import app as task_app

{prepare_assignment-0.4.0 → prepare_assignment-0.4.1}/prepare_assignment/cli/task.py

@@ -1,8 +1,7 @@
 import logging
-from typing import Optional
+from typing import Annotated, Optional
 
 import typer
-from typing_extensions import Annotated
 
 from prepare_assignment.core.task_handler import info, remove, update, add
 

{prepare_assignment-0.4.0 → prepare_assignment-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "prepare-assignment"
-version = "0.4.0"
+version = "0.4.1"
 description = "Prepare assignment"
 authors = [{name = "Bonajo", email = "m.bonajo@fontys.nl"}]
 license = {text = "MIT"}

prepare_assignment-0.4.1/tests/test_dependencies.py

@@ -0,0 +1,48 @@
+import ast
+import sys
+from importlib.metadata import packages_distributions, requires
+from pathlib import Path
+from typing import Set
+
+from packaging.requirements import Requirement
+from packaging.utils import canonicalize_name
+
+PACKAGE = Path(__file__).parent.parent / "prepare_assignment"
+
+
+def _imported_modules() -> Set[str]:
+    modules: Set[str] = set()
+    for file in PACKAGE.rglob("*.py"):
+        tree = ast.parse(file.read_text(encoding="utf-8"))
+        for node in ast.walk(tree):
+            if isinstance(node, ast.Import):
+                modules.update(alias.name.split(".")[0] for alias in node.names)
+            elif isinstance(node, ast.ImportFrom) and node.level == 0 and node.module is not None:
+                modules.add(node.module.split(".")[0])
+    return {module for module in modules
+            if module not in sys.stdlib_module_names and module != "prepare_assignment"}
+
+
+def _declared_dependencies() -> Set[str]:
+    declared: Set[str] = set()
+    for line in requires("prepare-assignment") or []:
+        requirement = Requirement(line)
+        # Skip optional dependencies (extras)
+        if requirement.marker is None or requirement.marker.evaluate({"extra": ""}):
+            declared.add(canonicalize_name(requirement.name))
+    return declared
+
+
+def test_all_imports_are_declared_dependencies() -> None:
+    """
+    A module that is only installed as a dependency of a (test) dependency works in development, but not for users.
+    typer 0.27 dropped its typing-extensions dependency, which broke the released 0.4.0.
+    """
+    distributions = packages_distributions()
+    declared = _declared_dependencies()
+    undeclared = {}
+    for module in sorted(_imported_modules()):
+        names = {canonicalize_name(name) for name in distributions.get(module, [])}
+        if not names & declared:
+            undeclared[module] = sorted(names) or ["not installed"]
+    assert undeclared == {}, f"Imported, but not declared in pyproject.toml dependencies: {undeclared}"