Updated documentation for redis module (#761)

Author: amenezes

.mypy.ini

@@ -27,9 +27,6 @@ disallow_any_unimported = False
 [mypy-aiopg.*]
 ignore_missing_imports = True
 
-[mypy-aioredis.*]
-ignore_missing_imports = True
-
 [mypy-aiomcache.*]
 ignore_missing_imports = True
 

Makefile

@@ -7,7 +7,6 @@ setup:
 flake fmt:
 	python -m pre_commit run --all-files
 
-
 test:
 	py.test ./tests/
 

README.rst

@@ -79,10 +79,8 @@ Available session storages are:
 
 * ``aiohttp_session.redis_storage.RedisStorage(redis_pool)`` -- stores
   JSON encoded data in *redis*, keeping only the redis key (a random UUID) in
-  the cookie. ``redis_pool`` is a ``aioredis`` pool object, created by
-  ``await aioredis.create_redis_pool(...)`` call.
-
-  Requires ``aioredis`` library (only versions ``1.0+`` are supported)::
+  the cookie. ``redis_pool`` is a ``redis`` object, created by
+  ``await aioredis.from_url(...)`` call.
 
       $ pip install aiohttp_session[aioredis]
 

aiohttp_session/redis_storage.py

@@ -7,8 +7,7 @@
 from . import AbstractStorage, Session
 
 try:
-    from redis import asyncio as aioredis
-    from redis import VERSION as REDIS_VERSION
+    from redis import VERSION as REDIS_VERSION, asyncio as aioredis
 except ImportError:  # pragma: no cover
     aioredis = None  # type: ignore[assignment]
 

demo/redis_storage.py

@@ -1,8 +1,8 @@
 import time
 from typing import AsyncIterator
 
-import aioredis
 from aiohttp import web
+from redis import asyncio as aioredis
 
 from aiohttp_session import get_session, setup
 from aiohttp_session.redis_storage import RedisStorage
@@ -18,10 +18,7 @@ async def handler(request: web.Request) -> web.Response:
 
 async def redis_pool(app: web.Application) -> AsyncIterator[None]:
     redis_address = "redis://127.0.0.1:6379"
-    async with aioredis.from_url(
-        redis_address,
-        timeout=1,
-    ) as redis:
+    async with aioredis.from_url(redis_address) as redis:
         storage = RedisStorage(redis)
         setup(app, storage)
         yield

docs/conf.py

@@ -343,7 +343,7 @@
 intersphinx_mapping = {
     "https://docs.python.org/3": None,
     "https://aiohttp.readthedocs.io/en/stable": None,
-    "https://aioredis.readthedocs.io/en/latest": None,
+    "https://redis.readthedocs.io/en/latest": None,
     # 'https://github.com/aio-libs/aiomcache': None,
     "http://cryptography.io/en/latest": None,
     "https://pynacl.readthedocs.io/en/latest": None,

docs/glossary.rst

@@ -10,9 +10,9 @@
 
    aioredis
 
-      :term:`asyncio` compatible Redis client library
+      :term:`asyncio` compatible module in the :term:`redis` library.
 
-      https://aioredis.readthedocs.io/
+      https://redis-py.readthedocs.io/en/stable/examples/asyncio_examples.html
 
    aiomcache
 

docs/index.rst

@@ -79,7 +79,7 @@ Available session storages are:
   ``e33b57c7ec6e425eb626610f811ab6ae`` (a random UUID) they key inside
   redis will be ``AIOHTTP_SESSION_e33b57c7ec6e425eb626610f811ab6ae``.
 
-  Requires :term:`aioredis` library:
+  Requires :term:`redis` library:
 
   .. code-block:: bash
 
@@ -121,7 +121,7 @@ Dependencies
 
 - :term:`cryptography` for
   :class:`~aiohttp_session.cookie_storage.EncryptedCookieStorage`
-- :term:`aioredis` for
+- :term:`redis` for
   :class:`~aiohttp_session.redis_storage.RedisStorage`
 
 

docs/reference.rst

@@ -378,11 +378,11 @@ Redis Storage
 The storage that stores session data in Redis database and
 keeps only Redis keys (UUIDs actually) in HTTP cookies.
 
-It operates with Redis database via :class:`aioredis.RedisPool`.
+It operates with Redis database via :class:`redis.asyncio.Redis`.
 
 To use the storage you need setup it first::
 
-   redis = await aioredis.create_pool(('localhost', 6379))
+   redis = await aioredis.from_url("redis://127.0.0.1:6379")
    storage = aiohttp_session.redis_storage.RedisStorage(redis)
    aiohttp_session.setup(app, storage)
 
@@ -398,18 +398,18 @@ To use the storage you need setup it first::
 
    The class is inherited from :class:`~aiohttp_session.AbstractStorage`.
 
-   *redis_pool* is a :class:`~aioredis.RedisPool` which should be
-   created by :func:`~aioredis.create_pool` call, e.g.::
+   *redis_pool* is a :class:`~redis.asyncio.Redis` which should be
+   created by :func:`~redis.asyncio.from_url` call, e.g.::
 
-      redis = await aioredis.create_pool(('localhost', 6379))
+      redis = await aioredis.from_url("redis://localhost:6379")
       storage = aiohttp_session.redis_storage.RedisStorage(redis)
 
    Other parameters are the same as for
    :class:`~aiohttp_session.AbstractStorage` constructor.
 
 
 Memcached Storage
-----------------
+-----------------
 
 The storage that stores session data in Memcached and
 keeps only keys (UUIDs actually) in HTTP cookies.

requirements-dev.txt

@@ -1,7 +1,6 @@
 -e .
 aiohttp==3.8.3
 aiomcache==0.7.0
-redis==4.3.4
 attrs==22.1.0
 chardet==5.0.0
 cryptography==38.0.1
@@ -21,6 +20,7 @@ pytest-aiohttp==1.0.4
 pytest-cov==4.0.0
 pytest-mock==3.10.0
 pytest-sugar==0.9.5
+redis==4.3.4
 sphinx==4.3.2
 types-redis==4.3.21.3
 typing-extensions==4.4.0