@@ -257,7 +257,48 @@ def __init__(
257
257
event_dispatcher : Optional [EventDispatcher ] = None ,
258
258
):
259
259
"""
260
- Initialize a new Redis client.
260
+ Initialize a new async Redis client.
261
+
262
+ PARAMETER DOCUMENTATION
263
+ =======================
264
+
265
+ host (str, default="localhost"): Redis server hostname or IP address
266
+ port (int, default=6379): Redis server port number
267
+ db (Union[str, int], default=0): Redis logical database number (0-15, shared CPU/memory/ACL)
268
+ password (Optional[str], default=None): Redis server authentication password
269
+ socket_timeout (Optional[float], default=None): Socket read/write timeout in seconds (None=no timeout)
270
+ socket_connect_timeout (Optional[float], default=None): Socket connection timeout in seconds (None=system default ~60-120s)
271
+ socket_keepalive (Optional[bool], default=None): Enable TCP keepalive for dead connection detection (None=disabled)
272
+ socket_keepalive_options (Optional[Mapping], default=None): Advanced TCP keepalive socket options (e.g. {socket.TCP_KEEPIDLE: 30})
273
+ connection_pool (Optional[ConnectionPool], default=None): Pre-configured connection pool instance
274
+ unix_socket_path (Optional[str], default=None): Path to Unix domain socket for local connections
275
+ encoding (str, default="utf-8"): Character encoding for string values (utf-8, ascii, latin-1, etc.)
276
+ encoding_errors (str, default="strict"): How to handle encoding/decoding errors (strict, ignore, replace)
277
+ decode_responses (bool, default=False): Automatically decode byte responses to strings
278
+ retry_on_timeout (bool, default=False): Deprecated - use retry_on_error list instead
279
+ retry (Retry, default=Retry(...)): Retry policy configuration for failed operations (defaults: 3 retries on ConnectionError, TimeoutError, BusyLoadingError)
280
+ retry_on_error (Optional[list], default=None): Additional error types to retry beyond defaults
281
+ ssl (bool, default=False): Enable SSL/TLS encryption for connections
282
+ ssl_keyfile (Optional[str], default=None): Path to client private key file for mutual TLS
283
+ ssl_certfile (Optional[str], default=None): Path to client certificate file for mutual TLS
284
+ ssl_cert_reqs (Union[str, VerifyMode], default="required"): Certificate verification (required/optional/none)
285
+ ssl_ca_certs (Optional[str], default=None): Path to CA certificate bundle (None=system default)
286
+ ssl_ca_data (Optional[str], default=None): CA certificate data as string (alternative to ssl_ca_certs)
287
+ ssl_check_hostname (bool, default=True): Verify certificate hostname matches connection
288
+ ssl_min_version (Optional[TLSVersion], default=None): Minimum TLS version (None=system default)
289
+ ssl_ciphers (Optional[str], default=None): Allowed SSL cipher suites in OpenSSL format (None=system default)
290
+ max_connections (Optional[int], default=None): Maximum connections in pool (None=unlimited)
291
+ single_connection_client (bool, default=False): Use single connection instead of pool (not thread-safe)
292
+ health_check_interval (int, default=0): Seconds before connection health check on acquisition (0=disabled)
293
+ client_name (Optional[str], default=None): Client name identifier sent to Redis server (visible in CLIENT LIST)
294
+ lib_name (Optional[str], default="redis-py"): Library name identifier
295
+ lib_version (Optional[str], default=auto): Library version identifier (auto-detected)
296
+ username (Optional[str], default=None): Username for Redis ACL authentication (None=use default user)
297
+ auto_close_connection_pool (Optional[bool], default=None): Deprecated - connection pools are auto-closed by default
298
+ redis_connect_func (Optional[Callable], default=None): Custom function called after connection (replaces default setup)
299
+ credential_provider (Optional[CredentialProvider], default=None): Dynamic credential provider (for rotating credentials)
300
+ protocol (Optional[int], default=2): Redis protocol version (2=RESP2, 3=RESP3, requires Redis 6.0+ for RESP3)
301
+ event_dispatcher (Optional[EventDispatcher], default=None): Event dispatcher for lifecycle events (None=default with re-auth support)
261
302
262
303
To specify a retry policy for specific errors, you have two options:
263
304
0 commit comments