lesscode-flask 0.2.89__tar.gz → 0.2.92__tar.gz

{lesscode_flask-0.2.89 → lesscode_flask-0.2.92}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lesscode-flask
-Version: 0.2.89
+Version: 0.2.92
 Summary: lesscode-flask 是基于flask的web开发脚手架项目，该项目初衷为简化开发过程，让研发人员更加关注业务。
 Home-page: https://lesscode-flask
 Author: Chao.yy
@@ -11,7 +11,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: Flask==3.0.3
-Requires-Dist: lesscode-utils==0.0.91
+Requires-Dist: lesscode-utils==0.0.95
 Requires-Dist: Flask-Login==0.6.3
 Requires-Dist: redis==5.1.1
 Requires-Dist: flask-swagger-ui==4.11.1

{lesscode_flask-0.2.89 → lesscode_flask-0.2.92}/lesscode_flask/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.89"
+__version__ = "0.2.92"
 
 import functools
 import logging

{lesscode_flask-0.2.89 → lesscode_flask-0.2.92}/lesscode_flask/setup/__init__.py

@@ -1,4 +1,5 @@
 import inspect
+import json
 import uuid
 from datetime import datetime
 from importlib import import_module
@@ -6,6 +7,7 @@ from logging.handlers import TimedRotatingFileHandler
 
 import requests
 from flask import current_app, Response, request
+from lesscode_utils.encryption_algorithm import AES
 
 from lesscode_flask import download_func_dict, SQ_Blueprint
 from lesscode_flask.db import db
@@ -94,6 +96,7 @@ def setup_blueprint(app, path=None, pkg_name="handlers", blueprint_map=None):
         while f"{blueprint_name}-{index}" in blueprint_map:
             index += 1
         return f"{blueprint_name}-{index}"
+
     if path is None:
         # 项目内Handler的文件路径，使用当前工作目录作为根
         path = os.path.join(os.getcwd(), pkg_name)
@@ -169,7 +172,122 @@ def _normalize_methods(raw_methods, supported_methods):
     return [item for item in methods if item in supported_methods] or ["POST"]
 
 
