Route definitions

aiohttp/web_urldispatcher.py

@@ -6,7 +6,8 @@
 import os
 import re
 import warnings
-from collections.abc import Container, Iterable, Sized
+from collections import namedtuple
+from collections.abc import Container, Iterable, Sequence, Sized
 from functools import wraps
 from pathlib import Path
 from types import MappingProxyType
@@ -28,13 +29,32 @@
 __all__ = ('UrlDispatcher', 'UrlMappingMatchInfo',
            'AbstractResource', 'Resource', 'PlainResource', 'DynamicResource',
            'AbstractRoute', 'ResourceRoute',
-           'StaticResource', 'View')
+           'StaticResource', 'View', 'RouteDef', 'RouteTableDef',
+           'head', 'get', 'post', 'patch', 'put', 'delete', 'route')
 
 HTTP_METHOD_RE = re.compile(r"^[0-9A-Za-z!#\$%&'\*\+\-\.\^_`\|~]+$")
 ROUTE_RE = re.compile(r'(\{[_a-zA-Z][^{}]*(?:\{[^{}]*\}[^{}]*)*\})')
 PATH_SEP = re.escape('/')
 
 
+class RouteDef(namedtuple('_RouteDef', 'method, path, handler, kwargs')):
+    def __repr__(self):
+        info = []
+        for name, value in sorted(self.kwargs.items()):
+            info += ", {}={}".format(name, value)
+        return ("<RouteDef {method} {path} -> {handler.__name__!r}"
+                "{info}>".format(method=self.method, path=self.path,
+                                 handler=self.handler, info=''.join(info)))
+
+    def register(self, router):
+        if self.method in hdrs.METH_ALL:
+            reg = getattr(router, 'add_'+self.method.lower())
+            reg(self.path, self.handler, **self.kwargs)
+        else:
+            router.add_route(self.method, self.path, self.handler,
+                             **self.kwargs)
+
+
 class AbstractResource(Sized, Iterable):
 
     def __init__(self, *, name=None):
@@ -897,3 +917,86 @@ def freeze(self):
         super().freeze()
         for resource in self._resources:
             resource.freeze()
+
+    def add_routes(self, routes):
+        """Append routes to route table.
+
+        Parameter should be a sequence of RouteDef objects.
+        """
+        # TODO: add_table maybe?
+        for route in routes:
+            route.register(self)
+
+
+def route(method, path, handler, **kwargs):
+    return RouteDef(method, path, handler, kwargs)
+
+
+def head(path, handler, **kwargs):
+    return route(hdrs.METH_HEAD, path, handler, **kwargs)
+
+
+def get(path, handler, *, name=None, allow_head=True, **kwargs):
+    return route(hdrs.METH_GET, path, handler,
+                 allow_head=allow_head, **kwargs)
+
+
+def post(path, handler, **kwargs):
+    return route(hdrs.METH_POST, path, handler, **kwargs)
+
+
+def put(path, handler, **kwargs):
+    return route(hdrs.METH_PUT, path, handler, **kwargs)
+
+
+def patch(path, handler, **kwargs):
+    return route(hdrs.METH_PATCH, path, handler, **kwargs)
+
+
+def delete(path, handler, **kwargs):
+    return route(hdrs.METH_DELETE, path, handler, **kwargs)
+
+
+class RouteTableDef(Sequence):
+    """Route definition table"""
+    def __init__(self):
+        self._items = []
+
+    def __repr__(self):
+        return "<RouteTableDef count={}>".format(len(self._items))
+
+    def __getitem__(self, index):
+        return self._items[index]
+
+    def __iter__(self):
+        return iter(self._items)
+
+    def __len__(self):
+        return len(self._items)
+
+    def __contains__(self, item):
+        return item in self._items
+
+    def route(self, method, path, **kwargs):
+        def inner(handler):
+            self._items.append(RouteDef(method, path, handler, kwargs))
+            return handler
+        return inner
+
+    def head(self, path, **kwargs):
+        return self.route(hdrs.METH_HEAD, path, **kwargs)
+
+    def get(self, path, **kwargs):
+        return self.route(hdrs.METH_GET, path, **kwargs)
+
+    def post(self, path, **kwargs):
+        return self.route(hdrs.METH_POST, path, **kwargs)
+
+    def put(self, path, **kwargs):
+        return self.route(hdrs.METH_PUT, path, **kwargs)
+
+    def patch(self, path, **kwargs):
+        return self.route(hdrs.METH_PATCH, path, **kwargs)
+
+    def delete(self, path, **kwargs):
+        return self.route(hdrs.METH_DELETE, path, **kwargs)

