fastled 1.2.74__tar.gz → 1.2.76__tar.gz

{fastled-1.2.74 → fastled-1.2.76}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastled
-Version: 1.2.74
+Version: 1.2.76
 Summary: FastLED Wasm Compiler
 Home-page: https://github.com/zackees/fastled-wasm
 Maintainer: Zachary Vorhies

{fastled-1.2.74 → fastled-1.2.76}/src/fastled/__init__.py

@@ -13,7 +13,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.74"
+__version__ = "1.2.76"
 
 DOCKER_FILE = (
     "https://raw.githubusercontent.com/zackees/fastled-wasm/refs/heads/main/Dockerfile"

{fastled-1.2.74 → fastled-1.2.76}/src/fastled/docker_manager.py

@@ -25,6 +25,7 @@ from docker.models.containers import Container
 from docker.models.images import Image
 from filelock import FileLock
 
+from fastled.print_filter import PrintFilter, PrintFilterFastled
 from fastled.spinner import Spinner
 
 CONFIG_DIR = Path(user_data_dir("fastled", "fastled"))
@@ -99,25 +100,10 @@ class Volume:
         return volumes
 
 
-class PrintFilter:
-    """Provides filtering for text output so that source files match up with local names."""
-
-    def __init__(self) -> None:
-        pass
-
-    def _remove_ino_cpp(self, text: str) -> str:
-        return text.replace(".ino.cpp", ".ino")
-
-    def _filter_all(self, text: str) -> str:
-        text = self._remove_ino_cpp(text)
-        return text
-
-    def print(self, text: str | bytes) -> None:
-        """Prints the text to the console."""
-        if isinstance(text, bytes):
-            text = text.decode("utf-8")
-        text = self._filter_all(text)
-        print(text, end="")
+# Override the default PrintFilter to use a custom one.
+def make_default_print_filter() -> PrintFilter:
+    """Create a default PrintFilter instance."""
+    return PrintFilterFastled()
 
 
 class RunningContainer:
@@ -127,7 +113,7 @@ class RunningContainer:
         first_run: bool = False,
         filter: PrintFilter | None = None,
     ) -> None:
-        self.filter = filter or PrintFilter()
+        self.filter = filter or make_default_print_filter()
         self.container = container
         self.first_run = first_run
         self.running = True

{fastled-1.2.74 → fastled-1.2.76}/src/fastled/parse_args.py

@@ -24,10 +24,37 @@ def _find_fastled_repo(start: Path) -> Path | None:
     return None
 
 
+_DEFAULT_HELP_TEXT = """
+FastLED WASM Compiler - Useful options:
+  <directory>           Directory containing the FastLED sketch to compile
+  --init [example]      Initialize one of the top tier WASM examples
+  --web [url]           Use web compiler
+  --server              Run the compiler server
+  --debug               Build with debug symbols for dev-tools debugging
+  --quick               Build in quick mode (default)
+  --release             Build in optimized release mode
+  --profile             Enable profiling the C++ build system
+  --update              Update the docker image for the wasm compiler
+  --purge               Remove all FastLED containers and images
+  --version             Show version information
+  --help                Show detailed help
+Examples:
+  fastled (will auto detect the sketch directory and prompt you)
+  fastled my_sketch
+  fastled my_sketch --web (compiles using the web compiler only)
+  fastled --init Blink (initializes a new sketch directory with the Blink example)
+  fastled --server (runs the compiler server in the current directory)
+"""
+
+
 def parse_args() -> Args:
     """Parse command-line arguments."""
     from fastled import __version__
 
