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

{py_img_processor-1.2.4/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.2.4
+Version: 1.3.2
 Summary: Image editor using Python and Pillow.
 Home-page: https://github.com/SkylerHu/py-img-processor.git
 Author: SkylerHu
@@ -68,7 +68,7 @@ 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匹配）， 默认无限制 | `()` |
@@ -86,16 +86,18 @@ Image editor using Python and Pillow.
 
 ### 处理函数
 ```python
-from imgprocessor.processor import process_image
+from imgprocessor.processor import process_image, process_image_obj
 
-process_image(input_uri, out_path, params)
+process_image(input_uri, params, out_path=out_path)
+# 或者
+process_image_obj(im, params, out_path=out_path)
 ```
 
 参数说明：
 
 - `input_uri` str，输入图像文件路径或者链接地址
-- `out_path` str, 输出图像保存路径
 - `params` str or json，图像处理参数，参数说明详见 [Reference.md](https://github.com/SkylerHu/py-img-processor/blob/master/docs/Reference.md)
+- `out_path` str, 输出图像保存路径, 默认为空，为空时返回二进制内容
 
 
 ### 图像处理参数为字符串
@@ -111,9 +113,9 @@ from imgprocessor.processor import process_image
 
 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",
 )
 ```
 
@@ -129,7 +131,6 @@ process_image(
 ```python
 process_image(
     "docs/imgs/lenna-400x225.jpg",
-    "/tmp/output.png",
     {
         "actions": [
             {"key": "resize", "s": 200},
@@ -140,6 +141,7 @@ process_image(
         ],
         "format": "png",
     },
+    out_path="/tmp/output.png",
 )
 ```
 该操作与上述字符串示例参数等效。

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

@@ -42,7 +42,7 @@ 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匹配）， 默认无限制 | `()` |
@@ -60,16 +60,18 @@ Image editor using Python and Pillow.
 
 ### 处理函数
 ```python
-from imgprocessor.processor import process_image
+from imgprocessor.processor import process_image, process_image_obj
 
-process_image(input_uri, out_path, params)
+process_image(input_uri, params, out_path=out_path)
+# 或者
+process_image_obj(im, params, out_path=out_path)
 ```
 
 参数说明：
 
 - `input_uri` str，输入图像文件路径或者链接地址
-- `out_path` str, 输出图像保存路径
 - `params` str or json，图像处理参数，参数说明详见 [Reference.md](./docs/Reference.md)
+- `out_path` str, 输出图像保存路径, 默认为空，为空时返回二进制内容
 
 
 ### 图像处理参数为字符串
@@ -85,9 +87,9 @@ from imgprocessor.processor import process_image
 
 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",
 )
 ```
 
@@ -103,7 +105,6 @@ process_image(
 ```python
 process_image(
     "docs/imgs/lenna-400x225.jpg",
-    "/tmp/output.png",
     {
         "actions": [
             {"key": "resize", "s": 200},
@@ -114,6 +115,7 @@ process_image(
         ],
         "format": "png",
     },
+    out_path="/tmp/output.png",
 )
 ```
 该操作与上述字符串示例参数等效。

{py_img_processor-1.2.4 → 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.2.4"
+__version__ = "1.3.2"
 
 
 VERSION = __version__
@@ -72,3 +74,6 @@ class SettingsProxy(object):
 
 
 settings = SettingsProxy()
+
+
+Image.MAX_IMAGE_PIXELS = settings.PROCESSOR_MAX_PIXEL

{py_img_processor-1.2.4 → 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", "裁剪")

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

@@ -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(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.2.4 → py_img_processor-1.3.2}/imgprocessor/parsers/__init__.py

@@ -33,6 +33,14 @@ _ACTION_PARASER_MAP: dict[str, typing.Any] = {
 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,
@@ -66,6 +74,7 @@ class ProcessParams(object):
 
         save_args = [""]  # 加空字符串，是为了保证解析出key
 
+        save_keys = list(ImgSaveParser.ARGS.keys())
         for item in value.split("/"):
             if not item:
                 continue
@@ -77,7 +86,7 @@ class ProcessParams(object):
                 key, param_str = info
             if not key:
                 raise ParamParseException(f"参数必须指定操作类型 [{item}]不符合参数要求")
-            if key in [enums.OpAction.FORMAT.value, enums.OpAction.QUALITY.value, enums.OpAction.INTERLACE.value]:
+            if key in save_keys:
                 save_args.append(f"{key}_{param_str}")
             else:
                 action_cls = _ACTION_PARASER_MAP.get(key)

{py_img_processor-1.2.4 → 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
@@ -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()

{py_img_processor-1.2.4 → py_img_processor-1.3.2}/imgprocessor/parsers/base.py

@@ -9,7 +9,7 @@ import urllib.parse
 from urllib.request import urlretrieve
 from contextlib import contextmanager
 
-from PIL import Image, ImageOps
+from PIL import Image, ImageOps, ImageFile
 
 from py_enum import ChoiceEnum
 from imgprocessor import settings, enums, utils
@@ -43,7 +43,7 @@ class BaseParser(object):
         """由子类继承实现各类实例的数据校验"""
         pass
 
-    def do_action(self, im: Image) -> Image:
+    def do_action(self, im: ImageFile.ImageFile) -> ImageFile.ImageFile:
         raise NotImplementedError
 
     def to_dict(self) -> dict:
@@ -214,7 +214,7 @@ class BaseParser(object):
         return params
 
 
-def pre_processing(im: Image, use_alpha: bool = False) -> Image:
+def pre_processing(im: ImageFile.ImageFile, use_alpha: bool = False) -> ImageFile.ImageFile:
     """预处理图像，默认转成`RGB`，若为`use_alpha=True`转为`RGBA`
 
     Args:
@@ -367,7 +367,7 @@ def compute_splice_two_im(
     return w, h, x1, y1, x2, y2
 
 
-def validate_ori_im(ori_im: Image) -> None:
+def validate_ori_im(ori_im: ImageFile.ImageFile) -> None:
     src_w, src_h = ori_im.size
     if src_w > settings.PROCESSOR_MAX_W_H or src_h > settings.PROCESSOR_MAX_W_H:
         raise ProcessLimitException(
@@ -377,7 +377,7 @@ def validate_ori_im(ori_im: Image) -> None:
         raise ProcessLimitException(f"图像总像素不可超过{settings.PROCESSOR_MAX_PIXEL}像素，输入图像({src_w}, {src_h})")
 
 
-def copy_full_img(ori_im: Image) -> Image:
+def copy_full_img(ori_im: ImageFile.ImageFile) -> ImageFile.ImageFile:
     out_im = ori_im.copy()
     # 复制格式信息
     out_im.format = ori_im.format
@@ -433,6 +433,8 @@ def trans_uri_to_im(uri: str, use_copy: bool = False) -> typing.Generator:
 
 class ImgSaveParser(BaseParser):
     KEY = ""
+
+    # 定义的key注意和枚举 `OpAction` 中的key不能重复
     ARGS = {
         "format": {"type": enums.ArgType.STRING.value, "default": None},
         "quality": {"type": enums.ArgType.INTEGER.value, "default": None, "min": 1, "max": 100},
@@ -458,7 +460,7 @@ class ImgSaveParser(BaseParser):
             if self.format not in fmt_values:
                 raise ParamValidateException(f"参数 format 只能是其中之一：{fmt_values}")
 
-    def compute(self, in_im: Image, out_im: Image) -> dict:
+    def compute(self, in_im: ImageFile.ImageFile, out_im: ImageFile.ImageFile) -> dict:
         kwargs = {
             "format": self.format or in_im.format,
             # png 和 gif 格式的选项是 interlace（一般翻译成交错），jpeg(jpg) 的选项则是 progressive （翻译成 渐进）

{py_img_processor-1.2.4 → py_img_processor-1.3.2}/imgprocessor/parsers/blur.py

@@ -2,7 +2,7 @@
 # coding=utf-8
 import typing
 
-from PIL import Image, ImageFilter
+from PIL import ImageFilter, ImageFile
 
 from imgprocessor import enums
 from .base import BaseParser, pre_processing
@@ -23,7 +23,7 @@ class BlurParser(BaseParser):
     ) -> None:
         self.r = r
 
-    def do_action(self, im: Image) -> Image:
+    def do_action(self, im: ImageFile.ImageFile) -> ImageFile.ImageFile:
         im = pre_processing(im)
         im = im.filter(ImageFilter.GaussianBlur(radius=self.r))
         return im

{py_img_processor-1.2.4 → py_img_processor-1.3.2}/imgprocessor/parsers/circle.py

@@ -2,7 +2,7 @@
 # coding=utf-8
 import typing
 
-from PIL import Image, ImageDraw
+from PIL import Image, ImageDraw, ImageFile
 
 from imgprocessor import enums, settings
 from .base import BaseParser, pre_processing
@@ -32,7 +32,7 @@ class CircleParser(BaseParser):
 
         return r
 
-    def do_action(self, im: Image) -> Image:
+    def do_action(self, im: ImageFile.ImageFile) -> ImageFile.ImageFile:
         im = pre_processing(im, use_alpha=True)
 
         src_w, src_h = im.size

{py_img_processor-1.2.4 → py_img_processor-1.3.2}/imgprocessor/parsers/crop.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding=utf-8
 import typing
-from PIL import Image
+from PIL import ImageFile
 from imgprocessor import enums, settings
 from imgprocessor.exceptions import ParamValidateException
 from .base import BaseParser, pre_processing, compute_by_geography, compute_by_ratio
@@ -89,7 +89,7 @@ class CropParser(BaseParser):
 
         return x, y, w, h
 
-    def do_action(self, im: Image) -> Image:
+    def do_action(self, im: ImageFile.ImageFile) -> ImageFile.ImageFile:
         im = pre_processing(im)
         x, y, w, h = self.compute(*im.size)
 

{py_img_processor-1.2.4 → py_img_processor-1.3.2}/imgprocessor/parsers/gray.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
@@ -19,6 +19,6 @@ class GrayParser(BaseParser):
     ) -> None:
         pass
 
-    def do_action(self, im: Image) -> Image:
+    def do_action(self, im: ImageFile.ImageFile) -> ImageFile.ImageFile:
         im = im.convert("L")
         return im

{py_img_processor-1.2.4 → py_img_processor-1.3.2}/imgprocessor/parsers/merge.py

@@ -2,7 +2,7 @@
 # coding=utf-8
 import typing
 
-from PIL import Image
+from PIL import Image, ImageFile
 
 from imgprocessor import enums, settings
 from imgprocessor.exceptions import ParamValidateException
@@ -115,7 +115,7 @@ class MergeParser(BaseParser):
 
         return w, h, x1, y1, x2, y2
 
-    def do_action(self, im: Image) -> Image:
+    def do_action(self, im: ImageFile.ImageFile) -> ImageFile.ImageFile:
         im = pre_processing(im, use_alpha=True)
 
         # 处理要合并的图像

{py_img_processor-1.2.4 → py_img_processor-1.3.2}/imgprocessor/parsers/resize.py

@@ -2,7 +2,7 @@
 # coding=utf-8
 import typing
 
-from PIL import Image, ImageOps
+from PIL import Image, ImageOps, ImageFile
 from imgprocessor import enums, settings
 from imgprocessor.exceptions import ParamValidateException, ProcessLimitException
 from .base import BaseParser, pre_processing
@@ -112,7 +112,7 @@ class ResizeParser(BaseParser):
             raise ProcessLimitException(f"缩放的目标图像总像素不可超过{settings.PROCESSOR_MAX_PIXEL}像素")
         return (w, h)
 
-    def do_action(self, im: Image) -> Image:
+    def do_action(self, im: ImageFile.ImageFile) -> ImageFile.ImageFile:
         im = pre_processing(im)
         size = self.compute(*im.size)
         if size == im.size:

{py_img_processor-1.2.4 → py_img_processor-1.3.2}/imgprocessor/parsers/rotate.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
@@ -23,7 +23,7 @@ class RotateParser(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)
         if 0 < self.value < 360:
             # 函数提供的是逆时针旋转

{py_img_processor-1.2.4 → py_img_processor-1.3.2}/imgprocessor/parsers/watermark.py

@@ -2,7 +2,7 @@
 # coding=utf-8
 import typing
 
-from PIL import Image, ImageFont, ImageDraw
+from PIL import Image, ImageFont, ImageDraw, ImageFile
 
 from imgprocessor import enums, settings, utils
 from imgprocessor.exceptions import ParamValidateException
@@ -113,7 +113,7 @@ class WatermarkParser(BaseParser):
         if not self.image and not self.text:
             raise ParamValidateException("image或者text参数必须传递一个")
 
-    def get_watermark_im(self) -> Image:
+    def get_watermark_im(self) -> ImageFile.ImageFile:
         """初始化水印对象"""
         w1, h1, w2, h2 = 0, 0, 0, 0
         icon = None
@@ -171,7 +171,7 @@ class WatermarkParser(BaseParser):
 
         return mark
 
-    def do_action(self, im: Image) -> Image:
+    def do_action(self, im: ImageFile.ImageFile) -> ImageFile.ImageFile:
         im = pre_processing(im, use_alpha=True)
         src_w, src_h = im.size
 

{py_img_processor-1.2.4 → py_img_processor-1.3.2}/imgprocessor/processor.py

@@ -4,7 +4,7 @@ import typing
 import tempfile
 import colorsys
 
-from PIL import Image, ImageOps
+from PIL import Image, ImageOps, ImageFile
 
 from imgprocessor import enums, settings
 from imgprocessor.parsers import BaseParser, ProcessParams
@@ -13,29 +13,8 @@ from imgprocessor.parsers.base import trans_uri_to_im
 
 class ProcessorCtr(object):
 
-    def __init__(self, input_uri: str, out_path: str, params: typing.Union[ProcessParams, dict, str]) -> None:
-        # 输入文件检验路径
-        self.input_uri = BaseParser._validate_uri(input_uri)
-        self.out_path = out_path
-        # 初始化处理参数
-        if isinstance(params, dict):
-            params = ProcessParams(**params)
-        elif isinstance(params, str):
-            params = ProcessParams.parse_str(params)
-        params = typing.cast(ProcessParams, params)
-        self.params = params
-
-    def run(self) -> typing.Optional[typing.ByteString]:
-        # 初始化输入
-        with trans_uri_to_im(self.input_uri) as ori_im:
-            # 处理图像
-            im = self.handle_img_actions(ori_im, self.params.actions)
-            # 输出、保存
-            kwargs = self.params.save_parser.compute(ori_im, im)
-            return self.save_img_to_file(im, out_path=self.out_path, **kwargs)
-
     @classmethod
-    def handle_img_actions(cls, ori_im: Image, actions: list[BaseParser]) -> Image:
+    def handle_img_actions(cls, ori_im: ImageFile.ImageFile, actions: list[BaseParser]) -> ImageFile.ImageFile:
         im = ori_im
         # 解决旋转问题
         im = ImageOps.exif_transpose(im)
@@ -46,7 +25,7 @@ class ProcessorCtr(object):
     @classmethod
     def save_img_to_file(
         cls,
-        im: Image,
+        im: ImageFile.ImageFile,
         out_path: typing.Optional[str] = None,
         **kwargs: typing.Any,
     ) -> typing.Optional[typing.ByteString]:
@@ -76,14 +55,17 @@ class ProcessorCtr(object):
 
 
 def process_image(
-    input_uri: str, out_path: str, params: typing.Union[ProcessParams, dict, str]
+    input_uri: str,
+    params: typing.Union[ProcessParams, dict, str],
+    out_path: typing.Optional[str] = None,
+    **kwargs: typing.Any,
 ) -> typing.Optional[typing.ByteString]:
     """处理图像
 
     Args:
         input_uri: 输入图像路径
-        out_path: 输出图像保存路径
         params: 图像处理参数
+        out_path: 输出图像保存路径
 
     Raises:
         ProcessLimitException: 超过处理限制会抛出异常
@@ -91,8 +73,40 @@ def process_image(
     Returns:
         默认输出直接存储无返回，仅当out_path为空时会返回处理后图像的二进制内容
     """
-    ctr = ProcessorCtr(input_uri, out_path, params)
-    return ctr.run()
+    # 初始化输入
+    params_obj: ProcessParams = ProcessParams.init(params)
+    with trans_uri_to_im(input_uri) as ori_im:
+        # 处理图像
+        im = ProcessorCtr.handle_img_actions(ori_im, params_obj.actions)
+        # 输出、保存
+        _kwargs = params_obj.save_parser.compute(ori_im, im)
+        _kwargs.update(kwargs)
+        ret = ProcessorCtr.save_img_to_file(im, out_path=out_path, **_kwargs)
+    return ret
+
+
+def process_image_obj(
+    ori_im: ImageFile.ImageFile,
+    params: typing.Union[ProcessParams, dict, str],
+    out_path: typing.Optional[str] = None,
+    **kwargs: typing.Any,
+) -> typing.Optional[typing.ByteString]:
+    """处理图像
+
+    Args:
+        ori_im: 输入图像为Image对象
+        params: 图像处理参数
+        out_path: 输出图像保存路径
+
+    Returns:
+        默认输出直接存储无返回，仅当out_path为空时会返回处理后图像的二进制内容
+    """
+    params_obj: ProcessParams = ProcessParams.init(params)
+    im = ProcessorCtr.handle_img_actions(ori_im, params_obj.actions)
+    _kwargs = params_obj.save_parser.compute(ori_im, im)
+    _kwargs.update(kwargs)
+    ret = ProcessorCtr.save_img_to_file(im, out_path=out_path, **_kwargs)
+    return ret
 
 
 def extract_main_color(img_path: str, delta_h: float = 0.3) -> str:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-img-processor
-Version: 1.2.4
+Version: 1.3.2
 Summary: Image editor using Python and Pillow.
 Home-page: https://github.com/SkylerHu/py-img-processor.git
 Author: SkylerHu
@@ -68,7 +68,7 @@ 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匹配）， 默认无限制 | `()` |
@@ -86,16 +86,18 @@ Image editor using Python and Pillow.
 
 ### 处理函数
 ```python
-from imgprocessor.processor import process_image
+from imgprocessor.processor import process_image, process_image_obj
 
-process_image(input_uri, out_path, params)
+process_image(input_uri, params, out_path=out_path)
+# 或者
+process_image_obj(im, params, out_path=out_path)
 ```
 
 参数说明：
 
 - `input_uri` str，输入图像文件路径或者链接地址
-- `out_path` str, 输出图像保存路径
 - `params` str or json，图像处理参数，参数说明详见 [Reference.md](https://github.com/SkylerHu/py-img-processor/blob/master/docs/Reference.md)
+- `out_path` str, 输出图像保存路径, 默认为空，为空时返回二进制内容
 
 
 ### 图像处理参数为字符串
@@ -111,9 +113,9 @@ from imgprocessor.processor import process_image
 
 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",
 )
 ```
 
@@ -129,7 +131,6 @@ process_image(
 ```python
 process_image(
     "docs/imgs/lenna-400x225.jpg",
-    "/tmp/output.png",
     {
         "actions": [
             {"key": "resize", "s": 200},
@@ -140,6 +141,7 @@ process_image(
         ],
         "format": "png",
     },
+    out_path="/tmp/output.png",
 )
 ```
 该操作与上述字符串示例参数等效。