✨ version 0.3.2

is_direct/public_message

Author: RF-Tar-Railt

arclet/entari/__init__.py

@@ -43,6 +43,8 @@
 from .core import Entari as Entari
 from .event import MessageCreatedEvent as MessageCreatedEvent
 from .event import MessageEvent as MessageEvent
+from .filter import is_direct_message as is_direct_message
+from .filter import is_public_message as is_public_message
 from .message import MessageChain as MessageChain
 from .plugin import Plugin as Plugin
 from .plugin import load_plugin as load_plugin

arclet/entari/event.py

@@ -33,7 +33,7 @@ def parse(cls, account: Account, origin: SatoriEvent):
                 continue
             if attr := getattr(origin, fd.name, None):
                 attrs[fd.name] = attr
-        res = cls(**attrs)
+        res = cls(**attrs)  # type: ignore
         res._origin = origin
         return res
 
@@ -56,22 +56,32 @@ def validate(self, param: Param):
             return param.name == "operator" and super().validate(param)
 
         async def __call__(self, context: Contexts):
+            if "operator" in context:
+                return context["operator"]
             return context["$origin_event"].operator
 
     class UserProvider(Provider[User]):
         async def __call__(self, context: Contexts):
+            if "user" in context:
+                return context["user"]
             return context["$origin_event"].user
 
     class MessageProvider(Provider[MessageObject]):
         async def __call__(self, context: Contexts):
+            if "$message_origin" in context:
+                return context["$message_origin"]
             return context["$origin_event"].message
 
     class ChannelProvider(Provider[Channel]):
         async def __call__(self, context: Contexts):
+            if "channel" in context:
+                return context["channel"]
             return context["$origin_event"].channel
 
     class GuildProvider(Provider[Guild]):
         async def __call__(self, context: Contexts):
+            if "guild" in context:
+                return context["guild"]
             return context["$origin_event"].guild
 
 

arclet/entari/filter.py

@@ -0,0 +1,34 @@
+from typing import Optional
+
+from arclet.letoderea import Contexts, JudgeAuxiliary, Scope
+from satori import Channel, ChannelType
+
+
+class DirectMessageJudger(JudgeAuxiliary):
+    async def __call__(self, scope: Scope, context: Contexts) -> Optional[bool]:
+        if "channel" not in context:
+            return False
+        channel: Channel = context["channel"]
+        return channel.type == ChannelType.DIRECT
+
+    @property
+    def scopes(self) -> set[Scope]:
+        return {Scope.prepare}
+
+
+is_direct_message = DirectMessageJudger()
+
+
+class PublicMessageJudger(JudgeAuxiliary):
+    async def __call__(self, scope: Scope, context: Contexts) -> Optional[bool]:
+        if "channel" not in context:
+            return False
+        channel: Channel = context["channel"]
+        return channel.type != ChannelType.DIRECT
+
+    @property
+    def scopes(self) -> set[Scope]:
+        return {Scope.prepare}
+
+
+is_public_message = PublicMessageJudger()

arclet/entari/message.py

@@ -15,7 +15,7 @@
 class MessageChain(list[TE]):
     """消息序列
 
-    参数:
+    Args:
         message: 消息内容
     """
 
@@ -101,54 +101,54 @@ def __iadd__(self, other: str | TE | Iterable[TE]) -> Self:
     def __getitem__(self, args: type[TE1]) -> MessageChain[TE1]:
         """获取仅包含指定消息段类型的消息
 
-        参数:
+        Args:
             args: 消息段类型
 
-        返回:
+        Return:
             所有类型为 `args` 的消息段
         """
 
     @overload
     def __getitem__(self, args: tuple[type[TE1], int]) -> TE1:
         """索引指定类型的消息段
 
-        参数:
+        Args:
             args: 消息段类型和索引
 
-        返回:
+        Return:
             类型为 `args[0]` 的消息段第 `args[1]` 个
         """
 
     @overload
     def __getitem__(self, args: tuple[type[TE1], slice]) -> MessageChain[TE1]:
         """切片指定类型的消息段
 
-        参数:
+        Args:
             args: 消息段类型和切片
 
-        返回:
+        Return:
             类型为 `args[0]` 的消息段切片 `args[1]`
         """
 
     @overload
     def __getitem__(self, args: int) -> TE:
         """索引消息段
 
-        参数:
+        Args:
             args: 索引
 
-        返回:
+        Return:
             第 `args` 个消息段
         """
 
     @overload
     def __getitem__(self, args: slice) -> Self:
         """切片消息段
 
-        参数:
+        Args:
             args: 切片
 
-        返回:
+        Return:
             消息切片 `args`
         """
 