-def _build_proxy_view(app, target_url, title, description=None, dynamic_params=None):
+def _build_forward_headers(app):
+    headers = {}
+    for key, value in request.headers:
+        if key.lower() not in {"host", "content-length"}:
+            headers[key] = value
+    # 转调时按配置补充自定义请求头，用于能力平台鉴权/路由。
+    data_source_key = app.config.get("DATA_SOURCE_KEY")
+    data_source_value = app.config.get("DATA_SOURCE_VALUE")
+    if data_source_key and data_source_value is not None:
+        headers[str(data_source_key)] = str(data_source_value)
+    return headers
+
+
+def _build_download_key(target_url, request_method):
+    key_seed = f"{str(request_method).upper()}::{target_url}"
+    # 保持原有 AES 风格，同时拼接首尾片段，避免只截前缀导致不同接口冲突。
+    encrypted = AES.encrypt(key_seed)
+    return f"{encrypted[:8]}{encrypted[-8:]}"
+
+
+def _is_auto_export_route(route):
+    route = str(route or "").lower()
+    return "/list/" in route
+
+
+def _apply_path_params(route, request_params):
+    target_route = str(route or "")
+    for param_name in list(request_params.keys()):
+        placeholder = f"<{param_name}>"
+        legacy_placeholder = f"{{{param_name}}}"
+        if placeholder not in target_route and legacy_placeholder not in target_route:
+            continue
+        value = str(request_params.pop(param_name))
+        target_route = target_route.replace(placeholder, value).replace(legacy_placeholder, value)
+    return target_route
+
+
+def _inject_download_key(payload, download_key):
+    if not download_key or not isinstance(payload, dict):
+        return payload
+    # 自动注册接口仍然沿用老的 download_key 协议，优先回填到 data 节点。
+    data_payload = payload.get("data")
+    if isinstance(data_payload, dict):
+        data_payload["download_key"] = download_key
+    else:
+        payload["download_key"] = download_key
+    return payload
+
+
+def _extract_auto_export_result(payload):
+    if isinstance(payload, list):
+        return {"dataSource": payload, "columns": []}
+    if not isinstance(payload, dict):
+        raise Exception("自动导出接口返回格式不支持")
+
+    # 兼容能力平台常见的列表返回结构，统一转换成 data_download 可消费的格式。
+    candidate_list = [payload]
+    data_payload = payload.get("data")
+    if isinstance(data_payload, dict):
+        candidate_list.insert(0, data_payload)
+
+    for candidate in candidate_list:
+        if not isinstance(candidate, dict):
+            continue
+        if isinstance(candidate.get("dataSource"), list):
+            return candidate
+        for key in ("list", "rows", "records", "items", "result"):
+            value = candidate.get(key)
+            if isinstance(value, list):
+                return {
+                    "dataSource": value,
+                    "columns": candidate.get("columns") or candidate.get("column") or []
+                }
+            if isinstance(value, dict) and isinstance(value.get("dataSource"), list):
+                return value
+    raise Exception("自动导出接口缺少可识别的数据列表")
+
+
+def _register_auto_export_handler(app, target_url, request_method):
+    download_key = _build_download_key(target_url, request_method)
+
+    def _auto_export_func(offset=0, size=10, **kwargs):
+        # 自动注册接口没有本地业务函数，这里动态构造一个“导出函数”给 data_download 调用。
+        request_params = {"offset": offset, "size": size}
+        request_params.update(kwargs)
+        export_url = _apply_path_params(target_url, request_params)
+        headers = _build_forward_headers(app)
+        request_method_upper = str(request_method).upper()
+        request_kwargs = {
+            "method": request_method_upper,
+            "url": export_url,
+            "headers": headers,
+            "timeout": 30,
+        }
+        if request_method_upper == "GET":
+            request_kwargs["params"] = request_params
+            resp = requests.request(**request_kwargs)
+        else:
+            request_kwargs["json"] = request_params
+            resp = requests.request(**request_kwargs)
+            # 某些 /list/ 接口可能不是 JSON 入参；仅在常见参数错误场景下回退到表单透传。
+            if resp.status_code in {400, 415, 422}:
+                request_kwargs.pop("json", None)
+                form_headers = {k: v for k, v in headers.items() if k.lower() != "content-type"}
+                request_kwargs["headers"] = form_headers
+                request_kwargs["data"] = request_params
+                resp = requests.request(**request_kwargs)
+        resp.raise_for_status()
+        return _extract_auto_export_result(resp.json())
+
+    _auto_export_func.__name__ = f"auto_export_{uuid.uuid4().hex}"
+    download_func_dict[download_key] = _auto_export_func
+    return download_key
+
+
+def _build_proxy_view(app, target_url, title, description=None, dynamic_params=None, download_key=None):
     # 生成一个代理视图：把当前请求透明转发到能力平台目标地址。
     def _proxy_view(**path_params):
         url = target_url
