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

{prepare_assignment-0.4.0 → prepare_assignment-0.4.2}/.github/workflows/semantic-release.yml

@@ -38,11 +38,17 @@ jobs:
           node-version: 22
 
       # Pinned to an exact version: this action publishes no floating major
-      # tags, so @v6 would not resolve. All three plugins in .releaserc.json
-      # ship with the semantic-release core it bundles.
+      # tags, so @v6 would not resolve. The plugins in .releaserc.json ship
+      # with the semantic-release core it bundles, the conventionalcommits
+      # preset (which understands `feat!:`) has to be installed. Version 9:
+      # version 10 needs a newer changelog writer than the bundled
+      # release-notes-generator uses.
       - name: Semantic release
         id: semantic
         uses: cycjimmy/semantic-release-action@v6.0.0
+        with:
+          extra_plugins: |
+            conventional-changelog-conventionalcommits@9
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

{prepare_assignment-0.4.0 → prepare_assignment-0.4.2}/.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.2/.releaserc.json

@@ -0,0 +1,9 @@
+{
+  "branches": ["main"],
+  "tagFormat": "v${version}",
+  "plugins": [
+    ["@semantic-release/commit-analyzer", { "preset": "conventionalcommits" }],
+    ["@semantic-release/release-notes-generator", { "preset": "conventionalcommits" }],
+    "@semantic-release/github"
+  ]
+}

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: prepare-assignment
-Version: 0.4.0
+Version: 0.4.2
 Summary: Prepare assignment
 Author-email: Bonajo <m.bonajo@fontys.nl>
 License: MIT
@@ -11,7 +11,7 @@ Requires-Dist: gitpython>=3.1.59
 Requires-Dist: jsonschema>=4.21.1
 Requires-Dist: multipledispatch>=1.0.0
 Requires-Dist: packaging>=24.0
-Requires-Dist: prepare-toolbox==0.4.0
+Requires-Dist: prepare-toolbox>=1.0.1
 Requires-Dist: ruamel-yaml>=0.18.5
 Requires-Dist: simpleeval>=1.0.0
 Requires-Dist: treelib>=1.7.0
@@ -30,7 +30,7 @@ Prepare assignment is a GitHub Actions inspired helper tool to prepare assignmen
 
 ## Installation
 
