Values a server can turn into a response (Effect's
HttpServerRespondable).
A respondable defines __http_response__, giving the response to send
when it is an error of a handler (HttpServerError reasons, schema
errors, a HttpServerResponse itself)::
@dataclass(eq=False)
class Unauthorized(fx.TaggedError):
def __http_response__(self):
return succeed(server_response.empty(status=401))Classes#
Functions#
is_respondable#
is_respondable(value) -> TypeIs[Respondable]| Parameter | Type | Description |
|---|---|---|
value | object |
Returns TypeIs[Respondable]
def is_respondable(value: object) -> TypeIs[Respondable]:
return isinstance(value, Respondable)to_response#
to_response(value) -> Effect[HttpServerResponse]The response of value; its failure is a defect.
| Parameter | Type | Description |
|---|---|---|
value | Respondable |
Returns Effect[HttpServerResponse]
def to_response(value: Respondable) -> Effect[HttpServerResponse]:
"""The response of ``value``; its failure is a defect."""
if isinstance(value, HttpServerResponse):
return succeed(value)
return value.__http_response__().or_die()to_response_or_else#
to_response_or_else(value, or_else) -> Effect[HttpServerResponse]The response of a respondable (or_else if making it fails), 400
for a SchemaError, 404 for a NoSuchElementException, else
or_else.
| Parameter | Type | Description |
|---|---|---|
value | object | |
or_else | HttpServerResponse |
Returns Effect[HttpServerResponse]
def to_response_or_else(value: object, or_else: HttpServerResponse) -> Effect[HttpServerResponse]:
"""The response of a respondable (``or_else`` if making it fails), 400
for a ``SchemaError``, 404 for a ``NoSuchElementException``, else
``or_else``."""
if isinstance(value, HttpServerResponse):
return succeed(value)
if is_respondable(value):
return value.__http_response__().catch_cause(lambda _: succeed(or_else))
if isinstance(value, SchemaError):
return succeed(_BAD_REQUEST)
if isinstance(value, NoSuchElementException):
return succeed(_NOT_FOUND)
return succeed(or_else)to_response_or_else_defect#
to_response_or_else_defect(value, or_else) -> Effect[HttpServerResponse]to_response_or_else for a defect: only respondables count.
| Parameter | Type | Description |
|---|---|---|
value | object | |
or_else | HttpServerResponse |
Returns Effect[HttpServerResponse]
def to_response_or_else_defect(
value: object, or_else: HttpServerResponse
) -> Effect[HttpServerResponse]:
"""``to_response_or_else`` for a defect: only respondables count."""
if isinstance(value, HttpServerResponse):
return succeed(value)
if is_respondable(value):
return value.__http_response__().catch_cause(lambda _: succeed(or_else))
return succeed(or_else)