Module aiocqhttp.api

此模块提供了 OneBot (CQHTTP) API 的接口类。

"""
此模块提供了 OneBot (CQHTTP) API 的接口类。
"""

import abc
import functools
from typing import Callable, Any, Union, Awaitable


class Api:
    """
    API 接口类。

    继承此类的具体实现类应实现 `call_action` 方法。
    """

    @abc.abstractmethod
    def call_action(self, action: str, **params) -> Union[Awaitable[Any], Any]:
        """
        调用 OneBot API，`action` 为要调用的 API 动作名，`**params`
        为 API 所需参数。

        根据实现类的不同，此函数可能是异步也可能是同步函数。
        """
        pass

    def __getattr__(self,
                    item: str) -> Callable[..., Union[Awaitable[Any], Any]]:
        """获取一个可调用对象，用于调用对应 API。"""
        return functools.partial(self.call_action, item)


class AsyncApi(Api):
    """
    异步 API 接口类。

    继承此类的具体实现类应实现异步的 `call_action` 方法。
    """

    @abc.abstractmethod
    async def call_action(self, action: str, **params) -> Any:
        ...


class SyncApi(Api):
    """
    同步 API 接口类。

    继承此类的具体实现类应实现同步的 `call_action` 方法。
    """

    @abc.abstractmethod
    def call_action(self, action: str, **params) -> Any:
        ...

Classes

class Api

API 接口类。

继承此类的具体实现类应实现 call_action 方法。

Expand source code

class Api:
    """
    API 接口类。

    继承此类的具体实现类应实现 `call_action` 方法。
    """

    @abc.abstractmethod
    def call_action(self, action: str, **params) -> Union[Awaitable[Any], Any]:
        """
        调用 OneBot API，`action` 为要调用的 API 动作名，`**params`
        为 API 所需参数。

        根据实现类的不同，此函数可能是异步也可能是同步函数。
        """
        pass

    def __getattr__(self,
                    item: str) -> Callable[..., Union[Awaitable[Any], Any]]:
        """获取一个可调用对象，用于调用对应 API。"""
        return functools.partial(self.call_action, item)

Subclasses

• AsyncApi
• SyncApi
• LazyApi

Methods

def call_action(self, action: str, **params) ‑> Union[Awaitable[Any], Any]

调用 OneBot API，action 为要调用的 API 动作名，**params 为 API 所需参数。

根据实现类的不同，此函数可能是异步也可能是同步函数。

Expand source code

@abc.abstractmethod
def call_action(self, action: str, **params) -> Union[Awaitable[Any], Any]:
    """
    调用 OneBot API，`action` 为要调用的 API 动作名，`**params`
    为 API 所需参数。

    根据实现类的不同，此函数可能是异步也可能是同步函数。
    """
    pass

class AsyncApi

异步 API 接口类。

继承此类的具体实现类应实现异步的 call_action 方法。

Expand source code

class AsyncApi(Api):
    """
    异步 API 接口类。

    继承此类的具体实现类应实现异步的 `call_action` 方法。
    """

    @abc.abstractmethod
    async def call_action(self, action: str, **params) -> Any:
        ...

Ancestors

• Api

Subclasses

• CQHttp
• HttpApi
• UnifiedApi
• WebSocketReverseApi

Methods

async def call_action(self, action: str, **params) ‑> Any

Inherited from: Api.call_action

调用 OneBot API，action 为要调用的 API 动作名，**params 为 API 所需参数。 …

Expand source code

@abc.abstractmethod
async def call_action(self, action: str, **params) -> Any:
    ...

class SyncApi

同步 API 接口类。

继承此类的具体实现类应实现同步的 call_action 方法。

Expand source code

class SyncApi(Api):
    """
    同步 API 接口类。

    继承此类的具体实现类应实现同步的 `call_action` 方法。
    """

    @abc.abstractmethod
    def call_action(self, action: str, **params) -> Any:
        ...

Ancestors

• Api

Subclasses

• SyncWrapperApi

Methods

def call_action(self, action: str, **params) ‑> Any

Inherited from: Api.call_action

调用 OneBot API，action 为要调用的 API 动作名，**params 为 API 所需参数。 …

Expand source code

@abc.abstractmethod
def call_action(self, action: str, **params) -> Any:
    ...