Set bypass constant

Author: middlered

README.md

@@ -101,11 +101,12 @@ async def handler(): ...
 自定义限制对象、定制最大使用量。
 ```python
 from datetime import timedelta # 支持传入 timedelta
+from nonebot_plugin_limiter import BYPASS_ENTITY
 
 # 同步样例。获取限制对象的唯一 ID
 def get_entity_id(bot: Bot, event: Event): # 可依赖注入
     if <any_condition>:
-        return "__bypass"   # 返回 `__bypass` 限制器将不会约束该对象的使用量
+        return BYPASS_ENTITY   # 返回 BYPASS_ENTITY 限制器将不会约束该对象的使用量
     return event.get_user_id()
 
 # 异步样例。获取不同用户的最大使用量

nonebot_plugin_limiter/__init__.py

@@ -20,6 +20,7 @@
 
 from .cooldown import Cooldown as Cooldown
 from .cooldown import SlidingWindowCooldown as SlidingWindowCooldown
+from .entity import BYPASS_ENTITY as BYPASS_ENTITY
 from .entity import CooldownEntity as CooldownEntity
 from .entity import GlobalScope as GlobalScope
 from .entity import PrivateScope as PrivateScope

nonebot_plugin_limiter/cooldown.py

@@ -14,7 +14,7 @@
 from nonebot_plugin_alconna import UniMessage
 from tzlocal import get_localzone
 
-from .entity import CooldownEntity
+from .entity import BYPASS_ENTITY, CooldownEntity
 
 _tz = get_localzone()
 
@@ -123,7 +123,7 @@ async def _limiter_dependency(
         entity_id: str = Depends(entity_id_dep),
         limit: int = Depends(limit_dep),
     ) -> None:
-        if entity_id == "__bypass":
+        if entity_id == BYPASS_ENTITY:
             return
 
         now = datetime.now(tz=_tz)
@@ -233,7 +233,7 @@ async def _limiter_dependency(
         entity_id: str = Depends(entity_id_dep),
         limit: int = Depends(limit_dep),
     ) -> None:
-        if entity_id == "__bypass":
+        if entity_id == BYPASS_ENTITY:
             return
 
         now = datetime.now(tz=_tz)

nonebot_plugin_limiter/entity.py

@@ -6,6 +6,7 @@
 from nonebot_plugin_uninfo import get_session
 
 _IdType = str | int
+BYPASS_ENTITY = "__bypass"
 
 
 class CooldownEntity:
@@ -69,13 +70,13 @@ def __init__(self, *, whitelist: None | tuple[_IdType, ...] = None, permission:
     async def get_entity_id(self, bot: Bot, event: Event) -> str:
         sess = await get_session(bot, event)
         if sess is None:
-            return "__bypass"
+            return BYPASS_ENTITY
 
         user_id = sess.user.id
         if self.whitelist is not None and user_id in self.whitelist:
-            return "__bypass"
+            return BYPASS_ENTITY
         if self.permission is not None and (await self.permission(bot, event)):
-            return "__bypass"
+            return BYPASS_ENTITY
         return f"u`{user_id}`"
 
 
@@ -106,13 +107,13 @@ def __init__(self, *, whitelist: None | tuple[_IdType, ...] = None, permission:
     async def get_entity_id(self, bot: Bot, event: Event) -> str:
         sess = await get_session(bot, event)
         if sess is None:
-            return "__bypass"
+            return BYPASS_ENTITY
 
         scene_id = sess.scene.id
         if self.whitelist is not None and scene_id in self.whitelist:
-            return "__bypass"
+            return BYPASS_ENTITY
         if self.permission is not None and (await self.permission(bot, event)):
-            return "__bypass"
+            return BYPASS_ENTITY
         return f"s`{scene_id}`"
 
 
@@ -151,16 +152,16 @@ def __init__(
     async def get_entity_id(self, bot: Bot, event: Event) -> str:
         sess = await get_session(bot, event)
         if sess is None:
-            return "__bypass"
+            return BYPASS_ENTITY
 
         user_id = sess.user.id
         scene_id = sess.scene.id
         if self.whitelist is not None:
             for uid, sid in self.whitelist:
                 if (uid == "*" or uid == user_id) and (sid == "*" or sid == scene_id):
-                    return "__bypass"
+                    return BYPASS_ENTITY
         if self.permission is not None and (await self.permission(bot, event)):
-            return "__bypass"
+            return BYPASS_ENTITY
         return f"u`{user_id}`_s`{scene_id}`"
 
 
@@ -193,13 +194,13 @@ def __init__(self, *, whitelist: None | tuple[_IdType, ...] = None, permission:
     async def get_entity_id(self, bot: Bot, event: Event) -> str:
         sess = await get_session(bot, event)
         if sess is None or not sess.scene.is_private:
-            return "__bypass"
+            return BYPASS_ENTITY
 
         user_id = sess.user.id
         if self.whitelist is not None and user_id in self.whitelist:
-            return "__bypass"
+            return BYPASS_ENTITY
         if self.permission is not None and (await self.permission(bot, event)):
-            return "__bypass"
+            return BYPASS_ENTITY
         return f"u`{user_id}`"
 
 
@@ -232,11 +233,11 @@ def __init__(self, *, whitelist: None | tuple[_IdType, ...] = None, permission:
     async def get_entity_id(self, bot: Bot, event: Event) -> str:
         sess = await get_session(bot, event)
         if sess is None or sess.scene.is_private:
-            return "__bypass"
+            return BYPASS_ENTITY
 
         user_id = sess.user.id
         if self.whitelist is not None and user_id in self.whitelist:
-            return "__bypass"
+            return BYPASS_ENTITY
         if self.permission is not None and (await self.permission(bot, event)):
-            return "__bypass"
+            return BYPASS_ENTITY
         return f"u`{user_id}`"

nonebot_plugin_limiter/handler.py

@@ -0,0 +1,5 @@
+from nonebot.params import Depends
+from nonebot.typing import T_State, _DependentCallable
+
+class Limiter:
+    pass