Core interface for Hikari’s configuration dataclasses.
- class hikari.api.config.CacheComponents[source]#
Flags to control the cache components.
- class hikari.api.config.CacheSettings[source]#
Settings to control the cache.
- abstract property components: CacheComponents[source]#
Cache components to use.
- class hikari.api.config.HTTPSettings[source]#
Settings to control HTTP clients.
- abstract property max_redirects: int | None[source]#
Behavior for handling redirect HTTP responses.
int, allow following redirects from
3xxHTTP responses for up to this many redirects. Exceeding this value will raise an exception.
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.
This will only apply to the REST API. WebSockets remain unaffected by any value set here.
- abstract property ssl: ssl.SSLContext[source]#
SSL context to use.
This may be assigned a
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.
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.
Setting a custom value here may have security implications, or may result in the application being unable to connect to Discord at all.
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.
- class hikari.api.config.ProxySettings[source]#
Settings for configuring an HTTP-based proxy.
- abstract property trust_env: bool[source]#
Toggle whether to look for a
netrcfile or environment variables.
True, and no
urlis given on this object, then
HTTPS_PROXYwill be used from the environment variables, or a
netrcfile may be read to determine credentials.
False, then this information is instead ignored.
For more details of using
netrc, visit: https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html