Index

A

ACCEPTED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) ApiError, [1] assertBadRequest() (birchrest.unittest.BirchRestTestCase method) assertBodyContains() (birchrest.unittest.BirchRestTestCase method) assertForbidden() (birchrest.unittest.BirchRestTestCase method) assertHasHeader() (birchrest.unittest.BirchRestTestCase method) assertHeader() (birchrest.unittest.BirchRestTestCase method)

assertInternalServerError() (birchrest.unittest.BirchRestTestCase method) assertNotFound() (birchrest.unittest.BirchRestTestCase method) assertNotOk() (birchrest.unittest.BirchRestTestCase method) assertOk() (birchrest.unittest.BirchRestTestCase method) assertRedirect() (birchrest.unittest.BirchRestTestCase method) assertStatus() (birchrest.unittest.BirchRestTestCase method) assertUnauthorized() (birchrest.unittest.BirchRestTestCase method) auth() (birchrest.app.BirchRest method) (birchrest.BirchRest method)

B

BAD_GATEWAY (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) BAD_REQUEST (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) BadRequest, [1] birchrest module BirchRest (class in birchrest) (class in birchrest.app) birchrest.app module birchrest.decorators module birchrest.decorators.body module birchrest.decorators.controller module birchrest.decorators.delete module birchrest.decorators.get module birchrest.decorators.head module birchrest.decorators.middleware module birchrest.decorators.options module birchrest.decorators.params module birchrest.decorators.patch module birchrest.decorators.post module birchrest.decorators.protected module birchrest.decorators.put module birchrest.decorators.queries module birchrest.exceptions module birchrest.exceptions.api_error module birchrest.exceptions.invalid_controller_registration module

birchrest.exceptions.missing_auth_handler_error module birchrest.http module birchrest.http.request module birchrest.http.response module birchrest.http.server module birchrest.http.status module birchrest.middlewares module birchrest.middlewares.cors module birchrest.middlewares.logger module birchrest.middlewares.rate_limiter module birchrest.routes module birchrest.routes.controller module birchrest.routes.route module birchrest.routes.validator module birchrest.types module birchrest.types.types module birchrest.unittest module birchrest.unittest.test_adapter module birchrest.utils module birchrest.utils.artwork module birchrest.version module BirchRestTestCase (class in birchrest.unittest) body() (in module birchrest.decorators) (in module birchrest.decorators.body)

C

collect_routes() (birchrest.Controller method) (birchrest.routes.Controller method) (birchrest.routes.controller.Controller method) Conflict, [1] CONFLICT (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) CONTINUE (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) Controller (class in birchrest) (class in birchrest.routes) (class in birchrest.routes.controller)

controller() (in module birchrest.decorators) (in module birchrest.decorators.controller) convert_to_response() (birchrest.exceptions.api_error.ApiError method) (birchrest.exceptions.ApiError method) Cors (class in birchrest.middlewares) (class in birchrest.middlewares.cors) CREATED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

D

debug() (birchrest.utils.Logger static method) delete() (birchrest.unittest.test_adapter.TestAdapter method) (birchrest.unittest.TestAdapter method) (in module birchrest.decorators) (in module birchrest.decorators.delete)

description() (birchrest.http.HttpStatus class method) (birchrest.http.status.HttpStatus class method) dict_to_dataclass() (in module birchrest.utils)

E

EARLY_HINTS (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) end() (birchrest.http.Response method) (birchrest.http.response.Response method)

error() (birchrest.app.BirchRest method) (birchrest.BirchRest method) (birchrest.utils.Logger static method) EXPECTATION_FAILED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

F

Forbidden, [1] FORBIDDEN (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

FOUND (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

G

GATEWAY_TIMEOUT (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) get() (birchrest.unittest.test_adapter.TestAdapter method) (birchrest.unittest.TestAdapter method) (in module birchrest.decorators) (in module birchrest.decorators.get)

get_artwork() (in module birchrest.utils) (in module birchrest.utils.artwork) get_header() (birchrest.http.Request method) (birchrest.http.request.Request method) Gone, [1] GONE (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

H

handle_request() (birchrest.app.BirchRest method) (birchrest.BirchRest method) head() (birchrest.unittest.test_adapter.TestAdapter method) (birchrest.unittest.TestAdapter method) (in module birchrest.decorators) (in module birchrest.decorators.head)

HTTP_VERSION_NOT_SUPPORTED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) HttpStatus (class in birchrest.http) (class in birchrest.http.status)

I

IM_A_TEAPOT (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) info() (birchrest.utils.Logger static method) INSUFFICIENT_STORAGE (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) INTERNAL_SERVER_ERROR (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

InternalServerError, [1] InvalidControllerRegistration, [1] InvalidValidationModel is_method_allowed() (birchrest.routes.Route method) (birchrest.routes.route.Route method)

L

LENGTH_REQUIRED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) LengthRequired, [1] Logger (class in birchrest.middlewares) (class in birchrest.middlewares.logger) (class in birchrest.utils)

LOOP_DETECTED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

M

make_protected() (birchrest.routes.Route method) (birchrest.routes.route.Route method) match() (birchrest.routes.Route method) (birchrest.routes.route.Route method) METHOD_NOT_ALLOWED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) MethodNotAllowed, [1] Middleware (class in birchrest) (class in birchrest.middlewares) middleware() (birchrest.app.BirchRest method) (birchrest.BirchRest method) (in module birchrest.decorators) (in module birchrest.decorators.middleware) MissingAuthHandlerError, [1] module birchrest birchrest.app birchrest.decorators birchrest.decorators.body birchrest.decorators.controller birchrest.decorators.delete birchrest.decorators.get birchrest.decorators.head birchrest.decorators.middleware birchrest.decorators.options birchrest.decorators.params birchrest.decorators.patch birchrest.decorators.post birchrest.decorators.protected birchrest.decorators.put birchrest.decorators.queries birchrest.exceptions birchrest.exceptions.api_error birchrest.exceptions.invalid_controller_registration birchrest.exceptions.missing_auth_handler_error birchrest.http birchrest.http.request birchrest.http.response birchrest.http.server birchrest.http.status birchrest.middlewares birchrest.middlewares.cors birchrest.middlewares.logger birchrest.middlewares.rate_limiter birchrest.routes birchrest.routes.controller birchrest.routes.route birchrest.routes.validator birchrest.types birchrest.types.types birchrest.unittest birchrest.unittest.test_adapter birchrest.utils birchrest.utils.artwork birchrest.version

MOVED_PERMANENTLY (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) MULTIPLE_CHOICES (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

N

NETWORK_AUTHENTICATION_REQUIRED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) NO_CONTENT (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) NON_AUTHORITATIVE_INFORMATION (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) NOT_ACCEPTABLE (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

NOT_EXTENDED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) NOT_FOUND (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) NOT_IMPLEMENTED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) NOT_MODIFIED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) NotFound, [1]

