Skip to content

castlecraft_engineer.caching

castlecraft_engineer.caching

get_redis_cache_async_connection(redis_uri=None, is_sentinel_enabled=None, sentinels_uri=None, sentinel_username=None, sentinel_password=None, sentinel_master_username=None, sentinel_master_password=None, sentinel_master_service=None) async

Gets an asynchronous Redis connection, allowing programmatic overrides. Falls back to environment variables if parameters are not provided.

Source code in src/castlecraft_engineer/caching/cache.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
async def get_redis_cache_async_connection(
    redis_uri: Optional[str] = None,
    is_sentinel_enabled: Optional[bool] = None,
    sentinels_uri: Optional[str] = None,
    sentinel_username: Optional[str] = None,
    sentinel_password: Optional[str] = None,
    sentinel_master_username: Optional[str] = None,
    sentinel_master_password: Optional[str] = None,
    sentinel_master_service: Optional[str] = None,
):
    """
    Gets an asynchronous Redis connection, allowing programmatic overrides.
    Falls back to environment variables if parameters are not provided.
    """
    try:
        # Prioritize programmatic parameters, then fall back to environment variables
        final_redis_uri = (
            redis_uri
            if redis_uri is not None
            else environ.get(ENV_CACHE_REDIS_URL, DEFAULT_CACHE_REDIS_URL)
        )
        final_is_sentinel_enabled = (
            is_sentinel_enabled
            if is_sentinel_enabled is not None
            else _is_truthy(environ.get(ENV_ENABLE_CACHE_REDIS_CLUSTER))
        )
        final_sentinels_uri = (
            sentinels_uri
            if sentinels_uri is not None
            else environ.get(ENV_CACHE_REDIS_SENTINELS)
        )
        final_sentinel_username = (
            sentinel_username
            if sentinel_username is not None
            else environ.get(ENV_CACHE_REDIS_SENTINEL_USERNAME)
        )
        final_sentinel_password = (
            sentinel_password
            if sentinel_password is not None
            else environ.get(ENV_CACHE_REDIS_SENTINEL_PASSWORD)
        )
        final_master_username = (
            sentinel_master_username
            if sentinel_master_username is not None
            else environ.get(ENV_CACHE_REDIS_MASTER_USERNAME)
        )
        final_master_password = (
            sentinel_master_password
            if sentinel_master_password is not None
            else environ.get(ENV_CACHE_REDIS_MASTER_PASSWORD)
        )
        final_master_service = (
            sentinel_master_service
            if sentinel_master_service is not None
            else environ.get(ENV_CACHE_REDIS_MASTER_SERVICE)
        )

        return await get_async_redis_connection(
            redis_uri=final_redis_uri,
            is_sentinel_enabled=final_is_sentinel_enabled,
            sentinels_uri=final_sentinels_uri,
            sentinel_username=final_sentinel_username,
            sentinel_password=final_sentinel_password,
            sentinel_master_username=final_master_username,
            sentinel_master_password=final_master_password,
            sentinel_master_service=final_master_service,
        )
    except ConnectionError as exc:
        logger.error(exc)
        return None

get_redis_cache_connection(redis_uri=None, is_sentinel_enabled=None, sentinels_uri=None, sentinel_username=None, sentinel_password=None, sentinel_master_username=None, sentinel_master_password=None, sentinel_master_service=None)

Gets a synchronous Redis connection, allowing programmatic overrides. Falls back to environment variables if parameters are not provided.

Source code in src/castlecraft_engineer/caching/cache.py 
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def get_redis_cache_connection(
    redis_uri: Optional[str] = None,
    is_sentinel_enabled: Optional[bool] = None,
    sentinels_uri: Optional[str] = None,
    sentinel_username: Optional[str] = None,
    sentinel_password: Optional[str] = None,
    sentinel_master_username: Optional[str] = None,
    sentinel_master_password: Optional[str] = None,
    sentinel_master_service: Optional[str] = None,
):
    """
    Gets a synchronous Redis connection, allowing programmatic overrides.
    Falls back to environment variables if parameters are not provided.
    """
    try:
        # Prioritize programmatic parameters, then fall back to environment variables
        final_redis_uri = (
            redis_uri
            if redis_uri is not None
            else environ.get(ENV_CACHE_REDIS_URL, DEFAULT_CACHE_REDIS_URL)
        )
        final_is_sentinel_enabled = (
            is_sentinel_enabled
            if is_sentinel_enabled is not None
            else _is_truthy(environ.get(ENV_ENABLE_CACHE_REDIS_CLUSTER))
        )
        final_sentinels_uri = (
            sentinels_uri
            if sentinels_uri is not None
            else environ.get(ENV_CACHE_REDIS_SENTINELS)
        )
        final_sentinel_username = (
            sentinel_username
            if sentinel_username is not None
            else environ.get(ENV_CACHE_REDIS_SENTINEL_USERNAME)
        )
        final_sentinel_password = (
            sentinel_password
            if sentinel_password is not None
            else environ.get(ENV_CACHE_REDIS_SENTINEL_PASSWORD)
        )
        final_master_username = (
            sentinel_master_username
            if sentinel_master_username is not None
            else environ.get(ENV_CACHE_REDIS_MASTER_USERNAME)
        )
        final_master_password = (
            sentinel_master_password
            if sentinel_master_password is not None
            else environ.get(ENV_CACHE_REDIS_MASTER_PASSWORD)
        )
        final_master_service = (
            sentinel_master_service
            if sentinel_master_service is not None
            else environ.get(ENV_CACHE_REDIS_MASTER_SERVICE)
        )

        return get_redis_connection(
            redis_uri=final_redis_uri,
            is_sentinel_enabled=final_is_sentinel_enabled,
            sentinels_uri=final_sentinels_uri,
            sentinel_username=final_sentinel_username,
            sentinel_password=final_sentinel_password,
            sentinel_master_username=final_master_username,
            sentinel_master_password=final_master_password,
            sentinel_master_service=final_master_service,
        )
    except ConnectionError as exc:
        logger.error(exc)
        return None