svg-ultralight 0.34.0__tar.gz → 0.36.0__tar.gz

{svg_ultralight-0.34.0 → svg_ultralight-0.36.0}/.pre-commit-config.yaml

@@ -42,12 +42,12 @@ repos:
         # files: .pre-commit-config.yaml
 
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.13.0
+  rev: v1.14.0
   hooks:
   - id: mypy
     name: mypy
     language: python
-    language_version: python 3.12
+    language_version: python 3.11
     types: [python]
     require_serial: true
     verbose: true
@@ -57,21 +57,8 @@ repos:
     # - --ignore-missing-imports
     # files: ^(src/|tests/)
 
-- repo: https://github.com/PyCQA/isort
-  rev: 5.13.2
-  hooks:
-  - id: isort
-    args: ["--profile", "black", "--filter-files", "--combine-as"]
-
-- repo: https://github.com/psf/black
-  rev: 24.10.0
-  hooks:
-  - id: black
-    language_version: python3.9
-    args: ["--skip-magic-trailing-comma"]
-
 - repo: https://github.com/asottile/pyupgrade
-  rev: v3.19.0
+  rev: v3.19.1
   hooks:
   - args:
     - --py39-plus
@@ -84,8 +71,6 @@ repos:
 
 - repo: https://github.com/charliermarsh/ruff-pre-commit
   # ignores
-  # ANN101 Missing type annotation for self in method
-  # ANN102 Missing type annotation for cls in classmethod
   # ANN201 Missing return type annotation for public function
   # ANN202 Missing return type annotation for private function (wants -> None everywhere)
   # B905 zip() without an explicit strict= parameter
@@ -103,25 +88,28 @@ repos:
   # S101 Use of `assert` detected
   # S603 `subprocess` call: check for execution of untrusted input
   # PLR2004 Magic value used in comparison
-  # D413 [*] Missing blank line after last section ("Attributes")
-  # D407 [*] Missing dashed underline after section ("Attributes")
-  # D406 [*] Section name should end with a newline ("Attributes")
   # S320 Using `lxml` to parse untrusted data is known to be vulnerable to XML attacks
   # S301 don't use pickle
   # B028 wants explicit stacklevel on warn
   # BLE001 Use of `except Exception:` detected
-  rev: 'v0.7.4'
+  rev: 'v0.8.4'
   hooks:
     - id: ruff
+      name: "ruff-lint"
       exclude: "tests"
       args:
       - --target-version=py39
       - --select=ALL
-      - --ignore=ANN101,ANN102,ANN201,ANN202,B905,COM812,D203,D213,I001,ISC003,N802,N806,PGH003,PLR0913,PTH108,S101,S603,PLR2004,D413,D407,D406,S320,S301,B028,BLE001
-      # - --fix
+      - --ignore=ANN201,ANN202,B905,COM812,D203,D213,I001,ISC003,N802,N806,PGH003,PLR0913,PTH108,S101,S603,PLR2004,S320,S301,B028,BLE001
+      - --fix
+      - --fixable=RUF022
+    - id: ruff
+      args: ["check", "--select", "I", "--fix"]
+    - id: ruff-format
+      name: "ruff-format"
 
 # reads pyproject.toml for additional config
 - repo: https://github.com/RobertCraigie/pyright-python
-  rev: v1.1.389
+  rev: v1.1.391
   hooks:
     - id: pyright

