Skip to content

Idle connection management #3866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
praboud wants to merge 14 commits into
base: master
Choose a base branch
from
Open

Idle connection management #3866

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
9191edd
WIP on adding idle timeout cleanup code to ConnectionPool
praboud Nov 5, 2025
ec4f28a
Improve the tests
praboud Nov 5, 2025
0bda373
Single threaded idle manager design
praboud Nov 5, 2025
e55c9fc
Improve tests
praboud Nov 5, 2025
11920c8
Improve tests
praboud Nov 5, 2025
2a2d68c
Simplify code
praboud Nov 5, 2025
19a9833
Update comments
praboud Nov 5, 2025
ee2f03c
Plumb through parameters
praboud Nov 5, 2025
ac60c07
Fix
praboud Nov 5, 2025
3d14374
Fix merge conflicts
praboud Dec 4, 2025
97df995
Fix tests
praboud Dec 4, 2025
7f72f28
Minor cleanup
praboud Dec 4, 2025
7570171
Lint
praboud Dec 4, 2025
b6ae4a7
Code review feedback
praboud Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions redis/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,8 @@ def __init__(
cache_config: Optional[CacheConfig] = None,
event_dispatcher: Optional[EventDispatcher] = None,
maint_notifications_config: Optional[MaintNotificationsConfig] = None,
idle_connection_timeout: Optional[float] = None,
idle_check_interval: float = 60.0,
Comment on lines +264 to +265
Copy link

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing documentation for new parameters. The idle_connection_timeout and idle_check_interval parameters are added to the __init__ method but are not documented in the docstring. These parameters should be documented in the Args section to help users understand their purpose and usage.

Consider adding documentation like:

idle_connection_timeout:
    If set, connections that have been idle (not used) for longer than
    this timeout (in seconds) will be automatically closed. If None (default),
    idle connections are never closed. Only used when connection_pool is not provided.
idle_check_interval:
    How frequently (in seconds) to check for idle connections. Defaults to 60 seconds.
    Only used when idle_connection_timeout is set and connection_pool is not provided.

Copilot uses AI. Check for mistakes.
) -> None:
"""
Initialize a new Redis client.
Expand Down Expand Up @@ -314,6 +316,8 @@ def __init__(
"redis_connect_func": redis_connect_func,
"credential_provider": credential_provider,
"protocol": protocol,
"idle_connection_timeout": idle_connection_timeout,
"idle_check_interval": idle_check_interval,
}
# based on input, setup appropriate connection args
if unix_socket_path is not None:
Expand Down
2 changes: 2 additions & 0 deletions redis/cluster.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,8 @@ def parse_cluster_myshardid(resp, **options):
"username",
"cache",
"cache_config",
"idle_connection_timeout",
"idle_check_interval",
)
KWARGS_DISABLED_KEYS = ("host", "port", "retry")

Expand Down
Loading