🔥 remove cqhttp api self_id arg

This commit is contained in:
yanyongyu
2021-05-25 16:59:26 +08:00
parent 918b375ece
commit 27fe6e4fcb

View File

@ -68,8 +68,7 @@ class Bot(BaseBot):
async def handle_message(self, message: dict):
...
async def call_api(self, api: str, *, self_id: Optional[str],
**data) -> Any:
async def call_api(self, api: str, *, **data) -> Any:
...
async def send(self, event: Event, message: Union[str, Message,
@ -77,12 +76,13 @@ class Bot(BaseBot):
**kwargs) -> Any:
...
async def send_private_msg(self,
*,
user_id: int,
message: Union[str, Message],
auto_escape: bool = ...,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def send_private_msg(
self,
*,
user_id: int,
message: Union[str, Message],
auto_escape: bool = ...,
) -> Dict[str, Any]:
"""
:说明:
@ -93,16 +93,17 @@ class Bot(BaseBot):
* ``user_id``: 对方 QQ 号
* ``message``: 要发送的内容
* ``auto_escape``: 消息内容是否作为纯文本发送(即不解析 CQ 码),只在 ``message`` 字段是字符串时有效
* ``self_id``: 机器人 QQ 号
"""
...
async def send_group_msg(self,
*,
group_id: int,
message: Union[str, Message],
auto_escape: bool = ...,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def send_group_msg(
self,
*,
group_id: int,
message: Union[str, Message],
auto_escape: bool = ...,
) -> Dict[str, Any]:
"""
:说明:
@ -113,18 +114,19 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``message``: 要发送的内容
* ``auto_escape``: 消息内容是否作为纯文本发送(即不解析 CQ 码),只在 ``message`` 字段是字符串时有效
* ``self_id``: 机器人 QQ 号
"""
...
async def send_msg(self,
*,
message_type: Optional[str] = ...,
user_id: Optional[int] = ...,
group_id: Optional[int] = ...,
message: Union[str, Message],
auto_escape: bool = ...,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def send_msg(
self,
*,
message_type: Optional[str] = ...,
user_id: Optional[int] = ...,
group_id: Optional[int] = ...,
message: Union[str, Message],
auto_escape: bool = ...,
) -> Dict[str, Any]:
"""
:说明:
@ -137,14 +139,15 @@ class Bot(BaseBot):
* ``group_id``: 群号(消息类型为 ``group`` 时需要)
* ``message``: 要发送的内容
* ``auto_escape``: 消息内容是否作为纯文本发送(即不解析 CQ 码),只在 ``message`` 字段是字符串时有效
* ``self_id``: 机器人 QQ 号
"""
...
async def delete_msg(self,
*,
message_id: int,
self_id: Optional[int] = ...) -> None:
async def delete_msg(
self,
*,
message_id: int,
) -> None:
"""
:说明:
@ -153,14 +156,15 @@ class Bot(BaseBot):
:参数:
* ``message_id``: 消息 ID
* ``self_id``: 机器人 QQ 号
"""
...
async def get_msg(self,
*,
message_id: int,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_msg(
self,
*,
message_id: int,
) -> Dict[str, Any]:
"""
:说明:
@ -169,14 +173,15 @@ class Bot(BaseBot):
:参数:
* ``message_id``: 消息 ID
* ``self_id``: 机器人 QQ 号
"""
...
async def get_forward_msg(self,
*,
id: int,
self_id: Optional[int] = ...) -> None:
async def get_forward_msg(
self,
*,
id: int,
) -> None:
"""
:说明:
@ -185,15 +190,16 @@ class Bot(BaseBot):
:参数:
* ``id``: 合并转发 ID
* ``self_id``: 机器人 QQ 号
"""
...
async def send_like(self,
*,
user_id: int,
times: int = ...,
self_id: Optional[int] = ...) -> None:
async def send_like(
self,
*,
user_id: int,
times: int = ...,
) -> None:
"""
:说明:
@ -203,16 +209,17 @@ class Bot(BaseBot):
* ``user_id``: 对方 QQ 号
* ``times``: 赞的次数,每个好友每天最多 10 次
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_kick(self,
*,
group_id: int,
user_id: int,
reject_add_request: bool = ...,
self_id: Optional[int] = ...) -> None:
async def set_group_kick(
self,
*,
group_id: int,
user_id: int,
reject_add_request: bool = ...,
) -> None:
"""
:说明:
@ -223,16 +230,17 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``user_id``: 要踢的 QQ 号
* ``reject_add_request``: 拒绝此人的加群请求
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_ban(self,
*,
group_id: int,
user_id: int,
duration: int = ...,
self_id: Optional[int] = ...) -> None:
async def set_group_ban(
self,
*,
group_id: int,
user_id: int,
duration: int = ...,
) -> None:
"""
:说明:
@ -243,17 +251,18 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``user_id``: 要禁言的 QQ 号
* ``duration``: 禁言时长,单位秒,``0`` 表示取消禁言
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_anonymous_ban(self,
*,
group_id: int,
anonymous: Optional[Dict[str, Any]] = ...,
anonymous_flag: Optional[str] = ...,
duration: int = ...,
self_id: Optional[int] = ...) -> None:
async def set_group_anonymous_ban(
self,
*,
group_id: int,
anonymous: Optional[Dict[str, Any]] = ...,
anonymous_flag: Optional[str] = ...,
duration: int = ...,
) -> None:
"""
:说明:
@ -265,15 +274,16 @@ class Bot(BaseBot):
* ``anonymous``: 可选,要禁言的匿名用户对象(群消息上报的 ``anonymous`` 字段)
* ``anonymous_flag``: 可选,要禁言的匿名用户的 flag需从群消息上报的数据中获得
* ``duration``: 禁言时长,单位秒,无法取消匿名用户禁言
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_whole_ban(self,
*,
group_id: int,
enable: bool = ...,
self_id: Optional[int] = ...) -> None:
async def set_group_whole_ban(
self,
*,
group_id: int,
enable: bool = ...,
) -> None:
"""
:说明:
@ -283,16 +293,17 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``enable``: 是否禁言
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_admin(self,
*,
group_id: int,
user_id: int,
enable: bool = ...,
self_id: Optional[int] = ...) -> None:
async def set_group_admin(
self,
*,
group_id: int,
user_id: int,
enable: bool = ...,
) -> None:
"""
:说明:
@ -303,15 +314,16 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``user_id``: 要设置管理员的 QQ 号
* ``enable``: ``True`` 为设置,``False`` 为取消
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_anonymous(self,
*,
group_id: int,
enable: bool = ...,
self_id: Optional[int] = ...) -> None:
async def set_group_anonymous(
self,
*,
group_id: int,
enable: bool = ...,
) -> None:
"""
:说明:
@ -321,16 +333,17 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``enable``: 是否允许匿名聊天
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_card(self,
*,
group_id: int,
user_id: int,
card: str = ...,
self_id: Optional[int] = ...) -> None:
async def set_group_card(
self,
*,
group_id: int,
user_id: int,
card: str = ...,
) -> None:
"""
:说明:
@ -341,15 +354,16 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``user_id``: 要设置的 QQ 号
* ``card``: 群名片内容,不填或空字符串表示删除群名片
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_name(self,
*,
group_id: int,
group_name: str,
self_id: Optional[int] = ...) -> None:
async def set_group_name(
self,
*,
group_id: int,
group_name: str,
) -> None:
"""
:说明:
@ -359,15 +373,16 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``group_name``: 新群名
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_leave(self,
*,
group_id: int,
is_dismiss: bool = ...,
self_id: Optional[int] = ...) -> None:
async def set_group_leave(
self,
*,
group_id: int,
is_dismiss: bool = ...,
) -> None:
"""
:说明:
@ -377,17 +392,18 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``is_dismiss``: 是否解散,如果登录号是群主,则仅在此项为 True 时能够解散
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_special_title(self,
*,
group_id: int,
user_id: int,
special_title: str = ...,
duration: int = ...,
self_id: Optional[int] = ...) -> None:
async def set_group_special_title(
self,
*,
group_id: int,
user_id: int,
special_title: str = ...,
duration: int = ...,
) -> None:
"""
:说明:
@ -399,16 +415,17 @@ class Bot(BaseBot):
* ``user_id``: 要设置的 QQ 号
* ``special_title``: 专属头衔,不填或空字符串表示删除专属头衔
* ``duration``: 专属头衔有效期,单位秒,-1 表示永久,不过此项似乎没有效果,可能是只有某些特殊的时间长度有效,有待测试
* ``self_id``: 机器人 QQ 号
"""
...
async def set_friend_add_request(self,
*,
flag: str,
approve: bool = ...,
remark: str = ...,
self_id: Optional[int] = ...) -> None:
async def set_friend_add_request(
self,
*,
flag: str,
approve: bool = ...,
remark: str = ...,
) -> None:
"""
:说明:
@ -419,17 +436,18 @@ class Bot(BaseBot):
* ``flag``: 加好友请求的 flag需从上报的数据中获得
* ``approve``: 是否同意请求
* ``remark``: 添加后的好友备注(仅在同意时有效)
* ``self_id``: 机器人 QQ 号
"""
...
async def set_group_add_request(self,
*,
flag: str,
sub_type: str,
approve: bool = ...,
reason: str = ...,
self_id: Optional[int] = ...) -> None:
async def set_group_add_request(
self,
*,
flag: str,
sub_type: str,
approve: bool = ...,
reason: str = ...,
) -> None:
"""
:说明:
@ -441,29 +459,25 @@ class Bot(BaseBot):
* ``sub_type``: ``add`` 或 ``invite``,请求类型(需要和上报消息中的 ``sub_type`` 字段相符)
* ``approve``: 是否同意请求/邀请
* ``reason``: 拒绝理由(仅在拒绝时有效)
* ``self_id``: 机器人 QQ 号
"""
...
async def get_login_info(self,
*,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_login_info(self) -> Dict[str, Any]:
"""
:说明:
获取登录号信息。
:参数:
* ``self_id``: 机器人 QQ 号
"""
...
async def get_stranger_info(self,
*,
user_id: int,
no_cache: bool = ...,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_stranger_info(
self,
*,
user_id: int,
no_cache: bool = ...,
) -> Dict[str, Any]:
"""
:说明:
@ -473,30 +487,25 @@ class Bot(BaseBot):
* ``user_id``: QQ 号
* ``no_cache``: 是否不使用缓存(使用缓存可能更新不及时,但响应更快)
* ``self_id``: 机器人 QQ 号
"""
...
async def get_friend_list(self,
*,
self_id: Optional[int] = ...
) -> List[Dict[str, Any]]:
async def get_friend_list(self) -> List[Dict[str, Any]]:
"""
:说明:
获取好友列表。
:参数:
* ``self_id``: 机器人 QQ 号
"""
...
async def get_group_info(self,
*,
group_id: int,
no_cache: bool = ...,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_group_info(
self,
*,
group_id: int,
no_cache: bool = ...,
) -> Dict[str, Any]:
"""
:说明:
@ -506,32 +515,26 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``no_cache``: 是否不使用缓存(使用缓存可能更新不及时,但响应更快)
* ``self_id``: 机器人 QQ 号
"""
...
async def get_group_list(self,
*,
self_id: Optional[int] = ...
) -> List[Dict[str, Any]]:
async def get_group_list(self) -> List[Dict[str, Any]]:
"""
:说明:
获取群列表。
:参数:
* ``self_id``: 机器人 QQ 号
"""
...
async def get_group_member_info(
self,
*,
group_id: int,
user_id: int,
no_cache: bool = ...,
self_id: Optional[int] = ...) -> Dict[str, Any]:
self,
*,
group_id: int,
user_id: int,
no_cache: bool = ...,
) -> Dict[str, Any]:
"""
:说明:
@ -542,15 +545,15 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``user_id``: QQ 号
* ``no_cache``: 是否不使用缓存(使用缓存可能更新不及时,但响应更快)
* ``self_id``: 机器人 QQ 号
"""
...
async def get_group_member_list(
self,
*,
group_id: int,
self_id: Optional[int] = ...) -> List[Dict[str, Any]]:
self,
*,
group_id: int,
) -> List[Dict[str, Any]]:
"""
:说明:
@ -559,16 +562,16 @@ class Bot(BaseBot):
:参数:
* ``group_id``: 群号
* ``self_id``: 机器人 QQ 号
"""
...
async def get_group_honor_info(self,
*,
group_id: int,
type: str = ...,
self_id: Optional[int] = ...
) -> Dict[str, Any]:
async def get_group_honor_info(
self,
*,
group_id: int,
type: str = ...,
) -> Dict[str, Any]:
"""
:说明:
@ -578,14 +581,15 @@ class Bot(BaseBot):
* ``group_id``: 群号
* ``type``: 要获取的群荣誉类型,可传入 ``talkative`` ``performer`` ``legend`` ``strong_newbie`` ``emotion`` 以分别获取单个类型的群荣誉数据,或传入 ``all`` 获取所有数据
* ``self_id``: 机器人 QQ 号
"""
...
async def get_cookies(self,
*,
domain: str = ...,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_cookies(
self,
*,
domain: str = ...,
) -> Dict[str, Any]:
"""
:说明:
@ -594,28 +598,24 @@ class Bot(BaseBot):
:参数:
* ``domain``: 需要获取 cookies 的域名
* ``self_id``: 机器人 QQ 号
"""
...
async def get_csrf_token(self,
*,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_csrf_token(self) -> Dict[str, Any]:
"""
:说明:
获取 CSRF Token。
:参数:
* ``self_id``: 机器人 QQ 号
"""
...
async def get_credentials(self,
*,
domain: str = ...,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_credentials(
self,
*,
domain: str = ...,
) -> Dict[str, Any]:
"""
:说明:
@ -624,15 +624,16 @@ class Bot(BaseBot):
:参数:
* ``domain``: 需要获取 cookies 的域名
* ``self_id``: 机器人 QQ 号
"""
...
async def get_record(self,
*,
file: str,
out_format: str,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_record(
self,
*,
file: str,
out_format: str,
) -> Dict[str, Any]:
"""
:说明:
@ -642,14 +643,15 @@ class Bot(BaseBot):
* ``file``: 收到的语音文件名CQ 码的 ``file`` 参数),如 ``0B38145AA44505000B38145AA4450500.silk``
* ``out_format``: 要转换到的格式,目前支持 ``mp3``、``amr``、``wma``、``m4a``、``spx``、``ogg``、``wav``、``flac``
* ``self_id``: 机器人 QQ 号
"""
...
async def get_image(self,
*,
file: str,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_image(
self,
*,
file: str,
) -> Dict[str, Any]:
"""
:说明:
@ -658,70 +660,51 @@ class Bot(BaseBot):
:参数:
* ``file``: 收到的图片文件名CQ 码的 ``file`` 参数),如 ``6B4DE3DFD1BD271E3297859D41C530F5.jpg``
* ``self_id``: 机器人 QQ 号
"""
...
async def can_send_image(self,
*,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def can_send_image(self) -> Dict[str, Any]:
"""
:说明:
检查是否可以发送图片。
:参数:
* ``self_id``: 机器人 QQ 号
"""
...
async def can_send_record(self,
*,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def can_send_record(self) -> Dict[str, Any]:
"""
:说明:
检查是否可以发送语音。
:参数:
* ``self_id``: 机器人 QQ 号
"""
...
async def get_status(self,
*,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_status(self) -> Dict[str, Any]:
"""
:说明:
获取插件运行状态。
:参数:
* ``self_id``: 机器人 QQ 号
"""
...
async def get_version_info(self,
*,
self_id: Optional[int] = ...) -> Dict[str, Any]:
async def get_version_info(self) -> Dict[str, Any]:
"""
:说明:
获取版本信息。
:参数:
* ``self_id``: 机器人 QQ 号
"""
...
async def set_restart(self,
*,
delay: int = ...,
self_id: Optional[int] = ...) -> None:
async def set_restart(
self,
*,
delay: int = ...,
) -> None:
"""
:说明:
@ -730,18 +713,15 @@ class Bot(BaseBot):
:参数:
* ``delay``: 要延迟的毫秒数,如果默认情况下无法重启,可以尝试设置延迟为 2000 左右
* ``self_id``: 机器人 QQ 号
"""
...
async def clean_cache(self, *, self_id: Optional[int] = ...) -> None:
async def clean_cache(self) -> None:
"""
:说明:
清理数据目录。
:参数:
* ``self_id``: 机器人 QQ 号
"""
...