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

{svg_ultralight-0.35.1 → 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
@@ -58,7 +58,7 @@ repos:
     # files: ^(src/|tests/)
 
 - repo: https://github.com/asottile/pyupgrade
-  rev: v3.19.0
+  rev: v3.19.1
   hooks:
   - args:
     - --py39-plus
@@ -92,7 +92,7 @@ repos:
   # S301 don't use pickle
   # B028 wants explicit stacklevel on warn
   # BLE001 Use of `except Exception:` detected
-  rev: 'v0.8.3'
+  rev: 'v0.8.4'
   hooks:
     - id: ruff
       name: "ruff-lint"
@@ -110,6 +110,6 @@ repos:
 
 # reads pyproject.toml for additional config
 - repo: https://github.com/RobertCraigie/pyright-python
-  rev: v1.1.390
+  rev: v1.1.391
   hooks:
     - id: pyright

{svg_ultralight-0.35.1/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.35.1
+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.35.1 → svg_ultralight-0.36.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "svg-ultralight"
-version = "0.35.1"
+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"]
@@ -41,7 +42,7 @@ convention = "pep257"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.35.1"
+version = "0.36.0"
 tag_format = "$version"
 version_files = ["pyproject.toml:^version"]
 annotated_tag = true

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.35.1 → 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.35.1
+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.35.1 → 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

{svg_ultralight-0.35.1 → svg_ultralight-0.36.0}/src/svg_ultralight.egg-info/requires.txt

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