Passing username to redis arguments

README.rst

@@ -106,18 +106,24 @@ There are several ways to specify a database number:
 - If using the ``redis://`` scheme, the path argument of the URL, e.g.
   ``redis://localhost/0``
 
-When using `Redis' ACLs <https://redis.io/topics/acl>`_, you will need to add the
-username to the URL (and provide the password with the Cache ``OPTIONS``).
+When using `Redis' ACLs <https://redis.io/topics/acl>`_, you can either pass the
+username and password in the Cache ``OPTIONS`` dict, in the URL, or the username 
+in the URL and the password in the ``OPTIONS``.
+
+Be aware that if the username/password are passed both in the URL and ``OPTIONS``
+dict, the ones passed in the URL prime.
+
 The login for the user ``django`` would look like this:
 
 .. code-block:: python
 
     CACHES = {
         "default": {
             "BACKEND": "django_redis.cache.RedisCache",
-            "LOCATION": "redis://django@localhost:6379/0",
+            "LOCATION": "redis://localhost:6379/0",
             "OPTIONS": {
                 "CLIENT_CLASS": "django_redis.client.DefaultClient",
+                "USERNAME": "django",
                 "PASSWORD": "mysecret"
             }
         }
@@ -137,25 +143,26 @@ An alternative would be write both username and password into the URL:
         }
     }
 
-In some circumstances the password you should use to connect Redis
-is not URL-safe, in this case you can escape it or just use the
-convenience option in ``OPTIONS`` dict:
+The username can also be passed in the URL, and the password in the ``OPTIONS``:
 
 .. code-block:: python
 
     CACHES = {
         "default": {
             "BACKEND": "django_redis.cache.RedisCache",
-            "LOCATION": "redis://127.0.0.1:6379/1",
+            "LOCATION": "redis://django@localhost:6379/0",
             "OPTIONS": {
                 "CLIENT_CLASS": "django_redis.client.DefaultClient",
                 "PASSWORD": "mysecret"
             }
         }
     }
 
-Take care, that this option does not overwrites the password in the uri, so if
-you have set the password in the uri, this settings will be ignored.
+
+NOTE: In some circumstances the password you should use to connect Redis
+is not URL-safe, in this case you can escape it or just use the
+convenience option in ``OPTIONS`` dict.
+
 
 Configure as session backend
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -693,8 +700,11 @@ In order to enable this functionality you should add the following:
                 # Sentinels which are passed directly to redis Sentinel.
                 "SENTINELS": SENTINELS,
 
-                # kwargs for redis Sentinel (optional).
-                "SENTINEL_KWARGS": {},
+                # kwargs for redis Sentinel (optional). Example with auth on sentinels
+                "SENTINEL_KWARGS": {
+                    "username": "sentinel-user",
+                    "password": "sentinel-pass",
+                },
 
                 # You can still override the connection pool (optional).
                 "CONNECTION_POOL_CLASS": "redis.sentinel.SentinelConnectionPool",

changelog.d/657.feature

@@ -0,0 +1 @@
+Added the ability to pass redis username in the cache options

django_redis/pool.py

@@ -43,6 +43,10 @@ def make_connection_params(self, url):
             "parser_class": self.get_parser_cls(),
         }
 
+        username = self.options.get("USERNAME", None)
+        if username:
+            kwargs["username"] = username
+
         password = self.options.get("PASSWORD", None)
         if password:
             kwargs["password"] = password

tests/test_connection_params.py

@@ -0,0 +1,38 @@
+import pytest
+
+from django_redis import pool
+
+
+class TestConnectionParams:
+    @pytest.mark.parametrize(
+        "connection_string",
+        [
+            "unix://tmp/foo.bar?db=1",
+            "redis://localhost/2",
+            "rediss://localhost:3333?db=2",
+        ],
+    )
+    def test_make_connection_params_url(self, connection_string: str):
+        cf = pool.get_connection_factory(
+            path="django_redis.pool.ConnectionFactory", options={}
+        )
+        res = cf.make_connection_params(connection_string)
+        assert res["url"] == connection_string
+
+    def test_make_connection_params_options(self):
+        options = {
+            "USERNAME": "django",
+            "PASSWORD": "mysecret",
+            "SOCKET_TIMEOUT": 5,
+        }
+        cf = pool.get_connection_factory(
+            path="django_redis.pool.ConnectionFactory", options=options
+        )
+        res = cf.make_connection_params("")
+        res.pop("url")
+        res.pop("parser_class")
+        assert res == {
+            "username": "django",
+            "password": "mysecret",
+            "socket_timeout": 5,
+        }