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

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/strings/svg_strings.py

@@ -17,13 +17,34 @@ if TYPE_CHECKING:
     from collections.abc import Iterable
 
 
+_MAX_8BIT = 255
+_BIG_INT = 2**32 - 1
+
+
+def _float_to_8bit_int(clipped_float: float) -> int:
+    """Convert a float between 0 and 255 to an int between 0 and 255.
+
+    :param float_: a float in the closed interval [0 .. 255]. Values outside this
+        range will be clipped.
+    :return: an int in the closed interval [0 .. 255]
+
+    Convert color floats [0 .. 255] to ints [0 .. 255] without rounding, which "short
+    changes" 0 and 255.
+    """
+    clipped_float = min(_MAX_8BIT, max(0, clipped_float))
+    if clipped_float % 1:
+        high_int = int(clipped_float / _MAX_8BIT * _BIG_INT)
+        return high_int >> 24
+    return int(clipped_float)
+
+
 def svg_color_tuple(rgb_floats: tuple[float, float, float]) -> str:
     """Turn an rgb tuple (0-255, 0-255, 0-255) into an svg color definition.
 
     :param rgb_floats: (0-255, 0-255, 0-255)
     :return: "rgb(128,128,128)"
     """
-    r, g, b = (round(x) for x in rgb_floats)
+    r, g, b = map(_float_to_8bit_int, rgb_floats)
     return f"rgb({r},{g},{b})"
 
 

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

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

@@ -1,5 +1,6 @@
 svg_ultralight/__init__.py,sha256=wUc79mKsG6lGZ1xaYijyJ4Sm9lG5-5XgRArVsCI0niY,2554
 svg_ultralight/animate.py,sha256=JSrBm-59BcNXDF0cGgl4-C89eBunjevZnwZxIWt48TU,1112
+svg_ultralight/image_ops.py,sha256=PXN_p5GX91UTvhnwwU-bPuj6WzM9wCx1SqfzR5icNnQ,4686
 svg_ultralight/inkscape.py,sha256=M8yTxXOu4NlXnhsMycvEJiIDpnDeiZ_bZakJBM38ZoU,9152
 svg_ultralight/layout.py,sha256=FgR45FsHax4xDjGkk9HEVW4OcwhtM8aqw2JUdZs_m7Q,12326
 svg_ultralight/main.py,sha256=6oNkZfD27UMdP-oYqp5agS_IGcYb8NkUZwM9Zdyb3SA,7287
@@ -21,8 +22,8 @@ svg_ultralight/bounding_boxes/type_padded_text.py,sha256=QA6PfeO_sQYc5pEXuyfyQ3l
 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.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,,
+svg_ultralight/strings/svg_strings.py,sha256=FQNxNmMkR2M-gCFo_woQKXLgCHi3ncUlRMiaRR_a9nQ,1978
+svg_ultralight-0.37.0.dist-info/METADATA,sha256=wWTDiiOScZrgr_Np0_XCqyJ9WKEAEKHJRXvPU5Qw5-Y,8933
+svg_ultralight-0.37.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+svg_ultralight-0.37.0.dist-info/top_level.txt,sha256=se-6yqM_0Yg5orJKvKWdjQZ4iR4G_EjhL7oRgju-fdY,15
+svg_ultralight-0.37.0.dist-info/RECORD,,