O

OK (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) options() (birchrest.unittest.test_adapter.TestAdapter method) (birchrest.unittest.TestAdapter method) (in module birchrest.decorators) (in module birchrest.decorators.options)

P

params() (in module birchrest.decorators) (in module birchrest.decorators.params) parse() (birchrest.http.Request static method) (birchrest.http.request.Request static method) parse_data_class() (in module birchrest.routes) (in module birchrest.routes.validator) PARTIAL_CONTENT (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) patch() (birchrest.unittest.test_adapter.TestAdapter method) (birchrest.unittest.TestAdapter method) (in module birchrest.decorators) (in module birchrest.decorators.patch) PAYLOAD_TOO_LARGE (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) PayloadTooLarge, [1] PAYMENT_REQUIRED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) PaymentRequired, [1] PERMANENT_REDIRECT (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

post() (birchrest.unittest.test_adapter.TestAdapter method) (birchrest.unittest.TestAdapter method) (in module birchrest.decorators) (in module birchrest.decorators.post) PRECONDITION_FAILED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) PRECONDITION_REQUIRED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) PreconditionFailed PROCESSING (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) produces() (in module birchrest.decorators) protected() (in module birchrest.decorators) (in module birchrest.decorators.protected) PROXY_AUTHENTICATION_REQUIRED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) put() (birchrest.unittest.test_adapter.TestAdapter method) (birchrest.unittest.TestAdapter method) (in module birchrest.decorators) (in module birchrest.decorators.put)

Q

queries() (in module birchrest.decorators) (in module birchrest.decorators.queries)

R

RANGE_NOT_SATISFIABLE (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) RateLimiter (class in birchrest.middlewares) (class in birchrest.middlewares.rate_limiter) register() (birchrest.app.BirchRest method) (birchrest.BirchRest method) register_auth_handler() (birchrest.routes.Route method) (birchrest.routes.route.Route method) Request (class in birchrest.http) (class in birchrest.http.request) REQUEST_HEADER_FIELDS_TOO_LARGE (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) REQUEST_TIMEOUT (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

RequestTimeout, [1] RESET_CONTENT (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) resolve() (birchrest.routes.Route method) (birchrest.routes.route.Route method) resolve_paths() (birchrest.Controller method) (birchrest.routes.Controller method) (birchrest.routes.controller.Controller method) Response (class in birchrest.http) (class in birchrest.http.response) Route (class in birchrest.routes) (class in birchrest.routes.route)

S

SEE_OTHER (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) send() (birchrest.http.Response method) (birchrest.http.response.Response method) serve() (birchrest.app.BirchRest method) (birchrest.BirchRest method) Server (class in birchrest.http) (class in birchrest.http.server) SERVICE_UNAVAILABLE (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

ServiceUnavailable, [1] set_header() (birchrest.http.Response method) (birchrest.http.response.Response method) shutdown() (birchrest.http.Server method) (birchrest.http.server.Server method) start() (birchrest.http.Server method) (birchrest.http.server.Server method) status() (birchrest.http.Response method) (birchrest.http.response.Response method) SWITCHING_PROTOCOLS (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

T

tag() (in module birchrest.decorators) TEMPORARY_REDIRECT (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) TestAdapter (class in birchrest.unittest) (class in birchrest.unittest.test_adapter)

TOO_EARLY (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) TOO_MANY_REQUESTS (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) TooManyRequests, [1]

U

Unauthorized, [1] UNAUTHORIZED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) UNPROCESSABLE_ENTITY (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) UnprocessableEntity, [1] UNSUPPORTED_MEDIA_TYPE (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

UnsupportedMediaType, [1] UPGRADE_REQUIRED (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute) UpgradeRequired, [1] URI_TOO_LONG (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

V

VARIANT_ALSO_NEGOTIATES (birchrest.http.HttpStatus attribute) (birchrest.http.status.HttpStatus attribute)

W

warning() (birchrest.utils.Logger static method)