Merge pull request #427 from wwwjfy/init-args

fix #407, extensions accept kwargs for db init

Author: wwwjfy

docs/aiohttp.rst

@@ -0,0 +1,5 @@
+===============
+Aiohttp Support
+===============
+
+**THIS IS A WIP**

docs/quart.rst

@@ -0,0 +1,5 @@
+===============
+Quart Support
+===============
+
+**THIS IS A WIP**

docs/sanic.rst

@@ -26,6 +26,7 @@ Supported configurations:
 - DB_POOL_MIN_SIZE
 - DB_POOL_MAX_SIZE
 - DB_USE_CONNECTION_FOR_REQUEST
+- DB_KWARGS
 
 An example server:
 
@@ -79,6 +80,7 @@ To integrate with Sanic, a few configurations needs to be set in
 - DB_ECHO: if not set, ``False``
 - DB_POOL_MIN_SIZE: if not set, 5
 - DB_POOL_MAX_SIZE: if not set, 10
+- DB_KWARGS; if not set, empty dictionary
 
 An example:
 

gino/ext/aiohttp.py

@@ -83,6 +83,8 @@ class Gino(_Gino):
     * ``pool_max_size`` - the maximum number of connections in the db pool.
     * ``echo`` - enable SQLAlchemy echo mode.
     * ``ssl`` - SSL context passed to ``asyncpg.connect``, default is ``None``.
+    * ``kwargs`` - other parameters passed to the specified dialects,
+      like ``asyncpg``. Unrecognized parameters will cause exceptions.
 
     If the ``db`` is set as an aiohttp middleware, then a lazy connection is
     available at ``request['connection']``. By default, a database connection
@@ -132,6 +134,7 @@ async def before_server_start(app_):
                 max_size=config.setdefault('pool_max_size', 10),
                 ssl=config.setdefault('ssl'),
                 loop=app_.loop,
+                **config.setdefault('kwargs', dict()),
             )
 
         async def after_server_stop(app_):

gino/ext/quart.py

@@ -116,6 +116,7 @@ async def before_first_request():
                 max_size=app.config.setdefault('DB_POOL_MAX_SIZE', 10),
                 ssl=app.config.setdefault('DB_SSL'),
                 loop=asyncio.get_event_loop(),
+                **app.config.setdefault('DB_KWARGS', dict()),
             )
 
     async def first_or_404(self, *args, **kwargs):

gino/ext/sanic.py

@@ -113,6 +113,7 @@ async def before_server_start(_, loop):
                 max_size=app.config.setdefault('DB_POOL_MAX_SIZE', 10),
                 ssl=app.config.setdefault('DB_SSL'),
                 loop=loop,
+                **app.config.setdefault('DB_KWARGS', dict()),
             )
 
         @app.listener('after_server_stop')

gino/ext/tornado.py

@@ -203,7 +203,7 @@ async def init_app(self, app, *, loop=None, dsn='', driver='asyncpg',
                        host='localhost', port=5432,
                        user='postgres', password='', database='postgres',
                        echo=False, pool_min_size=5, pool_max_size=10,
-                       ssl=None):
+                       ssl=None, **kwargs):
         """
         Initialize database
 
@@ -225,6 +225,8 @@ async def init_app(self, app, *, loop=None, dsn='', driver='asyncpg',
         pool, default is ``10``.
         :param ssl: SSL context passed to ``asyncpg.connect``, default is
         ``None``. This can be ``True`` or an instance of ``ssl.SSLContext``.
+        :param kwargs: other parameters passed to the specified dialects,
+        like ``asyncpg``. Unrecognized parameters will cause exceptions.
         """
         if loop is None:
             loop = tornado.ioloop.IOLoop.current()
@@ -243,7 +245,7 @@ async def init_app(self, app, *, loop=None, dsn='', driver='asyncpg',
 
         await self.set_bind(
             dsn, echo=echo, min_size=pool_min_size, max_size=pool_max_size,
-            ssl=ssl, loop=asyncio_loop,
+            ssl=ssl, loop=asyncio_loop, **kwargs,
         )
 
         app.db = self

tests/test_aiohttp.py

@@ -7,6 +7,7 @@
 from .models import DB_ARGS, PG_URL
 
 pytestmark = pytest.mark.asyncio
+_MAX_INACTIVE_CONNECTION_LIFETIME = 59.0
 
 
 # noinspection PyShadowingNames
@@ -15,6 +16,11 @@ async def _test_client(config):
 
     db = Gino()
     app = web.Application(middlewares=[db])
+    config.update({
+        'kwargs': dict(
+            max_inactive_connection_lifetime=_MAX_INACTIVE_CONNECTION_LIFETIME,
+        ),
+    })
     app['config'] = dict(gino=config)
     db.init_app(app)
 
@@ -28,6 +34,10 @@ class User(db.Model):
 
     @routes.get('/')
     async def root(request):
+        conn = await request['connection'].get_raw_connection()
+        # noinspection PyProtectedMember
+        assert conn._holder._max_inactive_time == \
+            _MAX_INACTIVE_CONNECTION_LIFETIME
         return web.Response(text='Hello, world!')
 
     @routes.get('/users/{uid}')

tests/test_quart.py

@@ -18,12 +18,18 @@
 from .models import DB_ARGS, PG_URL
 
 pytestmark = pytest.mark.asyncio
+_MAX_INACTIVE_CONNECTION_LIFETIME = 59.0
 
 
 # noinspection PyShadowingNames
 async def _app(config):
     app = Quart(__name__)
     app.config.update(config)
+    app.config.update({
+        'DB_KWARGS': dict(
+            max_inactive_connection_lifetime=_MAX_INACTIVE_CONNECTION_LIFETIME,
+        ),
+    })
 
     db = Gino(app)
 
@@ -35,6 +41,10 @@ class User(db.Model):
 
     @app.route('/')
     async def root():
+        conn = await request.connection.get_raw_connection()
+        # noinspection PyProtectedMember
+        assert conn._holder._max_inactive_time == \
+            _MAX_INACTIVE_CONNECTION_LIFETIME
         return 'Hello, world!'
 
     async def _get_user(ctx, uid: int, method: str) -> dict:

tests/test_sanic.py

@@ -8,11 +8,18 @@
 
 from .models import DB_ARGS, PG_URL
 
+_MAX_INACTIVE_CONNECTION_LIFETIME = 59.0
+
 
 # noinspection PyShadowingNames
 async def _app(config):
     app = sanic.Sanic()
     app.config.update(config)
+    app.config.update({
+        'DB_KWARGS': dict(
+            max_inactive_connection_lifetime=_MAX_INACTIVE_CONNECTION_LIFETIME,
+        ),
+    })
 
     db = Gino(app)
 
@@ -24,6 +31,10 @@ class User(db.Model):
 
     @app.route('/')
     async def root(request):
+        conn = await request['connection'].get_raw_connection()
+        # noinspection PyProtectedMember
+        assert conn._holder._max_inactive_time == \
+            _MAX_INACTIVE_CONNECTION_LIFETIME
         return text('Hello, world!')
 
     @app.route('/users/<uid:int>')