svg-ultralight 0.26.0__tar.gz → 0.27.0__tar.gz

{svg_ultralight-0.26.0 → svg_ultralight-0.27.0}/PKG-INFO

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

{svg_ultralight-0.26.0 → svg_ultralight-0.27.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "svg-ultralight"
-version = "0.26.0"
+version = "0.27.0"
 description = "a sensible way to create svg files with Python"
 authors = [{ name = "Shay Hill", email = "shay_public@hotmail.com" }]
 license = { text = "MIT" }
@@ -20,6 +20,10 @@ build-backend = "setuptools.build_meta"
 addopts = "--doctest-modules"
 
 
+[tool.isort]
+profile = "black"
+
+
 [tool.tox]
 legacy_tox_ini = """
     [tox]
@@ -33,7 +37,7 @@ legacy_tox_ini = """
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.26.0"
+version = "0.27.0"
 tag_format = "$version"
 version_files = ["pyproject.toml:^version"]
 annotated_tag = true

{svg_ultralight-0.26.0 → svg_ultralight-0.27.0}/src/svg_ultralight/__init__.py

@@ -4,6 +4,11 @@
 :created: 12/22/2019.
 """
 
+from svg_ultralight.bounding_boxes.bound_helpers import (
+    new_bbox_union,
+    new_bound_union,
+    new_element_union,
+)
 from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
 from svg_ultralight.bounding_boxes.type_bound_element import BoundElement
 from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
@@ -27,6 +32,7 @@ from svg_ultralight.nsmap import NSMAP, new_qname
 from svg_ultralight.query import pad_text
 from svg_ultralight.root_elements import new_svg_root_around_bounds
 from svg_ultralight.string_conversion import (
+    format_attr_dict,
     format_number,
     format_numbers,
     format_numbers_in_string,
@@ -39,10 +45,14 @@ __all__ = [
     "PaddedText",
     "SupportsBounds",
     "deepcopy_element",
+    "format_attr_dict",
     "format_number",
     "format_numbers",
     "format_numbers_in_string",
+    "new_bbox_union",
+    "new_bound_union",
     "new_element",
+    "new_element_union",
     "new_metadata",
     "new_qname",
     "new_sub_element",

svg_ultralight-0.27.0/src/svg_ultralight/bounding_boxes/bound_helpers.py

@@ -0,0 +1,95 @@
+"""Helper functions for dealing with BoundElements.
+
+:author: Shay Hill
+:created: 2024-05-03
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from lxml.etree import _Element as EtreeElement  # type: ignore
+
+from svg_ultralight.bounding_boxes.type_bound_element import BoundElement
+from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
+from svg_ultralight.bounding_boxes.type_padded_text import PaddedText
+from svg_ultralight.constructors import new_element
+
+if TYPE_CHECKING:
+    from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
+
+
+def new_element_union(
+    *elems: EtreeElement | SupportsBounds, **attributes: float | str
+) -> EtreeElement:
+    """Get the union of any elements found in the given arguments.
+
+    :param elems: BoundElements, PaddedTexts, or EtreeElements.
+        Other arguments will be ignored.
+    :return: a new group element containing all elements.
+
+    This does not support consolidating attributes. E.g., if all elements have the
+    same fill color, this will not be recognized and consilidated into a single
+    attribute for the group. Too many attributes change their behavior when applied
+    to a group.
+    """
+    elements_found: list[EtreeElement] = []
+    for elem in elems:
+        if isinstance(elem, (BoundElement, PaddedText)):
+            elements_found.append(elem.elem)
+        elif isinstance(elem, EtreeElement):
+            elements_found.append(elem)
+
+    if not elements_found:
+        msg = (
+            "Cannot find any elements to union. "
+            + "At least one argument must be a "
+            + "BoundElement, PaddedText, or EtreeElement."
+        )
+        raise ValueError(msg)
+    group = new_element("g", **attributes)
+    group.extend(elements_found)
+    return group
+
+
+def new_bbox_union(*blems: SupportsBounds | EtreeElement) -> BoundingBox:
+    """Get the union of the bounding boxes of the given elements.
+
+    :param blems: BoundElements, BoundingBoxes, or PaddedTexts.
+        Other arguments will be ignored.
+    :return: the union of all bounding boxes as a BoundingBox instance.
+
+    Will used the padded_box attribute of PaddedText instances.
+    """
+    bboxes: list[BoundingBox] = []
+    for blem in blems:
+        if isinstance(blem, BoundingBox):
+            bboxes.append(blem)
+        elif isinstance(blem, BoundElement):
+            bboxes.append(blem.bbox)
+        elif isinstance(blem, PaddedText):
+            bboxes.append(blem.padded_bbox)
+
+    if not bboxes:
+        msg = (
+            "Cannot find any bounding boxes to union. "
+            + "At least one argument must be a "
+            + "BoundElement, BoundingBox, or PaddedText."
+        )
+        raise ValueError(msg)
+
+    return BoundingBox.merged(*bboxes)
+
+
+def new_bound_union(*blems: SupportsBounds | EtreeElement) -> BoundElement:
+    """Get the union of the bounding boxes of the given elements.
+
+    :param blems: BoundElements or EtreeElements.
+        At least one argument must be a BoundElement, BoundingBox, or PaddedText.
+    :return: the union of all arguments as a BoundElement instance.
+
+    Will used the padded_box attribute of PaddedText instances.
+    """
+    group = new_element_union(*blems)
+    bbox = new_bbox_union(*blems)
+    return BoundElement(group, bbox)

{svg_ultralight-0.26.0 → svg_ultralight-0.27.0}/src/svg_ultralight/root_elements.py

@@ -8,9 +8,8 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-from svg_ultralight.bounding_boxes.type_bound_element import BoundElement
+from svg_ultralight.bounding_boxes import bound_helpers as bound
 from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
-from svg_ultralight.bounding_boxes.type_padded_text import PaddedText
 from svg_ultralight.main import new_svg_root
 
 if TYPE_CHECKING:
@@ -64,15 +63,8 @@ def new_svg_root_around_bounds(
     :return: root svg element
     :raise ValueError: if no bounding boxes are found in bounded
     """
-    bboxes = [x for x in bounded if isinstance(x, BoundingBox)]
-    bboxes += [x.bbox for x in bounded if isinstance(x, BoundElement)]
-    bboxes += [x.padded_bbox for x in bounded if isinstance(x, PaddedText)]
-
-    if not bboxes:
-        msg = "no bounding boxes found"
-        raise ValueError(msg)
-
-    viewbox = _viewbox_args_from_bboxes(*bboxes)
+    bbox = bound.new_bbox_union(*bounded)
+    viewbox = _viewbox_args_from_bboxes(bbox)
     return new_svg_root(
         x_=viewbox["x_"],
         y_=viewbox["y_"],

{svg_ultralight-0.26.0 → svg_ultralight-0.27.0}/src/svg_ultralight.egg-info/PKG-INFO

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

{svg_ultralight-0.26.0 → svg_ultralight-0.27.0}/src/svg_ultralight.egg-info/SOURCES.txt

@@ -20,6 +20,7 @@ src/svg_ultralight.egg-info/dependency_links.txt
 src/svg_ultralight.egg-info/requires.txt
 src/svg_ultralight.egg-info/top_level.txt
 src/svg_ultralight/bounding_boxes/__init__.py
+src/svg_ultralight/bounding_boxes/bound_helpers.py
 src/svg_ultralight/bounding_boxes/supports_bounds.py
 src/svg_ultralight/bounding_boxes/type_bound_element.py
 src/svg_ultralight/bounding_boxes/type_bounding_box.py

{svg_ultralight-0.26.0 → svg_ultralight-0.27.0}/tests/test_inkscape.py

@@ -17,10 +17,7 @@ from svg_ultralight.inkscape import convert_text_to_path
 from svg_ultralight.main import new_svg_root
 from svg_ultralight.nsmap import NSMAP
 
-INKSCAPE = Path(
-    r"C:\\Program Files\\WindowsApps\\25415Inkscape.Inkscape_1.3.2.0"
-    + "_x64__9waqn51p1ttv2\\VFS\\ProgramFilesX64\\Inkscape\\bin\\inkscape.exe"
-)
+INKSCAPE = Path(r"C:\Program Files\Inkscape\bin\inkscape")
 
 if not INKSCAPE.with_suffix(".exe").exists():
     msg = "Inkscape not found. Please install Inkscape or update the INKSCAPE path var."

{svg_ultralight-0.26.0 → svg_ultralight-0.27.0}/tests/test_queries.py

@@ -17,10 +17,7 @@ from svg_ultralight import new_svg_root
 from svg_ultralight.constructors import new_sub_element
 from svg_ultralight.query import BoundingBox, map_ids_to_bounding_boxes
 
-INKSCAPE = Path(
-    r"C:\\Program Files\\WindowsApps\\25415Inkscape.Inkscape_1.3.2.0"
-    + "_x64__9waqn51p1ttv2\\VFS\\ProgramFilesX64\\Inkscape\\bin\\inkscape.exe"
-)
+INKSCAPE = Path(r"C:\Program Files\Inkscape\bin\inkscape")
 
 if not INKSCAPE.with_suffix(".exe").exists():
     msg = "Inkscape not found. Please install Inkscape or update the INKSCAPE path var."

{svg_ultralight-0.26.0 → svg_ultralight-0.27.0}/tests/test_root_elements.py

@@ -6,15 +6,13 @@
 
 import pytest
 
-from svg_ultralight.main import new_svg_root
-from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
 from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
 from svg_ultralight.bounding_boxes.type_bound_element import BoundElement
 from svg_ultralight.bounding_boxes.type_padded_text import PaddedText
 from svg_ultralight.constructors import new_element
 from svg_ultralight.root_elements import new_svg_root_around_bounds
+from svg_ultralight.bounding_boxes.bound_helpers import new_bound_union
 from lxml.etree import _Element as EtreeElement  # type: ignore
-from typing import Union
 
 
 class TestNewSvgRootAroundBounds:
@@ -23,13 +21,13 @@ class TestNewSvgRootAroundBounds:
         """Raise ValueError if no bounding boxes found."""
         with pytest.raises(ValueError) as excinfo:
             _ = new_svg_root_around_bounds()
-        assert "no bounding boxes found" in str(excinfo.value)
+        assert "At least one argument" in str(excinfo.value)
 
     def test_no_bound_elements(self):
         """Raise ValueError if no BoundElements found."""
         with pytest.raises(ValueError) as excinfo:
             _ = new_svg_root_around_bounds(new_element("g"))
-        assert "no bounding boxes found" in str(excinfo.value)
+        assert "At least one argument" in str(excinfo.value)
 
     def test_bounding_boxes(self):
         """Create svg root element from bounding boxes."""
@@ -53,3 +51,33 @@ class TestNewSvgRootAroundBounds:
         result = new_svg_root_around_bounds(*args)
         assert isinstance(result, EtreeElement)
         assert result.attrib["viewBox"] == "0 0 201 201"
+
+class TestNewBoundUnion:
+
+    def test_bounding_boxes_only(self):
+        """Raise an error if no elements found."""
+        bboxes = [BoundingBox(0, 0, 100, 100), BoundingBox(50, 50, 150, 150)]
+        with pytest.raises(ValueError) as excinfo:
+            _ = new_bound_union(*bboxes)
+        assert "must be a BoundElement, PaddedText, or Etree" in str(excinfo.value)
+
+    def test_elements_only(self):
+        """Raise an error if no elements found."""
+        elems = [new_element("g"), new_element("g")]
+        with pytest.raises(ValueError) as excinfo:
+            _ = new_bound_union(*elems)
+        assert "must be a BoundElement, BoundingBox, or Padded" in str(excinfo.value)
+
+    def test_bound_elements(self):
+        """Create svg root element from BoundElements."""
+        bboxes = [BoundingBox(0, 0, 100, 100), BoundingBox(50, 50, 150, 150)]
+        args = bboxes[0], BoundElement(new_element("g"), bboxes[1])
+        result = new_bound_union(*args)
+        assert isinstance(result, BoundElement)
+
+    def test_padded_text(self):
+        """Create svg root element from BoundElements."""
+        bboxes = [BoundingBox(0, 0, 100, 100), BoundingBox(50, 50, 150, 150)]
+        args = bboxes[0], PaddedText(new_element("g"), bboxes[1], 1, 1, 1, 1)
+        result = new_bound_union(*args)
+        assert isinstance(result, BoundElement)