@@ -177,15 +295,7 @@ def _build_proxy_view(app, target_url, title, description=None, dynamic_params=N
             value = str(value)
             url = url.replace(f"<{key}>", value).replace(f"{{{key}}}", value)
 
-        headers = {}
-        for key, value in request.headers:
-            if key.lower() not in {"host", "content-length"}:
-                headers[key] = value
-        # 转调时按配置补充自定义请求头，用于能力平台鉴权/路由。
-        data_source_key = app.config.get("DATA_SOURCE_KEY")
-        data_source_value = app.config.get("DATA_SOURCE_VALUE")
-        if data_source_key and data_source_value is not None:
-            headers[str(data_source_key)] = str(data_source_value)
+        headers = _build_forward_headers(app)
 
         resp = requests.request(
             method=request.method,
@@ -198,6 +308,19 @@ def _build_proxy_view(app, target_url, title, description=None, dynamic_params=N
 
         excluded_headers = {"content-encoding", "content-length", "transfer-encoding", "connection"}
         response_headers = [(k, v) for k, v in resp.headers.items() if k.lower() not in excluded_headers]
+        if download_key:
+            try:
+                # 列表代理接口返回 JSON 时，把 download_key 挂回响应，前端可直接复用原导出流程。
+                payload = json.loads(resp.content)
+                payload = _inject_download_key(payload, download_key)
+                return Response(
+                    json.dumps(payload, ensure_ascii=False),
+                    status=resp.status_code,
+                    headers=response_headers,
+                    content_type=resp.headers.get("Content-Type", "application/json")
+                )
+            except Exception:
+                pass
         return Response(resp.content, status=resp.status_code, headers=response_headers)
 
     _proxy_view._title = title
@@ -388,8 +511,17 @@ def setup_api_blueprint(app, exclude_route_method_keys=None, existing_blueprint_
             title = item.get("title") or f"{bp_name}-{index + 1}"
             endpoint = f"auto_dynamic_{group_id}_{index}_{'_'.join(available_methods).lower()}"
             description = item.get("description") or title
+            download_key = None
+            if _is_auto_export_route(remote_route):
+                # 约定 /list/ 路由支持导出，因此额外挂载 download_key -> 动态导出函数。
+                download_key = _register_auto_export_handler(
+                    app,
+                    target_url=target_url,
+                    request_method=available_methods[0]
+                )
             view_func = _build_proxy_view(app, target_url=target_url, title=title,
-                                         description=description, dynamic_params=item.get("dynamic_params"))
+                                          description=description, dynamic_params=item.get("dynamic_params"),
+                                          download_key=download_key)
             dynamic_bp.add_url_rule(local_route, endpoint=endpoint, view_func=view_func, methods=available_methods)
             group_route_count += 1
             total_route_count += 1
@@ -628,7 +760,7 @@ def setup_resource_register(app):
         url_rules_dict = {}
         for blueprint_name, blueprint in app.blueprints.items():
             group_key = f'{blueprint_name}|{blueprint.url_prefix}'
-            if blueprint.url_prefix not in ["/swagger-ui"]:
+            if "swagger-ui" not in blueprint.url_prefix:
                 url_rules_dict[group_key] = []
                 # 遍历全局 URL 规则
                 for rule in app.url_map.iter_rules():
@@ -715,6 +847,9 @@ def setup_data_download(app):
         func = download_func_dict.get(download_key, {})
         request_param = {"offset": offset, "size": size}
         signature = inspect.signature(func)
+        if any(parameter.kind == inspect.Parameter.VAR_KEYWORD for parameter in signature.parameters.values()):
+            # 动态导出函数统一使用 **kwargs，直接透传前端筛选条件即可。
+            request_param.update(params)
         for parameter_name, parameter in signature.parameters.items():
             if params.get(parameter_name):
                 request_param[parameter_name] = params[parameter_name]

lesscode_flask-0.2.92/lesscode_flask/utils/fs_util.py

@@ -0,0 +1,68 @@
+import hashlib
+import logging
+
+import json
+
+import requests
+
+from lesscode_flask.utils.helpers import app_config
+from lesscode_flask.utils.redis.redis_helper import RedisHelper
+
+logger = logging.getLogger(__name__)
+
+_FS_WEBHOOK_CACHE_TTL = 3 * 60 * 60  # 3小时，单位秒
+
+
+def fs_webhook(webhook_url: str, title: str, fs_content: list):
+    """
+    发送飞书 webhook 消息。3小时内相同内容不重复发送。
+
+    :param webhook_url: 飞书 webhook 的 URL 地址
+    :param title: 消息的标题
+    :param fs_content: 消息内容列表
+    """
+    # 构建缓存 key：对 webhook_url + title + content 做 MD5 哈希
+    cache_raw = (
+        f"{webhook_url}:{title}:"
+        f"{json.dumps(fs_content, ensure_ascii=False, sort_keys=True)}"
+    )
+    cache_key = "fs_webhook:" + hashlib.md5(cache_raw.encode("utf-8")).hexdigest()
+
+    # 检查 Redis 中是否已存在该 key（3小时内已发送过）
+    redis = None
+    try:
+        redis_oauth_key = app_config.get("REDIS_OAUTH_KEY", "redis")
+        redis = RedisHelper(redis_oauth_key)
+        if redis.sync_exists(cache_key):
+            logger.info("fs_webhook 重复内容，跳过发送，cache_key=%s", cache_key)
+            return
+    except Exception:  # pylint: disable=broad-except
+        logger.warning("fs_webhook Redis 检查失败，继续发送")
+
+    headers = {'Content-Type': 'application/json;charset=utf-8'}
+
+    # 构造飞书消息的 JSON 结构
+    json_text = {
+        "msg_type": "post",
+        "content": {
+            "post": {
+                "zh_cn": {
+                    "title": title,
+                    "content": [
+                        fs_content
+                    ]
+                }
+            }
+        }
+    }
+
+    # 发送 POST 请求并记录响应结果
+    result = requests.post(webhook_url, json.dumps(json_text), headers=headers, timeout=10).content
+    logger.info(result)
+
+    # 发送成功后写入 Redis 缓存，3小时内不再重复发送
+    if redis is not None:
+        try:
+            redis.sync_set(cache_key, "1", ex=_FS_WEBHOOK_CACHE_TTL)
+        except Exception:  # pylint: disable=broad-except
+            logger.warning("fs_webhook Redis 写入缓存失败")

{lesscode_flask-0.2.89 → lesscode_flask-0.2.92}/lesscode_flask.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lesscode-flask
-Version: 0.2.89
+Version: 0.2.92
 Summary: lesscode-flask 是基于flask的web开发脚手架项目，该项目初衷为简化开发过程，让研发人员更加关注业务。
 Home-page: https://lesscode-flask
 Author: Chao.yy
@@ -11,7 +11,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: Flask==3.0.3
-Requires-Dist: lesscode-utils==0.0.91
+Requires-Dist: lesscode-utils==0.0.95
 Requires-Dist: Flask-Login==0.6.3
 Requires-Dist: redis==5.1.1
 Requires-Dist: flask-swagger-ui==4.11.1

{lesscode_flask-0.2.89 → lesscode_flask-0.2.92}/lesscode_flask.egg-info/requires.txt

@@ -1,5 +1,5 @@
 Flask==3.0.3
-lesscode-utils==0.0.91
+lesscode-utils==0.0.95
 Flask-Login==0.6.3
 redis==5.1.1
 flask-swagger-ui==4.11.1

lesscode_flask-0.2.89/lesscode_flask/utils/fs_util.py

@@ -1,55 +0,0 @@
-import logging
-
-import json
-
-import requests
-
-logger = logging.getLogger(__name__)
-
-def fs_webhook(webhook_url:str,title:str, fs_content:list):
-    """
-    发送飞书 webhook 消息
-
-    参数:
-        webhook_url (str): 飞书 webhook 的 URL 地址
-        title (str): 消息的标题
-        fs_content (str or list): 消息内容，可以是字符串或字符串列表
-
-    返回值:
-        无返回值，直接发送 HTTP 请求
-    """
-    headers = {'Content-Type': 'application/json;charset=utf-8'}
-
-    # # 根据内容类型构建飞书消息格式
-    # if isinstance(content, list):
-    #     fs_content = []
-    #     for i in content:
-    #         fs_content.append({
-    #             "tag": "text",
-    #             "text": f"{i}\n"
-    #         })
-    # else:
-    #     fs_content = [{
-    #         "tag": "text",
-    #         "text": f"{content}\n"
-    #     }]
-
-    # 构造飞书消息的 JSON 结构
-    json_text = {
-        "msg_type": "post",
-        "content": {
-            "post": {
-                "zh_cn": {
-                    "title": title,
-                    "content": [
-                        fs_content
-                    ]
-                }
-            }
-        }
-    }
-
-    # 发送 POST 请求并记录响应结果
-    result = requests.post(webhook_url, json.dumps(json_text), headers=headers).content
-    logger.info(result)
-