+    # Check if no arguments were provided
+    if len(sys.argv) == 1:
+        print(_DEFAULT_HELP_TEXT)
+
     parser = argparse.ArgumentParser(description=f"FastLED WASM Compiler {__version__}")
     parser.add_argument("--version", action="version", version=f"{__version__}")
     parser.add_argument(
@@ -66,7 +93,7 @@ def parse_args() -> Args:
     parser.add_argument(
         "--profile",
         action="store_true",
-        help="Enable profiling for web compilation",
+        help="Enable profiling of the C++ build system used for wasm compilation.",
     )
     parser.add_argument(
         "--force-compile",
@@ -79,6 +106,7 @@ def parse_args() -> Args:
         help="Disable automatic updates of the wasm compiler image when using docker.",
     )
     parser.add_argument(
+        "-u",
         "--update",
         "--upgrade",
         action="store_true",
@@ -89,7 +117,7 @@ def parse_args() -> Args:
         "--local",
         "-l",
         action="store_true",
-        help="Use localhost for web compilation from an instance of fastled --server, creating it if necessary",
+        help="(Default): Use localhost for web compilation from an instance of fastled --server, creating it if necessary",
     )
     parser.add_argument(
         "--build",

fastled-1.2.76/src/fastled/print_filter.py

@@ -0,0 +1,68 @@
+import re
+from abc import ABC, abstractmethod
+
+
+class PrintFilter(ABC):
+    """Abstract base class for filtering text output."""
+
+    def __init__(self, echo: bool = True) -> None:
+        self.echo = echo
+
+    @abstractmethod
+    def filter(self, text: str) -> str:
+        """Filter the text according to implementation-specific rules."""
+        pass
+
+    def print(self, text: str | bytes) -> str:
+        """Prints the text to the console after filtering."""
+        if isinstance(text, bytes):
+            text = text.decode("utf-8")
+        text = self.filter(text)
+        if self.echo:
+            print(text, end="")
+        return text
+
+
+def _handle_ino_cpp(line: str) -> str:
+    if ".ino.cpp" in line[0:30]:
+        # Extract the filename without path and extension
+        match = re.search(r"src/([^/]+)\.ino\.cpp", line)
+        if match:
+            filename = match.group(1)
+            # Replace with examples/Filename/Filename.ino format
+            line = line.replace(
+                f"src/{filename}.ino.cpp", f"examples/{filename}/{filename}.ino"
+            )
+        else:
+            # Fall back to simple extension replacement if regex doesn't match
+            line = line.replace(".ino.cpp", ".ino")
+    return line
+
+
+class PrintFilterDefault(PrintFilter):
+    """Provides default filtering for FastLED output."""
+
+    def filter(self, text: str) -> str:
+        return text
+
+
+class PrintFilterFastled(PrintFilter):
+    """Provides filtering for FastLED output so that source files match up with local names."""
+
+    def __init__(self, echo: bool = True) -> None:
+        super().__init__(echo)
+        self.build_started = False
+
+    def filter(self, text: str) -> str:
+        lines = text.splitlines()
+        out: list[str] = []
+        for line in lines:
+            ## DEBUG DO NOT SUBMIT
+            # print(line)
+            if "# WASM is building" in line:
+                self.build_started = True
+            if self.build_started or " error: " in line:
+                line = _handle_ino_cpp(line)
+            out.append(line)
+        text = "\n".join(out)
+        return text

{fastled-1.2.74 → fastled-1.2.76}/src/fastled/select_sketch_directory.py

@@ -20,7 +20,9 @@ def select_sketch_directory(
         print("\nMultiple Directories found, choose one:")
         for i, sketch_dir in enumerate(sketch_directories):
             print(f"  [{i+1}]: {sketch_dir}")
-        which = input("\nPlease specify a sketch directory: ").strip()
+        which = input(
+            "\nPlease specify a sketch directory\nYou can enter a number or type a fuzzy search: "
+        ).strip()
         try:
             index = int(which) - 1
             return str(sketch_directories[index])

{fastled-1.2.74 → fastled-1.2.76}/src/fastled/types.py

@@ -4,6 +4,8 @@ from enum import Enum
 from pathlib import Path
 from typing import Any
 
+from fastled.print_filter import PrintFilterFastled
+
 
 @dataclass
 class Args:
@@ -102,6 +104,11 @@ class CompileResult:
     def to_dict(self) -> dict[str, Any]:
         return self.__dict__.copy()
 
+    def __post_init__(self):
+        # Filter the stdout.
+        pf = PrintFilterFastled(echo=False)
+        self.stdout = pf.print(self.stdout)
+
 
 class CompileServerError(Exception):
     """Error class for failing to instantiate CompileServer."""

{fastled-1.2.74 → fastled-1.2.76}/src/fastled/web_compile.py

@@ -4,6 +4,7 @@ import json
 import os
 import shutil
 import tempfile
+import time
 import zipfile
 from concurrent.futures import Future, ThreadPoolExecutor, as_completed
 from dataclasses import dataclass
@@ -154,6 +155,37 @@ def find_good_connection(
     return None
 
 
+def _banner(msg: str) -> str:
+    """
+    Create a banner for the given message.
+    Example:
+    msg = "Hello, World!"
+    print -> "#################"
+             "# Hello, World! #"
+             "#################"
+    """
+    lines = msg.split("\n")
+    # Find the width of the widest line
+    max_width = max(len(line) for line in lines)
+    width = max_width + 4  # Add 4 for "# " and " #"
+
+    # Create the top border
+    banner = "\n" + "#" * width + "\n"
+
+    # Add each line with proper padding
+    for line in lines:
+        padding = max_width - len(line)
+        banner += f"# {line}{' ' * padding} #\n"
+
+    # Add the bottom border
+    banner += "#" * width + "\n"
+    return banner
+
+
+def _print_banner(msg: str) -> None:
+    print(_banner(msg))
+
+
 def web_compile(
     directory: Path | str,
     host: str | None = None,
@@ -161,11 +193,12 @@ def web_compile(
     build_mode: BuildMode | None = None,
     profile: bool = False,
 ) -> CompileResult:
+    start_time = time.time()
     if isinstance(directory, str):
         directory = Path(directory)
     host = _sanitize_host(host or DEFAULT_HOST)
     build_mode = build_mode or BuildMode.QUICK
-    print("Compiling on", host)
+    _print_banner(f"Compiling on {host}")
     auth_token = auth_token or _AUTH_TOKEN
     if not directory.exists():
         raise FileNotFoundError(f"Directory not found: {directory}")
@@ -186,7 +219,7 @@ def web_compile(
 
         connection_result = find_good_connection(urls)
         if connection_result is None:
-            print("Connection failed to all endpoints")
+            _print_banner("Connection failed to all endpoints")
             return CompileResult(
                 success=False,
                 stdout="Connection failed",
@@ -270,6 +303,9 @@ def web_compile(
                             relative_path = file_path.relative_to(extract_path)
                             out_zip.write(file_path, relative_path)
 
+                diff_time = time.time() - start_time
+                msg = f"Compilation success, took {diff_time:.2f} seconds"
+                _print_banner(msg)
                 return CompileResult(
                     success=True,
                     stdout=stdout,

{fastled-1.2.74 → fastled-1.2.76}/src/fastled.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastled
-Version: 1.2.74
+Version: 1.2.76
 Summary: FastLED Wasm Compiler
 Home-page: https://github.com/zackees/fastled-wasm
 Maintainer: Zachary Vorhies

{fastled-1.2.74 → fastled-1.2.76}/src/fastled.egg-info/SOURCES.txt

@@ -77,6 +77,7 @@ src/fastled/live_client.py
 src/fastled/open_browser.py
 src/fastled/parse_args.py
 src/fastled/paths.py
+src/fastled/print_filter.py
 src/fastled/project_init.py
 src/fastled/select_sketch_directory.py
 src/fastled/server_fastapi.py
@@ -113,6 +114,7 @@ tests/unit/test_docker_linux_on_windows.py
 tests/unit/test_embedded_data.py
 tests/unit/test_filechanger.py
 tests/unit/test_http_server.py
+tests/unit/test_print_filter.py
 tests/unit/test_project_init.py
 tests/unit/test_server_and_client_seperatly.py
 tests/unit/test_string_diff.py

{fastled-1.2.74 → fastled-1.2.76}/tests/unit/test_bad_ino.py

@@ -35,7 +35,15 @@ class WebCompileTester(unittest.TestCase):
             print("stdout:")
             print(result.stdout)
             self.fail("Expected error not found in stdout")
-        # self.assertIn("lsfjsdklfjdskfjkasdfjdsfds", result.stdout)
+        if "bad/bad.ino:" not in result.stdout:  # No .cpp extension.
+            print(
+                "bad.ino.cpp was not transformed to bad.ino without the cpp extension"
+            )
+            print("stdout:")
+            print(result.stdout)
+            self.fail(
+                "bad.ino.cpp was not transformed to bad.ino without the cpp extension"
+            )
 
         print(f"Zip size: {len(result.zip_bytes)} bytes")
 

fastled-1.2.76/tests/unit/test_print_filter.py

@@ -0,0 +1,28 @@
+"""
+Unit test file.
+"""
+
+import unittest
+
+from fastled.print_filter import PrintFilterFastled
+
+
+class PrintFitlerTester(unittest.TestCase):
+    """Main tester class."""
+
+    def test_print_filter(self) -> None:
+        """Tests that a project can be filtered"""
+        # Test the PrintFilter class
+        pf = PrintFilterFastled(echo=False)
+        pf.print("# WASM is building")  # This should trigger the filter.
+        result = pf.print(
+            "5.36 src/XYPath.ino.cpp:4:1: error: unknown type name 'kdsjfsdkfjsd'"
+        )  # This should now be transformed.
+        self.assertNotIn(".ino.cpp", result, "Expected .ino.cpp to be filtered out")
+        self.assertIn(
+            "examples/XYPath/XYPath.ino", result, "Expected path to be transformed"
+        )
+
+
+if __name__ == "__main__":
+    unittest.main()