svg-ultralight 0.33.0__tar.gz → 0.34.0__tar.gz

{svg_ultralight-0.33.0/src/svg_ultralight.egg-info → svg_ultralight-0.34.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: svg-ultralight
-Version: 0.33.0
+Version: 0.34.0
 Summary: a sensible way to create svg files with Python
 Author-email: Shay Hill <shay_public@hotmail.com>
 License: MIT

{svg_ultralight-0.33.0 → svg_ultralight-0.34.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "svg-ultralight"
-version = "0.33.0"
+version = "0.34.0"
 description = "a sensible way to create svg files with Python"
 authors = [{ name = "Shay Hill", email = "shay_public@hotmail.com" }]
 license = { text = "MIT" }
@@ -37,7 +37,7 @@ legacy_tox_ini = """
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.33.0"
+version = "0.34.0"
 tag_format = "$version"
 version_files = ["pyproject.toml:^version"]
 annotated_tag = true

{svg_ultralight-0.33.0 → svg_ultralight-0.34.0}/src/svg_ultralight/__init__.py

@@ -8,6 +8,10 @@ from svg_ultralight.bounding_boxes.bound_helpers import (
     new_bbox_union,
     new_bound_union,
     new_element_union,
+    cut_bbox,
+    pad_bbox,
+    bbox_dict,
+    new_bbox_rect,
 )
 from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
 from svg_ultralight.bounding_boxes.type_bound_collection import BoundCollection
@@ -57,7 +61,9 @@ __all__ = [
     "NSMAP",
     "PaddedText",
     "SupportsBounds",
+    "bbox_dict",
     "clear_svg_ultralight_cache",
+    "cut_bbox",
     "deepcopy_element",
     "format_attr_dict",
     "format_number",
@@ -68,6 +74,7 @@ __all__ = [
     "mat_apply",
     "mat_dot",
     "mat_invert",
+    "new_bbox_rect",
     "new_bbox_union",
     "new_bound_union",
     "new_element",
@@ -77,6 +84,7 @@ __all__ = [
     "new_sub_element",
     "new_svg_root",
     "new_svg_root_around_bounds",
+    "pad_bbox",
     "pad_text",
     "transform_element",
     "update_element",

{svg_ultralight-0.33.0 → svg_ultralight-0.34.0}/src/svg_ultralight/bounding_boxes/bound_helpers.py

@@ -95,3 +95,77 @@ def new_bound_union(*blems: SupportsBounds | EtreeElement) -> BoundElement:
     group = new_element_union(*blems)
     bbox = new_bbox_union(*blems)
     return BoundElement(group, bbox)
+
+
+def _expand_pad(pad: float | tuple[float, ...]) -> tuple[float, float, float, float]:
+    """Expand a float pad argument into a 4-tuple."""
+    if isinstance(pad, (int, float)):
+        return pad, pad, pad, pad
+    if len(pad) == 1:
+        return pad[0], pad[0], pad[0], pad[0]
+    if len(pad) == 2:
+        return pad[0], pad[1], pad[0], pad[1]
+    if len(pad) == 3:
+        return pad[0], pad[1], pad[2], pad[1]
+    return pad[0], pad[1], pad[2], pad[3]
+
+
+def cut_bbox(
+    bbox: SupportsBounds,
+    *,
+    x: float | None = None,
+    y: float | None = None,
+    x2: float | None = None,
+    y2: float | None = None,
+) -> BoundingBox:
+    """Return a new bounding box with updated limits.
+
+    :param bbox: the original bounding box or bounded element.
+    :param x: the new x-coordinate.
+    :param y: the new y-coordinate.
+    :param x2: the new x2-coordinate.
+    :param y2: the new y2-coordinate.
+    :return: a new bounding box with the updated limits.
+    """
+    x = bbox.x if x is None else x
+    y = bbox.y if y is None else y
+    x2 = bbox.x2 if x2 is None else x2
+    y2 = bbox.y2 if y2 is None else y2
+    width = x2 - x
+    height = y2 - y
+    return BoundingBox(x, y, width, height)
+
+
+def pad_bbox(bbox: SupportsBounds, pad: float | tuple[float, ...]) -> BoundingBox:
+    """Return a new bounding box with padding.
+
+    :param bbox: the original bounding box or bounded element.
+    :param pad: the padding to apply.
+        If a single number, the same padding will be applied to all sides.
+        If a tuple, will be applied per css rules.
+        len = 1 : 0, 0, 0, 0
+        len = 2 : 0, 1, 0, 1
+        len = 3 : 0, 1, 2, 1
+        len = 4 : 0, 1, 2, 3
+    :return: a new bounding box with padding applied.
+    """
+    t, r, b, l = _expand_pad(pad)
+    return cut_bbox(bbox, x=bbox.x - l, y=bbox.y - t, x2=bbox.x2 + r, y2=bbox.y2 + b)
+
+
+def bbox_dict(bbox: SupportsBounds) -> dict[str, float]:
+    """Return a dictionary representation of a bounding box.
+
+    :param bbox: the bounding box or bound element from which to extract dimensions.
+    :return: a dictionary with keys x, y, width, and height.
+    """
+    return {"x": bbox.x, "y": bbox.y, "width": bbox.width, "height": bbox.height}
+
+
+def new_bbox_rect(bbox: BoundingBox, **kwargs: float | str) -> EtreeElement:
+    """Return a new rect element with the same dimensions as the bounding box.
+
+    :param bbox: the bounding box or bound element from which to extract dimensions.
+    :param kwargs: additional attributes for the rect element.
+    """
+    return new_element("rect", **bbox_dict(bbox), **kwargs)

{svg_ultralight-0.33.0 → svg_ultralight-0.34.0}/src/svg_ultralight/layout.py

@@ -43,7 +43,10 @@ def expand_pad_arg(pad: PadArg) -> tuple[float, float, float, float]:
         return expand_pad_arg([pad])
     as_ms = [m if isinstance(m, Measurement) else Measurement(m) for m in pad]
     as_units = [m.value for m in as_ms]
-    as_units = [as_units[i % len(as_units)] for i in range(4)]
+    if len(as_units) == 3:
+        as_units = [*as_units, as_units[1]]
+    else:
+        as_units = [as_units[i % len(as_units)] for i in range(4)]
     return as_units[0], as_units[1], as_units[2], as_units[3]
 
 

{svg_ultralight-0.33.0 → svg_ultralight-0.34.0/src/svg_ultralight.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: svg-ultralight
-Version: 0.33.0
+Version: 0.34.0
 Summary: a sensible way to create svg files with Python
 Author-email: Shay Hill <shay_public@hotmail.com>
 License: MIT

{svg_ultralight-0.33.0 → svg_ultralight-0.34.0}/tests/test_bounding.py

@@ -10,9 +10,16 @@ from svg_ultralight.bounding_boxes.type_bound_element import BoundElement
 from svg_ultralight.bounding_boxes.type_padded_text import PaddedText
 from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
 from svg_ultralight.bounding_boxes.type_bound_collection import BoundCollection
+from svg_ultralight.bounding_boxes.bound_helpers import (
+    pad_bbox,
+    cut_bbox,
+    bbox_dict,
+    new_bbox_rect,
+)
 import copy
 from svg_ultralight.constructors import new_element
 
+
 class TestBoundElement:
     @pytest.fixture
     def bound_element(self) -> BoundElement:
@@ -84,7 +91,6 @@ class TestBoundElement:
         assert bound_element.y2 == 250.0
 
 
-
 class TestPaddedText:
     @pytest.fixture
     def bound_element(self) -> PaddedText:
@@ -155,6 +161,7 @@ class TestPaddedText:
         assert math.isclose(bound_element.height, 252.76)
         assert bound_element.y2 == 203.0
 
+
 class TestBoundCollection:
 
     @pytest.fixture
@@ -178,3 +185,63 @@ class TestBoundCollection:
         blem_trans = blem.elem.attrib["transform"]
         elem_trans = elem.attrib["transform"]
         assert blem_trans == elem_trans
+
+
+class TestBoundHelpers:
+    def test_pad_bbox(self):
+        bbox = BoundingBox(0, 0, 4, 4)
+        padded = pad_bbox(bbox, 1)
+        assert padded.x == -1
+        assert padded.y == -1
+        assert padded.width == 6
+        assert padded.height == 6
+
+    def test_pad_bbox_t1(self):
+        bbox = BoundingBox(0, 0, 4, 4)
+        padded = pad_bbox(bbox, (1,))
+        assert padded.x == -1
+        assert padded.y == -1
+        assert padded.width == 6
+        assert padded.height == 6
+
+    def test_pad_bbox_t2(self):
+        bbox = BoundingBox(0, 0, 4, 4)
+        padded = pad_bbox(bbox, (1, 2))
+        assert padded.x == -2
+        assert padded.y == -1
+        assert padded.width == 8
+        assert padded.height == 6
+
+    def test_pad_bbox_t3(self):
+        bbox = BoundingBox(0, 0, 4, 4)
+        padded = pad_bbox(bbox, (1, 2, 3))
+        assert padded.x == -2
+        assert padded.y == -1
+        assert padded.width == 8
+        assert padded.height == 8
+
+    def test_pad_bbox_t4(self):
+        bbox = BoundingBox(0, 0, 4, 4)
+        padded = pad_bbox(bbox, (1, 2, 3, 4))
+        assert padded.x == -4
+        assert padded.y == -1
+        assert padded.width == 10
+        assert padded.height == 8
+
+    def test_cut_bbox(self):
+        bbox = BoundingBox(0, 0, 4, 4)
+        cut = cut_bbox(bbox, x=1)
+        assert cut.x == 1
+        assert cut.y == 0
+        assert cut.width == 3
+        assert cut.height == 4
+
+    def test_bbox_dict(self):
+        bbox = BoundingBox(0, 1, 2, 3)
+        assert bbox_dict(bbox) == {"x": 0, "y": 1, "width": 2, "height": 3}
+
+    def test_new_bbox_rect(self):
+        bbox = BoundingBox(0, 1, 2, 3)
+        elem = new_bbox_rect(bbox)
+        assert elem.attrib == {"x": "0", "y": "1", "width": "2", "height": "3"}
+

{svg_ultralight-0.33.0 → svg_ultralight-0.34.0}/tests/test_layout.py

@@ -123,6 +123,27 @@ class TestMeasurement:
         assert (Measurement((1, unit)) / 4).value == Measurement((1 / 4, unit)).value
 
 
+class TestExpandPadArg:
+    def test_expand_val(self):
+        """Test that a single value is expanded to a 4-tuple."""
+        assert layout.expand_pad_arg(1) == (1, 1, 1, 1)
+
+    def test_expand_1tuple(self):
+        """Test that a single value is expanded to a 4-tuple."""
+        assert layout.expand_pad_arg(1) == (1, 1, 1, 1)
+
+    def test_expand_2tuple(self):
+        """Test that a single value is expanded to a 4-tuple."""
+        assert layout.expand_pad_arg((1, 2)) == (1, 2, 1, 2)
+
+    def test_expand_3tuple(self):
+        """Test that a single value is expanded to a 4-tuple per css rules."""
+        assert layout.expand_pad_arg((1, 2, 3)) == (1, 2, 3, 2)
+
+    def test_expand_4tuple(self):
+        """Test that a single value is expanded to a 4-tuple per css rules."""
+        assert layout.expand_pad_arg((1, 2, 3, 4)) == (1, 2, 3, 4)
+
 class TestLayout:
     def test_standard(self):
         """No print dimensions give expanded pad argument