use app.add_subapp instead of router.add_subapp

Author: Nikolay Kim

CHANGES.rst

@@ -6,8 +6,9 @@ CHANGES
 
 - Fix polls demo run application #1487
 
--
+- remove `web.Application` dependency from `web.UrlDispatcher` #1510
 
+ 
 1.2.0 (2016-12-17)
 ------------------
 

aiohttp/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.2.0'
+__version__ = '1.2.1a'
 
 # Deprecated, keep it here for a while for backward compatibility.
 import multidict  # noqa

aiohttp/web.py

@@ -18,7 +18,7 @@
 from .web_reqrep import *  # noqa
 from .web_server import Server
 from .web_urldispatcher import *  # noqa
-from .web_urldispatcher import PrefixedSubAppResource, _wrap_add_subbapp
+from .web_urldispatcher import PrefixedSubAppResource
 from .web_ws import *  # noqa
 
 __all__ = (web_reqrep.__all__ +
@@ -40,6 +40,7 @@ def __init__(self, *, logger=web_logger, loop=None,
             router = web_urldispatcher.UrlDispatcher()
         assert isinstance(router, AbstractRouter), router
 
+        # backward compatibility until full deprecation
         router.add_subapp = _wrap_add_subbapp(self)
 
         if debug is ...:
@@ -138,8 +139,8 @@ def add_subapp(self, prefix, subapp):
             raise ValueError("Prefix cannot be empty")
 
         resource = PrefixedSubAppResource(prefix, subapp)
-        self.reg_resource(resource)
-        subapp._reg_subapp_signals(subapp)
+        self.router.reg_resource(resource)
+        self._reg_subapp_signals(subapp)
         subapp.freeze()
         return resource
 
@@ -282,6 +283,16 @@ def __repr__(self):
         return "<Application 0x{:x}>".format(id(self))
 
 
+def _wrap_add_subbapp(app):
+    # backward compatibility
+
+    def add_subapp(prefix, subapp):
+        warnings.warn("Use app.add_subapp() instead", DeprecationWarning)
+        return app.add_subapp(prefix, subapp)
+
+    return add_subapp
+
+
 def run_app(app, *, host='0.0.0.0', port=None,
             shutdown_timeout=60.0, ssl_context=None,
             print=print, backlog=128, access_log_format=None,

aiohttp/web_urldispatcher.py

@@ -887,21 +887,3 @@ def freeze(self):
         super().freeze()
         for resource in self._resources:
             resource.freeze()
-
-
-def _wrap_add_subbapp(app):
-
-    def add_subapp(prefix, subapp):
-        if subapp.frozen:
-            raise RuntimeError("Cannot add frozen application")
-        if prefix.endswith('/'):
-            prefix = prefix[:-1]
-        if prefix in ('', '/'):
-            raise ValueError("Prefix cannot be empty")
-        resource = PrefixedSubAppResource(prefix, subapp)
-        app.router.reg_resource(resource)
-        app._reg_subapp_signals(subapp)
-        subapp.freeze()
-        return resource
-
-    return add_subapp

docs/web.rst

@@ -971,12 +971,12 @@ toolbar URLs are served by prefix like ``/admin``.
 
 Thus we'll create a totally separate application named ``admin`` and
 connect it to main app with prefix by
-:meth:`~aiohttp.web.UrlDispatcher.add_subapp`::
+:meth:`~aiohttp.web.Application.add_subapp`::
 
    admin = web.Application()
    # setup admin routes, signals and middlewares
 
-   app.router.add_subapp('/admin/', admin)
+   app.add_subapp('/admin/', admin)
 
 Middlewares and signals from ``app`` and ``admin`` are chained.
 
@@ -1006,7 +1006,7 @@ But for getting URL sub-application's router should be used::
    admin = web.Application()
    admin.router.add_get('/resource', handler, name='name')
 
-   app.router.add_subapp('/admin/', admin)
+   app.add_subapp('/admin/', admin)
 
    url = admin.router['name'].url_for()
 
@@ -1019,7 +1019,7 @@ use the following explicit technique::
    admin = web.Application()
    admin.router.add_get('/resource', handler, name='name')
 
-   app.router.add_subapp('/admin/', admin)
+   app.add_subapp('/admin/', admin)
    app['admin'] = admin
 
    async def handler(request):  # main application's handler

tests/test_urldispatch.py

@@ -907,46 +907,52 @@ def test_url_for_in_resource_route(router):
     assert URL('/get/John') == route.url_for(name='John')
 
 
-def test_subapp_get_info(router, loop):
+def test_subapp_get_info(app, loop):
     subapp = web.Application(loop=loop)
-    resource = router.add_subapp('/pre', subapp)
+    resource = subapp.add_subapp('/pre', subapp)
     assert resource.get_info() == {'prefix': '/pre', 'app': subapp}
 
 
-def test_subapp_url(router, loop):
+def test_subapp_backward_compatible(router, loop):
     subapp = web.Application(loop=loop)
     resource = router.add_subapp('/pre', subapp)
+    assert resource.get_info() == {'prefix': '/pre', 'app': subapp}
+
+
+def test_subapp_url(app, loop):
+    subapp = web.Application(loop=loop)
+    resource = app.add_subapp('/pre', subapp)
     with pytest.raises(RuntimeError):
         resource.url()
 
 
-def test_subapp_url_for(router, loop):
+def test_subapp_url_for(app, loop):
     subapp = web.Application(loop=loop)
-    resource = router.add_subapp('/pre', subapp)
+    resource = app.add_subapp('/pre', subapp)
     with pytest.raises(RuntimeError):
         resource.url_for()
 
 
-def test_subapp_repr(router, loop):
+def test_subapp_repr(app, loop):
     subapp = web.Application(loop=loop)
-    resource = router.add_subapp('/pre', subapp)
+    resource = app.add_subapp('/pre', subapp)
     assert repr(resource).startswith(
         '<PrefixedSubAppResource /pre -> <Application')
 
 
-def test_subapp_len(router, loop):
+def test_subapp_len(app, loop):
     subapp = web.Application(loop=loop)
     subapp.router.add_get('/', make_handler())
     subapp.router.add_post('/', make_handler())
-    resource = router.add_subapp('/pre', subapp)
+    resource = app.add_subapp('/pre', subapp)
     assert len(resource) == 2
 
 
-def test_subapp_iter(router, loop):
+def test_subapp_iter(app, loop):
     subapp = web.Application(loop=loop)
     r1 = subapp.router.add_get('/', make_handler())
     r2 = subapp.router.add_post('/', make_handler())
-    resource = router.add_subapp('/pre', subapp)
+    resource = app.add_subapp('/pre', subapp)
     assert list(resource) == [r1, r2]
 
 
@@ -961,11 +967,18 @@ def test_frozen_router(router):
         router.add_get('/', make_handler())
 
 
-def test_frozen_router_subapp(loop, router):
+def test_frozen_router_subapp(app, loop):
     subapp = web.Application(loop=loop)
     subapp.freeze()
     with pytest.raises(RuntimeError):
-        router.add_subapp('/', subapp)
+        app.add_subapp('/', subapp)
+
+
+def test_frozen_app_on_subapp(app, loop):
+    app.freeze()
+    subapp = web.Application(loop=loop)
+    with pytest.raises(RuntimeError):
+        app.add_subapp('/', subapp)
 
 
 def test_set_options_route(router):
@@ -991,16 +1004,16 @@ def test_dynamic_url_with_name_started_from_undescore(router):
     assert URL('/get/John') == route.url_for(_name='John')
 
 
-def test_cannot_add_subapp_with_empty_prefix(router, loop):
+def test_cannot_add_subapp_with_empty_prefix(app, loop):
     subapp = web.Application(loop=loop)
     with pytest.raises(ValueError):
-        router.add_subapp('', subapp)
+        app.add_subapp('', subapp)
 
 
-def test_cannot_add_subapp_with_slash_prefix(router, loop):
+def test_cannot_add_subapp_with_slash_prefix(app, loop):
     subapp = web.Application(loop=loop)
     with pytest.raises(ValueError):
-        router.add_subapp('/', subapp)
+        app.add_subapp('/', subapp)
 
 
 @asyncio.coroutine

tests/test_web_functional.py

@@ -869,7 +869,7 @@ def handler(request):
     app = web.Application(loop=loop)
     subapp = web.Application(loop=loop)
     subapp.router.add_get('/to', handler)
-    app.router.add_subapp('/path', subapp)
+    app.add_subapp('/path', subapp)
 
     client = yield from test_client(app)
     resp = yield from client.get('/path/to')
@@ -893,7 +893,7 @@ def handler2(request):
     subapp = web.Application(loop=loop)
     subapp.router.add_get('/to', handler)
     subapp.router.add_get('/final', handler2, name='name')
-    app.router.add_subapp('/path', subapp)
+    app.add_subapp('/path', subapp)
 
     client = yield from test_client(app)
     resp = yield from client.get('/path/to')
@@ -918,7 +918,7 @@ def handler2(request):
     subapp = web.Application(loop=loop)
     subapp.router.add_get('/to', handler)
     subapp.router.add_get('/{part}', handler2, name='name')
-    app.router.add_subapp('/path', subapp)
+    app.add_subapp('/path', subapp)
 
     client = yield from test_client(app)
     resp = yield from client.get('/path/to')
@@ -942,7 +942,7 @@ def handler(request):
     subapp.router.add_get('/to', handler)
     here = pathlib.Path(__file__).parent
     subapp.router.add_static('/static', here, name='name')
-    app.router.add_subapp('/path', subapp)
+    app.add_subapp('/path', subapp)
 
     client = yield from test_client(app)
     resp = yield from client.get('/path/to')
@@ -963,7 +963,7 @@ def handler(request):
     app = web.Application(loop=loop)
     subapp = web.Application(loop=loop)
     subapp.router.add_get('/to', handler)
-    app.router.add_subapp('/path/', subapp)
+    app.add_subapp('/path/', subapp)
 
     client = yield from test_client(app)
     resp = yield from client.get('/path/to')
@@ -981,7 +981,7 @@ def handler(request):
     app = web.Application(loop=loop)
     subapp = web.Application(loop=loop)
     subapp.router.add_get('/to', handler)
-    app.router.add_subapp('/path/', subapp)
+    app.add_subapp('/path/', subapp)
 
     client = yield from test_client(app)
     resp = yield from client.get('/path/other')
@@ -997,7 +997,7 @@ def handler(request):
     app = web.Application(loop=loop)
     subapp = web.Application(loop=loop)
     subapp.router.add_get('/to', handler)
-    app.router.add_subapp('/path/', subapp)
+    app.add_subapp('/path/', subapp)
 
     client = yield from test_client(app)
     resp = yield from client.get('/invalid/other')
@@ -1013,7 +1013,7 @@ def handler(request):
     app = web.Application(loop=loop)
     subapp = web.Application(loop=loop)
     subapp.router.add_get('/to', handler)
-    app.router.add_subapp('/path/', subapp)
+    app.add_subapp('/path/', subapp)
 
     client = yield from test_client(app)
     resp = yield from client.post('/path/to')
@@ -1031,7 +1031,7 @@ def handler(request):
     app = web.Application(loop=loop)
     subapp = web.Application(loop=loop)
     subapp.router.add_get('/to', handler)
-    app.router.add_subapp('/path/', subapp)
+    app.add_subapp('/path/', subapp)
 
     client = yield from test_client(app)
     resp = yield from client.get('/path/to')
@@ -1062,8 +1062,8 @@ def middleware(request):
     subapp1 = web.Application(loop=loop, middlewares=[middleware_factory])
     subapp2 = web.Application(loop=loop, middlewares=[middleware_factory])
     subapp2.router.add_get('/to', handler)
-    subapp1.router.add_subapp('/b/', subapp2)
-    app.router.add_subapp('/a/', subapp1)
+    subapp1.add_subapp('/b/', subapp2)
+    app.add_subapp('/a/', subapp1)
 
     client = yield from test_client(app)
     resp = yield from client.get('/a/b/to')
@@ -1095,8 +1095,8 @@ def on_response(request, response):
     subapp2 = web.Application(loop=loop)
     subapp2.on_response_prepare.append(make_signal(subapp2))
     subapp2.router.add_get('/to', handler)
-    subapp1.router.add_subapp('/b/', subapp2)
-    app.router.add_subapp('/a/', subapp1)
+    subapp1.add_subapp('/b/', subapp2)
+    app.add_subapp('/a/', subapp1)
 
     client = yield from test_client(app)
     resp = yield from client.get('/a/b/to')
@@ -1118,8 +1118,8 @@ def on_signal(app):
     subapp1.on_startup.append(on_signal)
     subapp2 = web.Application(loop=loop)
     subapp2.on_startup.append(on_signal)
-    subapp1.router.add_subapp('/b/', subapp2)
-    app.router.add_subapp('/a/', subapp1)
+    subapp1.add_subapp('/b/', subapp2)
+    app.add_subapp('/a/', subapp1)
 
     yield from test_server(app)
 
@@ -1139,8 +1139,8 @@ def on_signal(app):
     subapp1.on_shutdown.append(on_signal)
     subapp2 = web.Application(loop=loop)
     subapp2.on_shutdown.append(on_signal)
-    subapp1.router.add_subapp('/b/', subapp2)
-    app.router.add_subapp('/a/', subapp1)
+    subapp1.add_subapp('/b/', subapp2)
+    app.add_subapp('/a/', subapp1)
 
     server = yield from test_server(app)
     yield from server.close()
@@ -1162,8 +1162,8 @@ def on_signal(app):
     subapp1.on_cleanup.append(on_signal)
     subapp2 = web.Application(loop=loop)
     subapp2.on_cleanup.append(on_signal)
-    subapp1.router.add_subapp('/b/', subapp2)
-    app.router.add_subapp('/a/', subapp1)
+    subapp1.add_subapp('/b/', subapp2)
+    app.add_subapp('/a/', subapp1)
 
     server = yield from test_server(app)
     yield from server.close()