Merge branch 'release/0.5.0'

aiohttp_sqlalchemy/__init__.py

@@ -1,10 +1,10 @@
 from typing import TYPE_CHECKING
-import warnings
+
 from aiohttp_sqlalchemy.constants import DEFAULT_KEY
 from aiohttp_sqlalchemy.decorators import sa_decorator
-from aiohttp_sqlalchemy.exceptions import DuplicateAppKeyError
+from aiohttp_sqlalchemy.exceptions import DuplicateAppKeyError, DuplicateRequestKeyError
 from aiohttp_sqlalchemy.middlewares import sa_middleware
-from aiohttp_sqlalchemy.views import SAView, SAViewMixin
+from aiohttp_sqlalchemy.views import SABaseView, SAView, SAViewMixin
 
 
 if TYPE_CHECKING:
@@ -15,7 +15,11 @@
     TSABinding = Tuple[AsyncEngine, str, bool]
 
 
-__version__ = '0.4.0'
+__version__ = '0.5.0'
+
+__all__ = ['DuplicateAppKeyError', 'DuplicateRequestKeyError', 'SABaseView',
+           'sa_bind', 'sa_decorator', 'sa_middleware', 'SAView',
+           'SAViewMixin', 'setup',]
 
 
 def sa_bind(engine: 'AsyncEngine', key: str = DEFAULT_KEY, *,
@@ -24,14 +28,6 @@ def sa_bind(engine: 'AsyncEngine', key: str = DEFAULT_KEY, *,
     return engine, key, middleware
 
 
-def sa_engine(engine: 'AsyncEngine', key: str = DEFAULT_KEY, *,
-              middleware: bool = True) -> 'TSABinding':
-    msg = "aiohttp_sqlalchemy.sa_engine() is deprecated. " \
-          "Use aiohttp_sqlalchemy.sa_bind()."
-    warnings.warn(msg, DeprecationWarning, stacklevel=2)
-    return engine, key, middleware
-
-
 def setup(app: 'Application', bindings: 'Iterable[TSABinding]'):
     """ Setup function for binding SQLAlchemy engines. """
     for engine, key, middleware in bindings:

aiohttp_sqlalchemy/decorators.py

@@ -3,6 +3,7 @@
 from functools import wraps
 from sqlalchemy.ext.asyncio import AsyncSession
 from typing import TYPE_CHECKING
+
 from aiohttp_sqlalchemy.constants import DEFAULT_KEY
 from aiohttp_sqlalchemy.exceptions import DuplicateRequestKeyError
 

aiohttp_sqlalchemy/middlewares.py

@@ -1,6 +1,7 @@
 from aiohttp.web import middleware
 from sqlalchemy.ext.asyncio import AsyncSession
 from typing import TYPE_CHECKING
+
 from aiohttp_sqlalchemy.constants import DEFAULT_KEY
 from aiohttp_sqlalchemy.exceptions import DuplicateRequestKeyError
 

aiohttp_sqlalchemy/views.py

@@ -16,6 +16,10 @@ class SAViewMixin:
     """ SQLAlchemy class based view mixin. """
     request: 'Request'
 
+    def __init__(self):
+        msg = "SAViewMixin is deprecated. Use SAAbstractView."
+        warnings.warn(msg, DeprecationWarning, stacklevel=2)
+
     @property
     def sa_main_session(self) -> 'AsyncSession':
         msg = "SAViewMixin.sa_main_session is deprecated. " \
@@ -27,15 +31,25 @@ def sa_session(self, key: str = DEFAULT_KEY) -> 'AsyncSession':
         return self.request[key]
 
 
-class SAOneModelMixin(SAViewMixin):
-    sa_model: 'Any'  # Not all developers use declarative mapping
+class SAAbstractView(AbstractView, metaclass=ABCMeta):
+    """ SQLAlchemy view based on aiohttp.abc.AbstractView """
+
+    @property
+    def sa_main_session(self) -> 'AsyncSession':
+        msg = "SAAbstractView.sa_main_session is deprecated. " \
+              "Use SAAbstractView.sa_session()."
+        warnings.warn(msg, DeprecationWarning, stacklevel=2)
+        return self.request[DEFAULT_KEY]
 
+    def sa_session(self, key: str = DEFAULT_KEY) -> 'AsyncSession':
+        return self.request[key]
 
-class SAAbstractView(AbstractView, SAViewMixin, metaclass=ABCMeta):
-    """ SQLAlchemy view based on aiohttp.abc.AbstractView """
+
+class SAOneModelMixin(SAAbstractView, metaclass=ABCMeta):
+    sa_model: 'Any'  # Not all developers use declarative mapping
 
 
-class SABaseView(View, SAViewMixin):
+class SABaseView(View, SAAbstractView):
     """ Simple SQLAlchemy view based on aiohttp.web.View """
 
 

docs/conf.py

@@ -22,7 +22,7 @@
 author = 'Ruslan Ilyasovich Gilfanov'
 
 # The full version, including alpha/beta/rc tags
-release = '0.4.0'
+release = '0.5.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/index.rst

@@ -84,14 +84,12 @@ Copy and paste this code in a file and run:
 
 SQLAlchemy and Asyncio
 ----------------------
-
 See `Asynchronous I/O (asyncio) <https://docs.sqlalchemy.org/en/14/orm/extensions/asyncio.html>`_
 section in SQLAlchemy 1.4 Documentation.
 
 
 Binding multiple engines
 ------------------------
-
 .. code-block:: python
 
   main_engine = create_async_engine('postgresql+asyncpg://user:password@host/database')
@@ -107,11 +105,6 @@ Binding multiple engines
 
 Class based views
 -----------------
-.. warning::
-
-  For use a ``SAView`` in class based view inheritance, you must bind an
-  ``AsyncEngine`` with default key.
-
 .. code-block:: python
 
   from aiohttp_sqlalchemy import SAView
@@ -121,8 +114,15 @@ Class based views
           async with self.sa_session().begin():
               # some your code
 
-  engine = create_async_engine('sqlite+aiosqlite:///')
-  aiohttp_sqlalchemy.setup(app, [sa_bind(engine)])
+          async with self.sa_session('sa_second').begin():
+              # some your code
+
+  main_engine = create_async_engine('sqlite+aiosqlite:///')
+  second_engine = create_async_engine('sqlite+aiosqlite:///')
+  aiohttp_sqlalchemy.setup(app, [
+    sa_bind(main_engine),
+    sa_bind(second_engine, 'sa_second'),
+  ])
 
 
 Decorating handlers
@@ -179,17 +179,29 @@ Access to ``AsyncSession`` object from nested app has no differences.
 
 Change log
 ----------
+Version 0.5.0
+^^^^^^^^^^^^^
+Removed
+"""""""
+Deprecated function ``aiohttp_sqlalchemy.sa_engine()`` is removed. Use
+``aiohttp_sqlalchemy.sa_bind()``.
+
+Deprecated
+""""""""""
+Undocumented class ``views.SAViewMixin`` is deprecated. Use
+``views.SAAbstractView``.
+
 Version 0.4.0
 ^^^^^^^^^^^^^
 Added
 """""
-``SAView.sa_session(key: str ='sa_main')`` function is added instead
+``SAView.sa_session(key: str = 'sa_main')`` function is added instead
 ``SAView.sa_main_session``.
 
 Deprecated
 """"""""""
 ``SAView.sa_main_session`` is deprecated. Use
-``SAView.sa_session(key: str ='sa_main')``.
+``SAView.sa_session(key: str = 'sa_main')``.
 
 Version 0.3.0
 ^^^^^^^^^^^^^

examples/single_decorated_cbv.py

@@ -1,6 +1,6 @@
 from aiohttp import web
 import aiohttp_sqlalchemy
-from aiohttp_sqlalchemy import sa_decorator, sa_bind
+from aiohttp_sqlalchemy import sa_decorator, sa_bind, SAView
 from datetime import datetime
 import sqlalchemy as sa
 from sqlalchemy import orm
@@ -17,13 +17,13 @@ class Request(Base):
     timestamp = sa.Column(sa.DateTime(), default=datetime.now)
 
 
-class Main(web.View):
+class Main(SAView):
     @sa_decorator()
     async def get(self):
         async with self.request.app['sa_main'].begin() as conn:
             await conn.run_sync(Base.metadata.create_all)
 
-        async with self.request['sa_main'].begin():
+        async with self.sa_session().begin():
             self.request['sa_main'].add_all([Request()])
             result = await self.request['sa_main'].execute(sa.select(Request))
             data = {r.id: r.timestamp.isoformat() for r in result.scalars()}