hikari.impl.config#
Data class containing network-related configuration settings.
An object that can be set as a producer for a basic auth header.
class-attribute
instance-attribute
#
charset: str = field(default='utf-8', validator=instance_of(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).
class-attribute
instance-attribute
#
password: str = field(repr=False, validator=instance_of(str))
Password to use.
class-attribute
instance-attribute
#
username: str = field(validator=instance_of(str))
Username for the header.
Warning
This must not contain ":".
Bases: CacheSettings
Settings to control the cache.
class-attribute
instance-attribute
#
components: CacheComponents = field(converter=CacheComponents, default=ALL)
The cache components to use.
Defaults to hikari.api.config.CacheComponents.ALL.
class-attribute
instance-attribute
#
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.
class-attribute
instance-attribute
#
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.
Bases: HTTPSettings
Settings to control HTTP clients.
class-attribute
instance-attribute
#
enable_cleanup_closed: bool = field(default=False, validator=instance_of(bool))
class-attribute
instance-attribute
#
force_close_transports: bool = field(default=True, validator=instance_of(bool))
class-attribute
instance-attribute
#
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.
class-attribute
instance-attribute
#
ssl: SSLContext = field(
factory=lambda: _ssl_factory(True),
converter=_ssl_factory,
validator=instance_of(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.
class-attribute
instance-attribute
#
timeouts: HTTPTimeoutSettings = field(
factory=HTTPTimeoutSettings, validator=instance_of(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.
Settings to control HTTP request timeouts.
class-attribute
instance-attribute
#
Timeout for request_socket_connect PLUS connection acquisition.
By default, this has no timeout allocated. Setting it to None
will disable it.
class-attribute
instance-attribute
#
Timeout for connecting a socket.
By default, this has no timeout allocated. Setting it to None
will disable it.
Bases: ProxySettings
Settings for configuring an HTTP-based proxy.
property
#
all_headers: Optional[Headers]
Return all proxy headers.
Will be None if no headers are to be send with any request.
class-attribute
instance-attribute
#
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
hikari.impl.config.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.
class-attribute
instance-attribute
#
Additional headers to use for requests via a proxy, if required.
class-attribute
instance-attribute
#
trust_env: bool = field(default=False, validator=instance_of(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