faust.types.web

faust.types.web.HttpClientT

alias of aiohttp.client.ClientSession

class faust.types.web.Request

class faust.types.web.Response

class faust.types.web.Web

class faust.types.web.View

faust.types.web.ViewHandlerMethod

alias of typing.Callable

faust.types.web.ViewDecorator

alias of typing.Callable

class faust.types.web.ResourceOptions(*args, **kwargs)

CORS Options for specific route, or defaults.

property allow_credentials

Alias for field number 0

property expose_headers

Alias for field number 1

property allow_headers

Alias for field number 2

property max_age

Alias for field number 3

property allow_methods

Alias for field number 4

class faust.types.web.CacheBackendT(app: faust.types.web._AppT, url: Union[yarl.URL, str] = 'memory://', **kwargs: Any) → None

abstract async get(key: str) → Optional[bytes]

Return type

Optional[bytes]

abstract async set(key: str, value: bytes, timeout: float) → None

Return type

None

abstract async delete(key: str) → None

Return type

None

class faust.types.web.CacheT(timeout: Union[datetime.timedelta, float, str] = None, key_prefix: str = None, backend: Union[Type[faust.types.web.CacheBackendT], str] = None, **kwargs: Any) → None

abstract view(timeout: Union[datetime.timedelta, float, str] = None, include_headers: bool = False, key_prefix: str = None, **kwargs: Any) → Callable[Callable, Callable]

Return type

Callable[[Callable], Callable]

class faust.types.web.BlueprintT(*args, **kwargs)

abstract cache(timeout: Union[datetime.timedelta, float, str] = None, include_headers: bool = False, key_prefix: str = None, backend: Union[Type[faust.types.web.CacheBackendT], str] = None) → faust.types.web.CacheT

Return type

CacheT

abstract route(uri: str, *, name: Optional[str] = None, base: Type[faust.types.web.View] = <class 'faust.types.web.View'>) → Callable[Union[Type[faust.types.web.View], 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[Type[faust.types.web.View], 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]]]]]

Return type

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

abstract static(uri: str, file_or_directory: Union[str, pathlib.Path], *, name: Optional[str] = None) → None

Return type

None

abstract register(app: faust.types.web._AppT, *, url_prefix: Optional[str] = None) → None

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

Return type

None

abstract init_webserver(web: faust.types.web.Web) → None

Return type

None

abstract on_webserver_init(web: faust.types.web.Web) → None

Return type

None