Skip to content

Commit aa9b3b3

Browse files
committed
support report libname and libver to Redis
1 parent e1017fd commit aa9b3b3

File tree

10 files changed

+103
-2
lines changed

10 files changed

+103
-2
lines changed

redis/asyncio/client.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
import copy
33
import inspect
44
import re
5+
import sys
56
import warnings
67
from typing import (
78
TYPE_CHECKING,
@@ -59,6 +60,7 @@
5960
from redis.typing import ChannelT, EncodableT, KeyT
6061
from redis.utils import safe_str, str_if_bytes
6162

63+
6264
PubSubHandler = Callable[[Dict[str, str]], Awaitable[None]]
6365
_KeyT = TypeVar("_KeyT", bound=KeyT)
6466
_ArgT = TypeVar("_ArgT", KeyT, EncodableT)
@@ -171,6 +173,7 @@ def __init__(
171173
single_connection_client: bool = False,
172174
health_check_interval: int = 0,
173175
client_name: Optional[str] = None,
176+
set_lib: bool = True,
174177
username: Optional[str] = None,
175178
retry: Optional[Retry] = None,
176179
auto_close_connection_pool: bool = True,
@@ -212,6 +215,7 @@ def __init__(
212215
"max_connections": max_connections,
213216
"health_check_interval": health_check_interval,
214217
"client_name": client_name,
218+
"set_lib": set_lib,
215219
"redis_connect_func": redis_connect_func,
216220
}
217221
# based on input, setup appropriate connection args

redis/asyncio/connection.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
TimeoutError,
5656
)
5757
from redis.typing import EncodableT, EncodedT
58-
from redis.utils import HIREDIS_AVAILABLE, str_if_bytes
58+
from redis.utils import HIREDIS_AVAILABLE, str_if_bytes, get_libver
5959

6060
hiredis = None
6161
if HIREDIS_AVAILABLE:
@@ -457,6 +457,7 @@ class Connection:
457457
"db",
458458
"username",
459459
"client_name",
460+
"set_lib",
460461
"credential_provider",
461462
"password",
462463
"socket_timeout",
@@ -503,6 +504,7 @@ def __init__(
503504
socket_read_size: int = 65536,
504505
health_check_interval: float = 0,
505506
client_name: Optional[str] = None,
507+
set_lib: bool = False,
506508
username: Optional[str] = None,
507509
retry: Optional[Retry] = None,
508510
redis_connect_func: Optional[ConnectCallbackT] = None,
@@ -521,6 +523,7 @@ def __init__(
521523
self.port = int(port)
522524
self.db = db
523525
self.client_name = client_name
526+
self.set_lib = set_lib,
524527
self.credential_provider = credential_provider
525528
self.password = password
526529
self.username = username
@@ -717,7 +720,14 @@ async def on_connect(self) -> None:
717720
await self.send_command("CLIENT", "SETNAME", self.client_name)
718721
if str_if_bytes(await self.read_response()) != "OK":
719722
raise ConnectionError("Error setting client name")
720-
723+
if self.set_lib is True:
724+
try:
725+
await self.send_command("CLIENT", "SETINFO", "LIB-NAME", "redis-py")
726+
await self.read_response()
727+
await self.send_command("CLIENT", "SETINFO", "LIB-VERSION", get_libver())
728+
await self.read_response()
729+
except:
730+
pass
721731
# if a database is specified, switch to it
722732
if self.db:
723733
await self.send_command("SELECT", self.db)

redis/client.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import copy
22
import datetime
33
import re
4+
import sys
45
import threading
56
import time
67
import warnings
@@ -745,6 +746,7 @@ class AbstractRedis:
745746
"CLIENT LIST": parse_client_list,
746747
"CLIENT INFO": parse_client_info,
747748
"CLIENT SETNAME": bool_ok,
749+
"CLIENT SETINFO": bool_ok,
748750
"CLIENT UNBLOCK": lambda r: r and int(r) == 1 or False,
749751
"CLIENT PAUSE": bool_ok,
750752
"CLIENT GETREDIR": int,
@@ -938,6 +940,7 @@ def __init__(
938940
single_connection_client=False,
939941
health_check_interval=0,
940942
client_name=None,
943+
set_lib=True,
941944
username=None,
942945
retry=None,
943946
redis_connect_func=None,
@@ -988,6 +991,7 @@ def __init__(
988991
"max_connections": max_connections,
989992
"health_check_interval": health_check_interval,
990993
"client_name": client_name,
994+
"set_lib": set_lib,
991995
"redis_connect_func": redis_connect_func,
992996
"credential_provider": credential_provider,
993997
}

redis/cluster.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,7 @@ class AbstractRedisCluster:
212212
"AUTH",
213213
"CLIENT LIST",
214214
"CLIENT SETNAME",
215+
"CLIENT SETINFO",
215216
"CLIENT GETNAME",
216217
"CONFIG SET",
217218
"CONFIG REWRITE",

redis/commands/core.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -706,6 +706,14 @@ def client_setname(self, name: str, **kwargs) -> ResponseT:
706706
"""
707707
return self.execute_command("CLIENT SETNAME", name, **kwargs)
708708

709+
def client_setinfo(self, attr: str, value: str, **kwargs) -> ResponseT:
710+
"""
711+
Sets the current connection libname
712+
713+
For mor information see https://redis.io/commands/client-setinfo
714+
"""
715+
return self.execute_command("CLIENT SETINFO", attr, value, **kwargs)
716+
709717
def client_unblock(
710718
self, client_id: int, error: bool = False, **kwargs
711719
) -> ResponseT:

redis/connection.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
HIREDIS_AVAILABLE,
4040
HIREDIS_PACK_AVAILABLE,
4141
str_if_bytes,
42+
get_libver,
4243
)
4344

4445
try:
@@ -600,6 +601,7 @@ def __init__(
600601
socket_read_size=65536,
601602
health_check_interval=0,
602603
client_name=None,
604+
set_lib=False,
603605
username=None,
604606
retry=None,
605607
redis_connect_func=None,
@@ -623,6 +625,7 @@ def __init__(
623625
self.pid = os.getpid()
624626
self.db = db
625627
self.client_name = client_name
628+
self.set_lib = set_lib
626629
self.credential_provider = credential_provider
627630
self.password = password
628631
self.username = username
@@ -738,6 +741,10 @@ def _error_message(self, exception):
738741
def on_connect(self):
739742
"Initialize the connection, authenticate and select a database"
740743
self._parser.on_connect(self)
744+
if ssl_available:
745+
authened = False
746+
else:
747+
authened = True
741748

742749
# if credential provider or username and/or password are set, authenticate
743750
if self.credential_provider or (self.username or self.password):
@@ -762,12 +769,22 @@ def on_connect(self):
762769

763770
if str_if_bytes(auth_response) != "OK":
764771
raise AuthenticationError("Invalid Username or Password")
772+
else:
773+
authened = True
765774

766775
# if a client_name is given, set it
767776
if self.client_name:
768777
self.send_command("CLIENT", "SETNAME", self.client_name)
769778
if str_if_bytes(self.read_response()) != "OK":
770779
raise ConnectionError("Error setting client name")
780+
if self.set_lib is True and authened is True:
781+
try:
782+
self.send_command("CLIENT", "SETINFO", "LIB-NAME", "redis-py")
783+
self.read_response()
784+
self.send_command("CLIENT", "SETINFO", "LIB-VERSION", get_libver())
785+
self.read_response()
786+
except:
787+
pass
771788

772789
# if a database is specified, switch to it
773790
if self.db:

redis/utils.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import sys
12
from contextlib import contextmanager
23
from functools import wraps
34
from typing import Any, Dict, Mapping, Union
@@ -19,6 +20,11 @@
1920
except ImportError:
2021
CRYPTOGRAPHY_AVAILABLE = False
2122

23+
if sys.version_info >= (3, 8):
24+
from importlib import metadata
25+
else:
26+
import importlib_metadata as metadata
27+
2228

2329
def from_url(url, **kwargs):
2430
"""
@@ -110,3 +116,11 @@ def wrapper(*args, **kwargs):
110116
return wrapper
111117

112118
return decorator
119+
120+
121+
def get_libver():
122+
try:
123+
libver = metadata.version("redis")
124+
except metadata.PackageNotFoundError:
125+
libver = "99.99.99"
126+
return libver

tests/test_asyncio/test_cluster.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -870,6 +870,15 @@ async def test_client_setname(self, r: RedisCluster) -> None:
870870
client_name = await r.client_getname(target_nodes=node)
871871
assert client_name == "redis_py_test"
872872

873+
@skip_if_server_version_lt("7.2.0")
874+
async def test_client_setinfo(self, r: RedisCluster) -> None:
875+
node = r.get_random_node()
876+
await r.client_setinfo("lib-name", "redis-py", target_nodes=node)
877+
await r.client_setinfo("lib-ver", "4.33", target_nodes=node)
878+
info = await r.client_info(target_nodes=node)
879+
assert "lib-name" in info
880+
assert "lib-ver" in info
881+
873882
async def test_exists(self, r: RedisCluster) -> None:
874883
d = {"a": b"1", "b": b"2", "c": b"3", "d": b"4"}
875884
await r.mset_nonatomic(d)

tests/test_asyncio/test_commands.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,15 @@ async def test_client_setname(self, r: redis.Redis):
340340
assert await r.client_setname("redis_py_test")
341341
assert await r.client_getname() == "redis_py_test"
342342

343+
@skip_if_server_version_lt("7.2.0")
344+
@pytest.mark.onlynoncluster
345+
async def test_client_setinfo(self, r:redis.Redis):
346+
assert await r.client_setinfo("lib-name", "redis-py")
347+
assert await r.client_setinfo("lib-ver", "4.33")
348+
info = await r.client_info()
349+
assert "lib-name" in info
350+
assert "lib-ver" in info
351+
343352
@skip_if_server_version_lt("2.6.9")
344353
@pytest.mark.onlynoncluster
345354
async def test_client_kill(self, r: redis.Redis, r2):
@@ -438,6 +447,14 @@ async def test_client_list_after_client_setname(self, r: redis.Redis):
438447
# we don't know which client ours will be
439448
assert "redis_py_test" in [c["name"] for c in clients]
440449

450+
@skip_if_server_version_lt("7.2.0")
451+
async def test_client_list_after_client_setinfo(self, r: redis.Redis):
452+
await r.client_setinfo("lib-name", "redis-py")
453+
await r.client_setinfo("lib-ver", "4.33")
454+
clients = await r.client_list()
455+
assert "redis-py" in [c["lib-name"] for c in clients]
456+
assert "4.33" in [c["lib-ver"] for c in clients]
457+
441458
@skip_if_server_version_lt("2.9.50")
442459
@pytest.mark.onlynoncluster
443460
async def test_client_pause(self, r: redis.Redis):

tests/test_commands.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -530,6 +530,15 @@ def test_client_setname(self, r):
530530
assert r.client_setname("redis_py_test")
531531
assert r.client_getname() == "redis_py_test"
532532

533+
@pytest.mark.onlynoncluster
534+
@skip_if_server_version_lt("7.2.0")
535+
def test_client_setinfo(self, r):
536+
assert r.client_setinfo("lib-name", "redis-py")
537+
assert r.client_setinfo("lib-ver", "4.33")
538+
info = r.client_info()
539+
assert "lib-name" in info
540+
assert "lib-ver" in info
541+
533542
@pytest.mark.onlynoncluster
534543
@skip_if_server_version_lt("2.6.9")
535544
def test_client_kill(self, r, r2):
@@ -628,6 +637,14 @@ def test_client_list_after_client_setname(self, r):
628637
# we don't know which client ours will be
629638
assert "redis_py_test" in [c["name"] for c in clients]
630639

640+
@skip_if_server_version_lt("7.2.0")
641+
def test_client_list_after_client_setinfo(self, r):
642+
r.client_setinfo("lib-name", "redis-py")
643+
r.client_setinfo("lib-ver", "4.33")
644+
clients = r.client_list()
645+
assert "redis-py" in [c["lib-name"] for c in clients]
646+
assert "4.33" in [c["lib-ver"] for c in clients]
647+
631648
@skip_if_server_version_lt("6.2.0")
632649
def test_client_kill_filter_by_laddr(self, r, r2):
633650
r.client_setname("redis-py-c1")

0 commit comments

Comments
 (0)