version 3.8.0.0 update

集成Flask-Pydantic，现在可以使用type hints对API及SQL的参数类型进行校验

Author: ZongXR

Dockerfile

@@ -6,6 +6,6 @@ COPY . /opt
 VOLUME ["/opt/logs"]
 EXPOSE 5000
 RUN pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple -r /opt/requirements.txt
-RUN pip3 install Flask-SSM==3.7.3.4
+RUN pip3 install Flask-SSM==3.8.0.0
 # 启动
 CMD python3 ./app.py

README.md

@@ -51,7 +51,7 @@ APP_PROCESS = 1           # 进程个数
 <pre>from flask_ssm.springframework.stereotype import Controller</pre>
 </li>
 <li>
-如<code><a href="./test/demo/controller/base_controller.py" target="_blank">test.demo.controller.base_controller</a></code>所示，对需要注册的接口直接加上<code>&commat;RequestMapping&lpar;value=**&comma;&nbsp;method=**&rpar;</code>或<code>&commat;GetMapping&lpar;value=**&rpar;</code>或<code>&commat;PostMapping&lpar;value=**&rpar;</code>
+如<code><a href="./test/demo/controller/base_controller.py" target="_blank">test.demo.controller.base_controller</a></code>所示，对需要注册的接口直接加上<code>&commat;RequestMapping&lpar;value=**&comma;&nbsp;method=**&rpar;</code>或<code>&commat;GetMapping&lpar;value=**&rpar;</code>或<code>&commat;PostMapping&lpar;value=**&rpar;</code>。如果需要对参数的类型进行校验，可以使用type&nbsp;hints。
 </li>
 <li>
 如<code><a href="./test/demo/controller/customize_controller.py" target="_blank">test.demo.controller.customize_controller</a></code>所示，如果需要json格式的响应体，在<code>&commat;RequestMapping</code>后面加上<code>&commat;ResponseBody</code>，把函数返回值映射为json格式写入响应体中。
@@ -104,7 +104,7 @@ if __name__ == "__main__":
 <pre>from flask_ssm.springframework.stereotype import Repository</pre>
 </li>
 <li>
-如<code><a href="./test/demo/dao/tablename_dao.py" target="_blank">test.demo.dao.tablename_dao</a></code>所示，对于查询函数，使用<code>&commat;Mapper&lpar;result_type=**&rpar;</code>修饰，并使用<code>result_type</code>指定返回类型。函数的参数为传入SQL语句的参数，返回值为SQL语句，SQL语句的参数部分同MyBatis的用法，即可实现返回对象的自动封装。
+如<code><a href="./test/demo/dao/tablename_dao.py" target="_blank">test.demo.dao.tablename_dao</a></code>所示，对于查询函数，使用<code>&commat;Mapper&lpar;result_type=**&rpar;</code>修饰，并使用<code>result_type</code>指定返回类型。函数的参数为传入SQL语句的参数，返回值为SQL语句，SQL语句的参数部分同MyBatis的用法，即可实现返回对象的自动封装。如果需要对SQL语句传参类型进行校验，可以使用type&nbsp;hints。
 <pre>
 @Mapper(result_type=str)
 def query_one(param):
@@ -414,4 +414,7 @@ class Pojo:
 <tr>
 <td>3.7.3.4</td><td>fix some bugs</td><td>2024年7月27日</td>
 </tr>
+<tr>
+<td>3.8.0.0</td><td>集成Flask-Pydantic，现在可以使用type&nbsp;hints对API及SQL的参数类型进行校验</td><td>2024年7月31日</td>
+</tr>
 </table>

