svg-ultralight 0.50.2__tar.gz → 0.52.0__tar.gz

{svg_ultralight-0.50.2 → svg_ultralight-0.52.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: svg-ultralight
-Version: 0.50.2
+Version: 0.52.0
 Summary: a sensible way to create svg files with Python
 Author: Shay Hill
 Author-email: Shay Hill <shay_public@hotmail.com>

{svg_ultralight-0.50.2 → svg_ultralight-0.52.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "svg-ultralight"
-version = "0.50.2"
+version = "0.52.0"
 description = "a sensible way to create svg files with Python"
 readme = "README.md"
 license = "MIT"
@@ -33,7 +33,7 @@ dev = [
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.50.2"
+version = "0.52.0"
 tag_format = "$version"
 major-version-zero = true
 version_files = ["pyproject.toml:^version"]

{svg_ultralight-0.50.2 → svg_ultralight-0.52.0}/src/svg_ultralight/bounding_boxes/padded_text_initializers.py

@@ -23,11 +23,12 @@ to 16px.
 from __future__ import annotations
 
 from copy import deepcopy
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, overload
 
 from svg_ultralight.bounding_boxes.type_padded_text import PaddedText
 from svg_ultralight.constructors import new_element, update_element
 from svg_ultralight.font_tools.font_info import (
+    FTFontInfo,
     get_padded_text_info,
     get_svg_font_attributes,
 )
@@ -99,6 +100,7 @@ def pad_text(
     return PaddedText(text_elem, bbox, tpad, rpad, bpad, lpad)
 
 
+@overload
 def pad_text_ft(
     font: str | os.PathLike[str],
     text: str,
@@ -109,11 +111,38 @@ def pad_text_ft(
     y_bounds_reference: str | None = None,
     attrib: OptionalElemAttribMapping = None,
     **attributes: ElemAttrib,
-) -> PaddedText:
+) -> PaddedText: ...
+
+
+@overload
+def pad_text_ft(
+    font: str | os.PathLike[str],
+    text: list[str],
+    font_size: float | None = None,
+    ascent: float | None = None,
+    descent: float | None = None,
+    *,
+    y_bounds_reference: str | None = None,
+    attrib: OptionalElemAttribMapping = None,
+    **attributes: ElemAttrib,
+) -> list[PaddedText]: ...
+
+
+def pad_text_ft(
+    font: str | os.PathLike[str],
+    text: str | list[str],
+    font_size: float | None = None,
+    ascent: float | None = None,
+    descent: float | None = None,
+    *,
+    y_bounds_reference: str | None = None,
+    attrib: OptionalElemAttribMapping = None,
+    **attributes: ElemAttrib,
+) -> PaddedText | list[PaddedText]:
     """Create a new PaddedText instance using fontTools.
 
     :param font: path to a font file.
-    :param text: the text of the text element.
+    :param text: the text of the text element or a list of text strings.
     :param font_size: the font size to use.
     :param ascent: the ascent of the font. If not provided, it will be calculated
         from the font file.
@@ -130,7 +159,8 @@ def pad_text_ft(
     :param attributes: additional attributes to set on the text element. There is a
         chance these will cause the font element to exceed the BoundingBox of the
         PaddedText instance.
-    :return: a PaddedText instance with a line_gap defined.
+    :return: a PaddedText instance with a line_gap defined. If a list of strings is
+        given for parameter `text`, a list of PaddedText instances is returned.
     """
     attributes.update(attrib or {})
     attributes_ = format_attr_dict(**attributes)
@@ -142,11 +172,33 @@ def pad_text_ft(
     _ = attributes_.pop("font-weight", None)
     _ = attributes_.pop("font-stretch", None)
 
-    info = get_padded_text_info(
-        font, text, font_size, ascent, descent, y_bounds_reference=y_bounds_reference
-    )
-    elem = info.new_element(**attributes_)
-    return PaddedText(elem, info.bbox, *info.padding, info.line_gap)
+    font_info = FTFontInfo(font)
+
+    try:
+        input_one_text_item = False
+        if isinstance(text, str):
+            input_one_text_item = True
+            text = [text]
+
+        elems: list[PaddedText] = []
+        for text_item in text:
+            text_info = get_padded_text_info(
+                font_info,
+                text_item,
+                font_size,
+                ascent,
+                descent,
+                y_bounds_reference=y_bounds_reference,
+            )
+            elem = text_info.new_element(**attributes_)
+            elems.append(
+                PaddedText(elem, text_info.bbox, *text_info.padding, text_info.line_gap)
+            )
+    finally:
+        font_info.font.close()
+    if input_one_text_item:
+        return elems[0]
+    return elems
 
 
 def pad_text_mix(

{svg_ultralight-0.50.2 → svg_ultralight-0.52.0}/src/svg_ultralight/bounding_boxes/supports_bounds.py

@@ -52,6 +52,7 @@ class SupportsBounds(Protocol):
         scale: tuple[float, float] | float | None = None,
         dx: float | None = None,
         dy: float | None = None,
+        reverse: bool = False,
     ) -> None:
         """Apply a transformation to the object."""
         ...

{svg_ultralight-0.50.2 → svg_ultralight-0.52.0}/src/svg_ultralight/bounding_boxes/type_bound_collection.py

@@ -47,6 +47,7 @@ class BoundCollection(HasBoundingBox):
         scale: tuple[float, float] | float | None = None,
         dx: float | None = None,
         dy: float | None = None,
+        reverse: bool = False,
     ) -> None:
         """Transform each bound element in self.blems.
 
@@ -54,9 +55,11 @@ class BoundCollection(HasBoundingBox):
         :param scale: optional scale factor
         :param dx: optional x translation
         :param dy: optional y translation
+        :param reverse: Transform the element as if it were in a <g> element
+            transformed by tmat.
 
         Keep track of all compounding transformations in order to have a value for
-        self.scale (required for membersh and to provide access to cumulative
+        self.scale (required for members 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
@@ -66,6 +69,6 @@ class BoundCollection(HasBoundingBox):
         self.bbox.transform(tmat)
         for blem in self.blems:
             if isinstance(blem, EtreeElement):
-                _ = transform_element(blem, tmat)
+                _ = transform_element(blem, tmat, reverse=reverse)
             else:
-                blem.transform(tmat)
+                blem.transform(tmat, reverse=reverse)

{svg_ultralight-0.50.2 → svg_ultralight-0.52.0}/src/svg_ultralight/bounding_boxes/type_bound_element.py

@@ -52,6 +52,7 @@ class BoundElement(HasBoundingBox):
         scale: tuple[float, float] | float | None = None,
         dx: float | None = None,
         dy: float | None = None,
+        reverse: bool = False,
     ) -> None:
         """Transform the element and bounding box.
 
@@ -59,7 +60,9 @@ class BoundElement(HasBoundingBox):
         :param scale: a scaling factor
         :param dx: the x translation
         :param dy: the y translation
+        :param reverse: Transform the element as if it were in a <g> element
+            transformed by tmat.
         """
         tmat = new_transformation_matrix(transformation, scale=scale, dx=dx, dy=dy)
-        self.bbox.transform(tmat)
-        _ = transform_element(self.elem, tmat)
+        self.bbox.transform(tmat, reverse=reverse)
+        _ = transform_element(self.elem, tmat, reverse=reverse)

{svg_ultralight-0.50.2 → svg_ultralight-0.52.0}/src/svg_ultralight/bounding_boxes/type_bounding_box.py

@@ -78,6 +78,7 @@ class HasBoundingBox(SupportsBounds):
         scale: tuple[float, float] | float | None = None,
         dx: float | None = None,
         dy: float | None = None,
+        reverse: bool = False,
     ) -> None:
         """Transform the bounding box by updating the transformation attribute.
 
@@ -85,6 +86,8 @@ class HasBoundingBox(SupportsBounds):
         :param scale: scale factor
         :param dx: x translation
         :param dy: y translation
+        :param reverse: Transform the element as if it were in a <g> element
+            transformed by tmat.
 
         All parameters are optional. Scale, dx, and dy are optional and applied after
         the transformation matrix if both are given. This shouldn't be necessary in
@@ -94,7 +97,10 @@ class HasBoundingBox(SupportsBounds):
         when applying a transformation from another bounding box instance.
         """
         tmat = new_transformation_matrix(transformation, scale=scale, dx=dx, dy=dy)
-        self.bbox.transformation = mat_dot(tmat, self.bbox.transformation)
+        if reverse:
+            self.bbox.transformation = mat_dot(self.bbox.transformation, tmat)
+        else:
+            self.bbox.transformation = mat_dot(tmat, self.bbox.transformation)
 
     @property
     def scale(self) -> tuple[float, float]:

{svg_ultralight-0.50.2 → svg_ultralight-0.52.0}/src/svg_ultralight/bounding_boxes/type_padded_text.py

@@ -119,6 +119,16 @@ class PaddedText(BoundElement):
         self.lpad = lpad
         self._line_gap = line_gap
 
+    @property
+    def tbox(self) -> BoundingBox:
+        """Return the unpadded BoundingBox around the text element.
+
+        Tight bbox or True bbox. An alias for unpadded_bbox.
+
+        :return: The unpadded BoundingBox around the text element.
+        """
+        return self.unpadded_bbox
+
     @property
     def bbox(self) -> BoundingBox:
         """Return a BoundingBox around the margins and cap/baseline.
@@ -154,6 +164,7 @@ class PaddedText(BoundElement):
         scale: tuple[float, float] | float | None = None,
         dx: float | None = None,
         dy: float | None = None,
+        reverse: bool = False,
     ) -> None:
         """Transform the element and bounding box.
 
@@ -161,10 +172,12 @@ class PaddedText(BoundElement):
         :param scale: a scaling factor
         :param dx: the x translation
         :param dy: the y translation
+        :param reverse: Transform the element as if it were in a <g> element
+            transformed by tmat.
         """
         tmat = new_transformation_matrix(transformation, scale=scale, dx=dx, dy=dy)
-        self.unpadded_bbox.transform(tmat)
-        _ = transform_element(self.elem, tmat)
+        self.unpadded_bbox.transform(tmat, reverse=reverse)
+        _ = transform_element(self.elem, tmat, reverse=reverse)
 
     @property
     def line_gap(self) -> float:

{svg_ultralight-0.50.2 → svg_ultralight-0.52.0}/src/svg_ultralight/font_tools/font_info.py

@@ -425,7 +425,13 @@ class FTFontInfo:
         coordinates (+y is down).
         """
         min_x, min_y, max_x, max_y = self.get_char_bounds(char)
-        return BoundingBox(min_x, -max_y, max_x - min_x, max_y - min_y)
+        return BoundingBox(
+            min_x,
+            min_y,
+            max_x - min_x,
+            max_y - min_y,
+            transformation=(1, 0, 0, -1, 0, 0),
+        )
 
     def get_text_bounds(self, text: str) -> tuple[int, int, int, int]:
         """Return bounds of a string as xmin, ymin, xmax, ymax.
@@ -484,7 +490,13 @@ class FTFontInfo:
         coordinates (+y is down).
         """
         min_x, min_y, max_x, max_y = self.get_text_bounds(text)
-        return BoundingBox(min_x, -max_y, max_x - min_x, max_y - min_y)
+        return BoundingBox(
+            min_x,
+            min_y,
+            max_x - min_x,
+            max_y - min_y,
+            transformation=(1, 0, 0, -1, 0, 0),
+        )
 
     def get_lsb(self, char: str) -> float:
         """Return the left side bearing of a character."""
@@ -567,7 +579,7 @@ class FTTextInfo:
         """
         bbox = self.font.get_text_bbox(self.text)
         bbox.transform(scale=self.scale)
-        return BoundingBox(*bbox.values())
+        return bbox
 
     @property
     def ascent(self) -> float:
@@ -644,7 +656,7 @@ def get_font_size_given_height(font: str | os.PathLike[str], height: float) -> f
 
 
 def get_padded_text_info(
-    font: str | os.PathLike[str],
+    font: str | os.PathLike[str] | FTFontInfo,
     text: str,
     font_size: float | None = None,
     ascent: float | None = None,
@@ -669,7 +681,10 @@ def get_padded_text_info(
     :return: A FTTextInfo object with the information necessary to create a
         PaddedText instance: bbox, tpad, rpad, bpad, lpad.
     """
-    font_info = FTFontInfo(font)
+    if isinstance(font, FTFontInfo):
+        font_info = font
+    else:
+        font_info = FTFontInfo(font)
     if y_bounds_reference:
         capline_info = FTTextInfo(font_info, y_bounds_reference, font_size)
         ascent = -capline_info.bbox.y

{svg_ultralight-0.50.2 → svg_ultralight-0.52.0}/src/svg_ultralight/transformations.py

@@ -129,12 +129,24 @@ def new_transformation_matrix(
     return mat_dot((float(scale_x), 0, 0, float(scale_y), dx, dy), transformation)
 
 
-def transform_element(elem: EtreeElement, matrix: _Matrix) -> EtreeElement:
+def transform_element(
+    elem: EtreeElement, matrix: _Matrix, *, reverse: bool = False
+) -> EtreeElement:
     """Apply a transformation matrix to an svg element.
 
     :param elem: svg element
-    :param matrix: transformation matrix
+    :par m matrix: transformation matrix
+
+    :param reverse: If you have a transformation matrix, A, and wish to apply an
+    additional transform, B, the result is B @ A. This is how an element can be
+    cumulatively transformed in svg.
+
+    If the element is transformed by A and is a part of a GROUP transformed by B,
+    then the result is the reverse: A @ B.
     """
     current = get_transform_matrix(elem)
-    elem.attrib["transform"] = svg_matrix(mat_dot(matrix, current))
+    if reverse:
+        elem.attrib["transform"] = svg_matrix(mat_dot(current, matrix))
+    else:
+        elem.attrib["transform"] = svg_matrix(mat_dot(matrix, current))
     return elem