icalingua-python-bot/ica-rs/ica_typing.py
shenjack 469db17c3b
更新 IcaClient 类,添加 version 属性***
***更新 IcaClientPy 类,添加 get_version 方法***
***更新 base.py,修改回复消息中的版本号显示
2024-02-25 21:33:11 +08:00

152 lines
3.3 KiB
Python

# Python 兼容版本 3.8+
from typing import Callable, Tuple
"""
pub type RoomId = i64;
pub type UserId = i64;
pub type MessageId = String;
"""
RoomId = int
UserId = int
MessageId = str
class IcaStatus:
"""
ica状态信息
此类并不存储信息, 所有方法都是实时获取
"""
@property
def login(self) -> bool:
...
@property
def online(self) -> bool:
...
@property
def self_id(self) -> UserId:
...
@property
def nick_name(self) -> str:
...
@property
def ica_version(self) -> str:
...
@property
def os_info(self) -> str:
...
@property
def resident_set_size(self) -> str:
...
@property
def head_used(self) -> str:
...
@property
def load_average(self) -> str:
...
class ReplyMessage:
...
class SendMessage:
@property
def content(self) -> str:
...
@content.setter
def content(self, value: str) -> None:
...
def with_content(self, content: str) -> "SendMessage":
"""
为了链式调用, 返回自身
"""
self.content = content
return self
class DeleteMessage:
def __str__(self):
...
class NewMessage:
def reply_with(self, message: str) -> SendMessage:
...
def as_deleted(self) -> DeleteMessage:
...
def __str__(self) -> str:
...
@property
def id(self) -> MessageId:
...
@property
def content(self) -> str:
...
@property
def sender_id(self) -> UserId:
...
@property
def is_from_self(self) -> bool:
...
@property
def is_reply(self) -> bool:
...
class IcaClient:
@staticmethod
async def send_message_a(client: "IcaClient", message: SendMessage) -> bool:
"""
仅作占位, 不能使用
(因为目前来说, rust调用 Python端没法启动一个异步运行时
所以只能 tokio::task::block_in_place 转换成同步调用)
"""
def send_message(self, message: SendMessage) -> bool:
...
def send_and_warn(self, message: SendMessage) -> bool:
"""发送消息, 并在日志中输出警告信息"""
self.warn(message.content)
return self.send_message(message)
def delete_message(self, message: DeleteMessage) -> bool:
...
@property
def status() -> IcaStatus:
...
@property
def version() -> str:
...
def debug(self, message: str) -> None:
"""向日志中输出调试信息"""
def info(self, message: str) -> None:
"""向日志中输出信息"""
def warn(self, message: str) -> None:
"""向日志中输出警告信息"""
class ConfigData:
def __getitem__(self, key: str):
...
def have_key(self, key: str) -> bool:
...
on_load = Callable[[IcaClient], None]
# def on_load(client: IcaClient) -> None:
# ...
on_message = Callable[[NewMessage, IcaClient], None]
# def on_message(msg: NewMessage, client: IcaClient) -> None:
# ...
on_delete_message = Callable[[MessageId, IcaClient], None]
# def on_delete_message(msg_id: MessageId, client: IcaClient) -> None:
# ...
on_config = Callable[[None], Tuple[str, str]]
CONFIG_DATA: ConfigData = ConfigData()