yuyo.asgi#

Call the adapter.

Parameters:

• scope (Scope) –

  The scope of the request.

• receive (ASGIReceiveCallable) –

  The receive function to use.

• send (ASGISendCallable) –

  The send function to use.

Raises:

• NotImplementedError –

  If this is called with a websocket scope.

• RuntimeError –

  If an invalid scope event is passed.

Initialise the adapter.

Parameters:

• server (InteractionServer) –

  The interaction server to use.

• executor (Optional[Executor], default: None ) –

  If non-None, then this executor is used instead of the concurrent.futures.ThreadPoolExecutor attached to the asyncio.AbstractEventLoop that the bot will run on. This executor is used primarily for file-IO.

  While mainly supporting the concurrent.futures.ThreadPoolExecutor implementation in the standard lib, Hikari's file handling systems should also work with concurrent.futures.ProcessPoolExecutor, which relies on all objects used in IPC to be pickleable. Many third-party libraries will not support this fully though, so your mileage may vary on using ProcessPoolExecutor implementations with this parameter.

• max_body_size (int, default: 1024 ** 2 ) –

  The maximum body size this should allow received request bodies to be in bytes before failing the request with a 413 - Content Too Large.

Add a callback to be called when the ASGI server shuts down.

Parameters:

• callback (Callable[[], Coroutine[Any, Any, None]]) –

  The shutdown callback to add.

Returns:

• Self –

  The adapter to enable chained calls.

Add a callback to be called when the ASGI server starts up.

Parameters:

• callback (Callable[[], Coroutine[Any, Any, None]]) –

  The startup callback to add.

Returns:

• Self –

  The adapter to enable chained calls.

Remove a shutdown callback.

Parameters:

• callback (Callable[[], Coroutine[Any, Any, None]]) –

  The shutdown callback to remove.

Returns:

• Self –

  The adapter to enable chained calls.

Raises:

• ValueError –

  If the callback was not registered.

Remove a startup callback.

Parameters:

• callback (Callable[[], Coroutine[Any, Any, None]]) –

  The startup callback to remove.

Returns:

• Self –

  The adapter to enable chained calls.

Raises:

• ValueError –

  If the callback was not registered.

Call the bot with an ASGI event.

Parameters:

• scope (Scope) –

  The scope of the request.

• receive (ASGIReceiveCallable) –

  The receive function to use.

• send (ASGISendCallable) –

  The send function to use.

Raises:

• NotImplementedError –

  If this is called with a websocket scope.

• RuntimeError –

  If an invalid scope event is passed.

Initialise a new ASGI bot.

Parameters:

• token (Union[str, TokenStrategy]) –

  The bot or bearer token. If no token is to be used, this can be undefined.

• token_type (Union[TokenType, str, None], default: None ) –

  The type of token in use. This should only be passed when str is passed for token, can be "Bot" or "Bearer" and will be defaulted to "Bot" in this situation.

  This should be left as None when either hikari.api.TokenStrategy or None is passed for token.

• asgi_managed (bool, default: True ) –

  Whether this bot's internal components should be automatically started and stopped based on the Asgi lifespan events.

• executor (Optional[Executor], default: None ) –

  If non-None, then this executor is used instead of the concurrent.futures.ThreadPoolExecutor attached to the asyncio.AbstractEventLoop that the bot will run on. This executor is used primarily for file-IO.

  While mainly supporting the concurrent.futures.ThreadPoolExecutor implementation in the standard lib, Hikari's file handling systems should also work with concurrent.futures.ProcessPoolExecutor, which relies on all objects used in IPC to be pickleable. Many third-party libraries will not support this fully though, so your mileage may vary on using ProcessPoolExecutor implementations with this parameter.

• http_settings (Optional[HTTPSettings], default: None ) –

  Optional custom HTTP configuration settings to use. Allows you to customise functionality such as whether SSL-verification is enabled, what timeouts aiohttp should expect to use for requests, and behavior regarding HTTP-redirects.

• max_body_size (int, default: 1024 ** 2 ) –

  The maximum body size this should allow received request bodies to be in bytes before failing the request with a 413 - Content Too Large.

• max_rate_limit (float, default: 300.0 ) –

  The max number of seconds to backoff for when rate limited. Anything greater than this will instead raise an error.

  This defaults to five minutes to stop potentially indefinitely waiting on an endpoint, which is almost never what you want to do if giving a response to a user.

  You can set this to float("inf") to disable this check entirely. Note that this only applies to the REST API component that communicates with Discord, and will not affect sharding or third party HTTP endpoints that may be in use.

• max_retries (int, default: 3 ) –

  Maximum number of times a request will be retried if

  it fails with a 5xx status. Defaults to 3 if set to None.

• proxy_settings (Optional[ProxySettings], default: None ) –

  Custom proxy settings to use with network-layer logic in your application to get through an HTTP-proxy.

• public_key (Union[bytes, str, None], default: None ) –

  The public key to use to verify received interaction requests.

  This may be a hex encoded str or the raw bytes. If left as None then the client will try to work this value out based on token.

• rest_url (Optional[str], default: None ) –

  Defaults to the Discord REST API URL if None. Can be overridden if you are attempting to point to an unofficial endpoint, or if you are attempting to mock/stub the Discord API for any reason.

  Generally you do not want to change this.

Raises:

• ValueError –
  • If token_type is provided when a token strategy is passed for token.
  • if token_type is left as None when a string is passed for token.

Add a callback to be called when the bot shuts down.

Parameters:

• callback (Callable[[Self], Coroutine[Any, Any, None]]) –

  The shutdown callback to add.

Add a callback to be called when the bot starts up.

Parameters:

• callback (Callable[[Self], Coroutine[Any, Any, None]]) –

  The startup callback to add.

Close the bot's REST client.

Raises:

• RuntimeError –

  If the client isn't alive. If the client is ASGI managed.

Remove a shutdown callback.

Parameters:

• callback (Callable[[Self], Coroutine[Any, Any, None]]) –

  The shutdown callback to remove.

Raises:

• ValueError –

  If the callback was not registered.

Remove a startup callback.

Parameters:

• callback (Callable[[Self], Coroutine[Any, Any, None]]) –

  The startup callback to remove.

Raises:

• ValueError –

  If the callback was not registered.

Start the bot's REST client and wait until the bot's closed.

Raises:

• RuntimeError –

  If the client is already alive. If the client is ASGI managed.

Start the bot's REST client.

Raises:

• RuntimeError –

  If the client is already alive. If the client is ASGI managed.