build.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-docker build -t zongxr/flask-ssm-example:3.7.3.4 .
+docker build -t zongxr/flask-ssm-example:3.8.0.0 .
 python3 setup.py sdist bdist_wheel
 python3 -m twine upload --repository testpypi dist/*
 python3 -m twine upload dist/*

flask_ssm/__init__.py

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
 
 
-__version__ = "3.7.3.4"
+__version__ = "3.8.0.0"

flask_ssm/pybatis/annotation.py

@@ -14,9 +14,10 @@
 from sqlalchemy.engine.cursor import CursorResult
 from sqlalchemy.engine.result import MappingResult
 from sqlalchemy.engine.row import Row
+from pydantic import validate_call
 from flask_ssm.springframework.stereotype import Repository
 from flask_ssm.utils.module_utils import try_to_import
-from flask_ssm.utils.type_utils import __get_origin__, pojo_private_properties
+from flask_ssm.utils.type_utils import __get_origin__, pojo_private_properties, validate_single_value
 
 
 if sys.version_info >= (3, 9):
@@ -50,6 +51,8 @@ def __call__(self, func):
         :param func: 原函数
         :return:
         """
+        func = validate_call(func)
+
         @wraps(func)
         def wrapper(*params, **kwparams):
             _module_ = inspect.getmodule(func)
@@ -118,9 +121,7 @@ def wrapper(*params, **kwparams):
                         keys = list(result.mappings().keys())
                         if len(keys) > 1:
                             current_app.logger.warning("found %d columns, only pick columns[0]: %s" % (len(keys), keys[0]))
-                        _res_ = [x[0] for x in result]
-                        if len(_res_) > 0 and type(_res_[0]) is not _class_:
-                            current_app.logger.warning("type of T is %s, but required result_type is %s" % (type(_res_[0]), _class_))
+                        _res_ = [validate_single_value(_class_, x[0]) for x in result]
                         return _res_
             elif __get_origin__(self.result_type) is tuple:
                 if self.result_type in (Tuple, tuple):                                          # Tuple or tuple
@@ -148,9 +149,7 @@ def wrapper(*params, **kwparams):
                         keys = list(result.mappings().keys())
                         if len(keys) > 1:
                             current_app.logger.warning("found %d columns, only pick columns[0]: %s" % (len(keys), keys[0]))
-                        _res_ = tuple(x[0] for x in result)
-                        if len(_res_) > 0 and type(_res_[0]) is not _class_:
-                            current_app.logger.warning("type of T is %s, but required result_type is %s" % (type(_res_[0]), _class_))
+                        _res_ = tuple(validate_single_value(_class_, x[0]) for x in result)
                         return _res_
             elif issubclass(__get_origin__(self.result_type), Generator):
                 if self.result_type in (Generator, typing.Generator):                            # Generator
@@ -178,7 +177,7 @@ def wrapper(*params, **kwparams):
                         keys = list(result.mappings().keys())
                         if len(keys) > 1:
                             current_app.logger.warning("found %d columns, only pick columns[0]: %s" % (len(keys), keys[0]))
-                        return (x[0] for x in result)
+                        return (validate_single_value(_class_, x[0]) for x in result)
             elif __get_origin__(self.result_type) is dict:
                 if self.result_type is Dict or self.result_type is dict:                              # Dict or dict
                     result: CursorResult = db.session.execute(sql, kwparams)
@@ -194,7 +193,7 @@ def wrapper(*params, **kwparams):
                     values = list(zip(*result.fetchall()))
                     keys = list(result.mappings().keys())
                     return dict(zip(keys, values)) if len(values) > 0 else {key: tuple() for key in keys}
-                else:                                                                       # Dict[str, T]
+                else:                                                                       # Dict[str, Any]
                     result: CursorResult = db.session.execute(sql, kwparams)
                     values = result.fetchone()
                     keys = list(result.mappings().keys())
@@ -210,9 +209,7 @@ def wrapper(*params, **kwparams):
                         current_app.logger.warning("found %d fields, only pick fields[0]: %s" % (len(keys), keys[0]))
                     fetch_result = result.fetchone()
                     _res_ = None if fetch_result is None else fetch_result[0]
-                    if _res_ is not None and type(_res_) is not _class_:
-                        current_app.logger.warning("type of T is %s, but required result_type is %s" % (type(_res_), _class_))
-                    return _res_
+                    return validate_single_value(_class_, _res_)
         return wrapper
 
 

flask_ssm/springframework/web/bind/annotation.py

@@ -5,6 +5,7 @@
 import inspect
 from urllib.parse import unquote
 from flask import request, Response
+from flask_pydantic import validate
 from flask_ssm.utils.module_utils import blueprint_from_module
 from flask_ssm.utils.type_utils import to_json
 
@@ -65,6 +66,7 @@ def result(*args, **kwargs):
             else:
                 return _inner_result_
         bp = blueprint_from_module(func)
+        func = validate()(func)
         return bp.route(self.rule, methods=self.methods)(result)
 
 

flask_ssm/utils/type_utils.py

@@ -1,7 +1,9 @@
 # -*- coding: utf-8 -*-
 import sys
+import logging
 from typing import Type
 from flask import Response, jsonify
+from pydantic import create_model, ValidationError
 
 
 if sys.version_info >= (3, 8):
@@ -50,3 +52,13 @@ def to_json(obj) -> Response:
         return jsonify(dict(obj))
     else:
         return jsonify(obj.__dict__)
+
+
+def validate_single_value(value_type, value):
+    model = create_model('DynamicModel', value=(value_type, ...))
+    try:
+        validated_value = model(value=value)
+        return validated_value.value
+    except ValidationError as e:
+        logging.warning(e)
+        return value

requirements.txt

@@ -4,7 +4,10 @@ Flask-APScheduler~=1.12.3,>1.12.2
 Flask-Cors~=3.0.10
 Flask-HTTPAuth~=4.5.0
 Flask-SQLAlchemy~=2.5.1
+Flask-Pydantic~=0.12.0
 SQLAlchemy~=1.4.18
+pydantic~=2.0
 typing-inspect~=0.8.0;python_version=="3.7"
 APScheduler==3.10.4
-Werkzeug>=2.1.2,<=2.3.8
+Werkzeug>=2.1.2,<=2.3.8
+setuptools~=65.5.0

run_with_docker.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 mkdir -p /opt/flask-ssm-example/logs
-docker run -d -p 5000:5000 -v /opt/flask-ssm-example/logs:/opt/logs zongxr/flask-ssm-example:3.7.3.4
+docker run -d -p 5000:5000 -v /opt/flask-ssm-example/logs:/opt/logs zongxr/flask-ssm-example:3.8.0.0

setup.py

@@ -10,7 +10,7 @@
     long_description = long_description.replace("./app.py", base_url + "/tree/main/app.py")
 packages = list(filter(lambda x: not x.startswith("test"), setuptools.find_packages()))
 requires_list = open('./requirements.txt', 'r', encoding='utf8').readlines()
-requires_list = [x.strip() for x in requires_list if not x.startswith("PyMySQL")]
+requires_list = [x.strip() for x in requires_list if (not x.startswith("PyMySQL")) and (not x.startswith("setuptools"))]
 
 
 setuptools.setup(