examples/web_srv_route_deco.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python3
+"""Example for aiohttp.web basic server
+with decorator definition for routes
+"""
+
+import asyncio
+import textwrap
+
+from aiohttp import web
+
+
+routes = web.RouteTableDef()
+
+
+@routes.get('/')
+async def intro(request):
+    txt = textwrap.dedent("""\
+        Type {url}/hello/John  {url}/simple or {url}/change_body
+        in browser url bar
+    """).format(url='127.0.0.1:8080')
+    binary = txt.encode('utf8')
+    resp = web.StreamResponse()
+    resp.content_length = len(binary)
+    resp.content_type = 'text/plain'
+    await resp.prepare(request)
+    resp.write(binary)
+    return resp
+
+
+@routes.get('/simple')
+async def simple(request):
+    return web.Response(text="Simple answer")
+
+
+@routes.get('/change_body')
+async def change_body(request):
+    resp = web.Response()
+    resp.body = b"Body changed"
+    resp.content_type = 'text/plain'
+    return resp
+
+
+@routes.get('/hello')
+async def hello(request):
+    resp = web.StreamResponse()
+    name = request.match_info.get('name', 'Anonymous')
+    answer = ('Hello, ' + name).encode('utf8')
+    resp.content_length = len(answer)
+    resp.content_type = 'text/plain'
+    await resp.prepare(request)
+    resp.write(answer)
+    await resp.write_eof()
+    return resp
+
+
+async def init():
+    app = web.Application()
+    app.router.add_routes(routes)
+    return app
+
+loop = asyncio.get_event_loop()
+app = loop.run_until_complete(init())
+web.run_app(app)

examples/web_srv_route_table.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+"""Example for aiohttp.web basic server
+with table definition for routes
+"""
+
+import asyncio
+import textwrap
+
+from aiohttp import web
+
+
+async def intro(request):
+    txt = textwrap.dedent("""\
+        Type {url}/hello/John  {url}/simple or {url}/change_body
+        in browser url bar
+    """).format(url='127.0.0.1:8080')
+    binary = txt.encode('utf8')
+    resp = web.StreamResponse()
+    resp.content_length = len(binary)
+    resp.content_type = 'text/plain'
+    await resp.prepare(request)
+    resp.write(binary)
+    return resp
+
+
+async def simple(request):
+    return web.Response(text="Simple answer")
+
+
+async def change_body(request):
+    resp = web.Response()
+    resp.body = b"Body changed"
+    resp.content_type = 'text/plain'
+    return resp
+
+
+async def hello(request):
+    resp = web.StreamResponse()
+    name = request.match_info.get('name', 'Anonymous')
+    answer = ('Hello, ' + name).encode('utf8')
+    resp.content_length = len(answer)
+    resp.content_type = 'text/plain'
+    await resp.prepare(request)
+    resp.write(answer)
+    await resp.write_eof()
+    return resp
+
+
+async def init():
+    app = web.Application()
+    app.router.add_routes([
+        web.get('/', intro),
+        web.get('/simple', simple),
+        web.get('/change_body', change_body),
+        web.get('/hello/{name}', hello),
+        web.get('/hello', hello),
+    ])
+    return app
+
+loop = asyncio.get_event_loop()
+app = loop.run_until_complete(init())
+web.run_app(app)