Changed username and password to properties

Author: barshaul

redis/connection.py

@@ -718,7 +718,7 @@ def on_connect(self):
                 # https://github.com/andymccurdy/redis-py/issues/1274
                 self.send_command(
                     "AUTH",
-                    self.credentials_provider.get_password(),
+                    self.credentials_provider.password,
                     check_health=False,
                 )
                 auth_response = self.read_response()
@@ -1092,7 +1092,7 @@ def __init__(
         self.db = db
         self.client_name = client_name
         self.credentials_provider = credentials_provider
-        if not self.credentials_provider and (username or password):
+        if (username or password) and self.credentials_provider is None:
             self.credentials_provider = CredentialsProvider(username, password)
         self.socket_timeout = socket_timeout
         self.retry_on_timeout = retry_on_timeout

redis/credentials.py

@@ -1,9 +1,12 @@
+from typing import Callable, Optional
+
+
 class CredentialsProvider:
     def __init__(
         self,
         username: str = "",
         password: str = "",
-        supplier: callable = None,
+        supplier: Optional[Callable] = None,
         *args,
         **kwargs,
     ):
@@ -15,27 +18,33 @@ def supplier(arg1, arg2, ...) -> (username, password)
         :param args: arguments to pass to the supplier function
         :param kwargs: keyword arguments to pass to the supplier function
         """
-        self.username = username
-        self.password = password
+        self._username = "" if username is None else username
+        self._password = "" if password is None else password
         self.supplier = supplier
         self.args = args
         self.kwargs = kwargs
 
     def get_credentials(self):
         if self.supplier:
             self.username, self.password = self.supplier(*self.args, **self.kwargs)
-        if self.username:
-            auth_args = (self.username, self.password or "")
-        else:
-            auth_args = (self.password,)
-        return auth_args
+        return self._username, self._password
 
-    def get_password(self, call_supplier: bool = True):
-        if call_supplier and self.supplier:
+    @property
+    def password(self):
+        if self.supplier and not self._password:
             self.username, self.password = self.supplier(*self.args, **self.kwargs)
-        return self.password
+        return self._password
 
-    def get_username(self, call_supplier: bool = True):
-        if call_supplier and self.supplier:
+    @password.setter
+    def password(self, value):
+        self._password = value
+
+    @property
+    def username(self):
+        if self.supplier and not self._username:
             self.username, self.password = self.supplier(*self.args, **self.kwargs)
-        return self.username
+        return self._username
+
+    @username.setter
+    def username(self, value):
+        self._username = value

tests/test_credentials.py

@@ -1,6 +1,8 @@
 import random
 import string
 
+import pytest
+
 import redis
 from redis import ResponseError
 from redis.credentials import CredentialsProvider
@@ -17,7 +19,7 @@ def test_credentials_provider_without_supplier(self, r, request):
         r.config_set("requirepass", temp_pass)
         creds = creds_provider.get_credentials()
         assert r.auth(creds[1], creds[0]) is True
-        assert r.auth(creds_provider.get_password()) is True
+        assert r.auth(creds_provider.password) is True
 
         # test for other users
         username = "redis-py-auth"
@@ -48,8 +50,12 @@ def teardown():
 
         assert r2.ping() is True
 
+    @pytest.mark.parametrize("username", ["redis-py-auth", ""])
+    @pytest.mark.parametrize("use_password", [True, False])
     @skip_if_redis_enterprise()
-    def test_credentials_provider_with_supplier(self, r, request):
+    def test_credentials_provider_with_supplier(
+        self, r, request, username, use_password
+    ):
         import functools
 
         @functools.lru_cache(maxsize=10)
@@ -59,16 +65,18 @@ def get_random_string(length):
                 result_str = "".join(random.choice(letters) for i in range(length))
                 return result_str
 
-            auth_token = get_random_string(5) + user + "_" + endpoint
+            if use_password:
+                auth_token = get_random_string(5) + user + "_" + endpoint
+            else:
+                auth_token = ""
             return user, auth_token
 
-        username = "redis-py-auth"
         creds_provider = CredentialsProvider(
             supplier=auth_supplier,
             user=username,
             endpoint="localhost",
         )
-        password = creds_provider.get_password()
+        password = creds_provider.password
 
         assert r.acl_setuser(
             username,