Combined row and column layout methods (#3061)

The flexbox algorithm is almost identical between the row and column layout, the implementations can be shared with a very small amount of parameterization. This PR converges the two direction implementations into a single parameterised implementation.
beeware · Jan 3, 2025 · 4d0a179 · 4d0a179
1 parent 08e7d38
commit 4d0a179
Show file tree

Hide file tree

Showing 14 changed files with 390 additions and 545 deletions.
diff --git a/changes/3016.misc.rst → changes/3016.misc.1.rst b/changes/3016.misc.rst → changes/3016.misc.1.rst
diff --git a/changes/3061.misc.2.rst b/changes/3061.misc.2.rst
@@ -0,0 +1 @@
+Pack.layout() now has a single argument -- the viewport -- instead of (node, viewport).
diff --git a/changes/3061.misc.rst b/changes/3061.misc.rst
@@ -0,0 +1 @@
+Pack's layout logic for rows and columns has been combined into one direction-agnostic method.
diff --git a/core/src/toga/style/pack.py b/core/src/toga/style/pack.py
diff --git a/core/tests/style/pack/layout/test_beeliza.py b/core/tests/style/pack/layout/test_beeliza.py
@@ -32,7 +32,7 @@ def test_beeliza():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (160, 125),

diff --git a/core/tests/style/pack/layout/test_column_alignment.py b/core/tests/style/pack/layout/test_column_alignment.py
@@ -26,7 +26,7 @@ def test_left():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (540, 300),
@@ -72,7 +72,7 @@ def test_center():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (540, 300),
@@ -118,7 +118,7 @@ def test_right():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (540, 300),
@@ -151,7 +151,7 @@ def test_no_margin():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (540, 300),
@@ -194,7 +194,7 @@ def test_column_box():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (430, 310),

diff --git a/core/tests/style/pack/layout/test_fixed.py b/core/tests/style/pack/layout/test_fixed.py
@@ -37,7 +37,7 @@ def test_row_expanding_intrinsic():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (200, 100),
@@ -97,7 +97,7 @@ def test_row_fixed_intrinsic():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (150, 100),
@@ -159,7 +159,7 @@ def test_column_expanding_intrinsic():
     )
 
     # Normal size
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (100, 200),
@@ -216,7 +216,7 @@ def test_column_fixed_intrinsic():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (100, 150),

diff --git a/core/tests/style/pack/layout/test_flex.py b/core/tests/style/pack/layout/test_flex.py
@@ -29,7 +29,7 @@ def test_row_flex_no_hints():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (50, 50),
@@ -104,7 +104,7 @@ def test_row_flex():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (300, 100),
@@ -184,7 +184,7 @@ def test_row_flex_insufficient_space():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (200, 100),
@@ -249,7 +249,7 @@ def test_row_flex_insufficient_space_no_flex():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (220, 100),
@@ -302,7 +302,7 @@ def test_row_flex_grandchild_min_size():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (120, 100),
@@ -351,7 +351,7 @@ def test_column_flex_no_hints():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (50, 50),
@@ -426,7 +426,7 @@ def test_column_flex():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (100, 300),
@@ -507,7 +507,7 @@ def test_column_flex_insufficient_space():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (100, 200),
@@ -573,7 +573,7 @@ def test_column_flex_insufficient_space_no_flex():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (100, 220),
@@ -627,7 +627,7 @@ def test_column_flex_grandchild_min_size():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (100, 120),

diff --git a/core/tests/style/pack/layout/test_gap.py b/core/tests/style/pack/layout/test_gap.py
@@ -24,7 +24,7 @@ def test_gap():
     )
 
     # No gap
-    root.style.layout(root, viewport)
+    root.style.layout(viewport)
     assert_layout(
         root,
         (130, 100),
@@ -45,7 +45,7 @@ def test_gap():
 
     # Row, LTR
     root.style.update(direction="row", text_direction="ltr")
-    root.style.layout(root, viewport)
+    root.style.layout(viewport)
     assert_layout(
         root,
         (170, 100),
@@ -63,7 +63,7 @@ def test_gap():
 
     # Row, RTL
     root.style.update(direction="row", text_direction="rtl")
-    root.style.layout(root, viewport)
+    root.style.layout(viewport)
     assert_layout(
         root,
         (170, 100),
@@ -81,7 +81,7 @@ def test_gap():
 
     # Column
     root.style.update(direction="column")
-    root.style.layout(root, viewport)
+    root.style.layout(viewport)
     assert_layout(
         root,
         (100, 170),

diff --git a/core/tests/style/pack/layout/test_row_alignment.py b/core/tests/style/pack/layout/test_row_alignment.py
@@ -26,7 +26,7 @@ def test_top():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (300, 540),
@@ -72,7 +72,7 @@ def test_center():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (300, 540),
@@ -118,7 +118,7 @@ def test_bottom():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (300, 540),
@@ -151,7 +151,7 @@ def test_no_margin():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (300, 540),
@@ -194,7 +194,7 @@ def test_row_box():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (310, 430),

diff --git a/core/tests/style/pack/layout/test_rtl.py b/core/tests/style/pack/layout/test_rtl.py
@@ -19,7 +19,7 @@ def test_row_box_child_layout():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (210, 100),
@@ -52,7 +52,7 @@ def test_column_box_child_layout():
     )
 
     # Normal size
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (100, 210),
@@ -78,7 +78,7 @@ def test_align_items_top():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (60, 100),
@@ -104,7 +104,7 @@ def test_align_items_bottom():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (60, 100),
@@ -130,7 +130,7 @@ def test_align_items_left():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (100, 60),
@@ -156,7 +156,7 @@ def test_align_items_right():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (100, 60),

diff --git a/core/tests/style/pack/layout/test_tutorial0.py b/core/tests/style/pack/layout/test_tutorial0.py
@@ -16,7 +16,7 @@ def test_tutorial_0():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (220, 130),
@@ -41,7 +41,7 @@ def test_vertical():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(480, 640))
+    root.style.layout(ExampleViewport(480, 640))
     assert_layout(
         root,
         (130, 220),

diff --git a/core/tests/style/pack/layout/test_tutorial1.py b/core/tests/style/pack/layout/test_tutorial1.py
@@ -51,7 +51,7 @@ def test_tutorial_1():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (380, 120),

diff --git a/core/tests/style/pack/layout/test_tutorial3.py b/core/tests/style/pack/layout/test_tutorial3.py
@@ -30,7 +30,7 @@ def test_tutorial_3():
         ],
     )
 
-    root.style.layout(root, ExampleViewport(640, 480))
+    root.style.layout(ExampleViewport(640, 480))
     assert_layout(
         root,
         (170, 125),
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Pack.layout() now has a single argument -- the viewport -- instead of (node, viewport).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Pack's layout logic for rows and columns has been combined into one direction-agnostic method.