-Prepare-assignment is available from [PyPI](https://pypi.org/).
+Prepare-assignment is available from [PyPI](https://pypi.org/project/prepare-assignment/).
 
 
 ```bash
@@ -47,13 +47,13 @@ To execute a `prepare.yml` simply run `prepare run` from the same directory.
 
 ### Command line interface
 
-Use `prepare --help` to which commands and flags are available.
+Use `prepare --help` to see which commands and flags are available.
 
 ## Example `prepare.yml`
 
 First we need to have tasks available that can be executed. Take for example a look at the [remove](https://github.com/prepare-assignment/remove) task.
 
-The tests use a [testproject](https://github.com/prepare-assignment/core/tree/tests/testproject), which contains an example of a `prepare.yml`, see below for convenience.
+The tests use a [testproject](https://github.com/prepare-assignment/core/tree/main/tests/testproject), which contains an example of a `prepare.yml`, see below for convenience.
 
 ```yaml
 name: Test project
@@ -200,9 +200,9 @@ Releases are automated with [semantic-release](https://semantic-release.gitbook.
 
 | PR title | Release |
 |----------|---------|
-| `fix: ...` | patch (1.2.3 → 1.2.4) |
+| `fix: ...`, `perf: ...` | patch (1.2.3 → 1.2.4) |
 | `feat: ...` | minor (1.2.3 → 1.3.0) |
-| `feat!: ...` or a `BREAKING CHANGE:` footer | major (1.2.3 → 2.0.0) |
-| `docs:`, `chore:`, `ci:`, `build:`, `refactor:`, `test:`, `style:`, `perf:` | no release |
+| `!` after the type (e.g. `feat!: ...`, `refactor!: ...`) or a `BREAKING CHANGE:` footer | major (1.2.3 → 2.0.0) |
+| `docs:`, `chore:`, `ci:`, `build:`, `refactor:`, `test:`, `style:`, `revert:` | no release |
 
 On every merge to `main` the next version is determined, tagged (`vX.Y.Z`), a GitHub release is created and the package is published to PyPI. The version is set during the build and is not committed, so the version in `pyproject.toml` is not the released version.

{prepare_assignment-0.4.0 → prepare_assignment-0.4.2}/README.md

@@ -9,7 +9,7 @@ Prepare assignment is a GitHub Actions inspired helper tool to prepare assignmen
 
 ## Installation
 
-Prepare-assignment is available from [PyPI](https://pypi.org/).
+Prepare-assignment is available from [PyPI](https://pypi.org/project/prepare-assignment/).
 
 
 ```bash
@@ -26,13 +26,13 @@ To execute a `prepare.yml` simply run `prepare run` from the same directory.
 
 ### Command line interface
 
-Use `prepare --help` to which commands and flags are available.
+Use `prepare --help` to see which commands and flags are available.
 
 ## Example `prepare.yml`
 
 First we need to have tasks available that can be executed. Take for example a look at the [remove](https://github.com/prepare-assignment/remove) task.
 
-The tests use a [testproject](https://github.com/prepare-assignment/core/tree/tests/testproject), which contains an example of a `prepare.yml`, see below for convenience.
+The tests use a [testproject](https://github.com/prepare-assignment/core/tree/main/tests/testproject), which contains an example of a `prepare.yml`, see below for convenience.
 
 ```yaml
 name: Test project
@@ -179,9 +179,9 @@ Releases are automated with [semantic-release](https://semantic-release.gitbook.
 
 | PR title | Release |
 |----------|---------|
-| `fix: ...` | patch (1.2.3 → 1.2.4) |
+| `fix: ...`, `perf: ...` | patch (1.2.3 → 1.2.4) |
 | `feat: ...` | minor (1.2.3 → 1.3.0) |
-| `feat!: ...` or a `BREAKING CHANGE:` footer | major (1.2.3 → 2.0.0) |
-| `docs:`, `chore:`, `ci:`, `build:`, `refactor:`, `test:`, `style:`, `perf:` | no release |
+| `!` after the type (e.g. `feat!: ...`, `refactor!: ...`) or a `BREAKING CHANGE:` footer | major (1.2.3 → 2.0.0) |
+| `docs:`, `chore:`, `ci:`, `build:`, `refactor:`, `test:`, `style:`, `revert:` | no release |
 
 On every merge to `main` the next version is determined, tagged (`vX.Y.Z`), a GitHub release is created and the package is published to PyPI. The version is set during the build and is not committed, so the version in `pyproject.toml` is not the released version.

{prepare_assignment-0.4.0 → prepare_assignment-0.4.2}/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.2}/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.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "prepare-assignment"
-version = "0.4.0"
+version = "0.4.2"
 description = "Prepare assignment"
 authors = [{name = "Bonajo", email = "m.bonajo@fontys.nl"}]
 license = {text = "MIT"}
@@ -10,7 +10,7 @@ dependencies = [
     "ruamel-yaml>=0.18.5",
     "jsonschema>=4.21.1",
     "gitpython>=3.1.59",
-    "prepare-toolbox==0.4.0",
+    "prepare-toolbox>=1.0.1",
     "virtualenv>=20.25.0",
     "typer==0.27.2",
     "treelib>=1.7.0",

{prepare_assignment-0.4.0 → prepare_assignment-0.4.2}/tests/core/test_command.py

@@ -178,3 +178,20 @@ def test_handle_set_output_wrong_item_type(caplog: pytest.LogCaptureFixture) ->
                                current_task_definition=definition, current_task=task)
     handle_set_output(fresh_env, ["", json.dumps({"l": ["a", 1]})])
     assert 'l' not in fresh_env.outputs['id']
+
+
+def test_toolbox_set_output_with_separator_contract(capsys: pytest.CaptureFixture) -> None:
+    """Values containing the separator (escaped by prepare-toolbox >= 1.0.1) must arrive unchanged."""
+    from pathlib import Path
+    from prepare_toolbox.core import set_output
+    from prepare_assignment.core import runner
+    set_output("files", ["a:PA:b.txt", Path("src") / "A.java"])
+    line = capsys.readouterr().out
+    output_definition = TaskOutputDefinition(description="files", type="array", items="string")
+    definition = PythonTaskDefinition(outputs={"files": output_definition}, description="t", inputs=[], id="t",
+                                      name="t", path="path", main="main.py")  # type: ignore
+    fresh_env = JobEnvironment(environment={}, outputs={"id": {}}, inputs={},
+                               current_task_definition=definition, current_task=task)
+    runner.__process_output_line(line, fresh_env)  # type: ignore[attr-defined]
+    assert fresh_env.task_errors == []
+    assert fresh_env.outputs["id"]["files"] == ["a:PA:b.txt", str(Path("src") / "A.java")]

prepare_assignment-0.4.2/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}"

{prepare_assignment-0.4.0 → prepare_assignment-0.4.2}/tests/test_main.py

@@ -86,3 +86,13 @@ def test_multiple_prepare_files_message(monkeypatch: pytest.MonkeyPatch, tmp_pat
     with pytest.raises(AssertionError) as exc:
         prepare(None)
     assert "both a prepare.yml and a prepare.yaml" in str(exc.value)
+
+
+def test_prepare_file_in_directory_with_special_characters(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
+    """With prepare-toolbox < 0.4.4 the directory name was interpreted as part of the glob"""
+    from prepare_assignment.core.main import get_prepare_file
+    project = tmp_path / "[week 1] assignment"
+    project.mkdir()
+    (project / "prepare.yml").write_text("name: a\njobs: {}\n")
+    monkeypatch.chdir(project)
+    assert get_prepare_file(None) == "prepare.yml"

{prepare_assignment-0.4.0 → prepare_assignment-0.4.2}/uv.lock

@@ -582,7 +582,7 @@ requires-dist = [
     { name = "jsonschema", specifier = ">=4.21.1" },
     { name = "multipledispatch", specifier = ">=1.0.0" },
     { name = "packaging", specifier = ">=24.0" },
-    { name = "prepare-toolbox", specifier = "==0.4.0" },
+    { name = "prepare-toolbox", specifier = ">=1.0.1" },
     { name = "ruamel-yaml", specifier = ">=0.18.5" },
     { name = "simpleeval", specifier = ">=1.0.0" },
     { name = "treelib", specifier = ">=1.7.0" },
@@ -601,14 +601,14 @@ test = [
 
 [[package]]
 name = "prepare-toolbox"
-version = "0.4.0"
+version = "1.0.1"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "braceexpand" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/1d/c3/b6d5ad3819fa8f9149a3cbd3653dbcb9208103f91fec3a379d528602e7eb/prepare_toolbox-0.4.0.tar.gz", hash = "sha256:825f50b9bccefcaf091d0e29b7881c311ce7c9a2f510ec481951beffd29871b9", size = 4952, upload-time = "2023-11-01T19:10:30.85Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/80/67/85a18c89af943534c23ce825de8e6e17550481f8c90e02db1c3a2d8a865e/prepare_toolbox-1.0.1.tar.gz", hash = "sha256:c11f499018b181ae4bc548669de698ee50dfbd309d9080e9538920c046798959", size = 55292, upload-time = "2026-09-22T06:15:35.074Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/81/3d/9569c6585515e637f32e3ca691ce5df85a01903ca7aa0ce9e4f75580640e/prepare_toolbox-0.4.0-py3-none-any.whl", hash = "sha256:15f694af2883463ec83cb568885f85bca4a4225816d86846b296da69c027c5e8", size = 6836, upload-time = "2023-11-01T19:10:29.84Z" },
+    { url = "https://files.pythonhosted.org/packages/b4/35/dd4cacca4d58361b66394160f9ca0f4062c2b5e55c0a8aa1dc557d347a63/prepare_toolbox-1.0.1-py3-none-any.whl", hash = "sha256:41e10ac9fa61e0cfe53d5c04b69baf2b0ee8a607dda2c9825c6ce0293055fd57", size = 7443, upload-time = "2026-09-22T06:15:34.015Z" },
 ]
 
 [[package]]

prepare_assignment-0.4.0/.releaserc.json

@@ -1,9 +0,0 @@
-{
-  "branches": ["main"],
-  "tagFormat": "v${version}",
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/github"
-  ]
-}