svg-ultralight 0.28.0__tar.gz → 0.30.0__tar.gz

{svg_ultralight-0.28.0/src/svg_ultralight.egg-info → svg_ultralight-0.30.0}/PKG-INFO

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

{svg_ultralight-0.28.0 → svg_ultralight-0.30.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "svg-ultralight"
-version = "0.28.0"
+version = "0.30.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.28.0"
+version = "0.30.0"
 tag_format = "$version"
 version_files = ["pyproject.toml:^version"]
 annotated_tag = true

{svg_ultralight-0.28.0 → svg_ultralight-0.30.0}/src/svg_ultralight/__init__.py

@@ -10,6 +10,11 @@ from svg_ultralight.bounding_boxes.bound_helpers import (
     new_element_union,
 )
 from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
+<<<<<<< HEAD
+from svg_ultralight.bounding_boxes.type_bound_confederation import BoundConfederation
+=======
+from svg_ultralight.bounding_boxes.type_bound_collection import BoundCollection
+>>>>>>> dev
 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
@@ -37,8 +42,14 @@ from svg_ultralight.string_conversion import (
     format_numbers,
     format_numbers_in_string,
 )
+from svg_ultralight.transformations import transform_element
 
 __all__ = [
+<<<<<<< HEAD
+    "BoundConfederation",
+=======
+    "BoundCollection",
+>>>>>>> dev
     "BoundElement",
     "BoundingBox",
     "NSMAP",
@@ -59,6 +70,7 @@ __all__ = [
     "new_svg_root",
     "new_svg_root_around_bounds",
     "pad_text",
+    "transform_element",
     "update_element",
     "write_pdf",
     "write_pdf_from_svg",

{svg_ultralight-0.28.0 → svg_ultralight-0.30.0}/src/svg_ultralight/animate.py

@@ -34,7 +34,7 @@ def write_gif(
     :param loop: how many times to loop gif. 0 -> forever
     :effects: write file to gif
     """
-    images = [Image.open(x) for x in pngs]
-    images[0].save(
+    images = [Image.open(x) for x in pngs]  # type: ignore
+    images[0].save(  # type: ignore
         gif, save_all=True, append_images=images[1:], duration=duration, loop=loop
     )

{svg_ultralight-0.28.0 → svg_ultralight-0.30.0}/src/svg_ultralight/bounding_boxes/bound_helpers.py

@@ -18,6 +18,8 @@ from svg_ultralight.constructors import new_element
 if TYPE_CHECKING:
     from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
 
+_Matrix = tuple[float, float, float, float, float, float]
+
 
 def new_element_union(
     *elems: EtreeElement | SupportsBounds, **attributes: float | str

{svg_ultralight-0.28.0 → svg_ultralight-0.30.0}/src/svg_ultralight/bounding_boxes/supports_bounds.py

@@ -16,13 +16,19 @@ Attributes:
 :created: 2023-02-15
 """
 
+from __future__ import annotations
+
 from typing import Protocol
 
+_Matrix = tuple[float, float, float, float, float, float]
+
 
 class SupportsBounds(Protocol):
     """Protocol for objects that can have bounds.
 
     Attributes:
+        transformation (_Matrix): An svg-style transformation matrix.
+        transform (method): Apply a transformation to the object.
         x (float): The minimum x coordinate.
         x2 (float): The maximum x coordinate.
         cx (float): The center x coordinate.
@@ -39,6 +45,22 @@ class SupportsBounds(Protocol):
     set width and height.
     """
 
+    @property
+    def transformation(self) -> _Matrix:
+        """Return an svg-style transformation matrix."""
+        ...
+
+    def transform(
+        self,
+        transformation: _Matrix | None = None,
+        *,
+        scale: float | None = None,
+        dx: float | None = None,
+        dy: float | None = None,
+    ):
+        """Apply a transformation to the object."""
+        ...
+
     @property
     def x(self) -> float:
         """Return minimum x coordinate."""

svg_ultralight-0.30.0/src/svg_ultralight/bounding_boxes/type_bound_collection.py

@@ -0,0 +1,71 @@
+"""A class to hold a list of bound elements and transform them together.
+
+:author: Shay Hill
+:created: 2024-05-05
+"""
+
+from __future__ import annotations
+
+import dataclasses
+from typing import TYPE_CHECKING
+
+from lxml.etree import _Element as EtreeElement  # type: ignore
+
+from svg_ultralight.bounding_boxes.bound_helpers import new_bbox_union
+from svg_ultralight.bounding_boxes.type_bounding_box import HasBoundingBox
+from svg_ultralight.transformations import new_transformation_matrix, transform_element
+
+if TYPE_CHECKING:
+    from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
+    from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
+
+_Matrix = tuple[float, float, float, float, float, float]
+
+
+@dataclasses.dataclass
+class BoundCollection(HasBoundingBox):
+    """A class to hold a list of bound elements and transform them together.
+
+    This will transform the individual elements in place.
+    """
+
+    blems: list[SupportsBounds | EtreeElement] = dataclasses.field(init=False)
+    bbox: BoundingBox = dataclasses.field(init=False)
+
+    def __init__(self, *blems: SupportsBounds | EtreeElement) -> None:
+        """Initialize the bound collection.
+
+        :param blems: bound elements to be transformed together
+        """
+        self.blems = list(blems)
+        self.bbox = new_bbox_union(*self.blems)
+
+    def transform(
+        self,
+        transformation: _Matrix | None = None,
+        *,
+        scale: float | None = None,
+        dx: float | None = None,
+        dy: float | None = None,
+    ):
+        """Transform each bound element in self.blems.
+
+        :param transformation: 2D transformation matrix
+        :param scale: optional scale factor
+        :param dx: optional x translation
+        :param dy: optional y translation
+
+        Keep track of all compounding transformations in order to have a value for
+        self.scale (required for membersh and to provide access to cumulative
+        transforms should this be useful for any reason. This means all
+        transformations must be applied to two bounding boxes: a persistant bbox to
+        keep track of the scale property and a temporary bbox to isolate each
+        transformation.
+        """
+        tmat = new_transformation_matrix(transformation, scale=scale, dx=dx, dy=dy)
+        self.bbox.transform(tmat)
+        for blem in self.blems:
+            if isinstance(blem, EtreeElement):
+                _ = transform_element(blem, tmat)
+            else:
+                blem.transform(tmat)

svg_ultralight-0.30.0/src/svg_ultralight/bounding_boxes/type_bound_confederation.py

@@ -0,0 +1,71 @@
+"""A class to hold a list of bound elements and transform them together.
+
+:author: Shay Hill
+:created: 2024-05-05
+"""
+
+from __future__ import annotations
+
+import dataclasses
+from typing import TYPE_CHECKING
+
+from lxml.etree import _Element as EtreeElement  # type: ignore
+
+from svg_ultralight.bounding_boxes.bound_helpers import new_bbox_union
+from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
+from svg_ultralight.bounding_boxes.type_bounding_box import HasBoundingBox
+from svg_ultralight.transformations import new_transformation_matrix, transform_element
+
+if TYPE_CHECKING:
+    from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
+
+_Matrix = tuple[float, float, float, float, float, float]
+
+
+@dataclasses.dataclass
+class BoundConfederation(HasBoundingBox):
+    """A class to hold a list of bound elements and transform them together.
+
+    This will transform the individual elements in place.
+    """
+
+    blems: list[SupportsBounds | EtreeElement] = dataclasses.field(init=False)
+    bbox: BoundingBox = dataclasses.field(init=False)
+
+    def __init__(self, *blems: SupportsBounds | EtreeElement) -> None:
+        """Initialize the bound confederation.
+
+        :param blems: bound elements to be transformed together
+        """
+        self.blems = list(blems)
+        self.bbox = new_bbox_union(*self.blems)
+
+    def transform(
+        self,
+        transformation: _Matrix | None = None,
+        *,
+        scale: float | None = None,
+        dx: float | None = None,
+        dy: float | None = None,
+    ):
+        """Transform each bound element in self.blems.
+
+        :param transformation: 2D transformation matrix
+        :param scale: optional scale factor
+        :param dx: optional x translation
+        :param dy: optional y translation
+
+        Keep track of all compounding transformations in order to have a value for
+        self.scale (required for membersh and to provide access to cumulative
+        transforms should this be useful for any reason. This means all
+        transformations must be applied to two bounding boxes: a persistant bbox to
+        keep track of the scale property and a temporary bbox to isolate each
+        transformation.
+        """
+        tmat = new_transformation_matrix(transformation, scale=scale, dx=dx, dy=dy)
+        self.bbox.transform(tmat)
+        for blem in self.blems:
+            if isinstance(blem, EtreeElement):
+                _ = transform_element(blem, tmat)
+            else:
+                blem.transform(tmat)

svg_ultralight-0.30.0/src/svg_ultralight/bounding_boxes/type_bound_element.py

@@ -0,0 +1,66 @@
+"""An element tied to a BoundingBox instance.
+
+Take an element, associate it to a BoundingBox instance, transform the BoundingBox
+instance. The element will be transformed accordingly.
+
+It is critical to remember that self.elem is a reference. It is not necessary to
+access self.elem through the BoundElement instance. Earlier and later references will
+all be updated as the BoundElement instance is updated.
+
+:author: Shay Hill
+:created: 2022-12-09
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from svg_ultralight.bounding_boxes.type_bounding_box import HasBoundingBox
+from svg_ultralight.transformations import new_transformation_matrix, transform_element
+
+if TYPE_CHECKING:
+    from lxml.etree import _Element as EtreeElement  # type: ignore
+
+    from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
+
+_Matrix = tuple[float, float, float, float, float, float]
+
+
+class BoundElement(HasBoundingBox):
+    """An element with a bounding box.
+
+    Updates the element when x, y, x2, y2, width, or height are set.
+
+    Can access these BoundingBox attributes (plus scale) as attributes of this object.
+    """
+
+    def __init__(self, element: EtreeElement, bounding_box: BoundingBox) -> None:
+        """Initialize a BoundElement instance.
+
+        :param element: the element to be bound
+        :param bounding_box: the bounding box around the element
+        """
+        self.elem = element
+        self.bbox = bounding_box
+
+    def _update_elem(self):
+        self.elem.attrib["transform"] = self.bbox.transform_string
+
+    def transform(
+        self,
+        transformation: _Matrix | None = None,
+        *,
+        scale: float | None = None,
+        dx: float | None = None,
+        dy: float | None = None,
+    ):
+        """Transform the element and bounding box.
+
+        :param transformation: a 6-tuple transformation matrix
+        :param scale: a scaling factor
+        :param dx: the x translation
+        :param dy: the y translation
+        """
+        tmat = new_transformation_matrix(transformation, scale=scale, dx=dx, dy=dy)
+        self.bbox.transform(tmat)
+        _ = transform_element(self.elem, tmat)