api reference#

Submodules#

discord.ext.ipcs.client module#

class discord.ext.ipcs.client.Client(client: Client, secret_key: str, *, loop: Optional[AbstractEventLoop] = None, log: Optional[bool] = False)#

Bases: object

ipc client

Parameters

  • client (discord.Client) – Discord client

  • secret_key (str) – secret key

  • loop (Optional[asyncio.AbstractEventLoop]) – Event loop

  • log (Optional[bool]) – show log

async close(code: Optional[int] = 1000, message: Optional[str] = 'Bye') → None#

Close from ipc server

Parameters

  • code (Optional[int]) – Close code

  • message (Optional[str]) – Close message

Raises

ConnectionError – If you already close, it will be raise.

Examples

await ipc_client.close()

async connect(uri: str, *, reconnect: Optional[bool] = True) → None#

Connect to ipc server

Parameters

  • uri (str) – URI

  • reconnect (Optional[bool]) – Reconnect when it was closed.

Examples

await ipc_client.connect(“ws://localhost/ipc”)

Raises

ConnectionError – If you already connect, it will be raise.

dispatch(eventtype: str, response: ResponseItem) → None#

Run function

Parameters

  • eventtype (str) – Event type

  • response (ResponseItem) – response item

listen(eventtype: str)#

Catch data from ipc server

Parameters

eventtype (str) – Event type.

login()#

Login to ipc server

Examples

await ipc_client.login()

print(content: str) → None#

This can print like sanic

Parameters

content (str) – content

async reconnect() → None#

Reconnect from ipc server

Examples

await ipc_client.reconnect()

async recv() → None#

Get data and dispatch

async request(eventtype: str, data: Optional[dict] = {}) → None#

Send something to ipc server

Parameters

  • eventtype (str) – event type

  • data (Optional[dict]) – The data you want to send.

Examples

await ipc_client.request(“hello”, {“message”: “What your name”})

discord.ext.ipcs.errors module#

exception discord.ext.ipcs.errors.AsyncError#

Bases: Exception

exception discord.ext.ipcs.errors.ConnectionError#

Bases: Exception

discord.ext.ipcs.items module#

class discord.ext.ipcs.items.ResponseItem(data: dict)#

Bases: object

Response data

Parameters

data (dict) – Some kind of data.

Examples

response = ResponseItem({“hello”: “world”, “message”: “What your name?”}) print(response.hello)