lesscode-flask 0.2.6__tar.gz → 0.2.7__tar.gz

{lesscode_flask-0.2.6 → lesscode_flask-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.1
 Name: lesscode-flask
-Version: 0.2.6
+Version: 0.2.7
 Summary: lesscode-flask 是基于flask的web开发脚手架项目，该项目初衷为简化开发过程，让研发人员更加关注业务。
 Home-page: https://lesscode-flask
 Author: Chao.yy
@@ -26,16 +26,6 @@ Requires-Dist: gevent==25.5.1
 Requires-Dist: openpyxl==3.1.5
 Requires-Dist: iputil==0.3.1
 Requires-Dist: phone==0.4.5
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: platform
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # lesscode-flask
 

{lesscode_flask-0.2.6 → lesscode_flask-0.2.7}/lesscode_flask/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.2.6'
+__version__ = '0.2.7'
 
 import functools
 import logging

{lesscode_flask-0.2.6 → lesscode_flask-0.2.7}/lesscode_flask/app.py

@@ -22,10 +22,14 @@ from lesscode_flask.setup import setup_blueprint, setup_logging, setup_query_run
 from lesscode_flask.signals import app_runed
 from lesscode_flask.utils.helpers import inject_args, generate_uuid, app_config
 from lesscode_flask.utils.json.NotSortJSONProvider import NotSortJSONProvider
+from lesscode_flask.utils.limit import RedisRateLimiter
+from lesscode_flask.utils.limit.limit_util import get_rate_limit_info, get_count_limit_info
+from lesscode_flask.utils.limit.req.rate_limiter_handler import RateLimitHandler
+from lesscode_flask.utils.limit.req_count.count_limiter_handler import CountLimitHandler
+from lesscode_flask.utils.limit.req_count.redis_count_limiter import RedisCountLimiter
 from lesscode_flask.utils.redis.redis_helper import RedisHelper
 from lesscode_flask.utils.swagger.swagger_util import generate_openapi_spec
 
-
 # import collections.abc as cabc
 
 
@@ -55,9 +59,28 @@ class Lesscoder(Flask):
             setting_name = "setting.config.Config"
         self.config.from_object(setting_name)
         self.register_error_handler(Exception, self.handle_exception)
+        REDIS_RATE_LIMIT_ENABLE = self.config.get("RATE_LIMIT_ENABLE", False)
+        if REDIS_RATE_LIMIT_ENABLE:
+            self.rateLimiter = RedisRateLimiter(self.config.get("RATE_LIMIT_KEY", "redis"))
+        REDIS_COUNT_LIMIT_ENABLE = self.config.get("COUNT_LIMIT_ENABLE", False)
+        if REDIS_COUNT_LIMIT_ENABLE:
+            self.countLimiter = RedisCountLimiter(self.config.get("COUNT_LIMIT_KEY", "redis"))
 
     def preprocess_request(self) -> ft.ResponseReturnValue | None:
         v = super(Lesscoder, self).preprocess_request()
+
+        if  hasattr(self, 'countLimiter') and self.countLimiter:
+            allowed, remaining = self.countLimiter.is_allowed(*get_count_limit_info())
+            if not allowed:
+                countLimitHandler =  self.config.get("COUNT_LIMIT_HANDLER", CountLimitHandler)
+                countLimitHandler(request,remaining).response_handler()
+        if  hasattr(self, 'rateLimiter') and self.rateLimiter:
+            #  是否触发限流 延迟时间 超出数量
+            allowed,delay, excess =  self.rateLimiter.is_limited(*get_rate_limit_info())
+            if not allowed :
+                rateLimitHandler = self.config.get("RATE_LIMIT_HANDLER", RateLimitHandler)
+                rateLimitHandler(request,delay, excess).response_handler()
+
         if self.config.get("AUTHORIZATION_ENABLE"):  # 启动 AUTHORIZATION_ENABLE 才进行权限验证
             # 获取当前请求的url
             url = request.path

{lesscode_flask-0.2.6 → lesscode_flask-0.2.7}/lesscode_flask/model/base_model.py

@@ -28,7 +28,7 @@ class JSONEncodedDict(TypeDecorator):
     impl = VARCHAR
 
     def process_bind_param(self, value, dialect):
-        if value is not None:
+        if value is not None and not isinstance(value, str):
             value = json.dumps(value, ensure_ascii=False)
         return value
 

{lesscode_flask-0.2.6 → lesscode_flask-0.2.7}/lesscode_flask/setting/__init__.py

@@ -1,6 +1,9 @@
 import os
 import sys
 
+from lesscode_flask.utils.limit.req.rate_limiter_handler import RateLimitHandler
+from lesscode_flask.utils.limit.req_count.count_limiter_handler import CountLimitHandler
+
 
 class BaseConfig:
     # 应用id
@@ -72,7 +75,10 @@ class BaseConfig:
     REDIS_CACHE_KEY = "redis"
     # 权限缓存key
     REDIS_OAUTH_KEY = "oauth2_redis"
-
+    # 限流频率缓存key
+    REDIS_RATE_LIMIT_KEY = "redis"
+    # 限流计数缓存key
+    REDIS_COUNT_LIMIT_KEY = "redis"
     ##**************权限控制相关*****************##
     # 是否启用权限验证
     AUTHORIZATION_ENABLE: bool = False
@@ -84,6 +90,30 @@ class BaseConfig:
     AUTH_DEFAULT_ACCESS = 0
     # 启用生成刷新token
     OAUTH2_REFRESH_TOKEN_GENERATOR = True
+    # 是否启用限流频率验证
+    RATE_LIMIT_ENABLE: bool = False
+    # 触发限流的处理函数
+    RATE_LIMIT_HANDLER = RateLimitHandler
+    # 限流频率 单位是每秒
+    RATE_LIMIT_RATE = 1
+    # 限流频率允许的突发值 请求速率超过（rate + brust）的请求会被直接拒绝。
+    RATE_LIMIT_BURST = 0
+
+    # 是否启用限流计数验证
+    COUNT_LIMIT_ENABLE: bool = True
+    # 触发限流的处理函数
+    COUNT_LIMIT_HANDLER = CountLimitHandler
+    # 窗口期内最大访问量
+    COUNT_LIMIT_COUNT = 5
+    # 窗口期时长 单位秒
+    COUNT_LIMIT_TIME_WINDOW = 60
+    # 白名单
+    LIMIT_WHITE_LIST: list = ["/ike2b/user/WXOA/login", "/ike2b/detail/company/node/get_note",
+                                     "/ike2b/user/attention/attention_company_status",
+                                     "/ike2b/pay/wx_pay/sq_coin/get_payment_status",
+                                     "/toolEngine/targetedInvestmentPromotion/get_reach_chain",
+                                     "/ike2b/user/WXOA/bind", "/ike2b/select/park/park_list",
+                                     "/ike2b/pool/company/area_distribution/park_company_count_by_special_tag"]
     #
     # # 外网地址
     # OUTSIDE_SCREEN_IP: str = ""

lesscode_flask-0.2.7/lesscode_flask/utils/limit/__init__.py

@@ -0,0 +1,6 @@
+# __init__.py
+
+__all__ = ['RedisRateLimiter','RedisCountLimiter']
+
+from .req.redis_rate_limiter import RedisRateLimiter
+from .req_count.redis_count_limiter import RedisCountLimiter

lesscode_flask-0.2.7/lesscode_flask/utils/limit/limit_util.py

@@ -0,0 +1,50 @@
+import hashlib
+
+from flask import request, current_app
+
+from lesscode_flask.model.user import flask_login
+from lesscode_flask.utils.helpers import app_config
+def limit_key_encode() -> str:
+    limit_key = None
+    # 白名单
+    limit_white_list = app_config.get("LIMIT_WHITE_LIST", [])
+    request_url = request.url_rule.rule
+    if request_url in limit_white_list:
+        # 白名单访问 直接返回None
+        return None
+    # 1、获取当前用户
+    current_user = flask_login.current_user
+    if current_user and not current_user.is_anonymous_user:
+        user_id = current_user.id
+        # 拼接 key 用户id+url
+        limit_key = f"{user_id}:{request_url}"
+    # 如果键为空，使用客户端IP
+    if not limit_key:
+        limit_key = f"{request.remote_addr}{request_url}"
+    # 对键进行哈希处理，避免键过长
+    limit_key = hashlib.md5(limit_key.encode('utf-8')).hexdigest()
+    return hashlib.md5(limit_key.encode('utf-8')).hexdigest()
+
+
+def get_rate_limit_info() -> str:
+    """
+    获取限流信息，包含限流key 频率 rate , 突发数量 burst:
+    :return: 实际使用的限流键
+    """
+    rate = app_config.get("RATE_LIMIT_RATE", 1)  # 限流频率 单位是每秒
+    burst = app_config.get("RATE_LIMIT_BURST", 0)  # 限流频率允许的突发值 请求速率超过（rate + brust）的请求会被直接拒绝。
+    limit_key = limit_key_encode()
+    return limit_key, rate, burst
+
+def get_count_limit_info() -> str:
+    """
+    获取限流信息，包含限流key 总量 rate , 窗口期 burst:
+    :return: 实际使用的限流键
+    """
+    # 窗口期内最大访问量
+    count = app_config.get("COUNT_LIMIT_COUNT",500)
+    # 窗口期时长 单位秒
+    time_window = app_config.get("COUNT_LIMIT_TIME_WINDOW",3600)
+    limit_key = limit_key_encode()
+    return limit_key, count, time_window
+

lesscode_flask-0.2.7/lesscode_flask/utils/limit/req/rate_limiter_handler.py

@@ -0,0 +1,28 @@
+import time
+import logging
+
+from lesscode_flask.model.response_result import ResponseResult
+from lesscode_flask.utils.redis.redis_helper import RedisHelper
+
+logger = logging.getLogger(__name__)
+
+
+class RateLimitHandler:
+    """
+    限流后的处理函数实现
+    """
+    def __init__(self, req, delay: float, excess: float):
+        """
+         初始化
+        :param req:
+        :param delay: 延迟时间
+        :param excess: 超出数量
+        """
+        self.req = req
+        self.delay = delay
+        self.excess = excess
+
+
+    def response_handler(self):
+        message = "请求过于频繁，请稍后再试"
+        return ResponseResult.fail(status_code="403", http_code="403", message=message)

lesscode_flask-0.2.7/lesscode_flask/utils/limit/req/redis_rate_limiter.py

@@ -0,0 +1,62 @@
+import time
+import logging
+from lesscode_flask.utils.redis.redis_helper import RedisHelper
+
+logger = logging.getLogger(__name__)
+
+
+class RedisRateLimiter:
+    """
+    Redis限流实现
+    """
+
+    def __init__(self, redis_key):
+        self.redis_key = redis_key
+
+    def is_limited(self, key: str, rate: float, burst: float) -> tuple:
+        """
+        检查是否触发限流
+        :param key: 限流键
+        :param rate: 每秒请求速率
+        :param burst: 突发请求数
+        :return: (allowed,delay, excess) 是否触发限流 延迟时间和超出数量
+        """
+        if not key: # 没有key表示不验证
+            return True, 0,0
+        # 构造Redis键
+        key = f"limit_req:{key}"
+        # 存储键的键
+        excess_key = f"{key}excess"
+        # 存储最近一次请求时间毫秒的键
+        last_key = f"{key}last"
+        # 当前时间的毫秒表示形式
+        now = time.time() * 1000  # 转换为毫秒
+
+        try:
+            # 获取上次记录的信息
+            excess = RedisHelper(self.redis_key).sync_get(excess_key)
+            last =RedisHelper(self.redis_key).sync_get(last_key)
+
+            if excess is not None and last is not None:
+                excess = float(excess)
+                # 获取最近一次请求的时间毫秒值
+                last = float(last)
+                # 计算当前与最近一次访问的时间差
+                elapsed = now - last
+                # 根据时间差计算当前的excess值
+                excess = max(excess - (rate * abs(elapsed) / 1000) + 1, 0)
+            else:
+                excess = 0
+            # 返回延迟时间和超出数量
+            delay = excess / rate
+            # 检查是否超出限制
+            if excess > burst+rate:
+                return False, delay, excess # 被拒绝
+            # 更新Redis中的值
+            RedisHelper(self.redis_key).sync_set(excess_key, excess)
+            RedisHelper(self.redis_key).sync_set(last_key, now)
+            return True,delay, excess
+
+        except Exception as e:
+            logger.error(f"Redis rate limiter error: {e}")
+            return True, 0,0

lesscode_flask-0.2.7/lesscode_flask/utils/limit/req_count/count_limiter_handler.py

@@ -0,0 +1,20 @@
+import logging
+
+from lesscode_flask.model.response_result import ResponseResult
+
+logger = logging.getLogger(__name__)
+
+
+class CountLimitHandler:
+    """
+    限流后的处理函数实现
+    """
+
+    def __init__(self, req, remaining):
+        self.req = req
+        self.remaining = remaining
+
+
+    def response_handler(self):
+        message = "请求过于频繁，请稍后再试！"
+        return ResponseResult.fail(status_code="403", http_code="403", message=message)

lesscode_flask-0.2.7/lesscode_flask/utils/limit/req_count/redis_count_limiter.py

@@ -0,0 +1,40 @@
+import logging
+from lesscode_flask.utils.redis.redis_helper import RedisHelper
+
+logger = logging.getLogger(__name__)
+
+class RedisCountLimiter:
+    """Redis限流计数器实现"""
+    
+    def __init__(self, redis_key):
+        self.redis_key = redis_key
+
+    def is_allowed(self, key, count, time_window, cost=1):
+        """
+        检查是否允许请求
+        :param key: 限流键
+        :param count: 时间窗口内的请求数量限制
+        :param time_window: 时间窗口（秒）
+        :param cost: 本次请求消耗的令牌数
+        :return: (allowed, remaining)
+        """
+        if not key: # 没有key表示不验证
+            return True, 0
+        key = f"limit_count:{key}"
+
+        try:
+            remaining = RedisHelper(self.redis_key).sync_get(key)
+            if remaining is None:
+                remaining = count-cost
+                RedisHelper(self.redis_key).sync_set(key,remaining,time_window)
+            else:
+                # 键存在，减少令牌数
+                remaining = RedisHelper(self.redis_key).sync_incrby(name=key,amount=0- cost)
+            if remaining < 0:
+                return False, remaining
+            else:
+                return True, remaining
+        except Exception as e:
+            # Redis出错时的降级处理
+            logger.error(f"Redis count limiter error: {e}")
+            return True, remaining

{lesscode_flask-0.2.6 → lesscode_flask-0.2.7}/lesscode_flask/utils/redis/redis_helper.py

@@ -30,6 +30,9 @@ class RedisHelper:
     def sync_get(self, name):
         return self.get_connection().get(name)
 
+    def sync_incrby(self, name,amount):
+        return self.get_connection().incrby(name,amount)
+
     def sync_keys(self, pattern):
         return self.get_connection().keys(pattern=pattern)
 

{lesscode_flask-0.2.6 → lesscode_flask-0.2.7}/lesscode_flask.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.1
 Name: lesscode-flask
-Version: 0.2.6
+Version: 0.2.7
 Summary: lesscode-flask 是基于flask的web开发脚手架项目，该项目初衷为简化开发过程，让研发人员更加关注业务。
 Home-page: https://lesscode-flask
 Author: Chao.yy
@@ -26,16 +26,6 @@ Requires-Dist: gevent==25.5.1
 Requires-Dist: openpyxl==3.1.5
 Requires-Dist: iputil==0.3.1
 Requires-Dist: phone==0.4.5
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: platform
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # lesscode-flask
 

{lesscode_flask-0.2.6 → lesscode_flask-0.2.7}/lesscode_flask.egg-info/SOURCES.txt

@@ -27,6 +27,7 @@ lesscode_flask/service/resource_param_template_service.py
 lesscode_flask/setting/__init__.py
 lesscode_flask/setup/__init__.py
 lesscode_flask/static/swagger.py
+lesscode_flask/utils/__init__.py
 lesscode_flask/utils/dify_utils.py
 lesscode_flask/utils/helpers.py
 lesscode_flask/utils/decorator/__init__.py
@@ -35,6 +36,12 @@ lesscode_flask/utils/decorator/swagger.py
 lesscode_flask/utils/file/file_exporter.py
 lesscode_flask/utils/file/file_utils.py
 lesscode_flask/utils/json/NotSortJSONProvider.py
+lesscode_flask/utils/limit/__init__.py
+lesscode_flask/utils/limit/limit_util.py
+lesscode_flask/utils/limit/req/rate_limiter_handler.py
+lesscode_flask/utils/limit/req/redis_rate_limiter.py
+lesscode_flask/utils/limit/req_count/count_limiter_handler.py
+lesscode_flask/utils/limit/req_count/redis_count_limiter.py
 lesscode_flask/utils/oss/__init__.py
 lesscode_flask/utils/oss/aliyun_oss.py
 lesscode_flask/utils/oss/ks3_oss.py