Skip to content

Commit 82ff77c

Browse files
Adds async docstrings
Signed-off-by: Elena Kolevska <[email protected]>
1 parent fe8049c commit 82ff77c

File tree

2 files changed

+53
-12
lines changed

2 files changed

+53
-12
lines changed

redis/asyncio/client.py

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,48 @@ def __init__(
257257
event_dispatcher: Optional[EventDispatcher] = None,
258258
):
259259
"""
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)
261302
262303
To specify a retry policy for specific errors, you have two options:
263304

redis/client.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -267,24 +267,24 @@ def __init__(
267267
retry_on_timeout (bool, default=False): Deprecated - use retry_on_error list instead
268268
retry (Retry, default=Retry(...)): Retry policy configuration for failed operations (defaults: 3 retries with jitter backoff on ConnectionError, TimeoutError, BusyLoadingError)
269269
retry_on_error (Optional[List], default=None): Additional error types to retry beyond defaults
270-
max_connections (Optional[int], default=None): Maximum connections in pool (None=unlimited)
271-
health_check_interval (int, default=0): Seconds before connection health check on acquisition (0=disabled)
272-
single_connection_client (bool, default=False): Use single connection instead of pool (not thread-safe)
273270
ssl (bool, default=False): Enable SSL/TLS encryption for connections
274271
ssl_keyfile (Optional[str], default=None): Path to client private key file for mutual TLS
275272
ssl_certfile (Optional[str], default=None): Path to client certificate file for mutual TLS
276-
ssl_cert_reqs (Optional[str], default=None): Certificate verification (required/optional/none, None=none)
273+
ssl_cert_reqs (Union[str, ssl.VerifyMode], default="required"): Certificate verification (required/optional/none)
277274
ssl_ca_certs (Optional[str], default=None): Path to CA certificate bundle (None=system default)
275+
ssl_ca_path (Optional[str], default=None): Path to directory containing CA certificates
278276
ssl_ca_data (Optional[str], default=None): CA certificate data as string (alternative to ssl_ca_certs)
279-
ssl_check_hostname (Optional[bool], default=None): Verify certificate hostname matches connection (None=auto based on ssl_cert_reqs)
280-
ssl_password (Optional[Union[str, Callable]], default=None): Password for encrypted private key
281-
ssl_disable_dev_warnings (bool, default=False): Disable SSL development warnings
282-
ssl_ciphers (Optional[str], default=None): Allowed SSL cipher suites in OpenSSL format (None=system default)
283-
ssl_crlfile (Optional[str], default=None): Path to Certificate Revocation List file
277+
ssl_check_hostname (bool, default=True): Verify certificate hostname matches connection
278+
ssl_password (Optional[str], default=None): Password for encrypted private key
284279
ssl_validate_ocsp (bool, default=False): Enable OCSP certificate validation
285280
ssl_validate_ocsp_stapled (bool, default=False): Validate OCSP stapled responses
286-
ssl_ocsp_context (Optional[object], default=None): Custom OCSP context for validation
287-
ssl_ocsp_expected_cert (Optional[object], default=None): Expected certificate for OCSP validation
281+
ssl_ocsp_context (Optional[OpenSSL.SSL.Context], default=None): Custom OCSP context for validation
282+
ssl_ocsp_expected_cert (Optional[str], default=None): Expected certificate for OCSP validation
283+
ssl_min_version (Optional[ssl.TLSVersion], default=None): Minimum TLS version (None=system default)
284+
ssl_ciphers (Optional[str], default=None): Allowed SSL cipher suites in OpenSSL format (None=system default)
285+
max_connections (Optional[int], default=None): Maximum connections in pool (None=unlimited)
286+
single_connection_client (bool, default=False): Use single connection instead of pool (not thread-safe)
287+
health_check_interval (int, default=0): Seconds before connection health check on acquisition (0=disabled)
288288
client_name (Optional[str], default=None): Client name identifier sent to Redis server (visible in CLIENT LIST)
289289
lib_name (Optional[str], default="redis-py"): Library name identifier
290290
lib_version (Optional[str], default=auto): Library version identifier (auto-detected)

0 commit comments

Comments
 (0)