feat: change generate-demo-project.py to regenerate demos on top of existing ones unless --no-cache is provided

Author: 56kyle

noxfile.py

@@ -57,6 +57,7 @@ def generate_demo_project(session: Session) -> None:
         "python",
         GENERATE_DEMO_PROJECT_SCRIPT,
         *GENERATE_DEMO_PROJECT_OPTIONS,
+        *session.posargs
     )
 
 

scripts/generate-demo-project.py

@@ -1,10 +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
@@ -16,10 +19,11 @@
 )
 
 
-def generate_demo_project(repo_folder: Path, demos_cache_folder: Path, demo_name: str) -> 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)
-    _remove_existing_demo(demo_path=demos_cache_folder / demo_name)
+    if no_cache:
+        _remove_existing_demo(demo_path=demos_cache_folder / demo_name)
     cookiecutter(
         template=str(repo_folder),
         no_input=True,
@@ -44,7 +48,13 @@ def _remove_existing_demo(demo_path: Path) -> None:
             )
 
         typer.secho(f"Removing existing demo project at {demo_path=}.", fg="yellow")
-        shutil.rmtree(demo_path)
+        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)
 
 
 cli: typer.Typer = typer.Typer()
@@ -55,10 +65,16 @@ def main(
     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:
     """Updates the poetry.lock file."""
     try:
-        generate_demo_project(repo_folder=repo_folder, demos_cache_folder=demos_cache_folder, demo_name=demo_name)
+        generate_demo_project(
+            repo_folder=repo_folder,
+            demos_cache_folder=demos_cache_folder,
+            demo_name=demo_name,
+            no_cache=no_cache
+        )
     except Exception as error:
         typer.secho(f"error: {error}", fg="red")
         sys.exit(1)