UrlDispatcher - add_routes returns a list of AbstractRoutes

CHANGES/3866.feature

@@ -0,0 +1,3 @@
+`web.UrlDispatcher.add_routes` and `web.Application.add_routes` return a list
+of registered `AbstractRoute` instances. `RouteDef.register` returns the
+registered resource.

CONTRIBUTORS.txt

@@ -274,5 +274,6 @@ Young-Ho Cha
 Yuriy Shatrov
 Yury Selivanov
 Yusuke Tsutsumi
+Zlatan Sičanica
 Марк Коренберг
 Семён Марьясин

aiohttp/web_app.py

@@ -34,6 +34,7 @@
 from .web_routedef import AbstractRouteDef
 from .web_urldispatcher import (
     AbstractResource,
+    AbstractRoute,
     Domain,
     MaskDomain,
     MatchedSubAppResource,
@@ -250,8 +251,10 @@ def add_domain(self, domain: str,
         factory = partial(MatchedSubAppResource, rule, subapp)
         return self._add_subapp(factory, subapp)
 
-    def add_routes(self, routes: Iterable[AbstractRouteDef]) -> None:
-        self.router.add_routes(routes)
+    def add_routes(
+            self, routes: Iterable[AbstractRouteDef]
+    ) -> List[Optional[AbstractRoute]]:
+        return self.router.add_routes(routes)
 
     @property
     def on_response_prepare(self) -> _RespPrepareSignal:

aiohttp/web_routedef.py

@@ -22,11 +22,14 @@
 from .typedefs import PathLike
 
 if TYPE_CHECKING:  # pragma: no cover
-    from .web_urldispatcher import UrlDispatcher
+    from .web_urldispatcher import (
+        UrlDispatcher,
+        AbstractRoute
+    )
     from .web_request import Request
     from .web_response import StreamResponse
 else:
-    Request = StreamResponse = UrlDispatcher = None
+    Request = StreamResponse = UrlDispatcher = AbstractRoute = None
 
 
 __all__ = ('AbstractRouteDef', 'RouteDef', 'StaticDef', 'RouteTableDef',
@@ -36,7 +39,7 @@
 
 class AbstractRouteDef(abc.ABC):
     @abc.abstractmethod
-    def register(self, router: UrlDispatcher) -> None:
+    def register(self, router: UrlDispatcher) -> Optional[AbstractRoute]:
         pass  # pragma: no cover
 
 
@@ -59,13 +62,13 @@ def __repr__(self) -> str:
                 "{info}>".format(method=self.method, path=self.path,
                                  handler=self.handler, info=''.join(info)))
 
-    def register(self, router: UrlDispatcher) -> None:
+    def register(self, router: UrlDispatcher) -> AbstractRoute:
         if self.method in hdrs.METH_ALL:
             reg = getattr(router, 'add_'+self.method.lower())
-            reg(self.path, self.handler, **self.kwargs)
+            return reg(self.path, self.handler, **self.kwargs)
         else:
-            router.add_route(self.method, self.path, self.handler,
-                             **self.kwargs)
+            return router.add_route(self.method, self.path, self.handler,
+                                    **self.kwargs)
 
 
 @attr.s(frozen=True, repr=False, slots=True)

aiohttp/web_urldispatcher.py

@@ -1109,10 +1109,13 @@ def freeze(self) -> None:
         for resource in self._resources:
             resource.freeze()
 
-    def add_routes(self, routes: Iterable[AbstractRouteDef]) -> None:
+    def add_routes(
+            self, routes: Iterable[AbstractRouteDef]
+    ) -> List[Optional[AbstractRoute]]:
         """Append routes to route table.
 
         Parameter should be a sequence of RouteDef objects.
+
+        Returns a list of registered AbstractRoute instances.
         """
-        for route_def in routes:
-            route_def.register(self)
+        return [route_def.register(self) for route_def in routes]

docs/web_reference.rst

@@ -1413,6 +1413,8 @@ duplicated like one using :meth:`Application.copy`.
       The table is a :class:`list` of :class:`RouteDef` items or
       :class:`RouteTableDef`.
 
+      Returns a :class:`list` of registered :class:`AbstractRoute` instances.
+
       The method is a shortcut for
       ``app.router.add_routes(routes_table)``, see also
       :meth:`UrlDispatcher.add_routes`.
@@ -1569,6 +1571,8 @@ Router is any object that implements :class:`AbstractRouter` interface.
       The table is a :class:`list` of :class:`RouteDef` items or
       :class:`RouteTableDef`.
 
+      Returns a :class:`list` of registered :class:`AbstractRoute` instances.
+
       .. versionadded:: 2.3
 
    .. method:: add_get(path, handler, *, name=None, allow_head=True, **kwargs)
@@ -2080,6 +2084,8 @@ The definition is created by functions like :func:`get` or
 
       Abstract method, should be overridden by subclasses.
 
+      Returns the registered resource.
+
 
 .. class:: RouteDef