{svg_ultralight-0.34.0/src/svg_ultralight.egg-info → svg_ultralight-0.36.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: svg-ultralight
-Version: 0.34.0
+Version: 0.36.0
 Summary: a sensible way to create svg files with Python
 Author-email: Shay Hill <shay_public@hotmail.com>
 License: MIT
@@ -15,6 +15,8 @@ Requires-Dist: pytest; extra == "dev"
 Requires-Dist: commitizen; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: tox; extra == "dev"
+Provides-Extra: images
+Requires-Dist: pillow; extra == "images"
 
 # svg_ultralight
 

{svg_ultralight-0.34.0 → svg_ultralight-0.36.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "svg-ultralight"
-version = "0.34.0"
+version = "0.36.0"
 description = "a sensible way to create svg files with Python"
 authors = [{ name = "Shay Hill", email = "shay_public@hotmail.com" }]
 license = { text = "MIT" }
@@ -10,6 +10,7 @@ dependencies = ["lxml", "pillow", "paragraphs", "types-lxml"]
 
 [project.optional-dependencies]
 dev = ["pytest", "commitizen", "pre-commit", "tox"]
+images = ["pillow"]
 
 [build-system]
 requires = ["setuptools", "setuptools-scm"]
@@ -18,6 +19,8 @@ build-backend = "setuptools.build_meta"
 
 [tool.pytest.ini_options]
 addopts = "--doctest-modules"
+pythonpath = ["tests"]
+log_cli = 1
 
 
 [tool.isort]
@@ -34,10 +37,12 @@ legacy_tox_ini = """
     commands = pytest tests
 """
 
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.34.0"
+version = "0.36.0"
 tag_format = "$version"
 version_files = ["pyproject.toml:^version"]
 annotated_tag = true

{svg_ultralight-0.34.0 → svg_ultralight-0.36.0}/src/svg_ultralight/__init__.py

@@ -5,13 +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,
-    cut_bbox,
     pad_bbox,
-    bbox_dict,
-    new_bbox_rect,
+    parse_bound_element,
 )
 from svg_ultralight.bounding_boxes.supports_bounds import SupportsBounds
 from svg_ultralight.bounding_boxes.type_bound_collection import BoundCollection
@@ -35,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 (
@@ -55,10 +56,10 @@ from svg_ultralight.transformations import (
 )
 
 __all__ = [
+    "NSMAP",
     "BoundCollection",
     "BoundElement",
     "BoundingBox",
-    "NSMAP",
     "PaddedText",
     "SupportsBounds",
     "bbox_dict",
@@ -86,6 +87,7 @@ __all__ = [
     "new_svg_root_around_bounds",
     "pad_bbox",
     "pad_text",
+    "parse_bound_element",
     "transform_element",
     "update_element",
     "write_pdf",

{svg_ultralight-0.34.0 → svg_ultralight-0.36.0}/src/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]
 
@@ -149,8 +152,10 @@ def pad_bbox(bbox: SupportsBounds, pad: float | tuple[float, ...]) -> BoundingBo
         len = 4 : 0, 1, 2, 3
     :return: a new bounding box with padding applied.
     """
-    t, r, b, l = _expand_pad(pad)
-    return cut_bbox(bbox, x=bbox.x - l, y=bbox.y - t, x2=bbox.x2 + r, y2=bbox.y2 + b)
+    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]:
@@ -169,3 +174,34 @@ def new_bbox_rect(bbox: BoundingBox, **kwargs: float | str) -> EtreeElement:
     :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-0.34.0 → svg_ultralight-0.36.0}/src/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-0.34.0 → svg_ultralight-0.36.0}/src/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-0.36.0/src/svg_ultralight/image_ops.py

@@ -0,0 +1,134 @@
+"""Crop an image before converting to binary and including in the svg file.
+
+This optional module requires the Pillow library. Create an svg image element with a
+rasterized image positioned inside a bounding box.
+
+:author: Shay Hill
+:created: 2024-11-20
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from paragraphs import par
+
+try:
+    from PIL import Image
+
+    if TYPE_CHECKING:
+        from PIL.Image import Image as ImageType
+except ImportError as err:
+    msg = par(
+        """PIL is not installed. Install it using 'pip install Pillow' to use
+        svg_ultralight.image_ops module."""
+    )
+    raise ImportError(msg) from err
+
+import base64
+import io
+
+from lxml import etree
+
+from svg_ultralight import NSMAP
+from svg_ultralight.bounding_boxes.bound_helpers import bbox_dict
+from svg_ultralight.constructors import new_element
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from lxml.etree import (
+        _Element as EtreeElement,  # pyright: ignore [reportPrivateUsage]
+    )
+
+    from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
+
+
+def _symmetric_crop(
+    image: ImageType, center: tuple[float, float] | None = None
+) -> ImageType:
+    """Crop an image symmetrically around a center point.
+
+    :param image: PIL.Image instance
+    :param center: optional center point for cropping. Proportions of image with and
+        image height, so the default value, (0.5, 0.5), is the true center of the
+        image.  (0.4, 0.5) would crop 20% off the right side of the image.
+    :return: PIL.Image instance
+    """
+    if center is None:
+        return image
+
+    if not all(0 < x < 1 for x in center):
+        msg = "Center must be between (0, 0) and (1, 1)"
+        raise ValueError(msg)
+
+    xd, yd = (min(x, 1 - x) for x in center)
+    left, right = sorted(x * image.width for x in (center[0] - xd, center[0] + xd))
+    top, bottom = sorted(x * image.height for x in (center[1] - yd, center[1] + yd))
+
+    return image.crop((left, top, right, bottom))
+
+
+def _crop_image_to_bbox_ratio(
+    image: ImageType, bbox: BoundingBox, center: tuple[float, float] | None = None
+) -> ImageType:
+    """Crop an image to the ratio of a bounding box.
+
+    :param image: PIL.Image instance
+    :param bbox: BoundingBox instance
+    :param center: optional center point for cropping. Proportions of image with and
+        image height, so the default value, (0.5, 0.5), is the true center of the
+        image. (0.4, 0.5) would crop 20% off the right side of the image.
+    :return: PIL.Image instance
+
+    This crops the image to the specified ratio. It's not a resize, so it will cut
+    off the top and bottom or the sides of the image to fit the ratio.
+    """
+    image = _symmetric_crop(image, center)
+    width, height = image.size
+
+    ratio = bbox.width / bbox.height
+    if width / height > ratio:
+        new_width = height * ratio
+        left = (width - new_width) / 2
+        right = width - left
+        return image.crop((left, 0, right, height))
+    new_height = width / ratio
+    top = (height - new_height) / 2
+    bottom = height - top
+    return image.crop((0, top, width, bottom))
+
+
+def _get_svg_embedded_image_str(image: ImageType) -> str:
+    """Return the string you'll need to embed an image in an svg.
+
+    :param image: PIL.Image instance
+    :return: argument for xlink:href
+    """
+    in_mem_file = io.BytesIO()
+    image.save(in_mem_file, format="PNG")
+    _ = in_mem_file.seek(0)
+    img_bytes = in_mem_file.read()
+    base64_encoded_result_bytes = base64.b64encode(img_bytes)
+    base64_encoded_result_str = base64_encoded_result_bytes.decode("ascii")
+    return "data:image/png;base64," + base64_encoded_result_str
+
+
+def new_image_elem_in_bbox(
+    filename: Path | str, bbox: BoundingBox, center: tuple[float, float] | None
+) -> EtreeElement:
+    """Create a new svg image element inside a bounding box.
+
+    :param filename: filename of source image
+    :param bbox: bounding box for the image
+    :param center: center point for cropping. Proportions of image width and image
+        height, so the default value, (0.5, 0.5), is the true center of the image.
+        (0.4, 0.5) would crop 20% off the right side of the image.
+    :return: an etree image element with the cropped image embedded
+    """
+    image = _crop_image_to_bbox_ratio(Image.open(filename), bbox, center)
+    svg_image = new_element("image", **bbox_dict(bbox))
+    svg_image.set(
+        etree.QName(NSMAP["xlink"], "href"), _get_svg_embedded_image_str(image)
+    )
+    return svg_image

{svg_ultralight-0.34.0 → svg_ultralight-0.36.0}/src/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-0.34.0 → svg_ultralight-0.36.0}/src/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.34.0 → svg_ultralight-0.36.0/src/svg_ultralight.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: svg-ultralight
-Version: 0.34.0
+Version: 0.36.0
 Summary: a sensible way to create svg files with Python
 Author-email: Shay Hill <shay_public@hotmail.com>
 License: MIT
@@ -15,6 +15,8 @@ Requires-Dist: pytest; extra == "dev"
 Requires-Dist: commitizen; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: tox; extra == "dev"
+Provides-Extra: images
+Requires-Dist: pillow; extra == "images"
 
 # svg_ultralight
 

{svg_ultralight-0.34.0 → svg_ultralight-0.36.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/image_ops.py
 src/svg_ultralight/inkscape.py
 src/svg_ultralight/layout.py
 src/svg_ultralight/main.py
@@ -43,4 +44,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.34.0 → svg_ultralight-0.36.0}/src/svg_ultralight.egg-info/requires.txt

@@ -8,3 +8,6 @@ pytest
 commitizen
 pre-commit
 tox
+
+[images]
+pillow

svg_ultralight-0.36.0/tests/conftest.py

@@ -0,0 +1,16 @@
+"""Test configuration for pytest.
+
+:author: Shay Hill
+:created: 7/2/2019
+"""
+
+from pathlib import Path
+from typing import Any
+
+def pytest_assertrepr_compare(config: Any, op: str, left: str, right: str):
+    """See full error diffs"""
+    if op in ("==", "!="):
+        return ["{0} {1} {2}".format(left, op, right)]
+
+TEST_RESOURCES = Path(__file__).parent / "resources"
+

svg_ultralight-0.36.0/tests/resources/arrow.svg

@@ -0,0 +1,3 @@
+<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="0 0 10 10">
+  <rect x="0" y="0" width="10" height="10"/>
+</svg>

{svg_ultralight-0.34.0 → svg_ultralight-0.36.0}/tests/test_bounding.py

@@ -6,13 +6,16 @@
 
 import pytest
 import math
+from conftest import TEST_RESOURCES
 from svg_ultralight.bounding_boxes.type_bound_element import BoundElement
 from svg_ultralight.bounding_boxes.type_padded_text import PaddedText
+from lxml import etree
 from svg_ultralight.bounding_boxes.type_bounding_box import BoundingBox
 from svg_ultralight.bounding_boxes.type_bound_collection import BoundCollection
 from svg_ultralight.bounding_boxes.bound_helpers import (
     pad_bbox,
     cut_bbox,
+    parse_bound_element,
     bbox_dict,
     new_bbox_rect,
 )
@@ -245,3 +248,8 @@ class TestBoundHelpers:
         elem = new_bbox_rect(bbox)
         assert elem.attrib == {"x": "0", "y": "1", "width": "2", "height": "3"}
 
+def test_import_bound_element():
+    blem = parse_bound_element(TEST_RESOURCES / "arrow.svg")
+    assert blem.bbox == BoundingBox(_x=0, _y=0, _width=10, _height=10, _transformation=(1, 0, 0, 1, 0, 0))
+    assert etree.tostring(blem.elem) == b'<g><ns0:rect xmlns:ns0="http://www.w3.org/2000/svg"' + b' x="0" y="0" width="10" height="10"/>\n</g>'
+

svg_ultralight-0.34.0/tests/conftest.py

@@ -1,11 +0,0 @@
-"""Test configuration for pytest.
-
-:author: Shay Hill
-:created: 7/2/2019
-"""
-
-
-def pytest_assertrepr_compare(config, op, left, right):
-    """See full error diffs."""
-    if op in ("==", "!="):
-        return [f"{left} {op} {right}"]