Merge pull request #12 from 56kyle/develop

Many small changes and general workflow tweaks

Author: 56kyle

noxfile.py

@@ -41,70 +41,16 @@
     *("--demo-name", DEFAULT_DEMO_NAME),
 )
 
-SYNC_UV_WITH_DEMO_SCRIPT: Path = SCRIPTS_FOLDER / "sync-uv-with-demo.py"
-SYNC_UV_WITH_DEMO_OPTIONS: tuple[str, ...] = (
-    *("--template-folder", TEMPLATE_FOLDER),
-    *("--demos-cache-folder", PROJECT_DEMOS_FOLDER),
-    *("--demo-name", DEFAULT_DEMO_NAME),
-)
+
+MATCH_GENERATED_PRECOMMIT_SCRIPT: Path = SCRIPTS_FOLDER / "match-generated-precommit.py"
+MATCH_GENERATED_PRECOMMIT_OPTIONS: tuple[str, ...] = GENERATE_DEMO_PROJECT_OPTIONS
 
 
 @nox.session(name="generate-demo-project", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
 def generate_demo_project(session: Session) -> None:
     """Generates a project demo using the cookiecutter-robust-python template."""
     session.install("cookiecutter", "platformdirs", "loguru", "typer")
-    session.run(
-        "python",
-        GENERATE_DEMO_PROJECT_SCRIPT,
-        *GENERATE_DEMO_PROJECT_OPTIONS,
-        *session.posargs
-    )
-
-
-@nox.session(name="sync-uv-with-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
-def sync_uv_with_demo(session: Session) -> None:
-    """Syncs the uv environment with the current demo project."""
-    session.install("cookiecutter", "platformdirs", "loguru", "typer")
-    session.run(
-        "python",
-        SYNC_UV_WITH_DEMO_SCRIPT,
-        *SYNC_UV_WITH_DEMO_OPTIONS,
-    )
-
-
-@nox.session(name="uv-in-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
-def uv_in_demo(session: Session) -> None:
-    """Runs a uv command in a new project demo project then syncs with it."""
-    session.install("cookiecutter", "platformdirs", "loguru", "typer")
-    session.run(
-        "python",
-        GENERATE_DEMO_PROJECT_SCRIPT,
-        *GENERATE_DEMO_PROJECT_OPTIONS,
-    )
-    original_dir: Path = Path.cwd()
-    session.cd(DEMO_ROOT_FOLDER)
-    session.run("uv", *session.posargs)
-    session.cd(original_dir)
-    session.run(
-        SYNC_UV_WITH_DEMO_SCRIPT,
-        *SYNC_UV_WITH_DEMO_OPTIONS,
-        external=True,
-    )
-
-
-@nox.session(name="in-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
-def in_demo(session: Session) -> None:
-    """Generates a project demo and run a uv command in it."""
-    session.install("cookiecutter", "platformdirs", "loguru", "typer")
-    session.run(
-        "python",
-        GENERATE_DEMO_PROJECT_SCRIPT,
-        *GENERATE_DEMO_PROJECT_OPTIONS,
-    )
-    original_dir: Path = Path.cwd()
-    session.cd(DEMO_ROOT_FOLDER)
-    session.run(*session.posargs)
-    session.cd(original_dir)
+    session.run("python", GENERATE_DEMO_PROJECT_SCRIPT, *GENERATE_DEMO_PROJECT_OPTIONS, *session.posargs)
 
 
 @nox.session(name="clear-cache", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
@@ -131,15 +77,12 @@ def lint(session: Session):
     session.run("ruff", "check", "--verbose", "--fix")
 
 
-@nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION, name="lint-generated-project", tags=[])
-def lint_generated_project(session: Session):
+@nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION, name="match-generated-precommit", tags=[])
+def match_generated_precommit(session: Session):
     """Lint the generated project's Python files and configurations."""
     session.log("Installing linting dependencies for the generated project...")
     session.install("-e", ".", "--group", "dev", "--group", "lint")
-    session._runner.posargs = ["nox", "-s", "pre-commit"]
-    in_demo(session)
-    session._runner.posargs = [""]
-    session.run("retrocookie")
+    session.run("python", MATCH_GENERATED_PRECOMMIT_SCRIPT, *MATCH_GENERATED_PRECOMMIT_OPTIONS, *session.posargs)
 
 
 @nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION)

scripts/generate-demo-project.py

@@ -1,60 +1,13 @@
 """Python script for generating a demo project."""
-import os
-import shutil
-import stat
 import sys
 from functools import partial
 from pathlib import Path
 from typing import Annotated
-from typing import Any
-from typing import Callable
 
 import typer
-from cookiecutter.main import cookiecutter
-from typer.models import OptionInfo
 
-
-FolderOption: partial[OptionInfo] = partial(
-    typer.Option, dir_okay=True, file_okay=False, resolve_path=True, path_type=Path
-)
-
-
-def generate_demo_project(repo_folder: Path, demos_cache_folder: Path, demo_name: str, no_cache: bool) -> Path:
-    """Generates a demo project and returns its root path."""
-    demos_cache_folder.mkdir(exist_ok=True)
-    if no_cache:
-        _remove_existing_demo(demo_path=demos_cache_folder / demo_name)
-    cookiecutter(
-        template=str(repo_folder),
-        no_input=True,
-        extra_context={"project_name": demo_name},
-        overwrite_if_exists=True,
-        output_dir=str(demos_cache_folder),
-    )
-    return demos_cache_folder / demo_name
-
-
-def _remove_existing_demo(demo_path: Path) -> None:
-    """Removes the existing demo if present."""
-    if demo_path.exists() and demo_path.is_dir():
-        previous_demo_pyproject: Path = Path(demo_path, "pyproject.toml")
-        if not previous_demo_pyproject.exists():
-            typer.secho(f"No pyproject.toml found at {previous_demo_pyproject=}.", fg="red")
-            typer.confirm(
-                "This folder may not be a demo, are you sure you would like to continue?",
-                default=False,
-                abort=True,
-                show_default=True
-            )
-
-        typer.secho(f"Removing existing demo project at {demo_path=}.", fg="yellow")
-        shutil.rmtree(demo_path, onerror=remove_readonly)
-
-
-def remove_readonly(func: Callable[[str], Any], path: str, _: Any) -> None:
-    """Clears the readonly bit and attempts to call the provided function."""
-    os.chmod(path, stat.S_IWRITE)
-    func(path)
+from util import FolderOption
+from util import generate_demo_project
 
 
 cli: typer.Typer = typer.Typer()

scripts/match-generated-precommit.py

@@ -0,0 +1,41 @@
+import sys
+from pathlib import Path
+from typing import Annotated
+
+import pre_commit.main
+import typer
+from retrocookie.core import retrocookie
+
+from util import git
+from util import FolderOption
+from util import in_new_demo
+
+
+cli: typer.Typer = typer.Typer()
+
+
+@cli.callback(invoke_without_command=True)
+def match_generated_precommit(
+    repo_folder: Annotated[Path, FolderOption("--repo-folder", "-r")],
+    demos_cache_folder: Annotated[Path, FolderOption("--demos-cache-folder", "-c")],
+    demo_name: Annotated[str, typer.Option("--demo-name", "-d")],
+    no_cache: Annotated[bool, typer.Option("--no-cache", "-n")] = False,
+) -> None:
+    """Runs precommit in a generated project and matches the template to the results."""
+    try:
+        with in_new_demo(
+            repo_folder=repo_folder,
+            demos_cache_folder=demos_cache_folder,
+            demo_name=demo_name,
+            no_cache=no_cache
+        ) as demo_path:
+            pre_commit.main.main(["run", "--all-files", "--hook-stage=manual", "--show-diff-on-failure"])
+        retrocookie(instance_path=demo_path, commits=["HEAD"])
+        git("checkout", "HEAD", "--", "{{cookiecutter.project_name}}/pyproject.toml")
+    except Exception as error:
+        typer.secho(f"error: {error}", fg="red")
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    cli()

scripts/sync-uv-with-demo.py

@@ -0,0 +1,109 @@
+"""Module containing utility functions used throughout cookiecutter_robust_python scripts."""
+import os
+import shutil
+import stat
+import subprocess
+import sys
+from contextlib import contextmanager
+from functools import partial
+from pathlib import Path
+from typing import Any
+from typing import Callable
+from typing import Generator
+
+import typer
+from cookiecutter.main import cookiecutter
+from cookiecutter.utils import work_in
+from pygments.lexers import q
+from typer.models import OptionInfo
+
+
+FolderOption: partial[OptionInfo] = partial(
+    typer.Option, dir_okay=True, file_okay=False, resolve_path=True, path_type=Path
+)
+
+
+def remove_readonly(func: Callable[[str], Any], path: str, _: Any) -> None:
+    """Clears the readonly bit and attempts to call the provided function.
+
+    Meant for use as the onerror callback in shutil.rmtree.
+    """
+    os.chmod(path, stat.S_IWRITE)
+    func(path)
+
+
+def run_command(command: str, *args: str) -> subprocess.CompletedProcess:
+    """Runs the provided command in a subprocess."""
+    try:
+        process = subprocess.run([command, *args], check=True, capture_output=True, text=True)
+        return process
+    except subprocess.CalledProcessError as error:
+        print(error.stdout, end="")
+        print(error.stderr, end="", file=sys.stderr)
+        raise
+
+
+git: partial[subprocess.CompletedProcess] = partial(run_command, "git")
+uv: partial[subprocess.CompletedProcess] = partial(run_command, "uv")
+
+
+@contextmanager
+def in_new_demo(
+    repo_folder: Path,
+    demos_cache_folder: Path,
+    demo_name: str,
+    no_cache: bool,
+    **kwargs: Any
+) -> Generator[Path, None, None]:
+    """Returns a context manager for working within a new demo."""
+    demo_path: Path = generate_demo_project(
+        repo_folder=repo_folder,
+        demos_cache_folder=demos_cache_folder,
+        demo_name=demo_name,
+        no_cache=no_cache,
+        **kwargs
+    )
+    with work_in(demo_path):
+        yield demo_path
+
+
+def generate_demo_project(
+    repo_folder: Path,
+    demos_cache_folder: Path,
+    demo_name: str,
+    no_cache: bool,
+    **kwargs: Any
+) -> Path:
+    """Generates a demo project and returns its root path."""
+    demos_cache_folder.mkdir(exist_ok=True)
+    if no_cache:
+        _remove_existing_demo(demo_path=demos_cache_folder / demo_name)
+    cookiecutter(
+        template=str(repo_folder),
+        no_input=True,
+        extra_context={"project_name": demo_name, **kwargs},
+        overwrite_if_exists=True,
+        output_dir=str(demos_cache_folder),
+    )
+    return demos_cache_folder / demo_name
+
+
+def _remove_existing_demo(demo_path: Path) -> None:
+    """Removes the existing demo if present."""
+    if demo_path.exists() and demo_path.is_dir():
+        previous_demo_pyproject: Path = Path(demo_path, "pyproject.toml")
+        if not previous_demo_pyproject.exists():
+            typer.secho(f"No pyproject.toml found at {previous_demo_pyproject=}.", fg="red")
+            typer.confirm(
+                "This folder may not be a demo, are you sure you would like to continue?",
+                default=False,
+                abort=True,
+                show_default=True
+            )
+
+        typer.secho(f"Removing existing demo project at {demo_path=}.", fg="yellow")
+        shutil.rmtree(demo_path, onerror=remove_readonly)
+
+
+
+

scripts/util.py

@@ -30,7 +30,8 @@ def robust_python_demo_path(demos_folder: Path) -> Path:
         extra_context={"project_name": "robust-python-demo", "add_rust_extension": False},
     )
     path: Path = demos_folder / "robust-python-demo"
-    subprocess.run(["nox", "-s", "setup-repo"], cwd=path, capture_output=True)
+    subprocess.run(["nox", "-s", "setup-git"], cwd=path, capture_output=True)
+    subprocess.run(["nox", "-s", "setup-venv"], cwd=path, capture_output=True)
     return path
 
 
@@ -47,4 +48,3 @@ def robust_maturin_demo_path(demos_folder: Path) -> Path:
     path: Path = demos_folder / "robust-maturin-demo"
     subprocess.run(["nox", "-s", "setup-repo"], cwd=path, capture_output=True)
     return path
-