fastled 1.1.38__py2.py3-none-any.whl → 1.1.39__py2.py3-none-any.whl

fastled/__init__.py

@@ -6,9 +6,10 @@ from pathlib import Path
 from typing import Generator
 
 from .compile_server import CompileServer
+from .live_client import LiveClient
 from .types import BuildMode, CompileResult, CompileServerError
 
-__version__ = "1.1.38"
+__version__ = "1.1.39"
 
 
 class Api:
@@ -46,6 +47,26 @@ class Api:
         )
         return out
 
+    @staticmethod
+    def live_client(
+        sketch_directory: Path,
+        host: str | CompileServer | None = None,
+        auto_start=True,
+        open_web_browser=True,
+        keep_running=True,
+        build_mode=BuildMode.QUICK,
+        profile=False,
+    ) -> LiveClient:
+        return LiveClient(
+            sketch_directory=sketch_directory,
+            host=host,
+            auto_start=auto_start,
+            open_web_browser=open_web_browser,
+            keep_running=keep_running,
+            build_mode=build_mode,
+            profile=profile,
+        )
+
     @staticmethod
     def spawn_server(
         sketch_directory: Path | None = None,

fastled/client_server.py

@@ -1,6 +1,7 @@
 import argparse
 import shutil
 import tempfile
+import threading
 import time
 from multiprocessing import Process
 from pathlib import Path
@@ -12,7 +13,7 @@ from fastled.keyboard import SpaceBarWatcher
 from fastled.open_browser import open_browser_process
 from fastled.settings import DEFAULT_URL
 from fastled.sketch import looks_like_sketch_directory
-from fastled.types import BuildMode, CompileResult
+from fastled.types import BuildMode, CompileResult, CompileServerError
 from fastled.web_compile import (
     SERVER_PORT,
     ConnectionResult,
@@ -78,7 +79,7 @@ def _run_web_compiler(
 
 def _try_start_server_or_get_url(
     auto_update: bool, args_web: str | bool, localhost: bool
-) -> str | CompileServer:
+) -> tuple[str, CompileServer | None]:
     is_local_host = localhost or (
         isinstance(args_web, str)
         and ("localhost" in args_web or "127.0.0.1" in args_web)
@@ -94,16 +95,16 @@ def _try_start_server_or_get_url(
         result: ConnectionResult | None = find_good_connection(urls)
         if result is not None:
             print(f"Found local server at {result.host}")
-            return result.host
+            return (result.host, None)
         else:
             local_host_needs_server = True
 
     if not local_host_needs_server and args_web:
         if isinstance(args_web, str):
-            return args_web
+            return (args_web, None)
         if isinstance(args_web, bool):
-            return DEFAULT_URL
-        return args_web
+            return (DEFAULT_URL, None)
+        return (args_web, None)
     else:
         try:
             print("No local server found, starting one...")
@@ -111,63 +112,40 @@ def _try_start_server_or_get_url(
             print("Waiting for the local compiler to start...")
             if not compile_server.ping():
                 print("Failed to start local compiler.")
-                raise RuntimeError("Failed to start local compiler.")
-            return compile_server
+                raise CompileServerError("Failed to start local compiler.")
+            return (compile_server.url(), compile_server)
         except KeyboardInterrupt:
             raise
         except RuntimeError:
             print("Failed to start local compile server, using web compiler instead.")
-            return DEFAULT_URL
+            return (DEFAULT_URL, None)
 
 
-def run_client_server(args: argparse.Namespace) -> int:
-    compile_server: CompileServer | None = None
+def run_client(
+    directory: Path,
+    host: str | CompileServer | None,
+    open_web_browser: bool = True,
+    keep_running: bool = True,  # if false, only one compilation will be done.
+    build_mode: BuildMode = BuildMode.QUICK,
+    profile: bool = False,
+    shutdown: threading.Event | None = None,
+) -> int:
+
+    compile_server: CompileServer | None = (
+        host if isinstance(host, CompileServer) else None
+    )
+    shutdown = shutdown or threading.Event()
 
-    profile = bool(args.profile)
-    web: str | bool = args.web if isinstance(args.web, str) else bool(args.web)
-    auto_update = bool(args.auto_update)
-    localhost = bool(args.localhost)
-    directory = Path(args.directory)
-    just_compile = bool(args.just_compile)
-    interactive = bool(args.interactive)
-    force_compile = bool(args.force_compile)
-    open_web_browser = not just_compile and not interactive
+    def get_url() -> str:
+        if compile_server is not None:
+            return compile_server.url()
+        if isinstance(host, str):
+            return host
+        return DEFAULT_URL
 
-    if not force_compile and not looks_like_sketch_directory(directory):
-        print(
-            "Error: Not a valid FastLED sketch directory, if you are sure it is, use --force-compile"
-        )
-        return 1
+    url = get_url()
 
-    # If not explicitly using web compiler, check Docker installation
-    if not web and not DockerManager.is_docker_installed():
-        print(
-            "\nDocker is not installed on this system - switching to web compiler instead."
-        )
-        web = True
-
-    url: str
     try:
-        try:
-            url_or_server: str | CompileServer = _try_start_server_or_get_url(
-                auto_update, web, localhost
-            )
-            if isinstance(url_or_server, str):
-                print(f"Found URL: {url_or_server}")
-                url = url_or_server
-            else:
-                compile_server = url_or_server
-                print(f"Server started at {compile_server.url()}")
-                url = compile_server.url()
-        except KeyboardInterrupt:
-            print("\nExiting from first try...")
-            if compile_server:
-                compile_server.stop()
-            return 1
-        except Exception as e:
-            print(f"Error: {e}")
-            return 1
-        build_mode: BuildMode = BuildMode.from_args(args)
 
         def compile_function(
             url: str = url,
@@ -199,16 +177,12 @@ def run_client_server(args: argparse.Namespace) -> int:
                 compile_server.stop()
             return 0
 
-        if just_compile:
-            if compile_server:
-                compile_server.stop()
+        if not keep_running or shutdown.is_set():
             if browser_proc:
                 browser_proc.kill()
             return 0 if result.success else 1
     except KeyboardInterrupt:
         print("\nExiting from main")
-        if compile_server:
-            compile_server.stop()
         return 1
 
     sketch_filewatcher = FileWatcherProcess(directory, excluded_patterns=["fastled_js"])
@@ -243,6 +217,9 @@ def run_client_server(args: argparse.Namespace) -> int:
 
     try:
         while True:
+            if shutdown.is_set():
+                print("\nStopping watch mode...")
+                return 0
             if SpaceBarWatcher.watch_space_bar_pressed(timeout=1.0):
                 print("Compiling...")
                 last_compiled_result = compile_function(last_hash_value=None)
@@ -310,3 +287,59 @@ def run_client_server(args: argparse.Namespace) -> int:
             compile_server.stop()
         if browser_proc:
             browser_proc.kill()
+
+
+def run_client_server(args: argparse.Namespace) -> int:
+    profile = bool(args.profile)
+    web: str | bool = args.web if isinstance(args.web, str) else bool(args.web)
+    auto_update = bool(args.auto_update)
+    localhost = bool(args.localhost)
+    directory = Path(args.directory)
+    just_compile = bool(args.just_compile)
+    interactive = bool(args.interactive)
+    force_compile = bool(args.force_compile)
+    open_web_browser = not just_compile and not interactive
+    build_mode: BuildMode = BuildMode.from_args(args)
+
+    if not force_compile and not looks_like_sketch_directory(directory):
+        print(
+            "Error: Not a valid FastLED sketch directory, if you are sure it is, use --force-compile"
+        )
+        return 1
+
+    # If not explicitly using web compiler, check Docker installation
+    if not web and not DockerManager.is_docker_installed():
+        print(
+            "\nDocker is not installed on this system - switching to web compiler instead."
+        )
+        web = True
+
+    url: str
+    compile_server: CompileServer | None = None
+    try:
+        url, compile_server = _try_start_server_or_get_url(auto_update, web, localhost)
+    except KeyboardInterrupt:
+        print("\nExiting from first try...")
+        if compile_server:
+            compile_server.stop()
+        return 1
+    except Exception as e:
+        print(f"Error: {e}")
+        if compile_server:
+            compile_server.stop()
+        return 1
+
+    try:
+        return run_client(
+            directory=directory,
+            host=compile_server if compile_server else url,
+            open_web_browser=open_web_browser,
+            keep_running=not just_compile,
+            build_mode=build_mode,
+            profile=profile,
+        )
+    except KeyboardInterrupt:
+        return 1
+    finally:
+        if compile_server:
+            compile_server.stop()

fastled/compile_server.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from fastled.types import BuildMode, CompileResult
+from fastled.types import BuildMode, CompileResult, Platform
 
 
 class CompileServer:
@@ -13,11 +13,14 @@ class CompileServer:
         mapped_dir: Path | None = None,
         auto_start: bool = True,
         container_name: str | None = None,
+        platform: Platform = Platform.WASM,
     ) -> None:
         from fastled.compile_server_impl import (  # avoid circular import
             CompileServerImpl,
         )
 
+        assert platform == Platform.WASM, "Only WASM platform is supported right now."
+
         self.impl = CompileServerImpl(
             container_name=container_name,
             interactive=interactive,

fastled/live_client.py

@@ -0,0 +1,69 @@
+import threading
+from pathlib import Path
+
+from fastled.compile_server import CompileServer
+from fastled.types import BuildMode
+
+
+class LiveClient:
+    """LiveClient class watches for changes and auto-triggeres rebuild."""
+
+    def __init__(
+        self,
+        sketch_directory: Path,
+        host: str | CompileServer | None = None,
+        auto_start: bool = True,
+        open_web_browser: bool = True,
+        keep_running: bool = True,
+        build_mode: BuildMode = BuildMode.QUICK,
+        profile: bool = False,
+    ) -> None:
+        self.sketch_directory = sketch_directory
+        self.host = host
+        self.open_web_browser = open_web_browser
+        self.keep_running = keep_running
+        self.build_mode = build_mode
+        self.profile = profile
+        self.auto_start = auto_start
+        self.shutdown = threading.Event()
+        self.thread: threading.Thread | None = None
+        if auto_start:
+            self.start()
+
+    def run(self) -> int:
+        """Run the client."""
+        from fastled.client_server import run_client  # avoid circular import
+
+        rtn = run_client(
+            directory=self.sketch_directory,
+            host=self.host,
+            open_web_browser=self.open_web_browser,
+            keep_running=self.keep_running,
+            build_mode=self.build_mode,
+            profile=self.profile,
+            shutdown=self.shutdown,
+        )
+        return rtn
+
+    @property
+    def running(self) -> bool:
+        return self.thread is not None and self.thread.is_alive()
+
+    def start(self) -> None:
+        """Start the client."""
+        assert not self.running, "LiveClient is already running"
+        self.shutdown.clear()
+        self.thread = threading.Thread(target=self.run, daemon=True)
+        self.thread.start()
+
+    def stop(self) -> None:
+        """Stop the client."""
+        self.shutdown.set()
+        if self.thread:
+            self.thread.join()
+            self.thread = None
+
+    def finalize(self) -> None:
+        """Finalize the client."""
+        self.stop()
+        self.thread = None

fastled/types.py

@@ -45,3 +45,17 @@ class BuildMode(Enum):
             return BuildMode.RELEASE
         else:
             return BuildMode.QUICK
+
+
+class Platform(Enum):
+    WASM = "WASM"
+
+    @classmethod
+    def from_string(cls, platform_str: str) -> "Platform":
+        try:
+            return cls[platform_str.upper()]
+        except KeyError:
+            valid_modes = [mode.name for mode in cls]
+            raise ValueError(
+                f"Platform must be one of {valid_modes}, got {platform_str}"
+            )

{fastled-1.1.38.dist-info → fastled-1.1.39.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastled
-Version: 1.1.38
+Version: 1.1.39
 Summary: FastLED Wasm Compiler
 Home-page: https://github.com/zackees/fastled-wasm
 Maintainer: Zachary Vorhies
@@ -148,6 +148,35 @@ with Api.server() as server:
 
 ```
 
+**LiveClient will auto-trigger a build on code changes, just like the cli does**
+```python
+
+# Live Client will compile against the web-compiler
+from fastapi import Api, LiveClient
+client: LiveClient = Api.live_client(
+    "path/to/sketch_directory",
+)
+# Now user can start editing their sketch and it will auto-compile
+# ... after a while stop it like this.
+client.stop()
+```
+
+**LiveClient with local CompileServer**
+```python
+
+# Live Client will compile against a local server.
+from fastapi import Api, LiveClient
+
+with Api.server() as server:
+    client: LiveClient = Api.live_client(
+        "path/to/sketch_directory",
+        host=server
+    )
+    # Now user can start editing their sketch and it will auto-compile
+    # ... after a while stop it like this.
+    client.stop()
+```
+
 # Features
 
 ## Hot reload by default
@@ -168,11 +197,15 @@ can be much longer, for example if you modify a header file.
 Huge blobs of data like video will absolutely kill the compile performance as these blobs would normally have to be shuffled
 back and forth. Therefore a special directory `data/` is implicitly used to hold this blob data. Any data in this directory
 will be replaced with a stub containing the size and hash of the file during upload. On download these stubs are swapped back
-with their originals.
+with their originals during decompression.
 
 The wasm compiler will recognize all files in the `data/` directory and generate a `files.json` manifest and can be used
 in your wasm sketch using an emulated SD card system mounted at `/data/` on the SD Card. In order to increase load speed, these
-files will be asynchroniously streamed into the running sketch instance during runtime. The only caveat here is that although these files will be available during the setup() phase of the sketch, they will not be fully hydrated, so if you do a seek(end) of these files the results are undefined.
+files will be asynchroniously streamed into the running sketch instance during runtime. Files named with *.json, *.csv, *.txt will be
+immediately injected in the app before setup() is called and can be used immediatly in setup() in their entirety.
+
+All other files will be streamed in. The `Video` element in FastLED is designed to gracefully handle missing data streamed in through
+the file system.
 
 For an example of how to use this see `examples/SdCard` which is fully wasm compatible.
 
@@ -184,11 +217,9 @@ We use `ccache` to cache object files. This seems actually help a lot and is bet
 
 The compilation to wasm will happen under a lock. Removing this lock requires removing the platformio toolchain as the compiler backend which enforces it's own internal lock preventing parallel use.
 
-Simple syntax errors will be caught by the pre-processing step. This happens without a lock to reduce the single lock bottleneck.
-
 ## Sketch Cache
 
-Sketchs are aggresively finger-printed and stored in a cache. White space, comments, and other superficial data will be stripped out during pre-processing and minimization for fingerprinting. This source file decimation is only used for finger
+Sketchs are aggressively finger-printed and stored in a cache. White space, comments, and other superficial data will be stripped out during pre-processing and minimization for fingerprinting. This source file decimation is only used for finger
 printing while the actual source files are sent to compiler to preserve line numbers and file names.
 
 This pre-processing done is done via gcc and special regex's and will happen without a lock. This will allow you to have extremely quick recompiles for whitespace and changes in comments even if the compiler is executing under it's lock.
@@ -225,6 +256,7 @@ A: A big chunk of space is being used by unnecessary javascript `emscripten` is
 
 # Revisions
   
+  * 1.1.39 - Added `LiveClient`, `fastled.Api.live_server()` will spawn it. Allows user to have a live compiling client that re-triggers a compile on file changes.
   * 1.1.38 - Cleanup the `fastled.Api` object and streamline for general use.
   * 1.1.37 - `Test.test_examples()` is now unit tested to work correctly.
   * 1.1.36 - We now have an api. `from fastled import Api` and `from fastled import Test` for testing.

{fastled-1.1.38.dist-info → fastled-1.1.39.dist-info}/RECORD

@@ -1,12 +1,13 @@
-fastled/__init__.py,sha256=P9XIl4QcR1-RO-RBTPitME_vHzDDq4qFwkZDyEKvE0k,3001
+fastled/__init__.py,sha256=SQF8-PpioJm6DAQn5vCcc-muwXHBfs0loIofSRoWK8g,3613
 fastled/app.py,sha256=3xg7oVD-UYnKPU8SAY-Cs5UnAYdwpdpuEFRR2N8P1Tg,1787
 fastled/cli.py,sha256=CNR_pQR0sNVPNuv8e_nmm-0PI8sU-eUBUgnWgWkzW9c,237
-fastled/client_server.py,sha256=p9mbhgwA3UERrH-Hig0dLzpOpL3Y3xzIBCw3UMpoxPo,11518
-fastled/compile_server.py,sha256=g95J9ZtNG-GiBLIO_qyg8f5FJfnrUJxjxZY-cb3d9lY,2517
+fastled/client_server.py,sha256=KQsBKjHfkhgF5EOCHSbJcqu0dPKlOCsbXA2V035VCH0,12403
+fastled/compile_server.py,sha256=Z7rHFs3M6QPbSCsbgHAQDk6GTVAJMMPCXtD4Y0mu8RM,2659
 fastled/compile_server_impl.py,sha256=ClBLtFHB0ucaT8tAJfI6o3bJ-LRnXc4Pxy7bVKnFiww,8803
 fastled/docker_manager.py,sha256=zBCFGk2P3_bS7_SUQ5j2lpsOS3RvIzXYkrJXC6xP69k,25383
 fastled/filewatcher.py,sha256=LwEQJkqADsArZyY499RLAer6JjJyDwaQBcAvT7xmp3c,6708
 fastled/keyboard.py,sha256=Zz_ggxOUTX2XQEy6K6kAoorVlUev4wEk9Awpvv9aStA,3241
+fastled/live_client.py,sha256=_KvqmyUyyGpoYET1Z9CdeUVoIbFjIUWwPcTp5XCQuxY,2075
 fastled/open_browser.py,sha256=vzMBcpDNY0f-Bx9KmEILKDANZ6gvsywCVwn1FRhPXh4,1770
 fastled/parse_args.py,sha256=37WsELphNEqGQgmjppZx6uMWE2E-dZ58zCKUl-3mr3Q,6150
 fastled/paths.py,sha256=VsPmgu0lNSCFOoEC0BsTYzDygXqy15AHUfN-tTuzDZA,99
@@ -16,14 +17,14 @@ fastled/settings.py,sha256=3eMKv0tLXgIQ0CFDboIp_l5_71rzIIyWg353YjnYJnc,323
 fastled/sketch.py,sha256=483TrrIdZJfo1MIu5FkD-V5OGmOfHmsZ2f6VvNsJBJM,3299
 fastled/spinner.py,sha256=VHxmvB92P0Z_zYxRajb5HiNmkHHvZ5dG7hKtZltzpcs,867
 fastled/string_diff.py,sha256=UR1oRhg9lsPzAG4bn_MwJMCn0evP5AigkBiwLiI9fgA,1354
-fastled/types.py,sha256=brmCvXeGBYcw0Sket_5I1XGOvrLMfKnhm7ZVbi0oDnI,1098
+fastled/types.py,sha256=PpSEtzFCkWtSIEMC0QXGl966R97vLoryVl3yFW0YhTs,1475
 fastled/util.py,sha256=t4M3NFMhnCzfYbLvIyJi0RdFssZqbTN_vVIaej1WV-U,265
 fastled/web_compile.py,sha256=05PeLJ77QQC6PUKjDhsntBmyBola6QQIfF2k-zjYNE4,10261
 fastled/assets/example.txt,sha256=lTBovRjiz0_TgtAtbA1C5hNi2ffbqnNPqkKg6UiKCT8,54
 fastled/test/examples.py,sha256=EDXb6KastKOOWzew99zrpmcNcXTcAtYi8eud6F1pnWA,980
-fastled-1.1.38.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-fastled-1.1.38.dist-info/METADATA,sha256=hbt9CNXAOkHvxi7MasDzU9-RXBWab-mYTvoSItJWNJw,16912
-fastled-1.1.38.dist-info/WHEEL,sha256=0VNUDWQJzfRahYI3neAhz2UVbRCtztpN5dPHAGvmGXc,109
-fastled-1.1.38.dist-info/entry_points.txt,sha256=RCwmzCSOS4-C2i9EziANq7Z2Zb4KFnEMR1FQC0bBwAw,101
-fastled-1.1.38.dist-info/top_level.txt,sha256=Bbv5kpJpZhWNCvDF4K0VcvtBSDMa8B7PTOrZa9CezHY,8
-fastled-1.1.38.dist-info/RECORD,,
+fastled-1.1.39.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+fastled-1.1.39.dist-info/METADATA,sha256=a-iU6xg5tbGNPN-2l0Bydnk3Xax9-jfWAFV7ltioC6U,17889
+fastled-1.1.39.dist-info/WHEEL,sha256=0VNUDWQJzfRahYI3neAhz2UVbRCtztpN5dPHAGvmGXc,109
+fastled-1.1.39.dist-info/entry_points.txt,sha256=RCwmzCSOS4-C2i9EziANq7Z2Zb4KFnEMR1FQC0bBwAw,101
+fastled-1.1.39.dist-info/top_level.txt,sha256=Bbv5kpJpZhWNCvDF4K0VcvtBSDMa8B7PTOrZa9CezHY,8
+fastled-1.1.39.dist-info/RECORD,,