collagraph 0.9.2__tar.gz → 0.9.3__tar.gz

{collagraph-0.9.2 → collagraph-0.9.3}/.github/workflows/ci.yml

@@ -65,6 +65,22 @@ jobs:
         env:
           QT_QPA_PLATFORM: offscreen
 
+  pyinstaller:
+    name: Test PyInstaller hooks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      - name: Install dependencies
+        run: uv sync
+      - name: Test PyInstaller hooks
+        run: bash tests/pyinstaller/test_pyinstaller.sh
+
   build:
     name: Build and test wheel
     runs-on: ubuntu-latest
@@ -91,7 +107,7 @@ jobs:
   publish:
     name: Publish to Github and Pypi
     runs-on: ubuntu-latest
-    needs: [lint, test, build]
+    needs: [lint, test, build, pyinstaller]
     if: success() && startsWith(github.ref, 'refs/tags/v')
     environment:
       name: pypi

{collagraph-0.9.2 → collagraph-0.9.3}/.gitignore

@@ -4,5 +4,6 @@ __pycache__
 .coverage
 dist
 build
+*.spec
 uv.lock
 .venv

{collagraph-0.9.2 → collagraph-0.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: collagraph
-Version: 0.9.2
+Version: 0.9.3
 Summary: Reactive user interfaces
 Author-email: Berend Klein Haneveld <berendkleinhaneveld@gmail.com>, Korijn van Golen <korijn@gmail.com>
 License-Expression: MIT

collagraph-0.9.3/collagraph/__pyinstaller/hook-collagraph.py

@@ -0,0 +1,126 @@
+import ast
+import atexit
+from pathlib import Path
+
+from PyInstaller.lib.modulegraph.modulegraph import DependencyInfo, MissingModule
+
+from collagraph.sfc.compiler import construct_ast, get_script_ast
+from collagraph.sfc.parser import CGXParser
+
+# Keep track of generated files so they can be cleaned up
+_generated_files: list[Path] = []
+
+
+def _cleanup_generated_files():
+    for path in _generated_files:
+        path.unlink(missing_ok=True)
+
+
+atexit.register(_cleanup_generated_files)
+
+
+def hook(hook_api):
+    collagraph_uses = hook_api.analysis.graph.get_code_using("collagraph")
+
+    hidden_imports = set()
+    cgx_modules = set()
+
+    for package, code in collagraph_uses.items():
+        source_dir = Path(code.co_filename).parent
+
+        # Collect CGX files and their imports from the source directory
+        cgx_files = list(source_dir.glob("**/*.cgx"))
+        hidden_imports |= collect_hidden_imports(cgx_files)
+
+        # Pre-compile each CGX file to Python source so that
+        # PyInstaller can bundle them as regular Python modules,
+        # removing the need to bundle .cgx files and compile them
+        # at runtime
+        for cgx_path in cgx_files:
+            module_name = cgx_path.stem
+            tree, _name = construct_ast(cgx_path)
+            python_source = ast.unparse(tree)
+
+            # Write compiled module next to the CGX file so
+            # PyInstaller can discover it on its existing search path
+            py_path = cgx_path.with_suffix(".py")
+            if not py_path.exists():
+                py_path.write_text(python_source, encoding="utf-8")
+                _generated_files.append(py_path)
+            cgx_modules.add(module_name)
+
+    # Filter out imports that correspond to CGX modules, since
+    # they are now available as pre-compiled Python modules
+    hidden_imports -= cgx_modules
+
+    graph = hook_api.analysis.graph
+
+    # Remove any MissingModule nodes for CGX modules that were
+    # already marked as missing during initial analysis (before
+    # the compiled .py files existed).
+    # removeNode() calls hide_node() which moves the node to
+    # hidden_nodes. Graph.add_node() silently ignores nodes in
+    # hidden_nodes, so we must also delete from hidden_nodes to
+    # allow import_hook to re-add the module as a SourceModule.
+    for name in cgx_modules:
+        node = graph.find_node(name)
+        if isinstance(node, MissingModule):
+            graph.removeNode(node)
+            if name in graph.graph.hidden_nodes:
+                del graph.graph.hidden_nodes[name]
+
+    # Import CGX modules via the module graph and create edges
+    # to the collagraph node so they are included in the bundle.
+    collagraph_node = graph.find_node("collagraph")
+    for name in cgx_modules:
+        try:
+            nodes = graph.import_hook(name, collagraph_node)
+            for node in nodes:
+                graph._updateReference(
+                    collagraph_node,
+                    node,
+                    edge_data=DependencyInfo(
+                        conditional=False,
+                        fromlist=False,
+                        function=False,
+                        tryexcept=False,
+                    ),
+                )
+        except ImportError:
+            pass
+
+    # Add remaining hidden imports (non-CGX Python modules)
+    hook_api.add_imports(*hidden_imports)
+
+
+def collect_hidden_imports(cgx_files):
+    hidden_imports = set()
+    for path in cgx_files:
+        template = path.read_text(encoding="utf-8")
+        # Parse the file component into a tree of Node instances
+        parser = CGXParser()
+        parser.feed(template)
+
+        # Get the AST from the script tag
+        script_tree = get_script_ast(parser, path)
+
+        # Find a list of imported module names
+        imported_names = ImportsCollector()
+        imported_names.visit(script_tree)
+
+        hidden_imports |= imported_names.names
+
+    return hidden_imports
+
+
+class ImportsCollector(ast.NodeVisitor):
+    def __init__(self):
+        self.names = set()
+
+    def visit_ImportFrom(self, node):
+        if node.module:
+            self.names.add(node.module)
+
+    def visit_Import(self, node):
+        for alias in node.names:
+            self.names.add(alias.name)

{collagraph-0.9.2 → collagraph-0.9.3}/collagraph/sfc/importer.py

@@ -66,5 +66,8 @@ class CGXPathFinder(MetaPathFinder):
                 return spec
 
 
-# Add cgx path finder at the end of the list of finders
-sys.meta_path.append(CGXPathFinder())
+# Add cgx path finder at the end of the list of finders.
+# Skip when running as a frozen PyInstaller bundle, since CGX files
+# are pre-compiled to Python modules by the PyInstaller hook.
+if not getattr(sys, "frozen", False):
+    sys.meta_path.append(CGXPathFinder())

{collagraph-0.9.2 → collagraph-0.9.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "collagraph"
-version = "0.9.2"
+version = "0.9.3"
 description = "Reactive user interfaces"
 authors = [
     { name = "Berend Klein Haneveld", email = "berendkleinhaneveld@gmail.com" },
@@ -59,6 +59,7 @@ pyside-dev = [
 "examples/pygfx/*.py" = ["I001"]  # unsorted-imports
 "examples/pyside/flow_layout.py" = ["N802"]  # invalid-function-name
 "tests/*" = ["N806", "N802"]  # non-lowercase-variable-in-function, invalid-function-name
+"tests/pyinstaller/*" = ["I001", "T20"]  # unsorted-imports, flake8-print
 "tests/pyside/test_*.py" = ["E402"]  # module-import-not-at-top-of-file
 
 [tool.ruff.lint]

collagraph-0.9.3/tests/pyinstaller/expected_output.json

@@ -0,0 +1,28 @@
+{
+  "type": "root",
+  "children": [
+    {
+      "type": "list",
+      "children": [
+        {
+          "type": "item",
+          "attrs": {
+            "label": "[todo] Buy groceries"
+          }
+        },
+        {
+          "type": "item",
+          "attrs": {
+            "label": "[done] Write tests"
+          }
+        },
+        {
+          "type": "item",
+          "attrs": {
+            "label": "[todo] Deploy app"
+          }
+        }
+      ]
+    }
+  ]
+}

collagraph-0.9.3/tests/pyinstaller/test_pyinstaller.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+set -e
+
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+REPO_DIR="$(cd "$SCRIPT_DIR/../.." && pwd)"
+APP_DIR="$SCRIPT_DIR/todo_app"
+EXPECTED="$SCRIPT_DIR/expected_output.json"
+
+echo "==> Installing pyinstaller..."
+uv pip install pyinstaller
+
+echo "==> Building todo_app with PyInstaller..."
+cd "$APP_DIR"
+uv run pyinstaller \
+    --noconfirm \
+    --log-level WARN \
+    --onefile \
+    --name todo_app \
+    app.py
+
+echo "==> Running bundled application..."
+OUTPUT=$(./dist/todo_app)
+
+echo "==> Comparing output..."
+EXPECTED_CONTENT=$(cat "$EXPECTED")
+
+if [ "$OUTPUT" = "$EXPECTED_CONTENT" ]; then
+    echo "==> PyInstaller test PASSED"
+else
+    echo "==> PyInstaller test FAILED"
+    echo ""
+    echo "Expected:"
+    echo "$EXPECTED_CONTENT"
+    echo ""
+    echo "Got:"
+    echo "$OUTPUT"
+    exit 1
+fi

collagraph-0.9.3/tests/pyinstaller/todo_app/app.py

@@ -0,0 +1,14 @@
+import json
+
+import collagraph as cg
+
+from todo_list import TodoList
+
+container = {"type": "root"}
+gui = cg.Collagraph(
+    renderer=cg.DictRenderer(),
+    event_loop_type=cg.EventLoopType.SYNC,
+)
+gui.render(TodoList, container)
+
+print(json.dumps(container, indent=2))

collagraph-0.9.3/tests/pyinstaller/todo_app/helpers.py

@@ -0,0 +1,3 @@
+def format_label(text, done):
+    status = "done" if done else "todo"
+    return f"[{status}] {text}"

collagraph-0.9.3/tests/pyinstaller/todo_app/todo_item.cgx

@@ -0,0 +1,11 @@
+<item :label="format_label(props['text'], props['done'])" />
+
+<script>
+import collagraph as cg
+from helpers import format_label
+
+
+class TodoItem(cg.Component):
+    pass
+</script>
+

collagraph-0.9.3/tests/pyinstaller/todo_app/todo_list.cgx

@@ -0,0 +1,23 @@
+<list>
+  <TodoItem
+    v-for="todo in state['todos']"
+    :done="todo['done']"
+    :key="todo['id']"
+    :text="todo['text']"
+  />
+</list>
+
+<script>
+import collagraph as cg
+from todo_item import TodoItem
+
+
+class TodoList(cg.Component):
+    def init(self):
+        self.state["todos"] = [
+            {"id": 1, "text": "Buy groceries", "done": False},
+            {"id": 2, "text": "Write tests", "done": True},
+            {"id": 3, "text": "Deploy app", "done": False},
+        ]
+</script>
+

collagraph-0.9.2/collagraph/__pyinstaller/hook-collagraph.py

@@ -1,58 +0,0 @@
-import ast
-from pathlib import Path
-
-from PyInstaller.utils.hooks import collect_data_files
-
-from collagraph.sfc.compiler import get_script_ast
-from collagraph.sfc.parser import CGXParser
-
-
-def hook(hook_api):
-    collagraph_uses = hook_api.analysis.graph.get_code_using("collagraph")
-
-    hidden_imports = set()
-    datas = []
-    for package, code in collagraph_uses.items():
-        filename = Path(code.co_filename)
-        hidden_imports |= collect_hidden_imports(filename.parent)
-        datas += collect_data_files(package, includes=["**/*.cgx"])
-
-    hook_api.add_imports(*hidden_imports)
-    hook_api.add_datas(datas)
-
-
-def collect_hidden_imports(folder):
-    folder = Path(folder)
-
-    hidden_imports = set()
-    for path in folder.glob("**/*.cgx"):
-        template = path.read_text(encoding="utf-8")
-        # Parse the file component into a tree of Node instances
-        parser = CGXParser()
-        parser.feed(template)
-
-        # Get the AST from the script tag
-        script_tree = get_script_ast(parser, path)
-
-        # Find a list of imported names (or aliases, if any)
-        # Those names don't have to be wrapped by `_lookup`
-        imported_names = ImportsCollector()
-        imported_names.visit(script_tree)
-
-        hidden_imports |= imported_names.names
-
-    return hidden_imports
-
-
-class ImportsCollector(ast.NodeVisitor):
-    def __init__(self):
-        self.names = set()
-
-    def visit_ImportFrom(self, node):
-        for alias in node.names:
-            self.names.add(".".join([node.module, alias.name]))
-        self.names.add(node.module)
-
-    def visit_Import(self, node):
-        for alias in node.names:
-            self.names.add(alias.name)