svg-ultralight 0.33.0__py3-none-any.whl → 0.35.1__py3-none-any.whl

svg_ultralight/__init__.py

@@ -5,9 +5,14 @@
 """
 
 from svg_ultralight.bounding_boxes.bound_helpers import (
+    bbox_dict,
+    cut_bbox,
+    new_bbox_rect,
     new_bbox_union,
     new_bound_union,
     new_element_union,
+    pad_bbox,
+    parse_bound_element,
 )
 from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
 from svg_ultralight.bounding_boxes.type_bound_collection import BoundCollection
@@ -31,10 +36,10 @@ from svg_ultralight.main import new_svg_root, write_svg
 from svg_ultralight.metadata import new_metadata
 from svg_ultralight.nsmap import NSMAP, new_qname
 from svg_ultralight.query import (
+    clear_svg_ultralight_cache,
     get_bounding_box,
     get_bounding_boxes,
     pad_text,
-    clear_svg_ultralight_cache,
 )
 from svg_ultralight.root_elements import new_svg_root_around_bounds
 from svg_ultralight.string_conversion import (
@@ -51,13 +56,15 @@ from svg_ultralight.transformations import (
 )
 
 __all__ = [
+    "NSMAP",
     "BoundCollection",
     "BoundElement",
     "BoundingBox",
-    "NSMAP",
     "PaddedText",
     "SupportsBounds",
+    "bbox_dict",
     "clear_svg_ultralight_cache",
+    "cut_bbox",
     "deepcopy_element",
     "format_attr_dict",
     "format_number",
@@ -68,6 +75,7 @@ __all__ = [
     "mat_apply",
     "mat_dot",
     "mat_invert",
+    "new_bbox_rect",
     "new_bbox_union",
     "new_bound_union",
     "new_element",
@@ -77,7 +85,9 @@ __all__ = [
     "new_sub_element",
     "new_svg_root",
     "new_svg_root_around_bounds",
+    "pad_bbox",
     "pad_text",
+    "parse_bound_element",
     "transform_element",
     "update_element",
     "write_pdf",

svg_ultralight/bounding_boxes/bound_helpers.py

@@ -16,7 +16,10 @@ from svg_ultralight.bounding_boxes.type_padded_text import PaddedText
 from svg_ultralight.constructors import new_element
 
 if TYPE_CHECKING:
+    import os
+
     from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
+from lxml import etree
 
 _Matrix = tuple[float, float, float, float, float, float]
 
@@ -95,3 +98,110 @@ def new_bound_union(*blems: SupportsBounds | EtreeElement) -> BoundElement:
     group = new_element_union(*blems)
     bbox = new_bbox_union(*blems)
     return BoundElement(group, bbox)
+
+
+def _expand_pad(pad: float | tuple[float, ...]) -> tuple[float, float, float, float]:
+    """Expand a float pad argument into a 4-tuple."""
+    if isinstance(pad, (int, float)):
+        return pad, pad, pad, pad
+    if len(pad) == 1:
+        return pad[0], pad[0], pad[0], pad[0]
+    if len(pad) == 2:
+        return pad[0], pad[1], pad[0], pad[1]
+    if len(pad) == 3:
+        return pad[0], pad[1], pad[2], pad[1]
+    return pad[0], pad[1], pad[2], pad[3]
+
+
+def cut_bbox(
+    bbox: SupportsBounds,
+    *,
+    x: float | None = None,
+    y: float | None = None,
+    x2: float | None = None,
+    y2: float | None = None,
+) -> BoundingBox:
+    """Return a new bounding box with updated limits.
+
+    :param bbox: the original bounding box or bounded element.
+    :param x: the new x-coordinate.
+    :param y: the new y-coordinate.
+    :param x2: the new x2-coordinate.
+    :param y2: the new y2-coordinate.
+    :return: a new bounding box with the updated limits.
+    """
+    x = bbox.x if x is None else x
+    y = bbox.y if y is None else y
+    x2 = bbox.x2 if x2 is None else x2
+    y2 = bbox.y2 if y2 is None else y2
+    width = x2 - x
+    height = y2 - y
+    return BoundingBox(x, y, width, height)
+
+
+def pad_bbox(bbox: SupportsBounds, pad: float | tuple[float, ...]) -> BoundingBox:
+    """Return a new bounding box with padding.
+
+    :param bbox: the original bounding box or bounded element.
+    :param pad: the padding to apply.
+        If a single number, the same padding will be applied to all sides.
+        If a tuple, will be applied per css rules.
+        len = 1 : 0, 0, 0, 0
+        len = 2 : 0, 1, 0, 1
+        len = 3 : 0, 1, 2, 1
+        len = 4 : 0, 1, 2, 3
+    :return: a new bounding box with padding applied.
+    """
+    top, right, bottom, left = _expand_pad(pad)
+    return cut_bbox(
+        bbox, x=bbox.x - left, y=bbox.y - top, x2=bbox.x2 + right, y2=bbox.y2 + bottom
+    )
+
+
+def bbox_dict(bbox: SupportsBounds) -> dict[str, float]:
+    """Return a dictionary representation of a bounding box.
+
+    :param bbox: the bounding box or bound element from which to extract dimensions.
+    :return: a dictionary with keys x, y, width, and height.
+    """
+    return {"x": bbox.x, "y": bbox.y, "width": bbox.width, "height": bbox.height}
+
+
+def new_bbox_rect(bbox: BoundingBox, **kwargs: float | str) -> EtreeElement:
+    """Return a new rect element with the same dimensions as the bounding box.
+
+    :param bbox: the bounding box or bound element from which to extract dimensions.
+    :param kwargs: additional attributes for the rect element.
+    """
+    return new_element("rect", **bbox_dict(bbox), **kwargs)
+
+
+def _get_view_box(elem: EtreeElement) -> tuple[float, float, float, float]:
+    """Return the view box of an element as a tuple of floats.
+
+    :param elem: the element from which to extract the view box.
+    :return: a tuple of floats representing the view box.
+
+    This will work on svg files created by this library and some others. Not all svg
+    files have a viewBox attribute.
+    """
+    view_box = elem.get("viewBox")
+    if view_box is None:
+        msg = "Element does not have a viewBox attribute."
+        raise ValueError(msg)
+    x, y, width, height = map(float, view_box.split())
+    return x, y, width, height
+
+
+def parse_bound_element(svg_fil: 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)
+    root = tree.getroot()
+    elem = new_element("g")
+    elem.extend(list(root))
+    bbox = BoundingBox(*_get_view_box(root))
+    return BoundElement(elem, bbox)

svg_ultralight/constructors/__init__.py

@@ -11,4 +11,4 @@ from svg_ultralight.constructors.new_element import (
     update_element,
 )
 
-__all__ = ["new_element", "new_sub_element", "update_element", "deepcopy_element"]
+__all__ = ["deepcopy_element", "new_element", "new_sub_element", "update_element"]

svg_ultralight/constructors/new_element.py

@@ -20,7 +20,8 @@ from lxml import etree
 from svg_ultralight.string_conversion import set_attributes
 
 if TYPE_CHECKING:
-    from lxml.etree import QName, _Element as EtreeElement  # type: ignore
+    from lxml.etree import QName
+    from lxml.etree import _Element as EtreeElement  # type: ignore
 
 
 def new_element(tag: str | QName, **attributes: str | float) -> EtreeElement:

svg_ultralight/layout.py

@@ -43,7 +43,10 @@ def expand_pad_arg(pad: PadArg) -> tuple[float, float, float, float]:
         return expand_pad_arg([pad])
     as_ms = [m if isinstance(m, Measurement) else Measurement(m) for m in pad]
     as_units = [m.value for m in as_ms]
-    as_units = [as_units[i % len(as_units)] for i in range(4)]
+    if len(as_units) == 3:
+        as_units = [*as_units, as_units[1]]
+    else:
+        as_units = [as_units[i % len(as_units)] for i in range(4)]
     return as_units[0], as_units[1], as_units[2], as_units[3]
 
 

svg_ultralight/query.py

@@ -31,7 +31,6 @@ from svg_ultralight.bounding_boxes.type_padded_text import PaddedText
 from svg_ultralight.main import new_svg_root, write_svg
 
 if TYPE_CHECKING:
-
     from lxml.etree import _Element as EtreeElement  # type: ignore
 
 

svg_ultralight/strings/__init__.py

@@ -10,4 +10,4 @@ from svg_ultralight.strings.svg_strings import (
     svg_ints,
 )
 
-__all__ = ["svg_color_tuple", "svg_ints", "svg_float_tuples"]
+__all__ = ["svg_color_tuple", "svg_float_tuples", "svg_ints"]

{svg_ultralight-0.33.0.dist-info → svg_ultralight-0.35.1.dist-info}/METADATA

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

{svg_ultralight-0.33.0.dist-info → svg_ultralight-0.35.1.dist-info}/RECORD

@@ -1,28 +1,28 @@
-svg_ultralight/__init__.py,sha256=RNm7gHwJoffbMEbT4zx3Z5xmhvfvRnkvswA5IVlzoxw,2360
+svg_ultralight/__init__.py,sha256=wUc79mKsG6lGZ1xaYijyJ4Sm9lG5-5XgRArVsCI0niY,2554
 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
+svg_ultralight/layout.py,sha256=FgR45FsHax4xDjGkk9HEVW4OcwhtM8aqw2JUdZs_m7Q,12326
 svg_ultralight/main.py,sha256=6oNkZfD27UMdP-oYqp5agS_IGcYb8NkUZwM9Zdyb3SA,7287
 svg_ultralight/metadata.py,sha256=xR3ObM0QV7OQ90IKvfigR5B6e0JW6GGVGvTlL5NswWI,4211
 svg_ultralight/nsmap.py,sha256=y63upO78Rr-JJT56RWWZuyrsILh6HPoY4GhbYnK1A0g,1244
 svg_ultralight/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-svg_ultralight/query.py,sha256=F_yl-zbNQSOFxiuHT4qZ0LqLoYdD36BGTREJady5sBc,9430
+svg_ultralight/query.py,sha256=SufFumN11VTWloqjMpSuQ5eghAYx4ABQRIMXRJGs70o,9428
 svg_ultralight/root_elements.py,sha256=pt9J6mPrnoTAZVF6vKTZoM_o947I8UCj6MbGcD2JUCk,2869
 svg_ultralight/string_conversion.py,sha256=WEmpf75RJmJ2lfJluagAz2wPsz6wM8XvTEwkq4U0vEc,7353
 svg_ultralight/transformations.py,sha256=7-6NNh6xZ45mM_933fMuQfRGpI7q9Qrt5qse9e6FUek,4036
 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=YMClhdekeYbzD_ijXDAer-H3moWKN3lUNnZs1UNFFKc,3458
+svg_ultralight/bounding_boxes/bound_helpers.py,sha256=V0BlBHDZ9xksVG5dGLPfcyRwPP3jSj6ODdtIpqT-FcI,7273
 svg_ultralight/bounding_boxes/supports_bounds.py,sha256=fbHV6mGdeIVV3lS15vBKSrHiHKR7DMg4K5X__4LLmCE,4569
 svg_ultralight/bounding_boxes/type_bound_collection.py,sha256=b89TM2UsdaeApyjTQeMbx_FG_WcCiLAImEiHiZ6EWPI,2600
 svg_ultralight/bounding_boxes/type_bound_element.py,sha256=9RdxH8osOlAvPdWR0Ww9NsasHLPYFDs-MbydoV48x4E,2239
 svg_ultralight/bounding_boxes/type_bounding_box.py,sha256=cDrMp6uwaA--KJIQS2puG10qh8n3TBmiscg-cfk1f3w,16149
 svg_ultralight/bounding_boxes/type_padded_text.py,sha256=QA6PfeO_sQYc5pEXuyfyQ3lRUcZAc4B2BthWXpdt3qQ,14848
-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/constructors/__init__.py,sha256=XLOInLhzMERWNnFAs-itMs-OZrBOpvQthZJ2T5duqBE,327
+svg_ultralight/constructors/new_element.py,sha256=8nqmOEgt3j-aOVeRaMLFHqrwKg2Dm5w0AfuK9MP4ak8,3433
+svg_ultralight/strings/__init__.py,sha256=BMGhF1pulscIgkiYvZLr6kPRR0L4lW0jUNFxkul4_EM,295
 svg_ultralight/strings/svg_strings.py,sha256=RYKMxOHq9abbZyGcFqsElBGLrBX-EjjNxln3s_ibi30,1296
-svg_ultralight-0.33.0.dist-info/METADATA,sha256=dQ7MJsfoX8zthow6dSWRi4onL4izCdqCnX2IhSVn1aE,8867
-svg_ultralight-0.33.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-svg_ultralight-0.33.0.dist-info/top_level.txt,sha256=se-6yqM_0Yg5orJKvKWdjQZ4iR4G_EjhL7oRgju-fdY,15
-svg_ultralight-0.33.0.dist-info/RECORD,,
+svg_ultralight-0.35.1.dist-info/METADATA,sha256=PRuCkp6xtBx_t8pkPEJR00TZRcb82eygu1EQTuROHaM,8867
+svg_ultralight-0.35.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+svg_ultralight-0.35.1.dist-info/top_level.txt,sha256=se-6yqM_0Yg5orJKvKWdjQZ4iR4G_EjhL7oRgju-fdY,15
+svg_ultralight-0.35.1.dist-info/RECORD,,