Abstract Classes¶
Abstract routing¶
aiohttp has abstract classes for managing web interfaces.
The most part of aiohttp.web
is not intended to be inherited
but few of them are.
aiohttp.web is built on top of few concepts: application, router, request and response.
router is a pluggable part: a library user may build a router from scratch, all other parts should work with new router seamlessly.
AbstractRouter
has the only mandatory method:
AbstractRouter.resolve()
coroutine. It should return an
AbstractMatchInfo
instance.
If the requested URL handler is found
AbstractMatchInfo.handler()
is a web-handler for
requested URL and AbstractMatchInfo.http_exception
is None
.
Otherwise AbstractMatchInfo.http_exception
is an instance of
HTTPException
like 404: NotFound or 405: Method
Not Allowed. AbstractMatchInfo.handler()
raises
http_exception
on call.
-
class
aiohttp.abc.
AbstractRouter
[source]¶ Abstract router,
aiohttp.web.Application
accepts it as router parameter and returns asaiohttp.web.Application.router
.-
coroutine
resolve
(request)¶ Performs URL resolving. It’s an abstract method, should be overridden in router implementation.
Parameters: request – aiohttp.web.Request
instance for resolving, the request hasaiohttp.web.Request.match_info
equals toNone
at resolving stage.Returns: AbstractMatchInfo
instance.
-
coroutine
-
class
aiohttp.abc.
AbstractMatchInfo
[source]¶ Abstract math info, returned by
AbstractRouter()
call.-
http_exception
¶ aiohttp.web.HTTPException
if no match was found,None
otherwise.
-
coroutine
handler
(request)¶ Abstract method performing web-handler processing.
Parameters: request – aiohttp.web.Request
instance for resolving, the request hasaiohttp.web.Request.match_info
equals toNone
at resolving stage.Returns: aiohttp.web.StramResponse
or descendants.Raise: aiohttp.web.HTTPException
on error
-
coroutine
expect_handler
(request)¶ Abstract method for handling 100-continue processing.
-
Abstract Class Based Views¶
For class based view support aiohttp has abstract
AbstractView
class which is awaitable (may be uses like
await Cls()
or yield from Cls()
and has a request as an
attribute.
-
class
aiohttp.abc.
AbstractView
[source]¶ An abstract class, base for all class based views implementations.
Methods
__iter__
and__await__
should be overridden.-
request
¶ aiohttp.web.Request
instance for performing the request.
-