svg-ultralight 0.44.0__py3-none-any.whl → 0.45.1__py3-none-any.whl

svg_ultralight/attrib_hints.py

@@ -0,0 +1,14 @@
+"""Type hints for pass-through arguments to lxml constructors.
+
+:author: Shay Hill
+:created: 2025-07-09
+"""
+
+from collections.abc import Mapping
+from typing import Union
+
+# Types svg_ultralight can format to pass through to lxml constructors.
+ElemAttrib = Union[str, float, None]
+
+# Type for an optional dictionary of element attributes.
+OptionalElemAttribMapping = Union[Mapping[str, ElemAttrib], None]

svg_ultralight/bounding_boxes/bound_helpers.py

@@ -8,6 +8,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+from lxml import etree
 from lxml.etree import _Element as EtreeElement  # pyright: ignore[reportPrivateUsage]
 
 from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
@@ -19,14 +20,14 @@ from svg_ultralight.constructors import new_element
 if TYPE_CHECKING:
     import os
 
+    from svg_ultralight.attrib_hints import ElemAttrib
     from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
-from lxml import etree
 
 _Matrix = tuple[float, float, float, float, float, float]
 
 
 def new_element_union(
-    *elems: EtreeElement | SupportsBounds, **attributes: float | str
+    *elems: EtreeElement | SupportsBounds, **attributes: ElemAttrib
 ) -> EtreeElement:
     """Get the union of any elements found in the given arguments.
 
@@ -186,13 +187,13 @@ def _get_view_box(elem: EtreeElement) -> tuple[float, float, float, float]:
     return x, y, width, height
 
 
-def parse_bound_element(svg_fil: str | os.PathLike[str]) -> BoundElement:
+def parse_bound_element(svg_file: str | os.PathLike[str]) -> BoundElement:
     """Import an element as a BoundElement.
 
     :param elem: the element to import.
     :return: a BoundElement instance.
     """
-    tree = etree.parse(svg_fil)
+    tree = etree.parse(svg_file)
     root = tree.getroot()
     elem = new_element("g")
     elem.extend(list(root))

svg_ultralight/bounding_boxes/padded_text_initializers.py

@@ -27,10 +27,7 @@ from svg_ultralight.font_tools.font_info import (
 )
 from svg_ultralight.font_tools.globs import DEFAULT_FONT_SIZE
 from svg_ultralight.query import get_bounding_boxes
-from svg_ultralight.string_conversion import (
-    format_attr_dict,
-    format_number,
-)
+from svg_ultralight.string_conversion import format_attr_dict, format_number
 
 if TYPE_CHECKING:
     import os
@@ -39,6 +36,8 @@ if TYPE_CHECKING:
         _Element as EtreeElement,  # pyright: ignore[reportPrivateUsage]
     )
 
+    from svg_ultralight.attrib_hints import ElemAttrib, OptionalElemAttribMapping
+
 DEFAULT_Y_BOUNDS_REFERENCE = "{[|gjpqyf"
 
 
@@ -99,7 +98,8 @@ def pad_text_ft(
     descent: float | None = None,
     *,
     y_bounds_reference: str | None = None,
-    **attributes: str | float,
+    attrib: OptionalElemAttribMapping = None,
+    **attributes: ElemAttrib,
 ) -> PaddedText:
     """Create a new PaddedText instance using fontTools.
 
