fastled 1.2.29__tar.gz → 1.2.31__tar.gz

{fastled-1.2.29 → fastled-1.2.31}/.github/workflows/test_build_exe.yml

@@ -46,7 +46,7 @@ jobs:
         fi
       
     - name: Upload artifacts
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: fastled-${{ matrix.os }}
         path: |

{fastled-1.2.29 → fastled-1.2.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: fastled
-Version: 1.2.29
+Version: 1.2.31
 Summary: FastLED Wasm Compiler
 Home-page: https://github.com/zackees/fastled-wasm
 Maintainer: Zachary Vorhies
@@ -295,6 +295,7 @@ A: A big chunk of space is being used by unnecessary javascript `emscripten` bun
 
 # Revisions
 
+  * 1.2.31 - Bunch of fixes and ease of use while compiling code in the repo.
   * 1.2.22 - Prefer to use `live-server` from npm. If npm exists on the system then do a background install of `live-server` for next run.
   * 1.2.20 - Fixed up path issue for web browser launch for hot reload.
   * 1.2.19 - Compilation failure now overwrites the index.html file with error message.

{fastled-1.2.29 → fastled-1.2.31}/README.md

@@ -269,6 +269,7 @@ A: A big chunk of space is being used by unnecessary javascript `emscripten` bun
 
 # Revisions
 
+  * 1.2.31 - Bunch of fixes and ease of use while compiling code in the repo.
   * 1.2.22 - Prefer to use `live-server` from npm. If npm exists on the system then do a background install of `live-server` for next run.
   * 1.2.20 - Fixed up path issue for web browser launch for hot reload.
   * 1.2.19 - Compilation failure now overwrites the index.html file with error message.

{fastled-1.2.29 → fastled-1.2.31}/src/fastled/__init__.py

@@ -1,6 +1,7 @@
 """FastLED Wasm Compiler package."""
 
 # context
+import shutil
 import subprocess
 from contextlib import contextmanager
 from multiprocessing import Process
@@ -15,7 +16,7 @@ from .types import BuildMode, CompileResult, CompileServerError
 # IMPORTANT! There's a bug in github which will REJECT any version update
 # that has any other change in the repo. Please bump the version as the
 # ONLY change in a commit, or else the pypi update and the release will fail.
-__version__ = "1.2.29"
+__version__ = "1.2.31"
 
 
 class Api:
@@ -60,6 +61,7 @@ class Api:
     def live_client(
         sketch_directory: Path,
         host: str | CompileServer | None = None,
+        auto_updates: bool = True,
         auto_start=True,
         open_web_browser=True,
         keep_running=True,
@@ -69,6 +71,7 @@ class Api:
         return LiveClient(
             sketch_directory=sketch_directory,
             host=host,
+            auto_updates=auto_updates,
             auto_start=auto_start,
             open_web_browser=open_web_browser,
             keep_running=keep_running,
@@ -81,16 +84,20 @@ class Api:
         interactive=False,
         auto_updates=None,
         auto_start=True,
-        container_name: str | None = None,
+        mapped_dir: Path | None = None,  # Sketch directory.
+        container_name: str | None = None,  # Specific docker container name.
+        remove_previous: bool = False,
     ) -> CompileServer:
+        """Uses docker to spawn a compile server from the given name."""
         from fastled.compile_server import CompileServer
 
         out = CompileServer(
             container_name=container_name,
             interactive=interactive,
             auto_updates=auto_updates,
-            mapped_dir=None,
+            mapped_dir=mapped_dir,
             auto_start=auto_start,
+            remove_previous=remove_previous,
         )
         return out
 
@@ -100,13 +107,17 @@ class Api:
         interactive=False,
         auto_updates=None,
         auto_start=True,
-        container_name: str | None = None,
+        mapped_dir: Path | None = None,  # Sketch directory.
+        container_name: str | None = None,  # Specific docker container name.
+        remove_previous=False,
     ) -> Generator[CompileServer, None, None]:
         server = Api.spawn_server(
             interactive=interactive,
             auto_updates=auto_updates,
             auto_start=auto_start,
+            mapped_dir=mapped_dir,
             container_name=container_name,
+            remove_previous=remove_previous,
         )
         try:
             yield server
@@ -169,14 +180,37 @@ class Docker:
         # Create output directory if it doesn't exist
         output_dir.mkdir(parents=True, exist_ok=True)
 
+        git_dir = output_dir / ".git"
+        library_properties = output_dir / "library.properties"
+
+        git_dir_exists = git_dir.exists()
+        library_properties_exists = library_properties.exists()
+        library_properties_text = (
+            library_properties.read_text().strip() if library_properties_exists else ""
+        )
+
+        already_exists = (
+            git_dir_exists
+            and library_properties_exists
+            and "FastLED" in library_properties_text
+        )
+        if git_dir_exists and not already_exists:
+            if ".cache/fastled" in str(output_dir.as_posix()):
+                shutil.rmtree(output_dir)
+                already_exists = False
+            else:
+                raise ValueError(
+                    f"Output directory {output_dir} already exists but does not appear to be a FastLED repository."
+                )
+
         # Clone or update the repository
-        if (output_dir / ".git").exists():
+        if already_exists:
             print(f"Updating existing repository in {output_dir}")
             # Reset local changes and move HEAD back to handle force pushes
             subprocess.run(
                 ["git", "reset", "--hard", "HEAD~10"],
                 cwd=output_dir,
-                check=True,
+                check=False,
                 capture_output=True,  # Suppress output of reset
             )
             subprocess.run(
@@ -229,12 +263,14 @@ class Docker:
             remove_previous=True,  # Remove any existing container
         )
 
-        return container.name
+        return container.name  # Todo, create an external docker container api.
 
     @staticmethod
     def build_from_fastled_repo(
-        project_root: Path | str = Path("."), platform_tag: str = ""
-    ) -> str:
+        project_root: Path | str = Path("."),
+        interactive: bool = False,
+        sketch_folder: Path | None = None,
+    ) -> CompileServer:
         """Build the FastLED WASM compiler Docker image, which will be tagged as "main".
 
         Args:
@@ -247,15 +283,22 @@ class Docker:
         from fastled.docker_manager import DockerManager
         from fastled.settings import CONTAINER_NAME, IMAGE_NAME
 
+        project_root = Path(project_root)
+        if interactive:
+            if sketch_folder is None:
+                sketch_folder = project_root / "examples" / "wasm"
+        else:
+            if sketch_folder is not None:
+                raise ValueError(
+                    "Cannot specify sketch_folder when not in interactive mode."
+                )
         if isinstance(project_root, str):
             project_root = Path(project_root)
 
         dockerfile_path = (
             project_root / "src" / "platforms" / "wasm" / "compiler" / "Dockerfile"
         )
-
         docker_mgr = DockerManager()
-
         platform_tag = ""
         # if "arm" in docker_mgr.architecture():
         if (
@@ -277,18 +320,16 @@ class Docker:
             platform_tag=platform_tag,
         )
 
-        # Run the container and return it
-        container = docker_mgr.run_container_detached(
-            image_name=IMAGE_NAME,
-            tag="main",
+        out: CompileServer = CompileServer(
             container_name=CONTAINER_NAME,
-            command=None,  # Use default command from Dockerfile
-            volumes=None,  # No volumes needed for build
-            ports=None,  # No ports needed for build
-            remove_previous=True,  # Remove any existing container
+            interactive=interactive,
+            auto_updates=False,
+            mapped_dir=sketch_folder,
+            auto_start=True,
+            remove_previous=True,
         )
-        container_name = f"{container.name}"
-        return container_name
+
+        return out
 
 
 class Tools:

{fastled-1.2.29 → fastled-1.2.31}/src/fastled/app.py

@@ -7,8 +7,9 @@ import sys
 import time
 from pathlib import Path
 
-from fastled.client_server import run_client, run_client_server
+from fastled.client_server import run_client_server
 from fastled.compile_server import CompileServer
+from fastled.filewatcher import file_watcher_set
 from fastled.parse_args import parse_args
 
 
@@ -44,53 +45,65 @@ def run_server(args: argparse.Namespace) -> int:
 
 def main() -> int:
     args = parse_args()
-    if args.update:
+    interactive: bool = args.interactive
+    server: str | CompileServer | None = args.server
+    update: bool = args.update
+    build: bool = args.build
+    just_compile: bool = args.just_compile
+    # directory: Path | None = Path(args.directory).absolute() if args.directory else None
+    directory: Path | None = Path(args.directory) if args.directory else None
+
+    # broken for now
+    if directory is None and interactive:
+        # if examples/wasm exists
+        if Path("examples/wasm").exists():
+            print(f"Using {Path('examples/wasm')} as the sketch directory")
+            directory = Path("examples/wasm").absolute()
+
+    if update:
         # Force auto_update to ensure update check happens
         compile_server = CompileServer(interactive=False, auto_updates=True)
         compile_server.stop()
         print("Finished updating.")
         return 0
 
-    if args.build:
+    if build:
         try:
+            file_watcher_set(False)
             project_root = Path(".").absolute()
             print(f"Building Docker image at {project_root}")
             from fastled import Api, Docker
 
-            docker_image_name = Docker.build_from_fastled_repo(
-                project_root=project_root
+            server = Docker.build_from_fastled_repo(
+                project_root=project_root, interactive=interactive
             )
-            print(f"Built Docker image: {docker_image_name}")
-            if not args.directory:
-                print("No sketch directory specified. So exiting...")
+            assert isinstance(server, CompileServer)
+
+            if interactive:
+                server.stop()
                 return 0
+            print(f"Built Docker image: {server.name}")
+            if not directory:
+                if not directory:
+                    print("No directory specified")
+                server.stop()
+                return 0
+
             print("Running server")
-            with Api.server(
-                auto_updates=False, container_name=docker_image_name
-            ) as server:
-                sketch_dir = Path("examples/wasm")
-                if args.just_compile:
-                    rtn = run_client(
-                        directory=sketch_dir,
-                        host=server,
-                        open_web_browser=False,
-                        keep_running=False,
-                    )
-                    if rtn != 0:
-                        print(f"Failed to compile: {rtn})")
-                    return rtn
-                print(f"Server started at {server.url()}")
-                with Api.live_client(
-                    sketch_directory=sketch_dir, host=server
-                ) as client:
-                    print(f"Client started at {client.url()}")
-                    while True:
-                        time.sleep(0.1)
+            with Api.live_client(
+                auto_updates=False,
+                sketch_directory=directory,
+                host=server,
+                auto_start=True,
+                keep_running=not just_compile,
+            ) as client:
+                print(f"Exited client {client.url()}")
+                print(f"Exiting {server.name}")
         except KeyboardInterrupt:
             print("\nExiting from client...")
             return 1
 
-    if args.server:
+    if server:
         print("Running in server only mode.")
         return run_server(args)
     else:
@@ -101,6 +114,12 @@ def main() -> int:
 if __name__ == "__main__":
     # Note that the entry point for the exe is in cli.py
     try:
+        sys.argv.append("-b")
+        sys.argv.append("examples/wasm")
+        # sys.argv.append()
+        import os
+
+        os.chdir("../fastled")
         sys.exit(main())
     except KeyboardInterrupt:
         print("\nExiting from main...")

{fastled-1.2.29 → fastled-1.2.31}/src/fastled/compile_server.py

@@ -14,6 +14,7 @@ class CompileServer:
         auto_start: bool = True,
         container_name: str | None = None,
         platform: Platform = Platform.WASM,
+        remove_previous: bool = False,
     ) -> None:
         from fastled.compile_server_impl import (  # avoid circular import
             CompileServerImpl,
@@ -27,6 +28,7 @@ class CompileServer:
             auto_updates=auto_updates,
             mapped_dir=mapped_dir,
             auto_start=auto_start,
+            remove_previous=remove_previous,
         )
 
     # May throw CompileServerError if server could not be started.
@@ -51,6 +53,10 @@ class CompileServer:
 
         project_init(example=example, outputdir=outputdir)
 
+    @property
+    def name(self) -> str:
+        return self.impl.container_name
+
     @property
     def running(self) -> bool:
         return self.impl.running

{fastled-1.2.29 → fastled-1.2.31}/src/fastled/compile_server_impl.py

@@ -42,6 +42,7 @@ class CompileServerImpl:
         mapped_dir: Path | None = None,
         auto_start: bool = True,
         container_name: str | None = None,
+        remove_previous: bool = False,
     ) -> None:
         container_name = container_name or DEFAULT_CONTAINER_NAME
         if interactive and not mapped_dir:
@@ -49,7 +50,9 @@ class CompileServerImpl:
                 "Interactive mode requires a mapped directory point to a sketch"
             )
         if not interactive and mapped_dir:
-            raise ValueError("Mapped directory is only used in interactive mode")
+            warnings.warn(
+                f"Mapped directory {mapped_dir} is ignored in non-interactive mode"
+            )
         self.container_name = container_name
         self.mapped_dir = mapped_dir
         self.docker = DockerManager()
@@ -57,6 +60,7 @@ class CompileServerImpl:
         self.interactive = interactive
         self.running_container: RunningContainer | None = None
         self.auto_updates = auto_updates
+        self.remove_previous = remove_previous
         self._port = 0  # 0 until compile server is started
         if auto_start:
             self.start()
@@ -242,7 +246,7 @@ class CompileServerImpl:
                 command=cmd_str,
                 ports=ports,
                 volumes=volumes,
-                remove_previous=self.interactive,
+                remove_previous=self.interactive or self.remove_previous,
             )
             self.running_container = self.docker.attach_and_run(container)
             assert self.running_container is not None, "Container should be running"

{fastled-1.2.29 → fastled-1.2.31}/src/fastled/filewatcher.py

@@ -1,5 +1,4 @@
-"""File system watcher implementation using watchdog
-"""
+"""File system watcher implementation using watchdog"""
 
 import hashlib
 import os
@@ -17,6 +16,16 @@ from watchdog.observers import Observer
 from watchdog.observers.api import BaseObserver
 
 
+def file_watcher_enabled() -> bool:
+    """Check if watchdog is disabled"""
+    return os.getenv("NO_FILE_WATCHING", "0") == "1"
+
+
+def file_watcher_set(enabled: bool) -> None:
+    """Set the file watcher enabled state"""
+    os.environ["NO_FILE_WATCHING"] = "1" if not enabled else "0"
+
+
 class MyEventHandler(FileSystemEventHandler):
     def __init__(
         self,
@@ -120,6 +129,9 @@ class FileChangedNotifier(threading.Thread):
         Returns:
             Changed filepath or None if no change within timeout
         """
+        if file_watcher_enabled():
+            time.sleep(timeout)
+            return None
         try:
             filepath = self.change_queue.get(timeout=timeout)
             current_time = time.time()

{fastled-1.2.29 → fastled-1.2.31}/src/fastled/live_client.py

@@ -1,4 +1,5 @@
 import threading
+import warnings
 from pathlib import Path
 
 from fastled.compile_server import CompileServer
@@ -13,6 +14,7 @@ class LiveClient:
         sketch_directory: Path,
         host: str | CompileServer | None = None,
         auto_start: bool = True,
+        auto_updates: bool = True,
         open_web_browser: bool = True,
         keep_running: bool = True,
         build_mode: BuildMode = BuildMode.QUICK,
@@ -27,8 +29,11 @@ class LiveClient:
         self.auto_start = auto_start
         self.shutdown = threading.Event()
         self.thread: threading.Thread | None = None
+        self.auto_updates = auto_updates
         if auto_start:
             self.start()
+        if self.auto_updates is False:
+            warnings.warn("Auto updates False are not supported yet.")
 
     def run(self) -> int:
         """Run the client."""

{fastled-1.2.29 → fastled-1.2.31}/src/fastled/test/examples.py

@@ -32,6 +32,7 @@ def test_examples(
             print(f"Compilation took: {diff:.2f} seconds")
             result = Api.web_compile(sketch_dir, host=host)
             if not result.success:
+                print(f"Compilation failed for {example}: {result.stdout}")
                 out[example] = Exception(result.stdout)
     return out
 

{fastled-1.2.29 → fastled-1.2.31}/src/fastled.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: fastled
-Version: 1.2.29
+Version: 1.2.31
 Summary: FastLED Wasm Compiler
 Home-page: https://github.com/zackees/fastled-wasm
 Maintainer: Zachary Vorhies
@@ -295,6 +295,7 @@ A: A big chunk of space is being used by unnecessary javascript `emscripten` bun
 
 # Revisions
 
+  * 1.2.31 - Bunch of fixes and ease of use while compiling code in the repo.
   * 1.2.22 - Prefer to use `live-server` from npm. If npm exists on the system then do a background install of `live-server` for next run.
   * 1.2.20 - Fixed up path issue for web browser launch for hot reload.
   * 1.2.19 - Compilation failure now overwrites the index.html file with error message.

{fastled-1.2.29 → fastled-1.2.31}/src/fastled.egg-info/SOURCES.txt

@@ -65,6 +65,8 @@ tests/test_api.py
 tests/test_bad_ino.py
 tests/test_build.py
 tests/test_build_examples.py
+tests/test_build_from_docker.py
+tests/test_build_from_github.py
 tests/test_cli.py
 tests/test_compile_server.py
 tests/test_docker_linux_on_windows.py

{fastled-1.2.29 → fastled-1.2.31}/tests/test_build.py

@@ -35,11 +35,11 @@ class BuildDockerFromRepoTester(unittest.TestCase):
     def test_build_docker(self) -> None:
         """Builds the docker file from the fastled repo."""
 
-        docker_image_name = Docker.build_from_fastled_repo(FASTLED_SISTER_REPO)
-        self.assertTrue(docker_image_name, "Failed to build docker image")
-        server: CompileServer
-        with Api.server(auto_updates=True, container_name=docker_image_name) as server:
-            self.assertTrue(server.ping())
+        container = Docker.build_from_fastled_repo(FASTLED_SISTER_REPO)
+        try:
+            self.assertTrue(container.ping())
+        finally:
+            container.stop()
 
     @unittest.skipUnless(_enabled(), "Skipping test on non-Linux system on github")
     def test_build_docker_from_github(self) -> None:

fastled-1.2.31/tests/test_build_from_docker.py

@@ -0,0 +1,47 @@
+"""
+Unit test file.
+"""
+
+import unittest
+from pathlib import Path
+
+from fastled import CompileServer, Docker, Test
+
+HERE = Path(__file__).parent
+PROJECT_ROOT = HERE.parent
+FASTLED_SISTER_REPO = PROJECT_ROOT / ".." / "FastLED"
+
+DEFAULT_GITHUB_URL = "https://github.com/fastled/fastled"
+OUTPUT_DIR = Path(".cache/fastled")
+
+
+def _enabled() -> bool:
+    """Check if this system can run the tests."""
+    sister_repo_does_not_exist = not FASTLED_SISTER_REPO.exists()
+
+    if sister_repo_does_not_exist:
+        print(
+            f"This test is only enable when FastLED is a repo in the same directly as the project root folder: {FASTLED_SISTER_REPO} does not exist"
+        )
+        return False
+
+    return Test.can_run_local_docker_tests()
+
+
+class BuildDockerFromRepoTester(unittest.TestCase):
+    """Main tester class."""
+
+    @unittest.skipUnless(_enabled(), "Skipping test on non-Linux system on github")
+    def test_build_docker(self) -> None:
+        """Builds the docker file from the fastled repo."""
+        server: CompileServer = Docker.build_from_fastled_repo(FASTLED_SISTER_REPO)
+        self.assertIsNotNone(server, "Failed to build docker image")
+
+        try:
+            self.assertTrue(server.ping())
+        finally:
+            server.stop()
+
+
+if __name__ == "__main__":
+    unittest.main()

fastled-1.2.31/tests/test_build_from_github.py

@@ -0,0 +1,46 @@
+"""
+Unit test file.
+"""
+
+import unittest
+from pathlib import Path
+
+from fastled import Api, CompileServer, Docker, Test  # type: ignore
+
+HERE = Path(__file__).parent
+PROJECT_ROOT = HERE.parent
+FASTLED_SISTER_REPO = PROJECT_ROOT / ".." / "FastLED"
+
+DEFAULT_GITHUB_URL = "https://github.com/fastled/fastled"
+OUTPUT_DIR = Path(".cache/fastled")
+
+
+def _enabled() -> bool:
+    """Check if this system can run the tests."""
+    sister_repo_does_not_exist = not FASTLED_SISTER_REPO.exists()
+
+    if sister_repo_does_not_exist:
+        print(
+            f"This test is only enable when FastLED is a repo in the same directly as the project root folder: {FASTLED_SISTER_REPO} does not exist"
+        )
+        return False
+
+    return Test.can_run_local_docker_tests()
+
+
+class BuildDockerFromGithubTester(unittest.TestCase):
+
+    @unittest.skipUnless(_enabled(), "Skipping test on non-Linux system on github")
+    def test_build_docker_from_github(self) -> None:
+        """Builds the docker file from the fastled repo."""
+        url = DEFAULT_GITHUB_URL
+        print("Building from github")
+        docker_image_name = Docker.build_from_github(url=url, output_dir=OUTPUT_DIR)
+        self.assertTrue(docker_image_name, "Failed to build docker image")
+        server: CompileServer
+        with Api.server(auto_updates=True, container_name=docker_image_name) as server:
+            self.assertTrue(server.ping())
+
+
+if __name__ == "__main__":
+    unittest.main()