Lib.utils.Actions

  1"""
  2操作
  3"""
  4
  5import traceback
  6
  7from Lib.common import save_exc_dump
  8from Lib.core import OnebotAPI, ThreadPool, ConfigManager
  9from Lib.utils import QQRichText, Logger, QQDataCacher
 10
 11logger = Logger.get_logger()
 12
 13from typing import Generic, TypeVar, Union, Callable
 14
 15api = OnebotAPI.OnebotAPI()
 16
 17T = TypeVar("T")  # 成功类型
 18E = TypeVar("E")  # 错误类型
 19
 20
 21class Result(Generic[T, E]):
 22    """
 23    结果类
 24    """
 25
 26    def __init__(self, value: Union[T, E], is_ok: bool):
 27        self._value = value
 28        self._is_ok = is_ok
 29
 30    @property
 31    def is_ok(self) -> bool:
 32        """
 33        判断是否成功
 34        Returns:
 35            是否成功
 36        """
 37        return self._is_ok
 38
 39    @property
 40    def is_err(self) -> bool:
 41        """
 42        判断是否失败
 43        Returns:
 44            是否失败
 45        """
 46        return not self._is_ok
 47
 48    def unwrap(self) -> T:
 49        """
 50        获取结果（如果成功，否则触发异常）
 51        Returns:
 52            结果
 53        """
 54        if self.is_ok:
 55            return self._value
 56        raise Exception(f"Called unwrap on an Err value: {self._value}")
 57
 58    def unwrap_err(self) -> E:
 59        """
 60        获取错误（如果失败，否则触发异常）
 61        Returns:
 62            错误
 63        """
 64        if self.is_err:
 65            return self._value
 66        raise Exception(f"Called unwrap_err on an Ok value: {self._value}")
 67
 68    def expect(self, message: str) -> T:
 69        """
 70        获取结果（如果失败，否则触发异常）
 71        Args:
 72            message: 错误信息
 73        Returns:
 74            结果
 75        """
 76        if self.is_ok:
 77            return self._value
 78        raise Exception(message)
 79
 80
 81UnCalled = type("UnCalled", (), {})
 82
 83
 84class Action:
 85    """
 86    Action基类，无实际用途，勿调用
 87    """
 88    call_func = None
 89
 90    def __init__(self, *args, callback: Callable[[Result], ...] = None, **kwargs):
 91        self._result: UnCalled | Result = UnCalled
 92        self._async = None
 93        self.callback = callback
 94        self.args = args
 95        self.kwargs = kwargs
 96
 97    def set_callback(self, callback: Callable[[Result], ...]):
 98        """
 99        设置回调函数，如果Action已被调用则立即执行回调函数
100        Returns:
101            Action
102        """
103        self.callback = callback
104        if self._result is not UnCalled:
105            try:
106                self.callback(self._result)
107            except Exception as e:
108                if ConfigManager.GlobalConfig().debug.save_dump:
109                    dump_path = save_exc_dump(f"执行回调函数异常")
110                else:
111                    dump_path = None
112                logger.warning(f"执行回调函数异常: {repr(e)}\n"
113                               f"{traceback.format_exc()}"
114                               f"{f"\n已保存异常到 {dump_path}" if dump_path else ""}")
115        return self
116
117    def call(self):
118        """
119        调用Action
120        Returns:
121            Action
122        """
123        try:
124            result = Result(self.call_func(*self.args, **self.kwargs), True)
125        except Exception as e:
126            result = Result(e, False)
127        self._result = result
128        try:
129            if self._result.is_ok:
130                self.logger(result.unwrap(), *self.args, **self.kwargs)
131        except Exception as e:
132            if ConfigManager.GlobalConfig().debug.save_dump:
133                dump_path = save_exc_dump(f"调用日志记录函数异常")
134            else:
135                dump_path = None
136            logger.warning(f"调用日志记录函数异常: {repr(e)}\n"
137                           f"{traceback.format_exc()}"
138                           f"{f"\n已保存异常到 {dump_path}" if dump_path else ""}")
139        if self.callback is not None:
140            try:
141                self.callback(self._result)
142            except Exception as e:
143                if ConfigManager.GlobalConfig().debug.save_dump:
144                    dump_path = save_exc_dump(f"执行回调函数异常")
145                else:
146                    dump_path = None
147                logger.warning(f"回调函数异常: {repr(e)}\n"
148                               f"{traceback.format_exc()}"
149                               f"{f"\n已保存异常到 {dump_path}" if dump_path else ""}")
150        return self
151
152    def logger(self, *args, **kwargs):
153        """
154        当Action调用成功时调用此方法记录log
155        Args:
156            result: self.call_func返回的结果
157            *args: 传给self.call_func的参数
158            **kwargs: 传给self.call_func的参数
159        """
160        pass
161
162    def get_result(self) -> Result:
163        """
164        获取结果
165        Returns:
166            结果
167        """
168        if self._async is not None:
169            self._async.result()
170            self._async = None
171        if self._result is UnCalled:
172            raise Exception("Action not called")
173        return self._result
174
175    def call_get_result(self):
176        """
177        同步调用Action并获取结果
178        Returns:
179            结果
180        """
181        self.call()
182        return self.get_result()
183
184    def call_async(self):
185        """
186        异步调用Action
187        Returns:
188            Action
189        """
190
191        @ThreadPool.async_task
192        def _call_async():
193            return self.call()
194
195        self._async = _call_async()
196        return self
197
198    def wait_async(self):
199        """
200        等待异步调用
201        Returns:
202            Action
203        """
204        if self._async is None:
205            raise Exception("Action not called")
206        self._async.result()
207        return self
208
209
210class SendPrivateMsg(Action):
211    """
212    发送私聊消息
213    """
214
215    call_func = api.send_private_msg
216
217    def __init__(self, user_id: int, message: str | list[dict] | QQRichText.QQRichText,
218                 callback: Callable[[Result], ...] = None):
219        """
220        Args:
221            user_id (int): 对方 QQ 号
222            message (str | list[dict] | QQRichText.QQRichText): 要发送的内容
223            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
224        """
225        if isinstance(message, QQRichText.QQRichText):
226            message = message.get_array()
227        super().__init__(user_id=user_id, message=message, callback=callback)
228
229    def logger(self, result, user_id: int, message: str | list[dict] | QQRichText.QQRichText):
230        logger.info(f"向 {QQDataCacher.get_user_info(user_id).get_nickname()}({user_id}) "
231                    f"发送消息 {message}({result['message_id']})")
232
233
234class SendGroupMsg(Action):
235    """
236    发送群聊消息
237    """
238
239    call_func = api.send_group_msg
240
241    def __init__(self, group_id: int, message: str | list[dict] | QQRichText.QQRichText,
242                 callback: Callable[[Result], ...] = None):
243        """
244        Args:
245            group_id (int): 群号
246            message (str | list[dict] | QQRichText.QQRichText): 要发送的内容
247            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
248        """
249        if isinstance(message, QQRichText.QQRichText):
250            message = message.get_array()
251        super().__init__(group_id=group_id, message=message, callback=callback)
252
253    def logger(self, result, group_id: int, message: str | list[dict] | QQRichText.QQRichText):
254        logger.info(f"向群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) "
255                    f"发送消息 {QQRichText.QQRichText(message)}({result['message_id']})")
256
257
258class SendMsg(Action):
259    """
260    发送消息
261    """
262
263    call_func = api.send_msg
264
265    def __init__(self, user_id: int = -1, group_id: int = -1, message: str | list[dict] | QQRichText.QQRichText = "",
266                 callback: Callable[[Result], ...] = None):
267        """
268        Args:
269            user_id (int, optional): 对方 QQ 号（消息类型为 `private` 时需要）. Defaults to -1.
270            group_id (int, optional): 群号（消息类型为 `group` 时需要）. Defaults to -1.
271            message (str | list[dict] | QQRichText.QQRichText, optional): 要发送的内容. Defaults to "".
272            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
273        """
274        if isinstance(message, QQRichText.QQRichText):
275            message = message.get_array()
276
277        if user_id != -1 and group_id != -1:
278            raise ValueError('user_id and group_id cannot be both not -1.')
279        if user_id == -1 and group_id == -1:
280            raise ValueError('user_id and group_id cannot be both -1.')
281
282        super().__init__(user_id=user_id, group_id=group_id, message=message, callback=callback)
283
284    def logger(self, result, user_id: int, group_id: int, message: str | list[dict] | QQRichText.QQRichText):
285        if user_id != -1:
286            logger.info(f"向 {QQDataCacher.get_user_info(user_id).get_nickname()}({user_id}) "
287                        f"发送消息 {QQRichText.QQRichText(message)}({result['message_id']})")
288        else:
289            logger.info(f"向群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) "
290                        f"发送消息 {QQRichText.QQRichText(message)}({result['message_id']})")
291
292
293class DeleteMsg(Action):
294    """
295    撤回消息
296    """
297
298    call_func = api.delete_msg
299
300    def __init__(self, message_id: int, callback: Callable[[Result], ...] = None):
301        """
302        Args:
303            message_id (int): 消息 ID
304            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
305        """
306        super().__init__(message_id=message_id, callback=callback)
307
308    def logger(self, result, message_id: int):
309        logger.info(f"撤回消息 {message_id}")
310
311
312class GetMsg(Action):
313    """
314    获取消息
315    """
316
317    call_func = api.get_msg
318
319    def __init__(self, message_id: int, callback: Callable[[Result], ...] = None):
320        """
321        Args:
322            message_id (int): 消息 ID
323            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
324        """
325        super().__init__(message_id=message_id, callback=callback)
326
327    def logger(self, result, message_id: int):
328        logger.debug(f"获取消息 {message_id}")
329
330
331class GetForwardMsg(Action):
332    """
333    获取合并转发消息
334    """
335
336    call_func = api.get_forward_msg
337
338    def __init__(self, id: int, callback: Callable[[Result], ...] = None):
339        """
340        Args:
341            id (int): 合并转发 ID
342            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
343        """
344        super().__init__(id=id, callback=callback)
345
346    def logger(self, result, id: int):
347        logger.debug(f"获取合并转发消息 {id}")
348
349
350class SendLike(Action):
351    """
352    发送好友赞
353    """
354
355    call_func = api.send_like
356
357    def __init__(self, user_id: int, times: int = 1, callback: Callable[[Result], ...] = None):
358        """
359        Args:
360            user_id (int): 对方 QQ 号
361            times (int, optional): 赞的次数，每个好友每天最多 10 次. Defaults to 1.
362            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
363        """
364        super().__init__(user_id=user_id, times=times, callback=callback)
365
366    def logger(self, result, user_id: int, times: int):
367        logger.info(f"发送好友赞 {user_id} {times} 次")
368
369
370class SetGroupKick(Action):
371    """
372    群组踢人
373    """
374
375    call_func = api.set_group_kick
376
377    def __init__(self, group_id: int, user_id: int, reject_add_request: bool = False,
378                 callback: Callable[[Result], ...] = None):
379        """
380        Args:
381            group_id (int): 群号
382            user_id (int): 要踢的 QQ 号
383            reject_add_request (bool, optional): 拒绝此人的加群请求. Defaults to False.
384            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
385        """
386        super().__init__(group_id=group_id, user_id=user_id, reject_add_request=reject_add_request, callback=callback)
387
388    def logger(self, result, group_id: int, user_id: int, reject_add_request: bool):
389        logger.info(f"将群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) "
390                    f"内成员 {QQDataCacher.get_user_info(user_id).get_nickname()}({user_id}) 踢出群聊"
391                    f"{'并拒绝此人加群请求' if reject_add_request else ''}")
392
393
394class SetGroupBan(Action):
395    """
396    群组单人禁言
397    """
398
399    call_func = api.set_group_ban
400
401    def __init__(self, group_id: int, user_id: int, duration: int = 30 * 60, callback: Callable[[Result], ...] = None):
402        """
403        Args:
404            group_id (int): 群号
405            user_id (int): 要禁言的 QQ 号
406            duration (int, optional): 禁言时长，单位秒，0 表示取消禁言. Defaults to 30 * 60.
407            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
408        """
409        super().__init__(group_id=group_id, user_id=user_id, duration=duration, callback=callback)
410
411    def logger(self, result, group_id: int, user_id: int, duration: int):
412        logger.info(f"将群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) "
413                    f"内成员 {QQDataCacher.get_user_info(user_id).get_nickname()}({user_id}) 禁言 {duration} 秒")
414
415
416class SetGroupAnonymousBan(Action):
417    """
418    群组匿名用户禁言
419    """
420
421    call_func = api.set_group_anonymous_ban
422
423    def __init__(self, group_id: int, anonymous: dict = None, anonymous_flag: str = None, duration: int = 30 * 60,
424                 callback: Callable[[Result], ...] = None):
425        """
426        Args:
427            group_id (int): 群号
428            anonymous (dict, optional): 要禁言的匿名用户对象（群消息上报的 `anonymous` 字段）. Defaults to None.
429            anonymous_flag (str, optional): 要禁言的匿名用户的 flag（需从群消息上报的数据中获得）. Defaults to None.
430            duration (int, optional): 禁言时长，单位秒，无法取消匿名用户禁言. Defaults to 30 * 60.
431            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
432        """
433        super().__init__(group_id=group_id, anonymous=anonymous, anonymous_flag=anonymous_flag, duration=duration,
434                         callback=callback, **{'flag': anonymous_flag} if anonymous_flag else {})
435
436    def logger(self, result, group_id: int, anonymous: dict, anonymous_flag: str, duration: int):
437        anonymous_str = f"{QQDataCacher.get_user_info(anonymous['id']).nickname}" if anonymous else "匿名用户"
438        anonymous_detail = f"({anonymous['id']}; flag: {anonymous_flag})" if anonymous else ""
439        logger.info(f"将群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) "
440                    f"内成员 {anonymous_str} {anonymous_detail} 禁言 {duration} 秒")
441
442
443class SetGroupWholeBan(Action):
444    """
445    群组全员禁言
446    """
447
448    call_func = api.set_group_whole_ban
449
450    def __init__(self, group_id: int, enable: bool = True, callback: Callable[[Result], ...] = None):
451        """
452        Args:
453            group_id (int): 群号
454            enable (bool, optional): 是否禁言. Defaults to True.
455            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
456        """
457        super().__init__(group_id=group_id, enable=enable, callback=callback)
458
459    def logger(self, result, group_id: int, enable: bool):
460        logger.info(f"将群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) "
461                    f"{'开启' if enable else '关闭'}全员禁言")
462
463
464class SetGroupAdmin(Action):
465    """
466    设置群管理员
467    """
468
469    call_func = api.set_group_admin
470
471    def __init__(self, group_id: int, user_id: int, enable: bool = True, callback: Callable[[Result], ...] = None):
472        """
473        Args:
474            group_id (int): 群号
475            user_id (int): 要设置管理员的 QQ 号
476            enable (bool, optional): true 为设置，false 为取消. Defaults to True.
477            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
478        """
479        super().__init__(group_id=group_id, user_id=user_id, enable=enable, callback=callback)
480
481    def logger(self, result, group_id: int, user_id: int, enable: bool):
482        logger.info(f"将群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) "
483                    f"内成员 {QQDataCacher.get_user_info(user_id).get_nickname()}({user_id}) "
484                    f"{'设为' if enable else '取消设为'}管理员")
485
486
487class SetGroupCard(Action):
488    """
489    设置群名片（群备注）
490    """
491
492    call_func = api.set_group_card
493
494    def __init__(self, group_id: int, user_id: int, card: str = "", callback: Callable[[Result], ...] = None):
495        """
496        Args:
497            group_id (int): 群号
498            user_id (int): 要设置的 QQ 号
499            card (str, optional): 群名片内容，不填或空字符串表示删除群名片. Defaults to "".
500            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
501        """
502        super().__init__(group_id=group_id, user_id=user_id, card=card, callback=callback)
503
504    def logger(self, result, group_id: int, user_id: int, card: str):
505        logger.info(f"将群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) "
506                    f"内成员 {QQDataCacher.get_user_info(user_id).get_nickname()}({user_id}) "
507                    f"{'设置群名片为' if card else '删除群名片'} {card}")
508
509
510class SetGroupLeave(Action):
511    """
512    退出群组
513    """
514
515    call_func = api.set_group_leave
516
517    def __init__(self, group_id: int, is_dismiss: bool = False, callback: Callable[[Result], ...] = None):
518        """
519        Args:
520            group_id (int): 群号
521            is_dismiss (bool, optional): 是否解散，如果登录号是群主，则仅在此项为 true 时能够解散. Defaults to False.
522            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
523        """
524        super().__init__(group_id=group_id, is_dismiss=is_dismiss, callback=callback)
525
526    def logger(self, result, group_id: int, is_dismiss: bool):
527        logger.info(f"退出群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) "
528                    f"{'并解散' if is_dismiss else ''}")
529
530
531class SetGroupSpecialTitle(Action):
532    """
533    设置群组专属头衔
534    """
535
536    call_func = api.set_group_special_title
537
538    def __init__(self, group_id: int, user_id: int, special_title: str = "", duration: int = -1,
539                 callback: Callable[[Result], ...] = None):
540        """
541        Args:
542            group_id (int): 群号
543            user_id (int): 要设置的 QQ 号
544            special_title (str, optional): 专属头衔，不填或空字符串表示删除专属头衔. Defaults to "".
545            duration (int, optional): 专属头衔有效期，单位秒，-1 表示永久. Defaults to -1.
546            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
547        """
548        super().__init__(group_id=group_id, user_id=user_id, special_title=special_title, duration=duration,
549                         callback=callback)
550
551    def logger(self, result, group_id: int, user_id: int, special_title: str, duration: int):
552        logger.info(f"将群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) "
553                    f"内成员 {QQDataCacher.get_user_info(user_id).get_nickname()}({user_id}) "
554                    f"{'设置专属头衔为' if special_title else '删除专属头衔'} {special_title} "
555                    )
556
557
558class SetFriendAddRequest(Action):
559    """
560    处理加好友请求
561    """
562
563    call_func = api.set_friend_add_request
564
565    def __init__(self, flag: str, approve: bool = True, remark: str = "", callback: Callable[[Result], ...] = None):
566        """
567        Args:
568            flag (str): 加好友请求的 flag（需从上报的数据中获得）
569            approve (bool, optional): 是否同意请求. Defaults to True.
570            remark (str, optional): 添加后的好友备注（仅在同意时有效）. Defaults to "".
571            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
572        """
573        super().__init__(flag=flag, approve=approve, remark=remark, callback=callback)
574
575    def logger(self, result, flag: str, approve: bool, remark: str):
576        logger.info(f"处理加好友请求 {'同意' if approve else '拒绝'} "
577                    f"{'并设置备注为' if remark else ''} {remark}")
578
579
580class SetGroupAddRequest(Action):
581    """
582    处理加群请求/邀请
583    """
584
585    call_func = api.set_group_add_request
586
587    def __init__(self, flag: str, sub_type: str = "add", approve: bool = True, reason: str = "",
588                 callback: Callable[[Result], ...] = None):
589        """
590        Args:
591            flag (str): 加群请求的 flag（需从上报的数据中获得）
592            sub_type (str, optional): `add` 或 `invite`，请求类型（需要和上报消息中的 `sub_type` 字段相符）. Defaults to "add".
593            approve (bool, optional): 是否同意请求／邀请. Defaults to True.
594            reason (str, optional): 拒绝理由（仅在拒绝时有效）. Defaults to "".
595            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
596        """
597        super().__init__(flag=flag, sub_type=sub_type, approve=approve, reason=reason, callback=callback)
598
599    def logger(self, result, flag: str, sub_type: str, approve: bool, reason: str):
600        logger.info(f"处理加群请求/邀请 {'同意' if approve else '拒绝'} "
601                    f"{'并设置理由为' if reason else ''} {reason}")
602
603
604class GetLoginInfo(Action):
605    """
606    获取登录号信息
607    """
608
609    call_func = api.get_login_info
610
611    def __init__(self, callback: Callable[[Result], ...] = None):
612        """
613        Args:
614            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
615        """
616        super().__init__(callback=callback)
617
618    def logger(self, result):
619        logger.debug(f"获取登录号信息")
620
621
622class GetStrangerInfo(Action):
623    """
624    获取陌生人信息
625    """
626
627    call_func = api.get_stranger_info
628
629    def __init__(self, user_id: int, no_cache: bool = False, callback: Callable[[Result], ...] = None):
630        """
631        Args:
632            user_id (int): QQ 号
633            no_cache (bool, optional): 是否不使用缓存（使用缓存可能更新不及时，但响应更快）. Defaults to False.
634            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
635        """
636        super().__init__(user_id=user_id, no_cache=no_cache, callback=callback)
637
638    def logger(self, result, user_id: int, no_cache: bool):
639        logger.debug(f"获取陌生人 {user_id} 信息")
640
641
642class GetFriendList(Action):
643    """
644    获取好友列表
645    """
646
647    call_func = api.get_friend_list
648
649    def __init__(self, callback: Callable[[Result], ...] = None):
650        """
651        Args:
652            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
653        """
654        super().__init__(callback=callback)
655
656    def logger(self, result):
657        logger.debug(f"获取好友列表")
658
659
660class GetGroupInfo(Action):
661    """
662    获取群信息
663    """
664
665    call_func = api.get_group_info
666
667    def __init__(self, group_id: int, no_cache: bool = False, callback: Callable[[Result], ...] = None):
668        """
669        Args:
670            group_id (int): 群号
671            no_cache (bool, optional): 是否不使用缓存（使用缓存可能更新不及时，但响应更快）. Defaults to False.
672            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
673        """
674        super().__init__(group_id=group_id, no_cache=no_cache, callback=callback)
675
676    def logger(self, result, group_id: int, no_cache: bool):
677        logger.debug(f"获取群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) 信息")
678
679
680class GetGroupList(Action):
681    """
682    获取群列表
683    """
684
685    call_func = api.get_group_list
686
687    def __init__(self, callback: Callable[[Result], ...] = None):
688        """
689        Args:
690            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
691        """
692        super().__init__(callback=callback)
693
694    def logger(self, result):
695        logger.debug(f"获取群列表")
696
697
698class GetGroupMemberInfo(Action):
699    """
700    获取群成员信息
701    """
702
703    call_func = api.get_group_member_info
704
705    def __init__(self, group_id: int, user_id: int, no_cache: bool = False, callback: Callable[[Result], ...] = None):
706        """
707        Args:
708            group_id (int): 群号
709            user_id (int): QQ 号
710            no_cache (bool, optional): 是否不使用缓存（使用缓存可能更新不及时，但响应更快）. Defaults to False.
711            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
712        """
713        super().__init__(group_id=group_id, user_id=user_id, no_cache=no_cache, callback=callback)
714
715    def logger(self, result, group_id: int, user_id: int, no_cache: bool):
716        logger.debug(
717            f"获取群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) 成员 "
718            f"{QQDataCacher.get_user_info(user_id).get_nickname()}({user_id}) 信息")
719
720
721class GetGroupMemberList(Action):
722    """
723    获取群成员列表
724    """
725
726    call_func = api.get_group_member_list
727
728    def __init__(self, group_id: int, callback: Callable[[Result], ...] = None):
729        """
730        Args:
731            group_id (int): 群号
732            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
733        """
734        super().__init__(group_id=group_id, callback=callback)
735
736    def logger(self, result, group_id: int):
737        logger.debug(f"获取群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) 成员列表")
738
739
740class GetGroupHonorInfo(Action):
741    """
742    获取群荣誉信息
743    """
744
745    call_func = api.get_group_honor_info
746
747    def __init__(self, group_id: int, type_: str = "all", callback: Callable[[Result], ...] = None):
748        """
749        Args:
750            group_id (int): 群号
751            type_ (str, optional): 要获取的群荣誉类型，可传入 `talkative` `performer` `legend` `strong_newbie` `emotion`
752            以分别获取单个类型的群荣誉数据，或传入 `all` 获取所有数据. Defaults to "all".
753            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
754        """
755        super().__init__(group_id=group_id, type_=type_, callback=callback)
756
757    def logger(self, result, group_id: int, type_: str):
758        logger.debug(f"获取群 {QQDataCacher.get_group_info(group_id).group_name}({group_id}) 荣誉信息, 类型: {type_}")
759
760
761class GetCookies(Action):
762    """
763    获取 Cookies
764    """
765
766    call_func = api.get_cookies
767
768    def __init__(self, domain: str = "", callback: Callable[[Result], ...] = None):
769        """
770        Args:
771            domain (str, optional): 需要获取 cookies 的域名. Defaults to "".
772            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
773        """
774        super().__init__(domain=domain, callback=callback)
775
776    def logger(self, result, domain: str):
777        logger.debug(f"获取 Cookies, domain: {domain}")
778
779
780class GetCsrfToken(Action):
781    """
782    获取 CSRF Token
783    """
784
785    call_func = api.get_csrf_token
786
787    def __init__(self, callback: Callable[[Result], ...] = None):
788        """
789        Args:
790            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
791        """
792        super().__init__(callback=callback)
793
794    def logger(self, result):
795        logger.debug(f"获取 CSRF Token")
796
797
798class GetCredentials(Action):
799    """
800    获取 QQ 相关接口凭证
801    """
802
803    call_func = api.get_credentials
804
805    def __init__(self, domain: str = "", callback: Callable[[Result], ...] = None):
806        """
807        Args:
808            domain (str, optional): 需要获取 cookies 的域名. Defaults to "".
809            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
810        """
811        super().__init__(domain=domain, callback=callback)
812
813    def logger(self, result, domain: str):
814        logger.debug(f"获取 QQ 相关接口凭证, domain: {domain}")
815
816
817class GetRecord(Action):
818    """
819    获取语音
820    """
821
822    call_func = api.get_record
823
824    def __init__(self, file: str, out_format: str = "mp3", out_file: str = "",
825                 callback: Callable[[Result], ...] = None):
826        """
827        Args:
828            file (str): 收到的语音文件名（消息段的 `file` 参数），如 `0B38145AA44505000B38145AA4450500.silk`
829            out_format (str, optional): 要转换到的格式，目前支持
830            `mp3`、`amr`、`wma`、`m4a`、`spx`、`ogg`、`wav`、`flac`. Defaults to "mp3".
831            out_file (str, optional): unused parameter. Defaults to "".
832            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
833        """
834        super().__init__(file=file, out_format=out_format, out_file=out_file, callback=callback)
835
836    def logger(self, result, file: str, out_format: str, out_file: str):
837        logger.debug(f"获取语音文件: {file}, 转换格式: {out_format}")
838
839
840class GetImage(Action):
841    """
842    获取图片
843    """
844
845    call_func = api.get_image
846
847    def __init__(self, file: str, callback: Callable[[Result], ...] = None):
848        """
849        Args:
850            file (str): 收到的图片文件名（消息段的 `file` 参数），如 `6B4DE3DFD1BD271E3297859D41C530F5.jpg`
851            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
852        """
853        super().__init__(file=file, callback=callback)
854
855    def logger(self, result, file: str):
856        logger.debug(f"获取图片文件: {file}")
857
858
859class CanSendImage(Action):
860    """
861    检查是否可以发送图片
862    """
863
864    call_func = api.can_send_image
865
866    def __init__(self, callback: Callable[[Result], ...] = None):
867        """
868        Args:
869            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
870        """
871        super().__init__(callback=callback)
872
873    def logger(self, result):
874        logger.debug(f"检查是否可以发送图片")
875
876
877class CanSendRecord(Action):
878    """
879    检查是否可以发送语音
880    """
881
882    call_func = api.can_send_record
883
884    def __init__(self, callback: Callable[[Result], ...] = None):
885        """
886        Args:
887            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
888        """
889        super().__init__(callback=callback)
890
891    def logger(self, result):
892        logger.debug(f"检查是否可以发送语音")
893
894
895class GetStatus(Action):
896    """
897    获取运行状态
898    """
899
900    call_func = api.get_status
901
902    def __init__(self, callback: Callable[[Result], ...] = None):
903        """
904        Args:
905            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
906        """
907        super().__init__(callback=callback)
908
909    def logger(self, result):
910        logger.debug(f"获取Onebot运行状态")
911
912
913class GetVersionInfo(Action):
914    """
915    获取版本信息
916    """
917
918    call_func = api.get_version_info
919
920    def __init__(self, callback: Callable[[Result], ...] = None):
921        """
922        Args:
923            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
924        """
925        super().__init__(callback=callback)
926
927    def logger(self, result):
928        logger.debug(f"获取Onebot版本信息")
929
930
931class SetRestart(Action):
932    """
933    重启
934    """
935
936    call_func = api.set_restart
937
938    def __init__(self, delay: int = 0, callback: Callable[[Result], ...] = None):
939        """
940        Args:
941            delay (int, optional): 要延迟的毫秒数. Defaults to 0.
942            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
943        """
944        super().__init__(delay=delay, callback=callback)
945
946    def logger(self, result, delay: int):
947        logger.info(f"重启Onebot实现端, 延迟: {delay}ms")
948
949
950class CleanCache(Action):
951    """
952    清理缓存
953    """
954
955    call_func = api.clean_cache
956
957    def __init__(self, callback: Callable[[Result], ...] = None):
958        """
959        Args:
960            callback (Callable[[Result], ...], optional): 回调函数. Defaults to None.
961        """
962        super().__init__(callback=callback)
963
964    def logger(self, result):
965        logger.debug(f"清理Onebot实现端缓存")
966
967
968"""
969使用示例：
970
971if __name__ == "__main__":
972    ThreadPool.init()
973
974    action = SendPrivateMsg(user_id=123456789, message="Hello World").call()
975    res = action.get_result()
976
977    # 下面二者等价
978    res = SendPrivateMsg(user_id=123456789, message="Hello World").call().get_result()
979    res = SendPrivateMsg(user_id=123456789, message="Hello World").call_get_result()
980
981    action = SendPrivateMsg(user_id=123456789, message="Hello World").call_async()
982    res = action.get_result()
983
984    if res.is_ok:
985        print(res.unwrap())
986    else:
987        print(res.unwrap_err())
988"""