@@ -115,11 +115,15 @@ def pad_text_ft(
         extents of the capline reference. This argument is provided to mimic the
         behavior of the query module's `pad_text` function. `pad_text` does no
         inspect font files and relies on Inkscape to measure reference characters.
+    :param attrib: optionally pass additional attributes as a mapping instead of as
+        anonymous kwargs. This is useful for pleasing the linter when unpacking a
+        dictionary into a function call.
     :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.
     """
+    attributes.update(attrib or {})
     attributes_ = format_attr_dict(**attributes)
     attributes_.update(get_svg_font_attributes(font))
 
@@ -145,7 +149,8 @@ def pad_text_mix(
     descent: float | None = None,
     *,
     y_bounds_reference: str | None = None,
-    **attributes: str | float,
+    attrib: OptionalElemAttribMapping = None,
+    **attributes: ElemAttrib,
 ) -> PaddedText:
     """Use Inkscape text bounds and fill missing with fontTools.
 
@@ -161,11 +166,15 @@ def pad_text_mix(
         extents of the capline reference. This argument is provided to mimic the
         behavior of the query module's `pad_text` function. `pad_text` does no
         inspect font files and relies on Inkscape to measure reference characters.
+    :param attrib: optionally pass additional attributes as a mapping instead of as
+        anonymous kwargs. This is useful for pleasing the linter when unpacking a
+        dictionary into a function call.
     :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.
     """
+    attributes.update(attrib or {})
     elem = new_element("text", text=text, **attributes)
     padded_inkscape = pad_text(inkscape, elem, y_bounds_reference, font=font)
     padded_fonttools = pad_text_ft(
@@ -175,7 +184,7 @@ def pad_text_mix(
         ascent,
         descent,
         y_bounds_reference=y_bounds_reference,
-        **attributes,
+        attrib=attributes,
     )
     bbox = padded_inkscape.unpadded_bbox
     rpad = padded_inkscape.rpad

svg_ultralight/constructors/new_element.py

@@ -25,8 +25,10 @@ if TYPE_CHECKING:
         _Element as EtreeElement,  # pyright: ignore[reportPrivateUsage]
     )
 
+    from svg_ultralight.attrib_hints import ElemAttrib
 
-def new_element(tag: str | QName, **attributes: str | float) -> EtreeElement:
+
+def new_element(tag: str | QName, **attributes: ElemAttrib) -> EtreeElement:
     """Create an etree.Element, make every kwarg value a string.
 
     :param tag: element tag
@@ -62,7 +64,7 @@ def new_element(tag: str | QName, **attributes: str | float) -> EtreeElement:
 
 
 def new_sub_element(
-    parent: EtreeElement, tag: str | QName, **attributes: str | float
+    parent: EtreeElement, tag: str | QName, **attributes: ElemAttrib
 ) -> EtreeElement:
     """Create an etree.SubElement, make every kwarg value a string.
 
@@ -81,7 +83,7 @@ def new_sub_element(
     return elem
 
 
-def update_element(elem: EtreeElement, **attributes: str | float) -> EtreeElement:
+def update_element(elem: EtreeElement, **attributes: ElemAttrib) -> EtreeElement:
     """Update an existing etree.Element with additional params.
 
     :param elem: at etree element
@@ -94,7 +96,7 @@ def update_element(elem: EtreeElement, **attributes: str | float) -> EtreeElemen
     return elem
 
 
-def deepcopy_element(elem: EtreeElement, **attributes: str | float) -> EtreeElement:
+def deepcopy_element(elem: EtreeElement, **attributes: ElemAttrib) -> EtreeElement:
     """Create a deepcopy of an element. Optionally pass additional params.
 
     :param elem: at etree element or list of elements

svg_ultralight/font_tools/comp_results.py

@@ -281,11 +281,11 @@ def _test_every_font_on_my_system(
 
 if __name__ == "__main__":
     _INKSCAPE = Path(r"C:\Program Files\Inkscape\bin\inkscape")
-    # _FONT_DIRS = [
-    #     Path(r"C:\Windows\Fonts"),
-    #     Path(r"C:\Users\shaya\AppData\Local\Microsoft\Windows\Fonts"),
-    # ]
-    # _test_every_font_on_my_system(_INKSCAPE, _FONT_DIRS)
+    _FONT_DIRS = [
+        Path(r"C:\Windows\Fonts"),
+        Path(r"C:\Users\shaya\AppData\Local\Microsoft\Windows\Fonts"),
+    ]
+    _test_every_font_on_my_system(_INKSCAPE, _FONT_DIRS)
 
     font = Path(r"C:\Windows\Fonts\arial.ttf")
     font = Path("C:/Windows/Fonts/Aptos-Display-Bold.ttf")

svg_ultralight/font_tools/font_info.py

@@ -119,12 +119,28 @@ if TYPE_CHECKING:
 
     from lxml.etree import _Element as EtreeElement
 
+    from svg_ultralight.attrib_hints import ElemAttrib
+
 logging.getLogger("fontTools").setLevel(logging.ERROR)
 
 
+_ESCAPE_CHARS = {"&": "&amp;", "<": "&lt;", ">": "&gt;", '"': "&quot;", "'": "&apos;"}
+
+
+def _sanitize_svg_data_text(text: str) -> str:
+    """Sanitize a string for use in an SVG data-text attribute.
+
+    :param text: The input string to sanitize.
+    :return: The sanitized string with XML characters escaped.
+    """
+    for char, escape_seq in _ESCAPE_CHARS.items():
+        text = text.replace(char, escape_seq)
+    return text
+
+
 # extract_gpos_kerning is an unfinished attempt to extract kerning from the GPOS
 # table.
-def get_gpos_kerning(font: TTFont) -> dict[tuple[str, str], int]:
+def _get_gpos_kerning(font: TTFont) -> dict[tuple[str, str], int]:
     """Extract kerning pairs from the GPOS table of a font.
 
     :param font: A fontTools TTFont object.
@@ -323,7 +339,7 @@ class FTFontInfo:
         except (KeyError, AttributeError):
             kern = {}
         with suppress(Exception):
-            kern.update(get_gpos_kerning(self.font))
+            kern.update(_get_gpos_kerning(self.font))
 
         return kern
 
@@ -520,7 +536,7 @@ class FTTextInfo:
         """
         return self.font_size / self.font.units_per_em
 
-    def new_element(self, **attributes: str | float) -> EtreeElement:
+    def new_element(self, **attributes: ElemAttrib) -> EtreeElement:
         """Return an svg text element with the appropriate font attributes."""
         matrix_vals = (self.scale, 0, 0, -self.scale, 0, 0)
         matrix = f"matrix({' '.join(format_numbers(matrix_vals))})"
@@ -530,7 +546,7 @@ class FTTextInfo:
             attributes["stroke-width"] = float(stroke_width) / self.scale
         return new_element(
             "path",
-            data_text=self.text,
+            data_text=_sanitize_svg_data_text(self.text),
             d=self.font.get_text_svgd(self.text),
             **attributes,
         )

svg_ultralight/main.py

@@ -36,6 +36,7 @@ if TYPE_CHECKING:
         _Element as EtreeElement,  # pyright: ignore[reportPrivateUsage]
     )
 
+    from svg_ultralight.attrib_hints import ElemAttrib, OptionalElemAttribMapping
     from svg_ultralight.layout import PadArg
 
 
@@ -68,7 +69,8 @@ def new_svg_root(
     print_height_: float | str | None = None,
     dpu_: float = 1,
     nsmap: dict[str | None, str] | None = None,
-    **attributes: float | str,
+    attrib: OptionalElemAttribMapping | None = None,
+    **attributes: ElemAttrib,
 ) -> EtreeElement:
     """Create an svg root element from viewBox style parameters.
 
@@ -87,6 +89,9 @@ def new_svg_root(
         different from print_width_ and print_height_ in that dpu_ scales the
         *padded* output.
     :param nsmap: optionally pass a namespace map of your choosing
+    :param attrib: optionally pass additional attributes as a mapping instead of as
+        anonymous kwargs. This is useful for pleasing the linter when unpacking a
+        dictionary into a function call.
     :param attributes: element attribute names and values
     :return: root svg element
 
@@ -97,10 +102,11 @@ def new_svg_root(
     will be passed to ``etree.Element`` as element parameters. These will
     supercede any parameters inferred from the trailing underscore parameters.
     """
+    attributes.update(attrib or {})
     if nsmap is None:
         nsmap = NSMAP
 
-    inferred_attribs: dict[str, float | str] = {}
+    inferred_attribs: dict[str, ElemAttrib] = {}
     view_box_args = (x_, y_, width_, height_)
     if _is_four_floats(view_box_args):
         assert isinstance(x_, (float, int))

svg_ultralight/root_elements.py

@@ -17,6 +17,7 @@ if TYPE_CHECKING:
         _Element as EtreeElement,  # pyright: ignore[reportPrivateUsage]
     )
 
+    from svg_ultralight.attrib_hints import ElemAttrib, OptionalElemAttribMapping
     from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
     from svg_ultralight.layout import PadArg
 
@@ -43,7 +44,8 @@ def new_svg_root_around_bounds(
     print_height_: float | str | None = None,
     dpu_: float = 1,
     nsmap: dict[str | None, str] | None = None,
-    **attributes: float | str,
+    attrib: OptionalElemAttribMapping = None,
+    **attributes: ElemAttrib,
 ) -> EtreeElement:
     """Create svg root around BoundElements.
 
@@ -61,10 +63,14 @@ def new_svg_root_around_bounds(
         different from print_width_ and print_height_ in that dpu_ scales the
         *padded* output.
     :param nsmap: optionally pass a namespace map of your choosing
+    :param attrib: optionally pass additional attributes as a mapping instead of as
+        anonymous kwargs. This is useful for pleasing the linter when unpacking a
+        dictionary into a function call.
     :param attributes: element attribute names and values
     :return: root svg element
     :raise ValueError: if no bounding boxes are found in bounded
     """
+    attributes.update(attrib or {})
     bbox = bound.new_bbox_union(*bounded)
     viewbox = _viewbox_args_from_bboxes(bbox)
     return new_svg_root(
@@ -77,5 +83,5 @@ def new_svg_root_around_bounds(
         print_height_=print_height_,
         dpu_=dpu_,
         nsmap=nsmap,
-        **attributes,
+        attrib=attributes,
     )

svg_ultralight/string_conversion.py

@@ -26,6 +26,8 @@ if TYPE_CHECKING:
         _Element as EtreeElement,  # pyright: ignore[reportPrivateUsage]
     )
 
+    from svg_ultralight.attrib_hints import ElemAttrib
+
 
 def format_number(num: float | str, resolution: int | None = 6) -> str:
     """Format a number into an svg-readable float string with resolution = 6.
@@ -50,7 +52,7 @@ def format_numbers(
     return [format_number(num) for num in nums]
 
 
-def _fix_key_and_format_val(key: str, val: str | float) -> tuple[str, str]:
+def _fix_key_and_format_val(key: str, val: ElemAttrib) -> tuple[str, str]:
     """Format one key, value pair for an svg element.
 
     :param key: element attribute name
@@ -82,7 +84,9 @@ def _fix_key_and_format_val(key: str, val: str | float) -> tuple[str, str]:
     else:
         key_ = key.rstrip("_").replace("_", "-")
 
-    if isinstance(val, (int, float)):
+    if val is None:
+        val_ = "none"
+    elif isinstance(val, (int, float)):
         val_ = format_number(val)
     else:
         val_ = val
@@ -90,7 +94,7 @@ def _fix_key_and_format_val(key: str, val: str | float) -> tuple[str, str]:
     return key_, val_
 
 
-def format_attr_dict(**attributes: str | float) -> dict[str, str]:
+def format_attr_dict(**attributes: ElemAttrib) -> dict[str, str]:
     """Use svg_ultralight key / value fixer to create a dict of attributes.
 
     :param attributes: element attribute names and values.
@@ -99,7 +103,7 @@ def format_attr_dict(**attributes: str | float) -> dict[str, str]:
     return dict(_fix_key_and_format_val(key, val) for key, val in attributes.items())
 
 
-def set_attributes(elem: EtreeElement, **attributes: str | float) -> None:
+def set_attributes(elem: EtreeElement, **attributes: ElemAttrib) -> None:
     """Set name: value items as element attributes. Make every value a string.
 
     :param elem: element to receive element.set(keyword, str(value)) calls

{svg_ultralight-0.44.0.dist-info → svg_ultralight-0.45.1.dist-info}/METADATA

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

{svg_ultralight-0.44.0.dist-info → svg_ultralight-0.45.1.dist-info}/RECORD

@@ -1,34 +1,35 @@
 svg_ultralight/__init__.py,sha256=3YdTZfa0xUDrPCbOVyx39D9ENks-JEtsi9DFZzvaTf0,2755
 svg_ultralight/animate.py,sha256=SMcQkeWAP9dD08Iyzy9qGG8Qk1p-14WfrB7WSN8Pj_4,1133
+svg_ultralight/attrib_hints.py,sha256=oCF20eG06vg2Tuapk1A14ovN7ZqZoZ43d-um_Zh0BPs,418
 svg_ultralight/image_ops.py,sha256=6V9YkxnhZCBw_hbVyY0uxDj0pZgiEWBSGRuPuOYKY4w,4694
 svg_ultralight/inkscape.py,sha256=ySCxWnQwEt1sosa1b4mEkR-ugpfoAeg9gs1OLPS69iI,9597
 svg_ultralight/layout.py,sha256=7LV2I3u4EhqSc6ASvgwDtTZyV-Y1qt2wtvRtH2uKVAE,12799
-svg_ultralight/main.py,sha256=_zY6F8zc1tAGSe8isBOK5ajpDB8d4I7x7zD2fjsP4SE,7475
+svg_ultralight/main.py,sha256=zaqWc5y9tsJoyNhpX2gIHKj1ZGEcfJebxNCcRQyoziU,7857
 svg_ultralight/metadata.py,sha256=xaIfqhKu52Dl4JOrRlpUsWkkE7Umw8j5Z4waFTli-kI,4234
 svg_ultralight/nsmap.py,sha256=y63upO78Rr-JJT56RWWZuyrsILh6HPoY4GhbYnK1A0g,1244
 svg_ultralight/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 svg_ultralight/query.py,sha256=iFFsK78TuUT6h3iv_V8_fwCggIAdYa97K7oOPhhoPuY,9711
-svg_ultralight/root_elements.py,sha256=E_H7HXk0M5F3IyFVOxO8PQmhww1-sHTzJhx8hBJPZvg,2911
-svg_ultralight/string_conversion.py,sha256=omCmiwyu5AIDHltPiXIEYQG3KiII1twlUJN2oven0mM,8749
+svg_ultralight/root_elements.py,sha256=H_J7GMO8yqoie169uDUB1LxWSpc7BgUH6H657ZPRahg,3292
+svg_ultralight/string_conversion.py,sha256=NWguHAmuKWON7Fh2EkVDfMIwp-jk6k7SW8hAUh72H0o,8850
 svg_ultralight/transformations.py,sha256=T3vSxcTWOwWnwu3OF610LHMbKScUIVWICUAvru5zLnU,4488
 svg_ultralight/unit_conversion.py,sha256=g07nhzXdjPvGcJmkhLdFbeDLrSmbI8uFoVgPo7G62Bg,9258
 svg_ultralight/bounding_boxes/__init__.py,sha256=qUEn3r4s-1QNHaguhWhhaNfdP4tl_B6YEqxtiTFuzhQ,78
-svg_ultralight/bounding_boxes/bound_helpers.py,sha256=LFkVsdYFKYCnEL6vLvEa_5cfu8D44ZGYeEEb7_0MnC0,7146
-svg_ultralight/bounding_boxes/padded_text_initializers.py,sha256=tPQ5ilZnSm83HH852euoe0V77Nf-78BG7wlE7K8FqnM,7668
+svg_ultralight/bounding_boxes/bound_helpers.py,sha256=iCinp_kFsxi29gJEMnDZpKs13Fj1fj8SWqbbWO94UTI,7203
+svg_ultralight/bounding_boxes/padded_text_initializers.py,sha256=LytVTNwdkJvh914DXIzB4zfrbk563K30ODlk8BmuotA,8328
 svg_ultralight/bounding_boxes/supports_bounds.py,sha256=T7LGse58fDBgmlzupSC63C1ZMXjFbyzBTsTUaqD_4Sw,4513
 svg_ultralight/bounding_boxes/type_bound_collection.py,sha256=NAEpqo9H9ewhuLcOmBnMWUE0zQ1t4bvckovgvWy6hIo,2645
 svg_ultralight/bounding_boxes/type_bound_element.py,sha256=Sc-R0uXkb0aS8-OcyM5pDukKhFUka0G6KCp6LcYDcIU,2204
 svg_ultralight/bounding_boxes/type_bounding_box.py,sha256=bABFT-BwVdOmRJ-BHOLE_7LZv57MDwqABHvRDcVmvtI,13509
 svg_ultralight/bounding_boxes/type_padded_text.py,sha256=WNIoqC9pfB8g_00P6RHcBdNE6VniqlLJXw_bh-GNjFA,13098
 svg_ultralight/constructors/__init__.py,sha256=XLOInLhzMERWNnFAs-itMs-OZrBOpvQthZJ2T5duqBE,327
-svg_ultralight/constructors/new_element.py,sha256=hRUW2hR_BTkthEqPClYV7-IeFe9iv2zwb6ehp1k1xDk,3475
+svg_ultralight/constructors/new_element.py,sha256=kGRaVsT1yugADUCKz3NjFW_14Ts1M8UQeLPTarTXtBY,3529
 svg_ultralight/font_tools/__init__.py,sha256=NX3C0vvoB-G4S-h1f0NLWePjYAMMR37D1cl_G4WBjHc,83
-svg_ultralight/font_tools/comp_results.py,sha256=ypqIqt7pe4tCCRGMJl7hVJtmQyUAYlQj1HZHmTcVThE,10697
-svg_ultralight/font_tools/font_info.py,sha256=QztVHygo-qkp0IOe5bRnvjiR1rehEVxUyvsMZDJm5A0,29343
+svg_ultralight/font_tools/comp_results.py,sha256=gFxdqY1D5z8MGt1UyWOK8O_t50AHgg-B846uWdzoLco,10687
+svg_ultralight/font_tools/font_info.py,sha256=rIoEmEWhNYw04Jos_ETXQ11SkDhi6YlLd3VjZMLETXs,29875
 svg_ultralight/font_tools/globs.py,sha256=JdrrGMqDtD4WcY7YGUWV43DUW63RVev-x9vWqsQUhxU,119
 svg_ultralight/strings/__init__.py,sha256=BMGhF1pulscIgkiYvZLr6kPRR0L4lW0jUNFxkul4_EM,295
 svg_ultralight/strings/svg_strings.py,sha256=FQNxNmMkR2M-gCFo_woQKXLgCHi3ncUlRMiaRR_a9nQ,1978
-svg_ultralight-0.44.0.dist-info/METADATA,sha256=mHPgja-zNjke16M_4iZCj5gAS3orif2qnJTgkogwHvc,9052
-svg_ultralight-0.44.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-svg_ultralight-0.44.0.dist-info/top_level.txt,sha256=se-6yqM_0Yg5orJKvKWdjQZ4iR4G_EjhL7oRgju-fdY,15
-svg_ultralight-0.44.0.dist-info/RECORD,,
+svg_ultralight-0.45.1.dist-info/METADATA,sha256=_5egao_AkYDDIGZ7iN4anNt2FzM9KeVuK_ZSUvI_UVs,9052
+svg_ultralight-0.45.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+svg_ultralight-0.45.1.dist-info/top_level.txt,sha256=se-6yqM_0Yg5orJKvKWdjQZ4iR4G_EjhL7oRgju-fdY,15
+svg_ultralight-0.45.1.dist-info/RECORD,,