pynenc_redis.conf.config_redis

Module Contents

Classes

ConfigRedis

Specific Configuration for any Redis client.

API

class pynenc_redis.conf.config_redis.ConfigRedis(config_values: Optional[dict[str, Any]] = None, config_filepath: Optional[str] = None)[source]

Bases: pynenc.conf.config_base.ConfigPynencBase

Specific Configuration for any Redis client.

This class provides configuration settings specific to Redis clients, allowing for customization of the Redis connection used in the system.

Variables:

  • redis_username (ConfigField[str]) – The username to use when connecting to the Redis server. Defaults to an empty string, indicating that no username is provided.

  • redis_password (ConfigField[str]) – The password to use when connecting to the Redis server. Defaults to an empty string, indicating that no password is provided.

  • redis_host (ConfigField[str]) – The hostname of the Redis server. Defaults to ‘localhost’, specifying that the Redis server is expected to be running on the same machine as the client.

  • redis_port (ConfigField[int]) – The port number on which the Redis server is listening. Defaults to 6379, which is the default port for Redis.

  • redis_db (ConfigField[int]) – The database number to connect to on the Redis server. Redis servers typically support multiple databases (numbered from 0), allowing different applications or parts of an application to operate in separate data spaces. Defaults to 0.

  • redis_url (ConfigField[str]) – The URL of the Redis server. This field is intended to be used when the Redis server is accessed via a URL rather than a hostname and port. Defaults to an empty string, indicating that no URL is provided. If specified will override all other connection parameters.

  • socket_timeout (ConfigField[float]) – Timeout in seconds for socket operations. Defines how long to wait for data to be returned from an established connection before timing out. Defaults to 5.0 seconds to prevent operations from hanging indefinitely.

  • socket_connect_timeout (ConfigField[float]) – Timeout in seconds for socket connection establishment. Controls how long to wait when initially connecting to the Redis server before failing. Defaults to 5.0 seconds to ensure connections are established in a reasonable timeframe.

  • health_check_interval (ConfigField[int]) – Interval in seconds between automatic health checks to detect disconnected clients. Redis will periodically check if the connection is still alive. Defaults to 30 seconds, providing a balance between responsiveness and overhead.

  • max_connection_attempts (ConfigField[int]) – Maximum number of connection attempts before giving up. When a connection fails, the system will retry this many times before raising an error. Defaults to 3 attempts, allowing for transient network issues while preventing excessive delays.

  • redis_pool_max_connections (ConfigField[int]) – Maximum number of connections to keep in the Redis connection pool. Default is 10.

  • redis_pool_health_check_interval (ConfigField[float]) – Interval in seconds for checking the health of connections in the pool. Default is 30.0 seconds.

Example usage of the ConfigRedis class involves initializing it with specific values for host, port, and database, or relying on the defaults for a standard Redis setup.

Initialization

redis_username

‘ConfigField(…)’

redis_password

‘ConfigField(…)’

redis_host

‘ConfigField(…)’

redis_port

‘ConfigField(…)’

redis_db

‘ConfigField(…)’

redis_url

‘ConfigField(…)’

socket_timeout

‘ConfigField(…)’

socket_connect_timeout

‘ConfigField(…)’

health_check_interval

‘ConfigField(…)’

max_connection_attempts

‘ConfigField(…)’

redis_pool_max_connections

‘ConfigField(…)’

redis_pool_health_check_interval

‘ConfigField(…)’