py2max 0.3.4__tar.gz → 0.3.5__tar.gz

{py2max-0.3.4 → py2max-0.3.5}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+## [0.3.5]
+
+### Fixed: `Patcher.optimize_layout()` now reaches the incremental layout path
+
+- `Patcher.optimize_layout()` gained an optional `changed_objects: Optional[Set[str]]` parameter and forwards it to the layout manager. It previously called the manager with no arguments, silently discarding any change set, so the incremental layout engine (`layout/base.py` `optimize_layout(changed_objects)` / `should_use_incremental` / `_incremental_layout`) was unreachable through the public API -- every call forced a full relayout. Passing a set of object IDs now lets managers that support it (grid, flow) reposition only those objects and their patchline neighbours; `None` (the default) preserves the previous full-relayout behaviour, so the change is backward compatible. Matrix/columnar managers still recompute in full (they ignore the argument by design). This is the core prerequisite for server-side auto-layout, which lives in `py2max-server`.
+
 ## [0.3.4]
 
 ### New: Param docking in layouts

{py2max-0.3.4 → py2max-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py2max
-Version: 0.3.4
+Version: 0.3.5
 Summary: A library for offline generation of Max/MSP patcher (.maxpat) files.
 Keywords: Max,maxpat,offline
 Author: Shakeeb Alireza

{py2max-0.3.4 → py2max-0.3.5}/py2max/__init__.py

@@ -35,7 +35,7 @@ Example:
     >>> p.save()
 """
 
-__version__ = "0.3.4"
+__version__ = "0.3.5"
 
 from .core import Box, Patcher, Patchline
 from .exceptions import (

{py2max-0.3.4 → py2max-0.3.5}/py2max/core/patcher.py

@@ -23,6 +23,7 @@ from typing import (
     Iterator,
     List,
     Optional,
+    Set,
     Tuple,
     Union,
     cast,
@@ -656,7 +657,7 @@ class Patcher(BoxFactoryMixin, SerializationMixin, AbstractPatcher):
             return self._layout_mgr.get_pos(maxclass)
         return self._layout_mgr.get_pos()
 
-    def optimize_layout(self) -> None:
+    def optimize_layout(self, changed_objects: Optional[Set[str]] = None) -> None:
         """Optimize object positions based on layout manager type.
 
         Calls the layout manager's optimization method to improve object
@@ -669,9 +670,17 @@ class Patcher(BoxFactoryMixin, SerializationMixin, AbstractPatcher):
 
         This method should be called after all objects and connections
         have been added to the patch.
+
+        Args:
+            changed_objects: Optional set of object IDs that have changed. When
+                provided and small relative to the total, managers that support
+                it reposition only those objects and their neighbours
+                (incremental layout) instead of recomputing the whole patch;
+                when ``None`` a full layout is performed. Managers that do not
+                implement incremental layout ignore the argument.
         """
         if hasattr(self._layout_mgr, "optimize_layout"):
-            self._layout_mgr.optimize_layout()
+            self._layout_mgr.optimize_layout(changed_objects)
 
         # Dock value/UI params next to the object they drive (opt-in).
         if self._param_placement and hasattr(self._layout_mgr, "place_params"):

{py2max-0.3.4 → py2max-0.3.5}/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 maintainers = [
     { name = "Shakeeb Alireza", email = "shakfu@users.noreply.github.com" }
 ]
-version = "0.3.4"
+version = "0.3.5"
 readme = "README.md"
 requires-python = ">=3.9"
 keywords = ["Max", "maxpat", "offline"]

py2max-0.3.5/tests/test_patcher.py

@@ -0,0 +1,96 @@
+from pathlib import Path
+
+from py2max import Patcher
+import json
+
+DATA_DIR = Path(__file__).parent / "data"
+
+
+def test_patcher_basics():
+    p = Patcher("outputs/test_patcher_basics.maxpat", title="top notch patcher")
+    assert repr(p) == "Patcher(path='outputs/test_patcher_basics.maxpat')"
+    assert p._layout_mgr.parent.rect == p.rect
+    osc1 = p.add_textbox("cycle~")
+    osc2 = p.add_textbox("cycle~ 440")
+    assert osc1.id and osc2.id
+    assert repr(osc1) == f"Box(id='{osc1.id}', maxclass='newobj')"
+    assert osc1.oid == 1
+    line1 = p.add_patchline_by_index(osc1.id, osc2.id)
+    assert line1
+    assert repr(line1)
+    assert len(line1.to_tuple()) == 5
+    p.save()
+
+
+def test_patcher_from_file():
+    p = Patcher.from_file(
+        DATA_DIR / "complex.maxpat", save_to="outputs/test_complex.maxpat"
+    )
+    assert len(p._boxes) == len(p.boxes) == 53
+    assert len(list(p)) == 60
+    assert p.to_json()
+    p.save()
+    p.save_as("outputs/test_complex2.maxpat")
+
+
+def test_optimize_layout_forwards_changed_objects():
+    """Patcher.optimize_layout() must forward ``changed_objects`` to the layout
+    manager so the incremental path is reachable through the public API.
+
+    Regression: the facade previously called ``self._layout_mgr.optimize_layout()``
+    with no arguments, silently discarding the change set and always forcing a
+    full relayout.
+    """
+    p = Patcher("outputs/test_optimize_forwarding.maxpat", layout="grid")
+    a = p.add_textbox("cycle~ 440")
+    b = p.add_textbox("gain~")
+    p.add_line(a, b)
+
+    received: list = []
+    real = p._layout_mgr.optimize_layout
+
+    def spy(changed_objects=None):
+        received.append(changed_objects)
+        return real(changed_objects)
+
+    p._layout_mgr.optimize_layout = spy  # type: ignore[method-assign]
+
+    p.optimize_layout()  # full layout
+    p.optimize_layout({a.id})  # incremental request
+
+    assert received == [None, {a.id}]
+
+
+def test_optimize_layout_incremental_leaves_untouched_objects_fixed():
+    """A small change set routes through incremental layout, which keeps
+    unaffected, unconnected objects at their existing positions."""
+    p = Patcher("outputs/test_optimize_incremental.maxpat", layout="grid")
+    # Two connected objects plus a pool of disconnected ones so the affected
+    # fraction (one object + its neighbour) stays under the incremental threshold.
+    a = p.add_textbox("cycle~ 440")
+    b = p.add_textbox("gain~")
+    p.add_line(a, b)
+    others = [p.add_textbox(f"print label{i}") for i in range(12)]
+
+    p.optimize_layout()  # settle everything
+    before = {o.id: tuple(o.patching_rect) for o in others}
+
+    assert p._layout_mgr.should_use_incremental({a.id}) is True
+    p.optimize_layout({a.id})
+
+    after = {o.id: tuple(o.patching_rect) for o in others}
+    assert after == before
+
+
+def test_patcher_from_file_comparison_complex():
+    pd = Patcher.from_file(DATA_DIR / "complex.maxpat").to_dict()
+    with open(DATA_DIR / "complex.maxpat") as f:
+        d = json.load(f)
+    assert pd == d
+
+
+def test_patcher_from_file_comparison_simple():
+    pd = Patcher.from_file(DATA_DIR / "simple.maxpat").to_dict()
+    with open(DATA_DIR / "simple.maxpat") as f:
+        d = json.load(f)
+    assert pd == d

py2max-0.3.4/tests/test_patcher.py

@@ -1,47 +0,0 @@
-from pathlib import Path
-
-from py2max import Patcher
-import json
-
-DATA_DIR = Path(__file__).parent / "data"
-
-
-def test_patcher_basics():
-    p = Patcher("outputs/test_patcher_basics.maxpat", title="top notch patcher")
-    assert repr(p) == "Patcher(path='outputs/test_patcher_basics.maxpat')"
-    assert p._layout_mgr.parent.rect == p.rect
-    osc1 = p.add_textbox("cycle~")
-    osc2 = p.add_textbox("cycle~ 440")
-    assert osc1.id and osc2.id
-    assert repr(osc1) == f"Box(id='{osc1.id}', maxclass='newobj')"
-    assert osc1.oid == 1
-    line1 = p.add_patchline_by_index(osc1.id, osc2.id)
-    assert line1
-    assert repr(line1)
-    assert len(line1.to_tuple()) == 5
-    p.save()
-
-
-def test_patcher_from_file():
-    p = Patcher.from_file(
-        DATA_DIR / "complex.maxpat", save_to="outputs/test_complex.maxpat"
-    )
-    assert len(p._boxes) == len(p.boxes) == 53
-    assert len(list(p)) == 60
-    assert p.to_json()
-    p.save()
-    p.save_as("outputs/test_complex2.maxpat")
-
-
-def test_patcher_from_file_comparison_complex():
-    pd = Patcher.from_file(DATA_DIR / "complex.maxpat").to_dict()
-    with open(DATA_DIR / "complex.maxpat") as f:
-        d = json.load(f)
-    assert pd == d
-
-
-def test_patcher_from_file_comparison_simple():
-    pd = Patcher.from_file(DATA_DIR / "simple.maxpat").to_dict()
-    with open(DATA_DIR / "simple.maxpat") as f:
-        d = json.load(f)
-    assert pd == d