Source code for pynenc_redis.conf.config_redis

from cistell import ConfigField
from pynenc.conf.config_base import ConfigPynencBase




class ConfigRedis(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.

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

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

    :cvar ConfigField[str] redis_host:
        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.

    :cvar ConfigField[int] redis_port:
        The port number on which the Redis server is listening. Defaults to 6379,
        which is the default port for Redis.

    :cvar ConfigField[int] redis_db:
        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.

    :cvar ConfigField[str] redis_url:
        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.

    :cvar ConfigField[float] socket_timeout:
        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.

    :cvar ConfigField[float] socket_connect_timeout:
        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.

    :cvar ConfigField[int] health_check_interval:
        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.

    :cvar ConfigField[int] max_connection_attempts:
        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.

    :cvar ConfigField[int] redis_pool_max_connections:
        Maximum number of connections to keep in the Redis connection pool.
        Default is 10.

    :cvar ConfigField[float] redis_pool_health_check_interval:
        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.
    """

    redis_username = ConfigField("")
    redis_password = ConfigField("")
    redis_host = ConfigField("localhost")
    redis_port = ConfigField(6379)
    redis_db = ConfigField(0)
    redis_url = ConfigField("")

    # Connection management settings
    socket_timeout = ConfigField(5.0)
    socket_connect_timeout = ConfigField(5.0)
    health_check_interval = ConfigField(30)
    max_connection_attempts = ConfigField(3)

    # Redis connection pool settings
    redis_pool_max_connections = ConfigField(100)
    redis_pool_health_check_interval = ConfigField(30.0)