svg-ultralight 0.25.0__py3-none-any.whl → 0.27.0__py3-none-any.whl

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/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/bounding_boxes/type_bounding_box.py

@@ -6,7 +6,6 @@
 
 from __future__ import annotations
 
-import warnings
 from dataclasses import dataclass
 
 from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
@@ -286,12 +285,6 @@ class BoundingBox(SupportsBounds):
         :return: a bounding box around self and other bounding boxes
         :raises DeprecationWarning:
         """
-        warnings.warn(
-            "Method a.merge(b, c) is deprecated. "
-            + "Use classmethod BoundingBox.merged(a, b, c) instead.",
-            category=DeprecationWarning,
-            stacklevel=1,
-        )
         return BoundingBox.merged(self, *others)
 
     @classmethod

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/string_conversion.py

@@ -79,15 +79,18 @@ def format_numbers_in_string(data: float | str) -> str:
     :return: string with floats formatted to limited precision
 
     Works as a more robust version of format_number. Will correctly handle input
-    floats in exponential notation. This should work for and parameter value in an
-    svg except 'text'. The function will fail with input strings like
-    'ice3.14bucket', because 'e3.14' will be identified as a float. SVG param values
-    will not have such strings, but the 'text' attribute could. This function will
-    not handle that case. Do not attempt to reformat 'text' attribute values.
+    floats in exponential notation. This should work for any parameter value in an
+    svg except 'text', 'id' and for any other value except hex color codes. The
+    function will fail with input strings like 'ice3.14bucket', because 'e3.14' will
+    be identified as a float. SVG param values will not have such strings, but the
+    'text' attribute could. This function will not handle that case. Do not attempt
+    to reformat 'text' attribute values.
     """
     with suppress(ValueError):
         # try as a regular number to strip spaces from simple float strings
         return format_number(data)
+    if str(data).startswith("#"):
+        return str(data)
     words = re.split(r"([^\d.eE-]+)", str(data))
     words = [format_number(w) if _is_float_or_float_str(w) else w for w in words]
     return "".join(words)
@@ -123,7 +126,7 @@ def _fix_key_and_format_val(key: str, val: str | float) -> tuple[str, str]:
     else:
         key_ = key.rstrip("_").replace("_", "-")
 
-    if key_ == "text":
+    if key_ in {"id", "text"}:
         return key_, str(val)
 
     return key_, format_numbers_in_string(val)

{svg_ultralight-0.25.0.dist-info → svg_ultralight-0.27.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: svg-ultralight
-Version: 0.25.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.25.0.dist-info → svg_ultralight-0.27.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-svg_ultralight/__init__.py,sha256=5n-7C9idISTR56-AqZ834DpmYGgPUBdtFK7iIekiCqc,1627
+svg_ultralight/__init__.py,sha256=Xyi-aBOAfVNoUg9rHXYVMELehe1kReEyQYL682AcQ1A,1877
 svg_ultralight/animate.py,sha256=JSrBm-59BcNXDF0cGgl4-C89eBunjevZnwZxIWt48TU,1112
 svg_ultralight/inkscape.py,sha256=M8yTxXOu4NlXnhsMycvEJiIDpnDeiZ_bZakJBM38ZoU,9152
 svg_ultralight/layout.py,sha256=TTETT_8WLBXnQxDGXdAeczCFN5pFo5kKY3Q6zv4FPX4,12238
@@ -7,19 +7,20 @@ svg_ultralight/metadata.py,sha256=Mxgxrxe1Ar4kp2wTT29aadxgHNFaaNLABo29jStiWDg,42
 svg_ultralight/nsmap.py,sha256=y63upO78Rr-JJT56RWWZuyrsILh6HPoY4GhbYnK1A0g,1244
 svg_ultralight/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 svg_ultralight/query.py,sha256=PFyhR9v60JkuksRb0LVkml67nmOxfZW9eCtL-JoH52Y,7270
-svg_ultralight/root_elements.py,sha256=rUc26ec-FLAUgO5iOF3aOeKZC7CjiTw7TGyGAj33yNU,3219
-svg_ultralight/string_conversion.py,sha256=bIzhzF_T92VfceNAz27WmLP1YSSgq__-YCF25Dm0D0I,7226
+svg_ultralight/root_elements.py,sha256=pt9J6mPrnoTAZVF6vKTZoM_o947I8UCj6MbGcD2JUCk,2869
+svg_ultralight/string_conversion.py,sha256=WEmpf75RJmJ2lfJluagAz2wPsz6wM8XvTEwkq4U0vEc,7353
 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=D-Qp8yDmn5vIBdaSlBvaWR0F_iRCdotgQqjaRHXBq-8,3397
 svg_ultralight/bounding_boxes/supports_bounds.py,sha256=1yqmZ7PH1bBH-LTIUDzSvKFXkPLXfJM7jJNz0bXurZ4,3926
 svg_ultralight/bounding_boxes/type_bound_element.py,sha256=VKiN4UnC2XlPKapWRHxgtqhO4BuVoe6YkLrirlEP09w,5714
-svg_ultralight/bounding_boxes/type_bounding_box.py,sha256=9qhbhVCjwBXTeo7f7nNKJH5LXliQBJb80r8mXtVuUgc,10622
+svg_ultralight/bounding_boxes/type_bounding_box.py,sha256=OqvS6LhfMwnoE4PUwAmHlY0tjY-2YQZQiLY6O2U3vfs,10378
 svg_ultralight/bounding_boxes/type_padded_text.py,sha256=FnwHD54qPMlyOB0yhRgZShQWA_riaaTS9GwD9HnbPm4,14119
 svg_ultralight/constructors/__init__.py,sha256=YcnO0iBQc19aL8Iemw0Y452MBMBIT2AN5nZCnoGxpn0,327
 svg_ultralight/constructors/new_element.py,sha256=VtMz9sPn9rMk6rui5Poysy3vezlOaS-tGIcGbu-SXmY,3406
 svg_ultralight/strings/__init__.py,sha256=Zalrf-ThFz7b7xKELx5lb2gOlBgV-6jk_k_EeSdVCVk,295
 svg_ultralight/strings/svg_strings.py,sha256=RYKMxOHq9abbZyGcFqsElBGLrBX-EjjNxln3s_ibi30,1296
-svg_ultralight-0.25.0.dist-info/METADATA,sha256=_VUmlE9QVt_qiMGAn8OlUAki-KpIJOyDjoO94_Nl7Xo,8871
-svg_ultralight-0.25.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-svg_ultralight-0.25.0.dist-info/top_level.txt,sha256=se-6yqM_0Yg5orJKvKWdjQZ4iR4G_EjhL7oRgju-fdY,15
-svg_ultralight-0.25.0.dist-info/RECORD,,
+svg_ultralight-0.27.0.dist-info/METADATA,sha256=6GeOT7ohzqEuzvgofE7pKbI2FnP9H_DRfwV4pNfb5K4,8871
+svg_ultralight-0.27.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+svg_ultralight-0.27.0.dist-info/top_level.txt,sha256=se-6yqM_0Yg5orJKvKWdjQZ4iR4G_EjhL7oRgju-fdY,15
+svg_ultralight-0.27.0.dist-info/RECORD,,