0.0.8

Author: RF-Tar-Railt

README.md

@@ -1,17 +1,54 @@
+<div align="center"> 
+  
 # Edoves
-A new abstract framework based on Cesloi
 
-## Example
+  > _las su dres rin romilu, nann sune ri edar neru._
+  
+</div>
+
+## 简介
+[![Licence](https://img.shields.io/github/license/ArcletProject/Edoves)](https://github.com/ArcletProject/Edoves/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/arclet-edoves)](https://pypi.org/project/arclet-edoves)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/arclet-edoves)](https://www.python.org/)
+
+Edoves 是 `Arclet Project` 基于同项目下的 `Cesloi`的 **第二代** 框架实现, 
+
+**该框架目前处于快速迭代状态, API 可能会发生 _剧烈_ 变化, 可能还不适合进行生产性的开发与运维**
+
+## 特性
++ 主要部分
+    - [x] `InteractiveObject`: 对`Unity3d`中`GameObject`的简易模仿
+        - [x] `Monomer`: 代表逻辑关系的IO
+        - [x] `Module`: 负责处理事件的IO
+            - [x] `ServerDocker`: 负责网络会话交互
+            - [x] `Commander`: 基于 `Arclet Alconna` 的指令触发系统
+    - [x] `Component`: IO的主要属性, 负责实际的数据管理与事件响应
+    - [x] `Medium`: 传输事件信息的载体
+    - [x] `Protocol`: 调度`Medium`与`IO`
+    - [x] `Scene`: 对IO统一的生命周期管理
+
++ 实现支持
+    - [x] `Edoves for mirai-api-http` : 对 [ `mirai-api-http` ](https://github.com/project-mirai/mirai-api-http) 的支持.
+    - [ ] `Edoves for OneBot` : 对  [ `OneBot` ](https://github.com/botuniverse/onebot) 的协议实现.
+    - [ ] `Edoves for go-cqhttp` : 对 [ `go-cqhttp` ](https://github.com/Mrs4s/go-cqhttp) 的扩展 API 支持.
+
+## 样例
 
 main.py:
 ```python
-from arclet.edoves.builtin.mah.messages import Source
+from arclet.edoves.builtin.mah.actions import Reply
 from arclet.edoves.builtin.mah.module import MessageModule
-from arclet.edoves.builtin.commander import Commander
 from arclet.edoves.builtin.medium import Message
 from arclet.edoves.builtin.event.message import AllMessage
-from arclet.edoves.main import Edoves, Monomer
 from arclet.edoves.builtin.client import AioHttpClient
+from arclet.edoves.main import Edoves
+
+
+async def test_message_reaction(message: Message):
+    if message.content.startswith("Hello World"):
+        await Reply(message).execute()
+        await message.set("I received 'Hello World'!").send()
+
 
 app = Edoves(
     debug=False,
@@ -23,26 +60,6 @@ app = Edoves(
     }
 )
 message_module = app.scene.activate_module(MessageModule)
-commander = app.scene.activate_module(Commander)    
-
-
-@commander.command("print <content:str>")
-async def _(content: str, message: Message, sender: Monomer, bot: Edoves):
-    await message.set("This is commander test").send()
-    await message.set(f"I received content:{content} from {sender.metadata.name}").send()
-    if content == "all_group":
-        await message.set(f"{[k.metadata.name for k in bot.self.filter_parents('Group')]}").send()
-    if content == "friend":
-        await message.set(f"{[k.metadata.name for k in bot.self.filter_children('Friend')]}").send()
-
-
-async def test_message_reaction(message: Message):
-    if message.content.startswith("Hello"):
-        await message.purveyor.action("send_with")(
-            message, reply=True, quote=message.content.find(Source).id, type=message.type)
-        await message.set("I received 'Hello World!'").send()
-
-
 message_module.new_handler(AllMessage, test_message_reaction)
 app.run()
 ```
@@ -61,3 +78,20 @@ class MessageModule(BaseModule):
 
 
 ```
+
+## 相关项目
+
+> 这些项目都非常优秀, 我相信你听说过他们
+
++ [`Graia Framework`](https://github.com/GraiaProject)
+  - [`Avilla`](https://github.com/GraiaProject/Avilla): `Graia Project` 的 "下一代" 框架实现
+  - [ `Ariadne` ](https://github.com/GraiaProject/Ariadne): 继承了 `Graia Project` 中 `Application` 并进行了许多改进后产生的作品
++ [ `Mamoe Technologies` ](https://github.com/mamoe):
+    - [ `mirai` ](https://github.com/mamoe/mirai)
+    - [ `mirai-api-http` ](https://github.com/project-mirai/mirai-api-http)
+
+## 开源协议
+
+Edoves 及其拓展 使用 MIT 作为开源协议.
+
+但如果你若引用到了使用具有传染性开源协议（如 GPL/AGPL/LGPL 等）的项目, 请遵循相关规则.

arclet/edoves/builtin/__init__.py

@@ -0,0 +1 @@
+"""Edoves 内置组件"""

arclet/edoves/builtin/actions.py

@@ -0,0 +1,42 @@
+import inspect
+from typing import Optional
+from ..main.action import ExecutiveAction
+from .medium import Message
+
+
+class MessageAction(ExecutiveAction):
+    data: Message
+    action: str
+
+    def __init__(self, action: str, message: Message):
+        super().__init__(message)
+        self.action = action
+
+    async def execute(self):
+        return await self.target.action(self.action)(
+            self.data
+        )
+
+
+class MessageSend(MessageAction):
+
+    def __init__(self, message: Optional[Message] = None):
+        if not message:
+            try:
+                lcs = inspect.currentframe().f_back.f_back.f_locals
+                for v in lcs.values():
+                    if isinstance(v, Message):
+                        message = v
+            except AttributeError:
+                raise ValueError
+            else:
+                if not message:
+                    raise ValueError
+        super().__init__("send_with", message)
+
+
+class MessageSendDirectly(MessageSend):
+    async def execute(self):
+        return await self.target.action(self.action)(
+            self.data, type=self.data.type
+        )

arclet/edoves/builtin/client.py

@@ -13,6 +13,9 @@ class AioHttpClient(NetworkClient):
     def __init__(self):
         self.session = ClientSession()
 
+    async def close(self):
+        await self.session.close()
+
     @asynccontextmanager
     async def ensure_network(
             self,
@@ -22,11 +25,7 @@ async def ensure_network(
             timeout: float = 10.0,
             **kwargs: Any
     ):
-        # async with self.session.ws_connect(
-        #         url, timeout=timeout, **kwargs
-        # ) as resp:
-        #     yield NetworkResponse(get_connection=lambda: resp)
-        resp = await self.session.ws_connect(url, timeout=timeout, **kwargs).__aenter__()
+        resp: ClientWebSocketResponse = await self.session.ws_connect(url, timeout=timeout, **kwargs).__aenter__()
         yield NetworkResponse(get_connection=lambda: resp)
 
     @asynccontextmanager

arclet/edoves/builtin/combiner.py

@@ -0,0 +1,33 @@
+from typing import TypeVar, Union, Type, Optional
+from inspect import isclass
+from ..main.behavior import BaseBehavior
+
+TB = TypeVar("TB", bound=BaseBehavior)
+
+
+def combine_behaviors(*behavior: Union[Type[TB], TB]) -> Optional[Type[BaseBehavior]]:
+    """
+    混合传入的行为器, 要求传入的所有行为器的父类与io属性类型一致
+
+    Behavior_B(BehaviorA){io: Monomer}, Behavior_C(BehaviorA){io: Monomer}  # 通过
+
+    Behavior_B(BehaviorA){io: Monomer}, Behavior_C(BehaviorD){io: Monomer}  # 不通过
+
+    Behavior_B(BehaviorA){io: Module}, Behavior_C(BehaviorA){io: Monomer}  # 不通过
+
+    """
+    if not behavior:
+        return
+    base = behavior[0].__base__ if isclass(behavior[0]) else behavior[0].__class__.__base__
+    io = behavior[0].__annotations__.get("io") if isclass(behavior[0]) else behavior[0].io.__class__
+    for be in behavior:
+        if isclass(be):
+            if be.__base__ != base or be.__annotations__.get("io") != io:
+                return
+        else:
+            if be.__class__.__base__ != base or be.io.__class__ != io:
+                return
+
+    class CombineBehavior(*behavior):
+        pass
+    return CombineBehavior

arclet/edoves/builtin/commander.py

@@ -25,6 +25,8 @@ async def exec(self, params):
 
 class CommanderData(ModuleMetaComponent):
     identifier = EDOVES_DEFAULT
+    name = "Command of Edoves"
+    description = "Based on Edoves and Arclet-Alconna"
 
 
 class CommandParsers(Component):

arclet/edoves/builtin/event/__init__.py

@@ -0,0 +1,2 @@
+from .message import AllMessage
+from .network import DockerOperate

arclet/edoves/builtin/mah/actions.py

@@ -0,0 +1,11 @@
+from ..actions import MessageSend
+from .chain import Source
+
+MessageSend = MessageSend
+
+
+class Reply(MessageSend):
+    async def execute(self):
+        return await self.target.action(self.action)(
+            self.data, reply=True, quote=self.data.content.find(Source).id
+        )

arclet/edoves/builtin/mah/monomers.py

@@ -28,7 +28,7 @@ class MiraiMonoMetadata(MonoMetaComponent):
     joinTimestamp: Optional[int]
     lastSpeakTimestamp: Optional[int]
     mutetimeRemaining: Optional[int]
-    group: Optional[str]
+    group_id: Optional[str]
 
     def update_data(self, name: str, value: Any):
         if not self.__dict__.get(name):
@@ -53,8 +53,8 @@ def __init__(
             self.get_component(MiraiMonoMetadata).update_data(k, v)
 
     @property
-    def group(self):
-        return self.parents[self.metadata.group] if hasattr(self.metadata, "group") else None
+    def current_group(self):
+        return self.parents[self.metadata.group_id] if hasattr(self.metadata, "group_id") else None
 
     def avatar(self):
         return f'https://q4.qlogo.cn/g?b=qq&nk={self.metadata.identifier}&s=140'

arclet/edoves/builtin/mah/protocol.py

@@ -1,5 +1,6 @@
 from typing import Dict, TYPE_CHECKING, List, Type
 
+from ...utilles import IOStatus
 from .monomers import MiraiMonomer
 from ..medium import Message
 from .chain import MessageChain
@@ -17,6 +18,8 @@ class MAHProtocol(NetworkProtocol):
     async def medium_transport(self, action: str):
         server = list(self.storage.values())[-1]
         medium = await self.get_medium()
+        if server.metadata.state in (IOStatus.CLOSED, IOStatus.CLOSE_WAIT):
+            return
         if action.endswith("message"):
             rest = medium.get('rest')
             may_action = rest.get('type')
@@ -27,12 +30,12 @@ async def medium_transport(self, action: str):
                     action = "sendFriendMessage"
                 elif may_action.startswith("Group") and sender.compare("Member"):
                     if sender.parents:
-                        target = sender.metadata.group
+                        target = sender.metadata.group_id
                         action = "sendGroupMessage"
             else:
                 if sender.prime_tag == "Member":
                     if sender.parents:
-                        target = sender.metadata.group
+                        target = sender.metadata.group_id
                         action = "sendGroupMessage"
                 elif sender.prime_tag == "Friend":
                     action = "sendFriendMessage"
@@ -111,19 +114,19 @@ async def parse_raw_data(self, data: Dict):
                             group_data.get("name"),
                             group_data.get("id"),
                             **{
-                                "permission": sender_data.get("permission"),
+                                "permission": group_data.get("permission"),
                             }
                         )
                         self.scene.monomers.setdefault(group.metadata.identifier, group)
                     else:
-                        group.metadata.update_data("name", sender_data.get("name"))
-                        group.metadata.update_data("permission", sender_data.get("permission"))
+                        group.metadata.update_data("name", group_data.get("name"))
+                        group.metadata.update_data("permission", group_data.get("permission"))
 
                     group.set_child(self.scene.edoves.self)
                     group.set_prime_tag("Group")
                     if sender_id not in group.children:
                         group.set_child(sender)
-                    sender.metadata.update_data("group", group.metadata.identifier)
+                    sender.metadata.update_data("group_id", group.metadata.identifier)
                 else:
                     if not (sender := self.scene.monomers.get(sender_id)):
                         sender = MiraiMonomer(