svg-ultralight 0.31.0__tar.gz → 0.32.0__tar.gz

{svg_ultralight-0.31.0/src/svg_ultralight.egg-info → svg_ultralight-0.32.0}/PKG-INFO

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

{svg_ultralight-0.31.0 → svg_ultralight-0.32.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "svg-ultralight"
-version = "0.31.0"
+version = "0.32.0"
 description = "a sensible way to create svg files with Python"
 authors = [{ name = "Shay Hill", email = "shay_public@hotmail.com" }]
 license = { text = "MIT" }
@@ -37,7 +37,7 @@ legacy_tox_ini = """
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.31.0"
+version = "0.32.0"
 tag_format = "$version"
 version_files = ["pyproject.toml:^version"]
 annotated_tag = true

svg_ultralight-0.32.0/src/svg_ultralight/import_svg.py

@@ -0,0 +1,50 @@
+"""Import an svg file as a BoundElement.
+
+:author: Shay Hill
+:created: 2024-05-28
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from lxml import etree
+
+from svg_ultralight.bounding_boxes.type_bound_element import BoundElement
+from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
+from svg_ultralight.constructors import new_element
+
+if TYPE_CHECKING:
+    import os
+
+    from lxml.etree import _Element as EtreeElement  # type: ignore
+
+
+def _get_bounds_from_viewbox(root: EtreeElement) -> BoundingBox:
+    """Get the BoundingBox from the viewbox attribute of the root element.
+
+    :param root: The root element of the svg.
+    :return: The BoundingBox of the svg.
+    """
+    viewbox = root.attrib.get("viewBox")
+    if viewbox is None:
+        msg = "SVG file has no viewBox attribute. Failed to create BoundingBox."
+        raise ValueError(msg)
+    x, y, width, height = map(float, viewbox.split())
+    return BoundingBox(x, y, width, height)
+
+
+def import_svg(svg: str | os.PathLike[str]) -> BoundElement:
+    """Import an svg file as a BoundElement.
+
+    :param svg: The path to the svg file.
+    :return: The BoundElement representation of the svg.
+
+    The viewbox of the svg is used to create the BoundingBox of the BoundElement.
+    """
+    tree = etree.parse(svg)
+    root = tree.getroot()
+    bbox = _get_bounds_from_viewbox(root)
+    root_as_elem = new_element("g")
+    root_as_elem.extend(root)
+    return BoundElement(root_as_elem, bbox)

{svg_ultralight-0.31.0 → svg_ultralight-0.32.0}/src/svg_ultralight/layout.py

@@ -99,7 +99,7 @@ def _infer_scale(
     * print_h == 0 / viewbox_h > 0
 
     The print area is invalid, but there is special handling for this. Interpret
-    viewbox units as print_w.native_unit and determe print area from viewbox area 1
+    viewbox units as print_w.native_unit and determine print area from viewbox area 1
     to 1.
 
         >>> _infer_scale(Measurement("in"), Measurement("in"), 1, 2)

{svg_ultralight-0.31.0 → svg_ultralight-0.32.0/src/svg_ultralight.egg-info}/PKG-INFO

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

{svg_ultralight-0.31.0 → svg_ultralight-0.32.0}/src/svg_ultralight.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ pyproject.toml
 tox.ini
 src/svg_ultralight/__init__.py
 src/svg_ultralight/animate.py
+src/svg_ultralight/import_svg.py
 src/svg_ultralight/inkscape.py
 src/svg_ultralight/layout.py
 src/svg_ultralight/main.py
@@ -35,6 +36,7 @@ src/svg_ultralight/strings/svg_strings.py
 tests/__init__.py
 tests/conftest.py
 tests/test_bounding.py
+tests/test_import_svg.py
 tests/test_inkscape.py
 tests/test_layout.py
 tests/test_matrices.py
@@ -43,4 +45,5 @@ tests/test_new_element.py
 tests/test_queries.py
 tests/test_root_elements.py
 tests/test_string_conversion.py
-tests/test_svg_ultralight.py
+tests/test_svg_ultralight.py
+tests/resources/arrow.svg

svg_ultralight-0.32.0/tests/resources/arrow.svg

@@ -0,0 +1,21 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:cc="http://creativecommons.org/ns#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:svg="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" viewBox="-3 -3 128 128">
+  <defs>
+    <clipPath id="clip">
+      <path d="M0,122L0,103.7L40.666667,73.2L81.333333,79.3L99.556877,49.231152L122,12.2L122,122Z"/>
+    </clipPath>
+    <mask id="mask">
+      <g>
+        <rect x="0" y="0" width="122" height="122" fill="#FFFFFF"/>
+        <path d="M0,91.45Q0,91.2 0.2,91.05L37.845867,62.8156Q38.013194,62.690105 38.220037,62.721131L75.903051,68.373583Q76.232274,68.422967 76.40482,68.138266L90.745748,44.475734Q91.004899,44.048135 90.5773,43.788984L78.917555,36.722472Q78.176932,36.273609 78.935969,35.856642L121.240962,12.616967Q122,12.2 121.981585,13.06583L120.955238,61.322866Q120.936823,62.188695 120.1962,61.739833L108.536455,54.67332Q108.108856,54.41417 107.849705,54.841768L86.606939,89.892332Q86.434393,90.177033 86.10517,90.12765L43.526984,83.740922Q43.32014,83.709895 43.152813,83.83539L0.8,115.6Q0,116.2 0,115.2Z" fill="#000000" stroke="#000000" stroke-width="3.1"/>
+      </g>
+    </mask>
+  </defs>
+  <g clip-path="url(#clip)" mask="url(#mask)">
+    <rect x="0" y="0" width="23.6" height="122" fill="orange"/>
+    <rect x="24.6" y="0" width="23.6" height="122" fill="orange"/>
+    <rect x="49.2" y="0" width="23.6" height="122" fill="orange"/>
+    <rect x="73.8" y="0" width="23.6" height="122" fill="orange"/>
+    <rect x="98.4" y="0" width="23.6" height="122" fill="orange"/>
+  </g>
+  <path d="M0,91.45Q0,91.2 0.2,91.05L37.845867,62.8156Q38.013194,62.690105 38.220037,62.721131L75.903051,68.373583Q76.232274,68.422967 76.40482,68.138266L90.745748,44.475734Q91.004899,44.048135 90.5773,43.788984L78.917555,36.722472Q78.176932,36.273609 78.935969,35.856642L121.240962,12.616967Q122,12.2 121.981585,13.06583L120.955238,61.322866Q120.936823,62.188695 120.1962,61.739833L108.536455,54.67332Q108.108856,54.41417 107.849705,54.841768L86.606939,89.892332Q86.434393,90.177033 86.10517,90.12765L43.526984,83.740922Q43.32014,83.709895 43.152813,83.83539L0.8,115.6Q0,116.2 0,115.2Z" fill="#00bfff" stroke="none"/>
+</svg>

svg_ultralight-0.32.0/tests/test_import_svg.py

@@ -0,0 +1,32 @@
+"""Test importing an SVG file.
+
+:author: Shay Hill
+:created: 2024-05-28
+"""
+
+from pathlib import Path
+from svg_ultralight.import_svg import import_svg
+from lxml import etree
+
+_TEST_RESOURCES = Path(__file__).parent / "resources"
+_TEST_FILE = _TEST_RESOURCES / "arrow.svg"
+
+
+
+class TestImportSvg:
+    def test_get_bbox(self):
+        """Import an svg file as a BoundElement instance."""
+        blem = import_svg(_TEST_FILE)
+        assert blem.bbox.x == -3
+        assert blem.bbox.y == -3
+        assert blem.bbox.width == 128
+        assert blem.bbox.height == 128
+
+    def test_get_geometry(self):
+        tree = etree.parse(_TEST_FILE)
+        root = tree.getroot()
+        blem = import_svg(_TEST_FILE)
+        assert [x.tag for x in blem.elem] == [x.tag for x in root]
+
+
+