reykit 1.0.0__py3-none-any.whl

reykit/rimage.py

@@ -0,0 +1,261 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+@Time    : 2023-04-22 17:27:47
+@Author  : Rey
+@Contact : reyxbo@163.com
+@Explain : Image methods.
+"""
+
+
+from typing import Any, Union, Optional
+from io import BytesIO
+from qrcode import make as qrcode_make
+from qrcode.image.pil import PilImage
+from PIL.Image import open as pil_open, LANCZOS
+from captcha.image import ImageCaptcha
+
+from .rexception import catch_exc
+from .rmonkey import monkey_path_pil_image_get_bytes
+from .ros import RFile
+from .rrandom import randchar
+
+try:
+    from pyzbar.pyzbar import decode as pyzbar_decode
+except:
+    *_, pyzbar_decode, _ = catch_exc()
+
+
+__all__ = (
+    'RImage',
+    'encode_qrcode',
+    'decode_qrcode',
+    'compress_image',
+    'to_pimage',
+    'generate_captcha_image'
+)
+
+
+# Monkey path.
+monkey_image_type = monkey_path_pil_image_get_bytes()
+RImage = monkey_image_type
+
+
+def encode_qrcode(text: str, path: Optional[str] = None) -> bytes:
+    """
+    Encoding text to QR code image.
+
+    Parameters
+    ----------
+    text : Text.
+    path : File save path.
+        - `None`: Not save.
+
+    Returns
+    -------
+    Image bytes data.
+    """
+
+    # Encode.
+    image: PilImage = qrcode_make(text)
+
+    # Extract.
+    bytes_io = BytesIO()
+    image.save(bytes_io, 'JPEG')
+    file_bytes = bytes_io.getvalue()
+
+    # Save.
+    if path is not None:
+        rfile = RFile(path)
+        rfile.write(file_bytes)
+
+    return file_bytes
+
+
+def decode_qrcode(image: Union[str, bytes]) -> list[str]:
+    """
+    Decoding QR code or bar code image.
+
+    Parameters
+    ----------
+    image : Image bytes data or image file path.
+
+    Returns
+    -------
+    QR code or bar code text list.
+    """
+
+    # Check.
+    if isinstance(pyzbar_decode, BaseException):
+        raise pyzbar_decode
+
+    # Handle parameter.
+    if image.__class__ in (bytes, bytearray):
+        image = BytesIO(image)
+
+    # Decode.
+    image = pil_open(image)
+    qrcodes_data = pyzbar_decode(image)
+
+    # Convert.
+    texts = [
+        data.data.decode()
+        for data in qrcodes_data
+    ]
+
+    return texts
+
+
+def compress_image(
+    input_image: Union[str, bytes],
+    ouput_image: Optional[str] = None,
+    target_size: float = 0.5,
+    rate: int = 5,
+    reduce: bool = False,
+    max_quality: int = 75,
+    min_quality: int = 0
+) -> Optional[bytes]:
+    """
+    Compress image file.
+
+    Parameters
+    ----------
+    input_image : Input source image data.
+        - `str`: Source image read file path.
+        - `bytes`: Source image bytes data.
+    output_image : Output compressed image data.
+        - `None`: Return compressed image bytes data.
+        - `str`: Compressed image file save path, no return.
+    target_size : Compressed target size.
+        - `value < 1`: Not more than this size ratio.
+        - `value > 1`: Not more than this value, unit is KB.
+    rate : Compressed iteration rate of quality and resolution.
+    reduce : If target size is not completed, whether reduce image resolution for compression.
+    max_quality : Iteration start image quality rate.
+    min_quality : Iteration cutoff image quality rate.
+
+    Returns
+    -------
+    Compressed image bytes data.
+    """
+
+    # Handle parameter.
+    if input_image.__class__ == str:
+        rfile = RFile(input_image)
+        input_image = rfile.str
+    now_size = len(input_image)
+    if target_size < 1:
+        target_size = now_size * target_size
+    else:
+        target_size *= 1024
+
+    # Read image.
+    bytesio = BytesIO(input_image)
+    image = pil_open(bytesio)
+    image = image.convert('RGB')
+
+    # Step compress.
+    quality = max_quality
+    while now_size > target_size and quality >= min_quality:
+        bytesio = BytesIO()
+        image.save(bytesio, 'JPEG', quality=quality)
+        now_size = len(bytesio.read())
+        quality -= rate
+
+    # Step reduce.
+    if reduce:
+        ratio = 1 - rate / 100
+        while now_size > target_size:
+            bytesio = BytesIO()
+            resize = image.size[0] * ratio, image.size[1] * ratio
+            image.thumbnail(resize, LANCZOS)
+            image.save(bytesio, 'JPEG', quality=min_quality)
+            now_size = len(bytesio.read())
+            ratio -= rate / 100
+
+    # Return.
+    content = bytesio.read()
+
+    ## Return file bytes data.
+    if ouput_image is None:
+        return content
+
+    ## Save file and return path.
+    else:
+        rfile = RFile(ouput_image)
+        rfile(content)
+
+
+def to_pimage(image: Union[str, bytes]) -> RImage:
+    """
+    Get `Image` instance of `PIL` package.
+
+    Parameters
+    ----------
+    image : Image source data.
+        - `str`: Image file path.
+        - `bytes`: Image bytes data.
+
+    Returns
+    -------
+    `Image` instance.
+    """
+
+    # File path.
+    if image.__class__ == str:
+        pil_image = pil_open(image)
+
+    # Bytes data.
+    if image.__class__ in (bytes, bytearray):
+        bytes_io = BytesIO(image)
+        pil_image = pil_open(bytes_io)
+
+    return pil_image
+
+
+def generate_captcha_image(
+    text: Optional[Union[int, str]] = None,
+    path: Optional[str] = None,
+    **kwargs: Any
+) -> bytes:
+    """
+    Generate captcha image, based `captcha` package.
+
+    Parameters
+    ----------
+    text : Text, contains digits and Uppercase letters and lowercase letters.
+        - `None`: Random five characters.
+        - `int`: Given length Random characters.
+        - `str`: Given characters.
+    path : File save path.
+        - `None`: Not save.
+    kwargs : `ImageCaptcha` Parameters.
+
+    Returns
+    -------
+    Captcha image bytes data.
+    """
+
+    # Get parameter.
+    text = text or 5
+    if text.__class__ == int:
+        text = randchar(text, False)
+
+    # Generate.
+    default_kwargs = {
+        'width': 240,
+        'height': 90,
+        'font_sizes': (61, 75, 84)
+    }
+    default_kwargs.update(kwargs)
+    icaptcha = ImageCaptcha(**default_kwargs)
+    image: RImage = icaptcha.generate_image(text)
+    file_bytes = image.get_bytes()
+
+    # Save.
+    if path is not None:
+        rfile = RFile(path)
+        rfile.write(file_bytes)
+
+    return file_bytes