@@ -174,9 +174,9 @@ def __getitem__(
     def __contains__(self, value: str | Element | type[Element]) -> bool:
         """检查消息段是否存在
 
-        参数:
+        Args:
             value: 消息段或消息段类型
-        返回:
+        Return:
             消息内是否存在给定消息段或给定类型的消息段
         """
         if isinstance(value, type):
@@ -186,20 +186,19 @@ def __contains__(self, value: str | Element | type[Element]) -> bool:
         return super().__contains__(value)
 
     def has(self, value: str | Element | type[Element]) -> bool:
-        """与 {ref}``__contains__` <nonebot.adapters.Message.__contains__>` 相同"""
         return value in self
 
     def index(self, value: str | Element | type[Element], *args: SupportsIndex) -> int:
         """索引消息段
 
-        参数:
+        Args:
             value: 消息段或者消息段类型
-            arg: start 与 end
+            args: start 与 end
 
-        返回:
+        Return:
             索引 index
 
-        异常:
+        Raise:
             ValueError: 消息段不存在
         """
         if isinstance(value, type):
@@ -214,11 +213,11 @@ def index(self, value: str | Element | type[Element], *args: SupportsIndex) -> i
     def get(self, type_: type[TE], count: int | None = None) -> MessageChain[TE]:
         """获取指定类型的消息段
 
-        参数:
+        Args:
             type_: 消息段类型
             count: 获取个数
 
-        返回:
+        Return:
             构建的新消息
         """
         if count is None:
@@ -235,10 +234,10 @@ def get(self, type_: type[TE], count: int | None = None) -> MessageChain[TE]:
     def count(self, value: type[Element] | str | Element) -> int:
         """计算指定消息段的个数
 
-        参数:
+        Args:
             value: 消息段或消息段类型
 
-        返回:
+        Return:
             个数
         """
         if isinstance(value, str):
@@ -252,10 +251,10 @@ def count(self, value: type[Element] | str | Element) -> int:
     def only(self, value: type[Element] | str | Element) -> bool:
         """检查消息中是否仅包含指定消息段
 
-        参数:
+        Args:
             value: 指定消息段或消息段类型
 
-        返回:
+        Return:
             是否仅包含指定消息段
         """
         if isinstance(value, type):
@@ -267,10 +266,10 @@ def only(self, value: type[Element] | str | Element) -> bool:
     def join(self, iterable: Iterable[TE1 | MessageChain[TE1]]) -> MessageChain[TE | TE1]:
         """将多个消息连接并将自身作为分割
 
-        参数:
+        Args:
             iterable: 要连接的消息
 
-        返回:
+        Return:
             连接后的消息
         """
         ret = MessageChain()
@@ -287,24 +286,24 @@ def copy(self) -> MessageChain[TE]:
         """深拷贝消息"""
         return deepcopy(self)
 
-    def include(self, *types: type[Element]) -> Self:
+    def include(self, *types: type[Element]) -> MessageChain:
         """过滤消息
 
-        参数:
+        Args:
             types: 包含的消息段类型
 
-        返回:
+        Return:
             新构造的消息
         """
         return MessageChain(seg for seg in self if seg.__class__ in types)
 
-    def exclude(self, *types: type[Element]) -> Self:
+    def exclude(self, *types: type[Element]) -> MessageChain:
         """过滤消息
 
-        参数:
+        Args:
             types: 不包含的消息段类型
 
-        返回:
+        Return:
             新构造的消息
         """
         return MessageChain(seg for seg in self if seg.__class__ not in types)

example_plugin.py

@@ -1,17 +1,17 @@
-from arclet.entari import MessageCreatedEvent, Plugin, EntariCommands, ContextSession, AlconnaDispatcher
-from arclet.alconna import Alconna
+from arclet.entari import MessageCreatedEvent, Plugin, EntariCommands, ContextSession, AlconnaDispatcher, is_direct_message
+from arclet.alconna import Alconna, Args, AllParam
 
 plug = Plugin()
 
 disp_message = plug.dispatch(MessageCreatedEvent)
 
 
-@disp_message.on()
+@disp_message.on(auxiliaries=[is_direct_message])
 async def _(event: MessageCreatedEvent):
     print(event.content)
 
 
-on_alconna = plug.mount(AlconnaDispatcher(Alconna("test")))
+on_alconna = plug.mount(AlconnaDispatcher(Alconna("chat", Args["content", AllParam])))
 
 
 @on_alconna.on()

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "arclet-entari"
-version = "0.3.1"
+version = "0.3.2"
 description = "Simple IM Framework based on satori-python"
 authors = [
     {name = "RF-Tar-Railt",email = "rf_tar_railt@qq.com"},