193 lines
5.9 KiB
Python
193 lines
5.9 KiB
Python
import abc
|
|
import os # noqa
|
|
from typing import (
|
|
TYPE_CHECKING,
|
|
Any,
|
|
Awaitable,
|
|
Callable,
|
|
Dict,
|
|
Iterator,
|
|
List,
|
|
Optional,
|
|
Sequence,
|
|
Union,
|
|
overload,
|
|
)
|
|
|
|
import attr
|
|
|
|
from . import hdrs
|
|
from .abc import AbstractView
|
|
from .typedefs import PathLike
|
|
|
|
if TYPE_CHECKING: # pragma: no cover
|
|
from .web_urldispatcher import UrlDispatcher
|
|
from .web_request import Request
|
|
from .web_response import StreamResponse
|
|
else:
|
|
Request = StreamResponse = UrlDispatcher = None
|
|
|
|
|
|
__all__ = ('AbstractRouteDef', 'RouteDef', 'StaticDef', 'RouteTableDef',
|
|
'head', 'options', 'get', 'post', 'patch', 'put', 'delete',
|
|
'route', 'view', 'static')
|
|
|
|
|
|
class AbstractRouteDef(abc.ABC):
|
|
@abc.abstractmethod
|
|
def register(self, router: UrlDispatcher) -> None:
|
|
pass # pragma: no cover
|
|
|
|
|
|
_SimpleHandler = Callable[[Request], Awaitable[StreamResponse]]
|
|
_HandlerType = Union[AbstractView, _SimpleHandler]
|
|
|
|
|
|
@attr.s(frozen=True, repr=False, slots=True)
|
|
class RouteDef(AbstractRouteDef):
|
|
method = attr.ib(type=str)
|
|
path = attr.ib(type=str)
|
|
handler = attr.ib() # type: _HandlerType
|
|
kwargs = attr.ib(type=Dict[str, Any])
|
|
|
|
def __repr__(self) -> str:
|
|
info = []
|
|
for name, value in sorted(self.kwargs.items()):
|
|
info.append(", {}={!r}".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: UrlDispatcher) -> None:
|
|
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)
|
|
|
|
|
|
@attr.s(frozen=True, repr=False, slots=True)
|
|
class StaticDef(AbstractRouteDef):
|
|
prefix = attr.ib(type=str)
|
|
path = attr.ib() # type: PathLike
|
|
kwargs = attr.ib(type=Dict[str, Any])
|
|
|
|
def __repr__(self) -> str:
|
|
info = []
|
|
for name, value in sorted(self.kwargs.items()):
|
|
info.append(", {}={!r}".format(name, value))
|
|
return ("<StaticDef {prefix} -> {path}"
|
|
"{info}>".format(prefix=self.prefix, path=self.path,
|
|
info=''.join(info)))
|
|
|
|
def register(self, router: UrlDispatcher) -> None:
|
|
router.add_static(self.prefix, self.path, **self.kwargs)
|
|
|
|
|
|
def route(method: str, path: str, handler: _HandlerType,
|
|
**kwargs: Any) -> RouteDef:
|
|
return RouteDef(method, path, handler, kwargs)
|
|
|
|
|
|
def head(path: str, handler: _HandlerType, **kwargs: Any) -> RouteDef:
|
|
return route(hdrs.METH_HEAD, path, handler, **kwargs)
|
|
|
|
|
|
def options(path: str, handler: _HandlerType, **kwargs: Any) -> RouteDef:
|
|
return route(hdrs.METH_OPTIONS, path, handler, **kwargs)
|
|
|
|
|
|
def get(path: str, handler: _HandlerType, *, name: Optional[str]=None,
|
|
allow_head: bool=True, **kwargs: Any) -> RouteDef:
|
|
return route(hdrs.METH_GET, path, handler, name=name,
|
|
allow_head=allow_head, **kwargs)
|
|
|
|
|
|
def post(path: str, handler: _HandlerType, **kwargs: Any) -> RouteDef:
|
|
return route(hdrs.METH_POST, path, handler, **kwargs)
|
|
|
|
|
|
def put(path: str, handler: _HandlerType, **kwargs: Any) -> RouteDef:
|
|
return route(hdrs.METH_PUT, path, handler, **kwargs)
|
|
|
|
|
|
def patch(path: str, handler: _HandlerType, **kwargs: Any) -> RouteDef:
|
|
return route(hdrs.METH_PATCH, path, handler, **kwargs)
|
|
|
|
|
|
def delete(path: str, handler: _HandlerType, **kwargs: Any) -> RouteDef:
|
|
return route(hdrs.METH_DELETE, path, handler, **kwargs)
|
|
|
|
|
|
def view(path: str, handler: AbstractView, **kwargs: Any) -> RouteDef:
|
|
return route(hdrs.METH_ANY, path, handler, **kwargs)
|
|
|
|
|
|
def static(prefix: str, path: PathLike,
|
|
**kwargs: Any) -> StaticDef:
|
|
return StaticDef(prefix, path, kwargs)
|
|
|
|
|
|
_Deco = Callable[[_HandlerType], _HandlerType]
|
|
|
|
|
|
class RouteTableDef(Sequence[AbstractRouteDef]):
|
|
"""Route definition table"""
|
|
def __init__(self) -> None:
|
|
self._items = [] # type: List[AbstractRouteDef]
|
|
|
|
def __repr__(self) -> str:
|
|
return "<RouteTableDef count={}>".format(len(self._items))
|
|
|
|
@overload
|
|
def __getitem__(self, index: int) -> AbstractRouteDef: ... # noqa
|
|
|
|
@overload # noqa
|
|
def __getitem__(self, index: slice) -> List[AbstractRouteDef]: ... # noqa
|
|
|
|
def __getitem__(self, index): # type: ignore # noqa
|
|
return self._items[index]
|
|
|
|
def __iter__(self) -> Iterator[AbstractRouteDef]:
|
|
return iter(self._items)
|
|
|
|
def __len__(self) -> int:
|
|
return len(self._items)
|
|
|
|
def __contains__(self, item: object) -> bool:
|
|
return item in self._items
|
|
|
|
def route(self,
|
|
method: str,
|
|
path: str,
|
|
**kwargs: Any) -> _Deco:
|
|
def inner(handler: _HandlerType) -> _HandlerType:
|
|
self._items.append(RouteDef(method, path, handler, kwargs))
|
|
return handler
|
|
return inner
|
|
|
|
def head(self, path: str, **kwargs: Any) -> _Deco:
|
|
return self.route(hdrs.METH_HEAD, path, **kwargs)
|
|
|
|
def get(self, path: str, **kwargs: Any) -> _Deco:
|
|
return self.route(hdrs.METH_GET, path, **kwargs)
|
|
|
|
def post(self, path: str, **kwargs: Any) -> _Deco:
|
|
return self.route(hdrs.METH_POST, path, **kwargs)
|
|
|
|
def put(self, path: str, **kwargs: Any) -> _Deco:
|
|
return self.route(hdrs.METH_PUT, path, **kwargs)
|
|
|
|
def patch(self, path: str, **kwargs: Any) -> _Deco:
|
|
return self.route(hdrs.METH_PATCH, path, **kwargs)
|
|
|
|
def delete(self, path: str, **kwargs: Any) -> _Deco:
|
|
return self.route(hdrs.METH_DELETE, path, **kwargs)
|
|
|
|
def view(self, path: str, **kwargs: Any) -> _Deco:
|
|
return self.route(hdrs.METH_ANY, path, **kwargs)
|
|
|
|
def static(self, prefix: str, path: PathLike,
|
|
**kwargs: Any) -> None:
|
|
self._items.append(StaticDef(prefix, path, kwargs))
|