py-img-processor 1.0.1__tar.gz → 1.3.2__tar.gz

{py_img_processor-1.0.1/py_img_processor.egg-info → py_img_processor-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-img-processor
-Version: 1.0.1
+Version: 1.3.2
 Summary: Image editor using Python and Pillow.
 Home-page: https://github.com/SkylerHu/py-img-processor.git
 Author: SkylerHu
@@ -21,7 +21,7 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: py-enum>=1.1.1
+Requires-Dist: py-enum>=2.1.1
 Requires-Dist: Pillow>=8
 
 # py-img-processor
@@ -54,7 +54,7 @@ Image editor using Python and Pillow.
 
 ## 2. 使用(Usage)
 
-具体使用说明查看 [readthedocs](https://py-img-processor.readthedocs.io) 。
+具体使用说明查看 [readthedocs](https://py-img-processor.readthedocs.io/) 。
 
 ## 2.1 运行配置
 可以通过指定环境变量`PY_SETTINGS_MODULE`加载配置文件：
@@ -68,9 +68,12 @@ Image editor using Python and Pillow.
 | DEBUG | bool | 是否debug开发模式 | False |
 | PROCESSOR_MAX_FILE_SIZE | int | 处理原图的大小限制， 单位 MB | 20 |
 | PROCESSOR_MAX_W_H | int | 处理图像，原图宽高像素限制 | 30000 |
-| PROCESSOR_MAX_PIXEL | int | width x height总像素3亿，处理前后的值都被此配置限制 | 300000000 |
+| PROCESSOR_MAX_PIXEL | int | width x height总像素3亿，处理前后的值都被此配置限制，会覆盖`Image.MAX_IMAGE_PIXELS`设置 | 300000000 |
 | PROCESSOR_DEFAULT_QUALITY | int | 图像处理后的默认质量 | 75 |
 | PROCESSOR_TEXT_FONT | str | 默认字体文件，默认从系统中寻找；也可以直接传递字体文件路径 | Arial Unicode.ttf |
+| PROCESSOR_WORKSPACES | tuple | 限制水印等资源路径 （startswith匹配）， 默认无限制 | `()` |
+| PROCESSOR_ALLOW_DOMAINS | tuple | 限制链接地址域名 （endswith匹配），默认无限制 | `()` |
+| PROCESSOR_TEMP_DIR | str | tmpfile使用的临时目录,不设置默认使用系统tmp目录 | `None` |
 
 > `注意`：`PROCESSOR_TEXT_FONT` 字体的设置是文字水印必要参数，需保证系统已安装该字体。默认值 `Arial Unicode.ttf` 是MacOS系统存在的字体，建议设置字体文件路径。
 
@@ -82,13 +85,19 @@ Image editor using Python and Pillow.
 
 
 ### 处理函数
-`process_image_by_path(input_path, out_path, params)`
+```python
+from imgprocessor.processor import process_image, process_image_obj
+
+process_image(input_uri, params, out_path=out_path)
+# 或者
+process_image_obj(im, params, out_path=out_path)
+```
 
 参数说明：
 
-- `input_path` str，输入图像文件路径
-- `out_path` str, 输出图像保存路径
+- `input_uri` str，输入图像文件路径或者链接地址
 - `params` str or json，图像处理参数，参数说明详见 [Reference.md](https://github.com/SkylerHu/py-img-processor/blob/master/docs/Reference.md)
+- `out_path` str, 输出图像保存路径, 默认为空，为空时返回二进制内容
 
 
 ### 图像处理参数为字符串
@@ -100,13 +109,13 @@ Image editor using Python and Pillow.
 
 ```python
 from imgprocessor.utils import base64url_encode
-from imgprocessor.processor import process_image_by_path
+from imgprocessor.processor import process_image
 
-process_image_by_path(
+process_image(
     "docs/imgs/lenna-400x225.jpg",
-    "/tmp/output.png",
     # 对图片缩放、裁剪、生成圆角、并转成png存储
     f"resize,s_200/crop,w_200,h_200,g_center/watermark,text_{base64url_encode('Hello 世界')},color_FFF,size_20/circle,r_10/format,png",
+    out_path="/tmp/output.png",
 )
 ```
 
@@ -120,9 +129,8 @@ process_image_by_path(
 - 其他参数都放在 `actions` 数组中；
 
 ```python
-process_image_by_path(
+process_image(
     "docs/imgs/lenna-400x225.jpg",
-    "/tmp/output.png",
     {
         "actions": [
             {"key": "resize", "s": 200},
@@ -133,6 +141,7 @@ process_image_by_path(
         ],
         "format": "png",
     },
+    out_path="/tmp/output.png",
 )
 ```
 该操作与上述字符串示例参数等效。

{py_img_processor-1.0.1 → py_img_processor-1.3.2}/README.md

@@ -28,7 +28,7 @@ Image editor using Python and Pillow.
 
 ## 2. 使用(Usage)
 
-具体使用说明查看 [readthedocs](https://py-img-processor.readthedocs.io) 。
+具体使用说明查看 [readthedocs](https://py-img-processor.readthedocs.io/) 。
 
 ## 2.1 运行配置
 可以通过指定环境变量`PY_SETTINGS_MODULE`加载配置文件：
@@ -42,9 +42,12 @@ Image editor using Python and Pillow.
 | DEBUG | bool | 是否debug开发模式 | False |
 | PROCESSOR_MAX_FILE_SIZE | int | 处理原图的大小限制， 单位 MB | 20 |
 | PROCESSOR_MAX_W_H | int | 处理图像，原图宽高像素限制 | 30000 |
-| PROCESSOR_MAX_PIXEL | int | width x height总像素3亿，处理前后的值都被此配置限制 | 300000000 |
+| PROCESSOR_MAX_PIXEL | int | width x height总像素3亿，处理前后的值都被此配置限制，会覆盖`Image.MAX_IMAGE_PIXELS`设置 | 300000000 |
 | PROCESSOR_DEFAULT_QUALITY | int | 图像处理后的默认质量 | 75 |
 | PROCESSOR_TEXT_FONT | str | 默认字体文件，默认从系统中寻找；也可以直接传递字体文件路径 | Arial Unicode.ttf |
+| PROCESSOR_WORKSPACES | tuple | 限制水印等资源路径 （startswith匹配）， 默认无限制 | `()` |
+| PROCESSOR_ALLOW_DOMAINS | tuple | 限制链接地址域名 （endswith匹配），默认无限制 | `()` |
+| PROCESSOR_TEMP_DIR | str | tmpfile使用的临时目录,不设置默认使用系统tmp目录 | `None` |
 
 > `注意`：`PROCESSOR_TEXT_FONT` 字体的设置是文字水印必要参数，需保证系统已安装该字体。默认值 `Arial Unicode.ttf` 是MacOS系统存在的字体，建议设置字体文件路径。
 
@@ -56,13 +59,19 @@ Image editor using Python and Pillow.
 
 
 ### 处理函数
-`process_image_by_path(input_path, out_path, params)`
+```python
+from imgprocessor.processor import process_image, process_image_obj
+
+process_image(input_uri, params, out_path=out_path)
+# 或者
+process_image_obj(im, params, out_path=out_path)
+```
 
 参数说明：
 
-- `input_path` str，输入图像文件路径
-- `out_path` str, 输出图像保存路径
+- `input_uri` str，输入图像文件路径或者链接地址
 - `params` str or json，图像处理参数，参数说明详见 [Reference.md](./docs/Reference.md)
+- `out_path` str, 输出图像保存路径, 默认为空，为空时返回二进制内容
 
 
 ### 图像处理参数为字符串
@@ -74,13 +83,13 @@ Image editor using Python and Pillow.
 
 ```python
 from imgprocessor.utils import base64url_encode
-from imgprocessor.processor import process_image_by_path
+from imgprocessor.processor import process_image
 
-process_image_by_path(
+process_image(
     "docs/imgs/lenna-400x225.jpg",
-    "/tmp/output.png",
     # 对图片缩放、裁剪、生成圆角、并转成png存储
     f"resize,s_200/crop,w_200,h_200,g_center/watermark,text_{base64url_encode('Hello 世界')},color_FFF,size_20/circle,r_10/format,png",
+    out_path="/tmp/output.png",
 )
 ```
 
@@ -94,9 +103,8 @@ process_image_by_path(
 - 其他参数都放在 `actions` 数组中；
 
 ```python
-process_image_by_path(
+process_image(
     "docs/imgs/lenna-400x225.jpg",
-    "/tmp/output.png",
     {
         "actions": [
             {"key": "resize", "s": 200},
@@ -107,6 +115,7 @@ process_image_by_path(
         ],
         "format": "png",
     },
+    out_path="/tmp/output.png",
 )
 ```
 该操作与上述字符串示例参数等效。

{py_img_processor-1.0.1 → py_img_processor-1.3.2}/imgprocessor/__init__.py

@@ -3,9 +3,11 @@ import os
 import traceback
 import importlib
 
+from PIL import Image
+
 
 __all__ = ["settings", "VERSION"]
-__version__ = "1.0.1"
+__version__ = "1.3.2"
 
 
 VERSION = __version__
@@ -41,6 +43,12 @@ class SettingsProxy(object):
     PROCESSOR_DEFAULT_QUALITY = 75
     # 默认字体文件; 默认配置了MacOS系统中的字体
     PROCESSOR_TEXT_FONT = "Arial Unicode.ttf"
+    # 工作目录列表：例如水印文件必须限制在设定的目录下，避免恶意访问文件
+    PROCESSOR_WORKSPACES = ()
+    # 当资源文件uri使用链接地址时，限制地址域名来源
+    PROCESSOR_ALLOW_DOMAINS = ()
+    # 临时文件目录
+    PROCESSOR_TEMP_DIR = None
 
     def __getattribute__(self, attr: str) -> typing.Any:
         try:
@@ -66,3 +74,6 @@ class SettingsProxy(object):
 
 
 settings = SettingsProxy()
+
+
+Image.MAX_IMAGE_PIXELS = settings.PROCESSOR_MAX_PIXEL

{py_img_processor-1.0.1 → py_img_processor-1.3.2}/imgprocessor/enums.py

@@ -31,10 +31,6 @@ class ImageOrientation(ChoiceEnum):
 class OpAction(ChoiceEnum):
     """支持的操作类型"""
 
-    # 以下几个比较特殊，在保存文件时使用
-    FORMAT = ("format", "格式")
-    QUALITY = ("quality", "质量")
-    INTERLACE = ("interlace", "渐进显示")
     # 其他
     RESIZE = ("resize", "缩放")
     CROP = ("crop", "裁剪")
@@ -51,8 +47,8 @@ class OpAction(ChoiceEnum):
 class ResizeMode(ChoiceEnum):
     """图像缩放的模式"""
 
-    LFIT = ("lfit", "等比缩放，缩放图限制为指定w与h的矩形内的最大图片")  # 类似ImageOps.contain
-    MFIT = ("mfit", "等比缩放，缩放图为延伸出指定w与h的矩形框外的最小图片")  # 类似ImageOps.cover
+    LFIT = ("lfit", "等比缩放，缩放图限制为指定w与h的矩形内的最大图片")  # 类似 ImageOps.contain
+    MFIT = ("mfit", "等比缩放，缩放图为延伸出指定w与h的矩形框外的最小图片")  # 类似 ImageOps.cover
     FIT = ("fit", "将原图等比缩放为延伸出指定w与h的矩形框外的最小图片，然后将超出的部分进行居中裁剪")  # ImageOps.fit
     PAD = ("pad", "将原图缩放为指定w与h的矩形内的最大图片，然后使用指定颜色居中填充空白部分")  # ImageOps.pad
     FIXED = ("fixed", "固定宽高，强制缩放")
@@ -62,6 +58,8 @@ class ArgType(ChoiceEnum):
     STRING = ("str", "字符串")
     INTEGER = ("int", "整数")
     FLOAT = ("float", "浮点数")
+    URI = ("uri", "资源路径/链接")
+    ACTION = ("action", "对图像的操作")
 
 
 class Geography(ChoiceEnum):

{py_img_processor-1.0.1 → py_img_processor-1.3.2}/imgprocessor/main.py

@@ -7,7 +7,7 @@ import argparse
 import traceback
 
 from imgprocessor import VERSION
-from imgprocessor.processor import ProcessParams, process_image_by_path
+from imgprocessor.processor import ProcessParams, process_image
 
 
 def main(argv: typing.Optional[list[str]] = None) -> int:
@@ -95,7 +95,7 @@ def main(argv: typing.Optional[list[str]] = None) -> int:
             if not os.path.exists(cur_out_dir):
                 os.makedirs(cur_out_dir)
             try:
-                process_image_by_path(file_path, out_path, param_str)
+                process_image(file_path, param_str, out_path=out_path)
                 print(f"{tag}\t 成功", flush=True)
             except Exception as e:
                 print(f"{tag}\t \033[31m失败：{e}\033[0m", file=sys.stderr, flush=True)

{py_img_processor-1.0.1 → py_img_processor-1.3.2}/imgprocessor/parsers/__init__.py

@@ -4,7 +4,8 @@ import typing
 
 from imgprocessor import enums
 from imgprocessor.exceptions import ParamParseException
-from .base import BaseParser, ImgSaveParser  # noqa: F401
+
+from .base import BaseParser, ImgSaveParser
 from .resize import ResizeParser
 from .crop import CropParser
 from .circle import CircleParser
@@ -16,31 +17,39 @@ from .watermark import WatermarkParser
 from .merge import MergeParser
 
 
-_ACTION_PARASER_MAP: dict[str, BaseParser] = {
-    enums.OpAction.RESIZE: ResizeParser,  # type: ignore
-    enums.OpAction.CROP: CropParser,  # type: ignore
-    enums.OpAction.CIRCLE: CircleParser,  # type: ignore
-    enums.OpAction.BLUR: BlurParser,  # type: ignore
-    enums.OpAction.ROTATE: RotateParser,  # type: ignore
-    enums.OpAction.ALPHA: AlphaParser,  # type: ignore
-    enums.OpAction.GRAY: GrayParser,  # type: ignore
-    enums.OpAction.WATERMARK: WatermarkParser,  # type: ignore
-    enums.OpAction.MERGE: MergeParser,  # type: ignore
+_ACTION_PARASER_MAP: dict[str, typing.Any] = {
+    enums.OpAction.RESIZE.value: ResizeParser,
+    enums.OpAction.CROP.value: CropParser,
+    enums.OpAction.CIRCLE.value: CircleParser,
+    enums.OpAction.BLUR.value: BlurParser,
+    enums.OpAction.ROTATE.value: RotateParser,
+    enums.OpAction.ALPHA.value: AlphaParser,
+    enums.OpAction.GRAY.value: GrayParser,
+    enums.OpAction.WATERMARK.value: WatermarkParser,
+    enums.OpAction.MERGE.value: MergeParser,
 }
 
 
 class ProcessParams(object):
     """图像处理输入参数"""
 
+    @classmethod
+    def init(cls, params: typing.Union["ProcessParams", dict, str]) -> "ProcessParams":
+        if isinstance(params, ProcessParams):
+            return params
+        if isinstance(params, dict):
+            return cls(**params)
+        return cls.parse_str(params)
+
     def __init__(
         self,
         enable_base64: bool = False,
         actions: typing.Optional[list] = None,
         **kwargs: typing.Any,
     ) -> None:
-        self.save_parser: ImgSaveParser = ImgSaveParser.init(kwargs, enable_base64=enable_base64)
+        self.save_parser: ImgSaveParser = ImgSaveParser.init(kwargs, enable_base64=enable_base64)  # type: ignore
 
-        _actions = []
+        _actions: list[BaseParser] = []
         for i in actions or []:
             key = i.get("key")
             cls = _ACTION_PARASER_MAP.get(key)
@@ -65,6 +74,7 @@ class ProcessParams(object):
 
         save_args = [""]  # 加空字符串，是为了保证解析出key
 
+        save_keys = list(ImgSaveParser.ARGS.keys())
         for item in value.split("/"):
             if not item:
                 continue
@@ -76,7 +86,7 @@ class ProcessParams(object):
                 key, param_str = info
             if not key:
                 raise ParamParseException(f"参数必须指定操作类型 [{item}]不符合参数要求")
-            if key in [enums.OpAction.FORMAT, enums.OpAction.QUALITY, enums.OpAction.INTERLACE]:
+            if key in save_keys:
                 save_args.append(f"{key}_{param_str}")
             else:
                 action_cls = _ACTION_PARASER_MAP.get(key)

{py_img_processor-1.0.1 → py_img_processor-1.3.2}/imgprocessor/parsers/alpha.py

@@ -2,7 +2,7 @@
 # coding=utf-8
 import typing
 
-from PIL import Image
+from PIL import ImageFile
 
 from imgprocessor import enums
 from .base import BaseParser, pre_processing
@@ -10,10 +10,10 @@ from .base import BaseParser, pre_processing
 
 class AlphaParser(BaseParser):
 
-    KEY = enums.OpAction.ALPHA
+    KEY = enums.OpAction.ALPHA.value
     ARGS = {
         # 不透明度, 为100时，完全不透明，即原图; 为0时，完全透明
-        "value": {"type": enums.ArgType.INTEGER, "default": 100, "min": 0, "max": 100},
+        "value": {"type": enums.ArgType.INTEGER.value, "default": 100, "min": 0, "max": 100},
     }
 
     def __init__(
@@ -23,7 +23,7 @@ class AlphaParser(BaseParser):
     ) -> None:
         self.value = value
 
-    def do_action(self, im: Image) -> Image:
+    def do_action(self, im: ImageFile.ImageFile) -> ImageFile.ImageFile:
         im = pre_processing(im, use_alpha=True)
         if self.value < 100:
             _, _, _, alpha_channel = im.split()