faust.web.views

Class-based views.

class faust.web.views.View(app: faust.types.app.AppT, web: faust.web.base.Web) → None

Web view (HTTP endpoint).

exception ServerError(detail: str = None, *, code: int = None, **extra_context) → None

Internal Server Error (500).

code = 500

detail = 'Internal server error.'

exception ValidationError(detail: str = None, *, code: int = None, **extra_context) → None

Invalid input in POST data (400).

code = 400

detail = 'Invalid input.'

exception ParseError(detail: str = None, *, code: int = None, **extra_context) → None

Malformed request (400).

code = 400

detail = 'Malformed request.'

exception NotAuthenticated(detail: str = None, *, code: int = None, **extra_context) → None

Authentication credentials were not provided (401).

code = 401

detail = 'Authentication credentials were not provided.'

exception PermissionDenied(detail: str = None, *, code: int = None, **extra_context) → None

No permission to perform action (403).

code = 403

detail = 'You do not have permission to perform this action.'

exception NotFound(detail: str = None, *, code: int = None, **extra_context) → None

Resource not found (404).

code = 404

detauil = 'Not found.'

classmethod from_handler(fun: Union[Callable[[faust.types.web.View, faust.types.web.Request], Union[Coroutine[[Any, Any], faust.types.web.Response], Awaitable[faust.types.web.Response]]], Callable[[faust.types.web.View, faust.types.web.Request, Any, Any], Union[Coroutine[[Any, Any], faust.types.web.Response], Awaitable[faust.types.web.Response]]]]) → Type[faust.web.views.View]

Return type

Type[View]

text(value: str, *, content_type: str = None, status: int = 200, reason: str = None, headers: MutableMapping = None) → faust.web.base.Response

Return type

Response

html(value: str, *, content_type: str = None, status: int = 200, reason: str = None, headers: MutableMapping = None) → faust.web.base.Response

Return type

Response

json(value: Any, *, content_type: str = None, status: int = 200, reason: str = None, headers: MutableMapping = None) → faust.web.base.Response

Return type

Response

bytes(value: bytes, *, content_type: str = None, status: int = 200, reason: str = None, headers: MutableMapping = None) → faust.web.base.Response

Return type

Response

bytes_to_response(s: bytes) → faust.web.base.Response

Return type

Response

response_to_bytes(response: faust.web.base.Response) → bytes

Return type

bytes

route(pattern: str, handler: Callable) → Any

Return type

Any

notfound(reason: str = 'Not Found', **kwargs) → faust.web.base.Response

Return type

Response

error(status: int, reason: str, **kwargs) → faust.web.base.Response

Return type

Response

coroutine delete(self, request: faust.web.base.Request, **kwargs) → Any

coroutine dispatch(self, request: Any) → Any

Return type

Any

coroutine get(self, request: faust.web.base.Request, **kwargs) → Any

coroutine head(self, request: faust.web.base.Request, **kwargs) → Any

coroutine on_request_error(self, request: faust.web.base.Request, exc: faust.web.exceptions.WebError) → faust.web.base.Response

Return type

Response

coroutine options(self, request: faust.web.base.Request, **kwargs) → Any

coroutine patch(self, request: faust.web.base.Request, **kwargs) → Any

coroutine post(self, request: faust.web.base.Request, **kwargs) → Any

coroutine put(self, request: faust.web.base.Request, **kwargs) → Any

coroutine read_request_content(self, request: faust.web.base.Request) → bytes

Return type

bytes

faust.web.views.takes_model(Model: Type[faust.types.models.ModelT]) → Callable[Union[Callable[[faust.types.web.View, faust.types.web.Request], Union[Coroutine[[Any, Any], faust.types.web.Response], Awaitable[faust.types.web.Response]]], Callable[[faust.types.web.View, faust.types.web.Request, Any, Any], Union[Coroutine[[Any, Any], faust.types.web.Response], Awaitable[faust.types.web.Response]]]], Union[Callable[[faust.types.web.View, faust.types.web.Request], Union[Coroutine[[Any, Any], faust.types.web.Response], Awaitable[faust.types.web.Response]]], Callable[[faust.types.web.View, faust.types.web.Request, Any, Any], Union[Coroutine[[Any, Any], faust.types.web.Response], Awaitable[faust.types.web.Response]]]]]

Decorate view function to return model data.

Return type

Callable[[Union[Callable[[View, Request], Union[Coroutine[Any, Any, Response], Awaitable[Response]]], Callable[[View, Request, Any, Any], Union[Coroutine[Any, Any, Response], Awaitable[Response]]]]], Union[Callable[[View, Request], Union[Coroutine[Any, Any, Response], Awaitable[Response]]], Callable[[View, Request, Any, Any], Union[Coroutine[Any, Any, Response], Awaitable[Response]]]]]

faust.web.views.gives_model(Model: Type[faust.types.models.ModelT]) → Callable[Union[Callable[[faust.types.web.View, faust.types.web.Request], Union[Coroutine[[Any, Any], faust.types.web.Response], Awaitable[faust.types.web.Response]]], Callable[[faust.types.web.View, faust.types.web.Request, Any, Any], Union[Coroutine[[Any, Any], faust.types.web.Response], Awaitable[faust.types.web.Response]]]], Union[Callable[[faust.types.web.View, faust.types.web.Request], Union[Coroutine[[Any, Any], faust.types.web.Response], Awaitable[faust.types.web.Response]]], Callable[[faust.types.web.View, faust.types.web.Request, Any, Any], Union[Coroutine[[Any, Any], faust.types.web.Response], Awaitable[faust.types.web.Response]]]]]

Decorate view function to automatically decode POST data.

The POST data is decoded using the model you specify.

Return type

Callable[[Union[Callable[[View, Request], Union[Coroutine[Any, Any, Response], Awaitable[Response]]], Callable[[View, Request, Any, Any], Union[Coroutine[Any, Any, Response], Awaitable[Response]]]]], Union[Callable[[View, Request], Union[Coroutine[Any, Any, Response], Awaitable[Response]]], Callable[[View, Request, Any, Any], Union[Coroutine[Any, Any, Response], Awaitable[Response]]]]]