New async/await syntax and aioredis 1.0.0 compatibility (#234)

* New async/await syntax and aioredis 1.0.0 compatibility

* [Travis] Check with Python3.6

* Handle aioredis as optional dependency (and its version)

* Gradually deprecate ConnectionsPool

* Test missing or old version of aioredis

* Add no cover to ImportError

Author: panagiks

.travis.yml

@@ -4,8 +4,8 @@ services:
 - docker
 
 python:
-  - 3.4.3
   - 3.5
+  - 3.6
   - nightly
 
 install:

aiohttp_session/__init__.py

@@ -1,7 +1,6 @@
 """User sessions for aiohttp.web."""
 
 import abc
-import asyncio
 from collections import MutableMapping
 import json
 import time
@@ -94,8 +93,7 @@ def __delitem__(self, key):
 STORAGE_KEY = 'aiohttp_session_storage'
 
 
-@asyncio.coroutine
-def get_session(request):
+async def get_session(request):
     session = request.get(SESSION_KEY)
     if session is None:
         storage = request.get(STORAGE_KEY)
@@ -104,7 +102,7 @@ def get_session(request):
                 "Install aiohttp_session middleware "
                 "in your aiohttp.web.Application")
         else:
-            session = yield from storage.load_session(request)
+            session = await storage.load_session(request)
             if not isinstance(session, Session):
                 raise RuntimeError(
                     "Installed {!r} storage should return session instance "
@@ -119,12 +117,11 @@ def session_middleware(storage):
     assert isinstance(storage, AbstractStorage), storage
 
     @web.middleware
-    @asyncio.coroutine
-    def factory(request, handler):
+    async def factory(request, handler):
         request[STORAGE_KEY] = storage
         raise_response = False
         try:
-            response = yield from handler(request)
+            response = await handler(request)
         except web.HTTPException as exc:
             response = exc
             raise_response = True
@@ -139,7 +136,7 @@ def factory(request, handler):
         session = request.get(SESSION_KEY)
         if session is not None:
             if session._changed:
-                yield from storage.save_session(request, response, session)
+                await storage.save_session(request, response, session)
         if raise_response:
             raise response
         return response
@@ -188,14 +185,12 @@ def _get_session_data(self, session):
             data = {}
         return data
 
-    @asyncio.coroutine
     @abc.abstractmethod
-    def load_session(self, request):
+    async def load_session(self, request):
         pass
 
-    @asyncio.coroutine
     @abc.abstractmethod
-    def save_session(self, request, response, session):
+    async def save_session(self, request, response, session):
         pass
 
     def load_cookie(self, request):
@@ -231,16 +226,14 @@ def __init__(self, *, cookie_name="AIOHTTP_SESSION",
                          max_age=max_age, path=path, secure=secure,
                          httponly=httponly)
 
-    @asyncio.coroutine
-    def load_session(self, request):
+    async def load_session(self, request):
         cookie = self.load_cookie(request)
         if cookie is None:
             return Session(None, data=None, new=True, max_age=self.max_age)
         else:
             data = json.loads(cookie)
             return Session(None, data=data, new=False, max_age=self.max_age)
 
-    @asyncio.coroutine
-    def save_session(self, request, response, session):
+    async def save_session(self, request, response, session):
         cookie_data = json.dumps(self._get_session_data(session))
         self.save_cookie(response, cookie_data, max_age=session.max_age)

aiohttp_session/cookie_storage.py

@@ -1,4 +1,3 @@
-import asyncio
 import json
 import base64
 
@@ -26,8 +25,7 @@ def __init__(self, secret_key, *, cookie_name="AIOHTTP_SESSION",
             secret_key = base64.urlsafe_b64encode(secret_key)
         self._fernet = fernet.Fernet(secret_key)
 
-    @asyncio.coroutine
-    def load_session(self, request):
+    async def load_session(self, request):
         cookie = self.load_cookie(request)
         if cookie is None:
             return Session(None, data=None, new=True, max_age=self.max_age)
@@ -43,8 +41,7 @@ def load_session(self, request):
                             "create a new fresh session")
                 return Session(None, data=None, new=True, max_age=self.max_age)
 
-    @asyncio.coroutine
-    def save_session(self, request, response, session):
+    async def save_session(self, request, response, session):
         if session.empty:
             return self.save_cookie(response, '',
                                     max_age=session.max_age)

aiohttp_session/memcached_storage.py

@@ -1,4 +1,3 @@
-import asyncio
 import json
 import uuid
 
@@ -21,15 +20,14 @@ def __init__(self, memcached_conn, *, cookie_name="AIOHTTP_SESSION",
         self._key_factory = key_factory
         self.conn = memcached_conn
 
-    @asyncio.coroutine
-    def load_session(self, request):
+    async def load_session(self, request):
         cookie = self.load_cookie(request)
         if cookie is None:
             return Session(None, data=None, new=True, max_age=self.max_age)
         else:
             key = str(cookie)
             stored_key = (self.cookie_name + '_' + key).encode('utf-8')
-            data = yield from self.conn.get(stored_key)
+            data = await self.conn.get(stored_key)
             if data is None:
                 return Session(None, data=None,
                                new=True, max_age=self.max_age)
@@ -40,8 +38,7 @@ def load_session(self, request):
                 data = None
             return Session(key, data=data, new=False, max_age=self.max_age)
 
-    @asyncio.coroutine
-    def save_session(self, request, response, session):
+    async def save_session(self, request, response, session):
         key = session.identity
         if key is None:
             key = self._key_factory()
@@ -60,6 +57,6 @@ def save_session(self, request, response, session):
         max_age = session.max_age
         expire = max_age if max_age is not None else 0
         stored_key = (self.cookie_name + '_' + key).encode('utf-8')
-        yield from self.conn.set(
+        await self.conn.set(
                                 stored_key, data.encode('utf-8'),
                                 exptime=expire)

aiohttp_session/nacl_storage.py

@@ -1,4 +1,3 @@
-import asyncio
 import json
 
 import nacl.secret
@@ -21,8 +20,7 @@ def __init__(self, secret_key, *, cookie_name="AIOHTTP_SESSION",
 
         self._secretbox = nacl.secret.SecretBox(secret_key)
 
-    @asyncio.coroutine
-    def load_session(self, request):
+    async def load_session(self, request):
         cookie = self.load_cookie(request)
         if cookie is None:
             return Session(None, data=None, new=True, max_age=self.max_age)
@@ -33,8 +31,7 @@ def load_session(self, request):
             )
             return Session(None, data=data, new=False, max_age=self.max_age)
 
-    @asyncio.coroutine
-    def save_session(self, request, response, session):
+    async def save_session(self, request, response, session):
         if session.empty:
             return self.save_cookie(response, session._mapping,
                                     max_age=session.max_age)

aiohttp_session/redis_storage.py

@@ -1,7 +1,12 @@
-import asyncio
+try:
+    import aioredis
+except ImportError:  # pragma: no cover
+    aioredis = None
 import json
 import uuid
+import warnings
 
+from distutils.version import StrictVersion
 from . import AbstractStorage, Session
 
 
@@ -16,20 +21,33 @@ def __init__(self, redis_pool, *, cookie_name="AIOHTTP_SESSION",
         super().__init__(cookie_name=cookie_name, domain=domain,
                          max_age=max_age, path=path, secure=secure,
                          httponly=httponly)
+        if aioredis is None:
+            raise RuntimeError("Please install aioredis")
+        if StrictVersion(aioredis.__version__).version < (1, 0):
+            raise RuntimeError("aioredis<1.0 is not supported")
         self._encoder = encoder
         self._decoder = decoder
         self._key_factory = key_factory
+        if isinstance(redis_pool, aioredis.pool.ConnectionsPool):
+            warnings.warn(
+                "using a pool created with aioredis.create_pool is deprecated"
+                "please use a pool created with aioredis.create_redis_pool",
+                DeprecationWarning
+            )
+            redis_pool = aioredis.commands.Redis(redis_pool)
+        elif not isinstance(redis_pool, aioredis.commands.Redis):
+            raise TypeError("Expexted aioredis.commands.Redis got {}".format(
+                    type(redis_pool)))
         self._redis = redis_pool
 
-    @asyncio.coroutine
-    def load_session(self, request):
+    async def load_session(self, request):
         cookie = self.load_cookie(request)
         if cookie is None:
             return Session(None, data=None, new=True, max_age=self.max_age)
         else:
-            with (yield from self._redis) as conn:
+            with await self._redis as conn:
                 key = str(cookie)
-                data = yield from conn.get(self.cookie_name + '_' + key)
+                data = await conn.get(self.cookie_name + '_' + key)
                 if data is None:
                     return Session(None, data=None,
                                    new=True, max_age=self.max_age)
@@ -40,8 +58,7 @@ def load_session(self, request):
                     data = None
                 return Session(key, data=data, new=False, max_age=self.max_age)
 
-    @asyncio.coroutine
-    def save_session(self, request, response, session):
+    async def save_session(self, request, response, session):
         key = session.identity
         if key is None:
             key = self._key_factory()
@@ -57,8 +74,7 @@ def save_session(self, request, response, session):
                                  max_age=session.max_age)
 
         data = self._encoder(self._get_session_data(session))
-        with (yield from self._redis) as conn:
+        with await self._redis as conn:
             max_age = session.max_age
             expire = max_age if max_age is not None else 0
-            yield from conn.set(self.cookie_name + '_' + key,
-                                data, expire=expire)
+            await conn.set(self.cookie_name + '_' + key, data, expire=expire)

demo/redis_storage.py

@@ -17,10 +17,7 @@ async def handler(request):
 
 async def make_redis_pool():
     redis_address = ('127.0.0.1', '6379')
-    return await aioredis.create_pool(
-        redis_address,
-        create_connection_timeout=1,
-    )
+    return await aioredis.create_redis_pool(redis_address, timeout=1)
 
 
 def make_app():

docs/index.rst

@@ -115,7 +115,7 @@ Continious Integration.
 Dependencies
 ------------
 
-- Python 3.3 and :mod:`asyncio` or Python 3.4+
+- Python 3.5.3+
 - :term:`cryptography` for
   :class:`~aiohttp_session.cookie_storage.EncryptedCookieStorage`
 - :term:`aioredis` for

requirements-dev.txt

@@ -3,12 +3,13 @@ coverage==4.4.2
 sphinx==1.6.5
 pep257==0.7.0
 -e .
-aioredis==0.3.5
+aioredis==1.0.0
 cryptography==2.1.3
 docker-py==1.10.6
 pynacl==1.2.0
 pytest-aiohttp==0.1.3
 pytest-cov==2.5.1
+pytest-mock==1.6.3
 aiohttp==2.3.2
 multidict==3.3.2
 chardet==3.0.4

setup.py

@@ -17,7 +17,7 @@ def read(f):
 
 install_requires = ['aiohttp>=2.3.0']
 extras_require = {
-    'aioredis': ['aioredis>=0.1.4, <1.0'],
+    'aioredis': ['aioredis>=1.0.0'],
     'aiomcache': ['aiomcache>=0.5.2'],
     'pycrypto': ['cryptography'],
     'secure': ['cryptography'],
@@ -34,7 +34,6 @@ def read(f):
           'Intended Audience :: Developers',
           'Programming Language :: Python',
           'Programming Language :: Python :: 3',
-          'Programming Language :: Python :: 3.4',
           'Programming Language :: Python :: 3.5',
           'Programming Language :: Python :: 3.6',
           'Topic :: Internet :: WWW/HTTP',