Struct awr::client::Client

pub struct Client { /* private fields */ }

QQ 无头客户端。

Examples

client = await Dynamic().login(12345678, "./bots")

friend_list = client.get_friend_list()
for friend in friend_list.friends():
    print(friend.nickname())

await client.alive()

Python

class Client: ...

Implementations

impl Client

pub fn alive<'py>(&mut self, py: Python<'py>) -> PyResult<&'py PyAny>

等待并保持客户端连接，期间会自动进行断线重连。

多次调用此方法时，后续的调用将直接返回。

Examples

client = await awr.Dynamic().login(12345678, "./bots")
await client.alive()
print("客户端已退出~")

Python

async def alive(self) -> None: ...

pub fn uin(&self) -> i64

客户端 QQ 号。

Examples

client = await awr.Dynamic().login(12345678, "./bots")
assert client.uin == 12345678

Python

@property
def uin(self) -> int: ...

pub fn is_online(&self) -> bool

是否在线。

Python

def is_online(self) -> bool: ...

pub fn friend(&self, uin: i64) -> FriendSelector

构造好友选择器。

参考 FriendSelector。

Examples

await client.friend(12345678).poke()

Python

def friend(self, uin: int) -> FriendSelector: ...

pub fn get_account_info<'py>(&self, py: Python<'py>) -> PyResult<&'py PyAny>

获取账号信息。

参考 AccountInfo。

Examples

info = await client.get_account_info()
print("nickname:", info.nickname)
print("age:", info.age)
print("gender:", info.gender)

Python

async def get_account_info(self) -> AccountInfo: ...

pub fn get_friend_list<'py>(&self, py: Python<'py>) -> PyResult<&'py PyAny>

获取好友列表。

参考 FriendList。

Examples

friend_list = await client.get_friend_list()
for friend in friend_list.friends():
    print(friend.nickname)

Python

async def friend_list(self) -> FriendList: ...

pub fn get_friends<'py>(&self, py: Python<'py>) -> PyResult<&'py PyAny>

获取遍历好友信息的迭代器。

参考 Friend。

Examples

for friend in await client.get_friends():
    print(friend.nickname)

Python

async def get_friends(self) -> Iterator[Friend]:

pub fn get_friend<'py>(&self, py: Python<'py>, uin: i64) -> PyResult<&'py PyAny>

查找指定的好友。

参考 Friend。

Examples

friend = await client.get_friend(12345678)
if friend:
    print(friend.nickname)
else:
    print("未找到好友 12345678")

Python

async def get_friend(self, uin: int) -> Friend | None:

pub fn get_group<'py>(
    &self,
    py: Python<'py>,
    group_id: i64
) -> PyResult<&'py PyAny>

获取群。

参考 Group。

Examples

group = await client.get_group(12345678)
print(group.name)

Python

async def get_group(self, group_id: int) -> Group: ...

pub fn get_groups<'py>(
    &self,
    py: Python<'py>,
    group_ids: Vec<i64>
) -> PyResult<&'py PyAny>

批量获取群，返回 { 群号: 群对象 } 的字典。

当给出的群号不存在，或者未加入这个群时，将不会在返回值中出现。这意味着返回值长度可能会小于参数长度。

参考 Group。

Examples

groups = await client.get_groups([12345678, 87654321])
if 12345678 in groups:
    print(groups[12345678].name)
else:
    print("未加入群 12345678 或群不存在")

Python

async def get_groups(self, group_ids: Sequence[int]) -> dict[int, Group]: ...

pub fn get_group_list<'py>(&self, py: Python<'py>) -> PyResult<&'py PyAny>

获取群列表。

参考 Group。

Examples

group_list = await client.get_group_list()
for group in group_list:
    print(group.name)

Note

此方法获取到的 last_msg_seq 不可用，如需要此字段请使用 get_group 或 get_groups。

Python

async def get_group_list() -> list[Group]: ...

Trait Implementations

impl IntoPy<Py<PyAny>> for Client

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for Client

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Client

const DOC: &'static str = _

Class doc string

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type Layout = PyCell<Client>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<Client>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a Client

type Holder = Option<PyRef<'py, Client>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut Client

type Holder = Option<PyRefMut<'py, Client>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyMethods<Client> for PyClassImplCollector<Client>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Client

type AsRefTarget = PyCell<Client>

Utility type to make Py::as_ref work.

const NAME: &'static str = _

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.