svg-ultralight 0.50.1__tar.gz → 0.51.0__tar.gz

{svg_ultralight-0.50.1 → svg_ultralight-0.51.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: svg-ultralight
-Version: 0.50.1
+Version: 0.51.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.1 → svg_ultralight-0.51.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "svg-ultralight"
-version = "0.50.1"
+version = "0.51.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.1"
+version = "0.51.0"
 tag_format = "$version"
 major-version-zero = true
 version_files = ["pyproject.toml:^version"]

{svg_ultralight-0.50.1 → svg_ultralight-0.51.0}/src/svg_ultralight/attrib_hints.py

@@ -5,9 +5,10 @@
 """
 
 from collections.abc import Mapping
+from typing import TypeAlias
 
 # Types svg_ultralight can format to pass through to lxml constructors.
-ElemAttrib = str | float | None
+ElemAttrib: TypeAlias = str | float | None
 
 # Type for an optional dictionary of element attributes.
-OptionalElemAttribMapping = Mapping[str, ElemAttrib] | None
+OptionalElemAttribMapping: TypeAlias = Mapping[str, ElemAttrib] | None

{svg_ultralight-0.50.1 → svg_ultralight-0.51.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.1 → svg_ultralight-0.51.0}/src/svg_ultralight/constructors/new_element.py

@@ -13,14 +13,16 @@ from __future__ import annotations
 
 import copy
 import warnings
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 from lxml import etree
 
 from svg_ultralight.string_conversion import set_attributes
 
 if TYPE_CHECKING:
-    from lxml.etree import QName
+    from lxml.etree import (
+        QName,
+    )
     from lxml.etree import (
         _Element as EtreeElement,  # pyright: ignore[reportPrivateUsage]
     )
@@ -78,7 +80,10 @@ def new_sub_element(
         >>> etree.tostring(parent)
         b'<g><rect/></g>'
     """
-    elem = etree.SubElement(parent, tag)
+    elem = cast(
+        "EtreeElement",
+        etree.SubElement(parent, tag),  # pyright: ignore[reportUnknownMemberType]
+    )
     set_attributes(elem, **attributes)
     return elem
 

{svg_ultralight-0.50.1 → svg_ultralight-0.51.0}/src/svg_ultralight/font_tools/font_info.py

@@ -644,7 +644,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 +669,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.1 → svg_ultralight-0.51.0}/src/svg_ultralight/layout.py

@@ -7,11 +7,12 @@
 from __future__ import annotations
 
 from collections.abc import Sequence
+from typing import TypeAlias
 
 from svg_ultralight.string_conversion import format_number
 from svg_ultralight.unit_conversion import Measurement, MeasurementArg
 
-PadArg = float | str | Measurement | Sequence[float | str | Measurement]
+PadArg: TypeAlias = float | str | Measurement | Sequence[float | str | Measurement]
 
 
 def expand_pad_arg(pad: PadArg) -> tuple[float, float, float, float]:

{svg_ultralight-0.50.1 → svg_ultralight-0.51.0}/src/svg_ultralight/transformations.py

@@ -9,7 +9,7 @@ from __future__ import annotations
 import numbers
 import re
 from contextlib import suppress
-from typing import TYPE_CHECKING, cast
+from typing import TYPE_CHECKING, TypeAlias, cast
 
 from svg_ultralight.strings import svg_matrix
 
@@ -21,7 +21,7 @@ if TYPE_CHECKING:
 
 RE_MATRIX = re.compile(r"matrix\(([^)]+)\)")
 
-_Matrix = tuple[float, float, float, float, float, float]
+_Matrix: TypeAlias = tuple[float, float, float, float, float, float]
 
 
 def mat_dot(mat1: _Matrix, mat2: _Matrix) -> _Matrix: