hikari.impl.config

Data class containing network-related configuration settings.

Module Contents

class hikari.impl.config.BasicAuthHeader

An object that can be set as a producer for a basic auth header.

property header: str

Create the full Authentication header value.

charset: str

Encoding to use for the username and password.

Default is "utf-8", but you may choose to use something else, including third-party encodings (e.g. IBM’s EBCDIC codepages).

password: str

Password to use.

username: str

Username for the header.

Warning

This must not contain ":".

class hikari.impl.config.CacheSettings

Bases: hikari.api.config.CacheSettings

Settings to control the cache.

components: hikari.api.config.CacheComponents

The cache components to use.

Defaults to hikari.api.cache.CacheComponents.ALL.

max_dm_channel_ids: int

The maximum number of channel IDs to store in the cache at once.

This will have no effect if the channel IDs cache is not enabled.

Defaults to 50.

max_messages: int

The maximum number of messages to store in the cache at once.

This will have no effect if the messages cache is not enabled.

Defaults to 300.

class hikari.impl.config.HTTPSettings

Bases: hikari.api.config.HTTPSettings

Settings to control HTTP clients.

enable_cleanup_closed: bool

Toggle whether to clean up closed transports.

This defaults to False to combat various protocol and asyncio issues present. If you are sure you know what you are doing, you may instead set this to True to enable this behavior internally.

force_close_transports: bool

Toggle whether to force close transports on shut down.

This defaults to True to combat various protocol and asyncio issues present when using Microsoft Windows. If you are sure you know what you are doing, you may instead set this to False to disable this behavior internally.

max_redirects: int | None

Behavior for handling redirect HTTP responses.

If a int, allow following redirects from 3xx HTTP responses for up to this many redirects. Exceeding this value will raise an exception.

If None, then disallow any redirects.

The default is to disallow this behavior for security reasons.

Generally, it is safer to keep this disabled. You may find a case in the future where you need to enable this if Discord change their URL without warning.

Note

This will only apply to the REST API. WebSockets remain unaffected by any value set here.

ssl: ssl.SSLContext

SSL context to use.

This may be assigned a bool or an ssl.SSLContext object.

If assigned to True, a default SSL context is generated by this class that will enforce SSL verification. This is then stored in this field.

If False, then a default SSL context is generated by this class that will NOT enforce SSL verification. This is then stored in this field.

If an instance of ssl.SSLContext, then this context will be used.

Warning

Setting a custom value here may have security implications, or may result in the application being unable to connect to Discord at all.

Warning

Disabling SSL verification is almost always unadvised. This is because your application will no longer check whether you are connecting to Discord, or to some third party spoof designed to steal personal credentials such as your application token.

There may be cases where SSL certificates do not get updated, and in this case, you may find that disabling this explicitly allows you to work around any issues that are occurring, but you should immediately seek a better solution where possible if any form of personal security is in your interest.

timeouts: HTTPTimeoutSettings

Settings to control HTTP request timeouts.

The behaviour if this is not explicitly defined is to use sane defaults that are most efficient for optimal use of this library.

class hikari.impl.config.HTTPTimeoutSettings

Settings to control HTTP request timeouts.

acquire_and_connect: float | None

Timeout for request_socket_connect PLUS connection acquisition.

By default, this has no timeout allocated. Setting it to None will disable it.

request_socket_connect: float | None

Timeout for connecting a socket.

By default, this has no timeout allocated. Setting it to None will disable it.

request_socket_read: float | None

Timeout for reading a socket.

By default, this has no timeout allocated. Setting it to None will disable it.

total: float | None

Total timeout for entire request.

By default, this has a 30 second timeout allocated. Setting it to None will disable it.

class hikari.impl.config.ProxySettings

Bases: hikari.api.config.ProxySettings

Settings for configuring an HTTP-based proxy.

property all_headers: hikari.internal.data_binding.Headers | None

Return all proxy headers.

Will be None if no headers are to be send with any request.

auth: Any

Authentication header value to use.

When cast to a str, this should provide the full value for the authentication header.

If you are using basic auth, you should consider using the BasicAuthHeader helper object here, as this will provide any transformations you may require into a base64 string.

The default is to have this set to None, which will result in no authentication being provided.

headers: hikari.internal.data_binding.Headers | None

Additional headers to use for requests via a proxy, if required.

trust_env: bool

Toggle whether to look for a netrc file or environment variables.

If True, and no url is given on this object, then HTTP_PROXY and HTTPS_PROXY will be used from the environment variables, or a netrc file may be read to determine credentials.

If False, then this information is instead ignored.

Defaults to False to prevent potentially unwanted behavior.

Note

For more details of using netrc, visit: <https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html>

url: None | str

Proxy URL to use.

Defaults to None which disables the use of an explicit proxy.