Index

A

accept (falcon.asgi.Request attribute) (falcon.Request attribute) accept() (falcon.asgi.WebSocket method) accept_ranges (falcon.asgi.Response property) (falcon.Response property) access_route (falcon.asgi.Request attribute) (falcon.Request attribute) add_error_handler() (falcon.API method) (falcon.App method) (falcon.asgi.App method) add_middleware() (falcon.API method) (falcon.App method) add_route() (falcon.API method) (falcon.App method) (falcon.asgi.App method) (falcon.routing.CompiledRouter method) add_sink() (falcon.API method) (falcon.App method) (falcon.asgi.App method) add_static_route() (falcon.API method) (falcon.App method) after() (in module falcon)

API (class in falcon) App (class in falcon) (class in falcon.asgi) app (falcon.Request attribute) (falcon.testing.ASGIConductor attribute) (falcon.testing.TestCase attribute) (falcon.testing.TestClient attribute) append_header() (falcon.asgi.Response method) (falcon.Response method) append_link() (falcon.asgi.Response method) (falcon.Response method) AppInfo (class in falcon.inspect) ASGIConductor (class in falcon.testing) ASGILifespanEventEmitter (class in falcon.testing) ASGIRequestEventEmitter (class in falcon.testing) ASGIResponseEventCollector (class in falcon.testing) ASGIWebSocketSimulator (class in falcon.testing) async_to_sync() (in module falcon) auth (falcon.asgi.Request attribute) (falcon.Request attribute) auto_parse_form_urlencoded (falcon.RequestOptions attribute) auto_parse_qs_csv (falcon.RequestOptions attribute)

B

BaseConverter (class in falcon.routing) BaseHandler (class in falcon.media) before() (in module falcon) BinaryBaseHandlerWS (class in falcon.media) body (falcon.asgi.Response attribute) (falcon.HTTPStatus attribute) (falcon.Response attribute)

body_chunks (falcon.testing.ASGIResponseEventCollector attribute) BodyPart (class in falcon.media.multipart) bounded_stream (falcon.Request attribute) BoundedStream (class in falcon.asgi) (class in falcon.stream)

C

cache_control (falcon.asgi.Response property) (falcon.Response property) call_count (falcon.testing.StartResponseMock attribute) called (falcon.testing.SimpleTestResource attribute) capture_responder_args() (in module falcon.testing) capture_responder_args_async() (in module falcon.testing) captured_kwargs (falcon.testing.SimpleTestResource attribute) captured_req (falcon.testing.SimpleTestResource attribute) captured_resp (falcon.testing.SimpleTestResource attribute) client_accepts() (falcon.asgi.Request method) (falcon.Request method) client_accepts_json (falcon.asgi.Request attribute) (falcon.Request attribute) client_accepts_msgpack (falcon.asgi.Request attribute) (falcon.Request attribute) client_accepts_xml (falcon.asgi.Request attribute) (falcon.Request attribute) client_prefers() (falcon.asgi.Request method) (falcon.Request method) close() (falcon.asgi.BoundedStream method) (falcon.asgi.WebSocket method) (falcon.testing.ASGIWebSocketSimulator method) close_code (falcon.testing.ASGIWebSocketSimulator attribute) closed (falcon.asgi.WebSocket attribute) (falcon.testing.ASGIWebSocketSimulator attribute) closed_wsgi_iterable() (in module falcon.testing) code (falcon.HTTPError attribute) (falcon.WebSocketDisconnected attribute) code_to_http_status() (in module falcon) comment (falcon.asgi.SSEvent attribute) compile_uri_template() (in module falcon.routing) CompiledRouter (class in falcon.routing) complete (falcon.asgi.Response attribute) (falcon.Response attribute) content (falcon.testing.Result attribute) content_length (falcon.asgi.Request attribute) (falcon.asgi.Response property) (falcon.Request attribute) (falcon.Response property)

content_location (falcon.asgi.Response property) (falcon.Response property) content_range (falcon.asgi.Response property) (falcon.Response property) content_type (falcon.asgi.Request attribute) (falcon.asgi.Response property) (falcon.media.multipart.BodyPart attribute) (falcon.Request attribute) (falcon.Response property) Context (class in falcon) context (falcon.asgi.Request attribute) (falcon.asgi.Response attribute) (falcon.Request attribute) (falcon.Response attribute) context_type (falcon.asgi.Request attribute) (falcon.asgi.Response attribute) (falcon.Request attribute) (falcon.Response attribute) convert() (falcon.routing.BaseConverter method) (falcon.routing.DateTimeConverter method) (falcon.routing.IntConverter method) (falcon.routing.UUIDConverter method) Cookie (class in falcon.testing) cookies (falcon.asgi.Request attribute) (falcon.Request attribute) (falcon.testing.Result attribute) (falcon.testing.StreamedResult attribute) CORSMiddleware (class in falcon) create_asgi_req() (in module falcon.testing) create_environ() (in module falcon.testing) create_req() (in module falcon.testing) create_scope() (in module falcon.testing) create_scope_ws() (in module falcon.testing) create_task() (in module falcon)

D

data (falcon.asgi.Response attribute) (falcon.asgi.SSEvent attribute) (falcon.media.multipart.BodyPart attribute) (falcon.Response attribute) date (falcon.asgi.Request attribute) (falcon.Request attribute) DateTimeConverter (class in falcon.routing) decode() (in module falcon.uri) default_charset (falcon.media.multipart.MultipartParseOptions attribute) default_media_type (falcon.RequestOptions attribute) (falcon.ResponseOptions attribute) delete_header() (falcon.asgi.Response method) (falcon.Response method) deprecated() (in module falcon)

description (falcon.HTTPError attribute) deserialize() (falcon.media.BaseHandler method) (falcon.media.BinaryBaseHandlerWS method) (falcon.media.TextBaseHandlerWS method) deserialize_async() (falcon.media.BaseHandler method) dest (falcon.Forwarded attribute) disconnect() (falcon.testing.ASGIRequestEventEmitter method) disconnected (falcon.testing.ASGIRequestEventEmitter attribute) domain (falcon.testing.Cookie attribute) downloadable_as (falcon.asgi.Response property) (falcon.Response property) dst() (falcon.TimezoneGMT method) dt_to_http() (in module falcon) dumps() (falcon.ETag method)

E

encode() (in module falcon.uri) encode_check_escaped() (in module falcon.uri) encode_value() (in module falcon.uri) encode_value_check_escaped() (in module falcon.uri) encoding (falcon.testing.Result attribute) (falcon.testing.StreamedResult attribute) env (falcon.Request attribute) eof (falcon.stream.BoundedStream attribute) error_close_code (falcon.asgi.WebSocketOptions attribute) ErrorHandlerInfo (class in falcon.inspect) ETag (class in falcon) etag (falcon.asgi.Response property) (falcon.Response property)

event (falcon.asgi.SSEvent attribute) event_id (falcon.asgi.SSEvent attribute) events (falcon.testing.ASGIResponseEventCollector attribute) exhaust() (falcon.asgi.BoundedStream method) (falcon.stream.BoundedStream method) exhaust_stream (falcon.media.BaseHandler attribute) expect (falcon.asgi.Request attribute) (falcon.Request attribute) expires (falcon.asgi.Response property) (falcon.Response property) (falcon.testing.Cookie attribute)

F

falcon.uri module filename (falcon.media.multipart.BodyPart attribute) fileno() (falcon.asgi.BoundedStream method) finalize() (falcon.testing.StreamedResult method) find() (falcon.routing.CompiledRouter method) Forwarded (class in falcon) forwarded (falcon.asgi.Request attribute) (falcon.Request attribute)

forwarded_host (falcon.asgi.Request attribute) (falcon.Request attribute) forwarded_prefix (falcon.asgi.Request attribute) (falcon.Request attribute) forwarded_scheme (falcon.asgi.Request attribute) (falcon.Request attribute) forwarded_uri (falcon.asgi.Request attribute) (falcon.Request attribute)

G

get_bound_method() (in module falcon) get_cookie_values() (falcon.asgi.Request method) (falcon.Request method) get_data() (falcon.media.multipart.BodyPart method) get_encoding_from_headers() (in module falcon.testing) get_header() (falcon.asgi.Request method) (falcon.asgi.Response method) (falcon.Request method) (falcon.Response method) get_header_as_datetime() (falcon.asgi.Request method) (falcon.Request method) get_http_status() (in module falcon) get_media() (falcon.asgi.Request method) (falcon.media.multipart.BodyPart method) (falcon.Request method) get_param() (falcon.asgi.Request method) (falcon.Request method) get_param_as_bool() (falcon.asgi.Request method) (falcon.Request method)

get_param_as_date() (falcon.asgi.Request method) (falcon.Request method) get_param_as_datetime() (falcon.asgi.Request method) (falcon.Request method) get_param_as_float() (falcon.asgi.Request method) (falcon.Request method) get_param_as_int() (falcon.asgi.Request method) (falcon.Request method) get_param_as_json() (falcon.asgi.Request method) (falcon.Request method) get_param_as_list() (falcon.asgi.Request method) (falcon.Request method) get_param_as_uuid() (falcon.asgi.Request method) (falcon.Request method) get_running_loop() (in module falcon) get_text() (falcon.media.multipart.BodyPart method) get_unused_port() (in module falcon.testing)

H

Handlers (class in falcon.media) has_param() (falcon.asgi.Request method) (falcon.Request method) headers (falcon.asgi.Request attribute) (falcon.asgi.Response attribute) (falcon.HTTPError attribute) (falcon.HTTPStatus attribute) (falcon.Request attribute) (falcon.Response attribute) (falcon.testing.ASGIResponseEventCollector attribute) (falcon.testing.ASGIWebSocketSimulator attribute) (falcon.testing.Result attribute) (falcon.testing.StartResponseMock attribute) (falcon.testing.StreamedResult attribute) headers_dict (falcon.testing.StartResponseMock attribute) host (falcon.asgi.Request attribute) (falcon.Forwarded attribute) (falcon.Request attribute) http_date_to_dt() (in module falcon) http_now() (in module falcon) http_only (falcon.testing.Cookie attribute) http_status_to_code() (in module falcon) HTTPBadGateway (class in falcon) HTTPBadRequest (class in falcon) HTTPConflict (class in falcon) HTTPError (class in falcon) HTTPFailedDependency (class in falcon) HTTPForbidden (class in falcon) HTTPFound HTTPGatewayTimeout (class in falcon) HTTPGone (class in falcon) HTTPInsufficientStorage (class in falcon)

HTTPInternalServerError (class in falcon) HTTPInvalidHeader (class in falcon) HTTPInvalidParam (class in falcon) HTTPLengthRequired (class in falcon) HTTPLocked (class in falcon) HTTPLoopDetected (class in falcon) HTTPMethodNotAllowed (class in falcon) HTTPMissingHeader (class in falcon) HTTPMissingParam (class in falcon) HTTPMovedPermanently HTTPNetworkAuthenticationRequired (class in falcon) HTTPNotAcceptable (class in falcon) HTTPNotFound (class in falcon) HTTPNotImplemented (class in falcon) HTTPPayloadTooLarge (class in falcon) HTTPPermanentRedirect HTTPPreconditionFailed (class in falcon) HTTPPreconditionRequired (class in falcon) HTTPRangeNotSatisfiable (class in falcon) HTTPRequestHeaderFieldsTooLarge (class in falcon) HTTPRouteNotFound (class in falcon) HTTPSeeOther HTTPServiceUnavailable (class in falcon) HTTPStatus (class in falcon) HTTPTemporaryRedirect HTTPTooManyRequests (class in falcon) HTTPUnauthorized (class in falcon) HTTPUnavailableForLegalReasons (class in falcon) HTTPUnprocessableEntity (class in falcon) HTTPUnsupportedMediaType (class in falcon) HTTPUriTooLong (class in falcon) HTTPVersionNotSupported (class in falcon)

I

if_match (falcon.asgi.Request attribute) (falcon.Request attribute) if_modified_since (falcon.asgi.Request attribute) (falcon.Request attribute) if_none_match (falcon.asgi.Request attribute) (falcon.Request attribute) if_range (falcon.asgi.Request attribute) (falcon.Request attribute) if_unmodified_since (falcon.asgi.Request attribute) (falcon.Request attribute) independent_text (falcon.inspect.MiddlewareInfo attribute) inspect_app() (in module falcon.inspect)

inspect_compiled_router() (in module falcon.inspect) inspect_error_handlers() (in module falcon.inspect) inspect_middleware() (in module falcon.inspect) inspect_routes() (in module falcon.inspect) inspect_sinks() (in module falcon.inspect) inspect_static_routes() (in module falcon.inspect) InspectVisitor (class in falcon.inspect) IntConverter (class in falcon.routing) is_exhausted (falcon.stream.BoundedStream attribute) is_python_func() (in module falcon) is_weak (falcon.ETag attribute) is_websocket (falcon.asgi.Request attribute) isatty() (falcon.asgi.BoundedStream method)

J

json (falcon.asgi.SSEvent attribute) (falcon.testing.Result attribute)

JSONHandler (class in falcon.media) JSONHandlerWS (class in falcon.media)

K

keep_blank_qs_values (falcon.RequestOptions attribute)

L

last_modified (falcon.asgi.Response property) (falcon.Response property) link (falcon.HTTPError attribute) loads() (falcon.ETag class method)

location (falcon.asgi.Response property) (falcon.Response property) log_error() (falcon.asgi.Request method) (falcon.Request method)

M

map_http_methods() (falcon.routing.CompiledRouter method) (in module falcon.routing) max_age (falcon.testing.Cookie attribute) max_body_part_buffer_size (falcon.media.multipart.MultipartParseOptions attribute) max_body_part_count (falcon.media.multipart.MultipartParseOptions attribute) max_body_part_headers_size (falcon.media.multipart.MultipartParseOptions attribute) max_receive_queue (falcon.asgi.WebSocketOptions attribute) media (falcon.asgi.Request attribute) (falcon.asgi.Response attribute) (falcon.media.multipart.BodyPart attribute) (falcon.Request attribute) (falcon.Response attribute) media_handlers (falcon.asgi.WebSocketOptions attribute) (falcon.media.multipart.MultipartParseOptions attribute) (falcon.RequestOptions attribute) (falcon.ResponseOptions attribute)

MediaMalformedError (class in falcon) MediaNotFoundError (class in falcon) MessagePackHandler (class in falcon.media) MessagePackHandlerWS (class in falcon.media) method (falcon.asgi.Request attribute) (falcon.Request attribute) MiddlewareClassInfo (class in falcon.inspect) MiddlewareInfo (class in falcon.inspect) MiddlewareMethodInfo (class in falcon.inspect) MiddlewareTreeInfo (class in falcon.inspect) MiddlewareTreeItemInfo (class in falcon.inspect) module falcon.uri more_body (falcon.testing.ASGIResponseEventCollector attribute) MultipartFormHandler (class in falcon.media) MultipartParseError (class in falcon.media.multipart) MultipartParseOptions (class in falcon.media.multipart)

N

name (falcon.media.multipart.BodyPart attribute) (falcon.testing.Cookie attribute)

netloc (falcon.asgi.Request attribute) (falcon.Request attribute) next() (falcon.stream.BoundedStream method)

O

options (falcon.asgi.Request attribute) (falcon.asgi.Response attribute) (falcon.Request attribute) (falcon.Response attribute)

P

params (falcon.asgi.Request attribute) (falcon.Request attribute) parse_host() (in module falcon.uri) parse_query_string() (in module falcon.uri) path (falcon.asgi.Request attribute) (falcon.Request attribute) (falcon.testing.Cookie attribute)

PayloadTypeError (class in falcon) port (falcon.asgi.Request attribute) (falcon.Request attribute) prefix (falcon.asgi.Request attribute) (falcon.Request attribute) prepare_middleware() (in module falcon.app_helpers) prepare_middleware_ws() (in module falcon.app_helpers) process() (falcon.inspect.InspectVisitor method)

Q

query_string (falcon.asgi.Request attribute) (falcon.Request attribute)

R

rand_string() (in module falcon.testing) range (falcon.asgi.Request attribute) (falcon.Request attribute) range_unit (falcon.asgi.Request attribute) (falcon.Request attribute) read() (falcon.asgi.BoundedStream method) (falcon.stream.BoundedStream method) (falcon.testing.ResultBodyStream method) readable() (falcon.asgi.BoundedStream method) (falcon.stream.BoundedStream method) readall() (falcon.asgi.BoundedStream method) readline() (falcon.stream.BoundedStream method) readlines() (falcon.stream.BoundedStream method) ready (falcon.asgi.WebSocket attribute) (falcon.testing.ASGIWebSocketSimulator attribute) receive_data() (falcon.asgi.WebSocket method) (falcon.testing.ASGIWebSocketSimulator method) receive_json() (falcon.testing.ASGIWebSocketSimulator method) receive_media() (falcon.asgi.WebSocket method) receive_msgpack() (falcon.testing.ASGIWebSocketSimulator method) receive_text() (falcon.asgi.WebSocket method) (falcon.testing.ASGIWebSocketSimulator method) redirected() (in module falcon.testing) referer (falcon.asgi.Request attribute) (falcon.Request attribute) register_router() (in module falcon.inspect) relative_uri (falcon.asgi.Request attribute) (falcon.Request attribute)

remote_addr (falcon.asgi.Request attribute) (falcon.Request attribute) render_body() (falcon.asgi.Response method) (falcon.Response method) req_options (falcon.App attribute) (falcon.asgi.App attribute) Request (class in falcon) (class in falcon.asgi) RequestOptions (class in falcon) resp_options (falcon.App attribute) (falcon.asgi.App attribute) Response (class in falcon) (class in falcon.asgi) ResponseOptions (class in falcon) Result (class in falcon.testing) ResultBodyStream (class in falcon.testing) retry (falcon.asgi.SSEvent attribute) retry_after (falcon.asgi.Response property) (falcon.Response property) root_path (falcon.asgi.Request attribute) (falcon.Request attribute) RouteInfo (class in falcon.inspect) RouteMethodInfo (class in falcon.inspect) router_options (falcon.App attribute) (falcon.asgi.App attribute) runs_sync() (in module falcon)

S

schedule() (falcon.asgi.Response method) schedule_sync() (falcon.asgi.Response method) scheme (falcon.asgi.Request attribute) (falcon.Forwarded attribute) (falcon.Request attribute) scope (falcon.asgi.Request attribute) secure (falcon.testing.Cookie attribute) secure_cookies_by_default (falcon.ResponseOptions attribute) secure_filename (falcon.media.multipart.BodyPart attribute) secure_filename() (in module falcon) seekable() (falcon.asgi.BoundedStream method) (falcon.stream.BoundedStream method) send_data() (falcon.asgi.WebSocket method) (falcon.testing.ASGIWebSocketSimulator method) send_json() (falcon.testing.ASGIWebSocketSimulator method) send_media() (falcon.asgi.WebSocket method) send_msgpack() (falcon.testing.ASGIWebSocketSimulator method) send_text() (falcon.asgi.WebSocket method) (falcon.testing.ASGIWebSocketSimulator method) serialize() (falcon.asgi.SSEvent method) (falcon.media.BaseHandler method) (falcon.media.BinaryBaseHandlerWS method) (falcon.media.TextBaseHandlerWS method) serialize_async() (falcon.media.BaseHandler method) set_cookie() (falcon.asgi.Response method) (falcon.Response method) set_default_responders() (in module falcon.routing) set_error_serializer() (falcon.API method) (falcon.App method) set_header() (falcon.asgi.Response method) (falcon.Response method) set_headers() (falcon.asgi.Response method) (falcon.Response method) set_resp_defaults() (in module falcon.testing) set_resp_defaults_async() (in module falcon.testing) set_stream() (falcon.asgi.Response method) (falcon.Response method) setUp() (falcon.testing.TestCase method) SimpleTestResource (class in falcon.testing) simulate_delete() (falcon.testing.ASGIConductor method) (falcon.testing.TestClient method) (in module falcon.testing) simulate_get() (falcon.testing.ASGIConductor method) (falcon.testing.TestClient method) (in module falcon.testing) simulate_get_stream() (falcon.testing.ASGIConductor method) simulate_head() (falcon.testing.ASGIConductor method) (falcon.testing.TestClient method) (in module falcon.testing)

simulate_options() (falcon.testing.ASGIConductor method) (falcon.testing.TestClient method) (in module falcon.testing) simulate_patch() (falcon.testing.ASGIConductor method) (falcon.testing.TestClient method) (in module falcon.testing) simulate_post() (falcon.testing.ASGIConductor method) (falcon.testing.TestClient method) (in module falcon.testing) simulate_put() (falcon.testing.ASGIConductor method) (falcon.testing.TestClient method) (in module falcon.testing) simulate_request() (falcon.testing.ASGIConductor method) (falcon.testing.TestClient method) (in module falcon.testing) simulate_ws() (falcon.testing.ASGIConductor method) SinkInfo (class in falcon.inspect) src (falcon.Forwarded attribute) sse (falcon.asgi.Response attribute) SSEvent (class in falcon.asgi) StartResponseMock (class in falcon.testing) static_media_types (falcon.ResponseOptions attribute) StaticRouteInfo (class in falcon.inspect) status (falcon.asgi.Response attribute) (falcon.HTTPError attribute) (falcon.HTTPStatus attribute) (falcon.Response attribute) (falcon.testing.ASGIResponseEventCollector attribute) (falcon.testing.Result attribute) (falcon.testing.StartResponseMock attribute) (falcon.testing.StreamedResult attribute) status_code (falcon.testing.Result attribute) (falcon.testing.StreamedResult attribute) stream (falcon.asgi.Request attribute) (falcon.asgi.Response attribute) (falcon.media.multipart.BodyPart attribute) (falcon.Request attribute) (falcon.Response attribute) (falcon.testing.StreamedResult attribute) StreamedResult (class in falcon.testing) StringVisitor (class in falcon.inspect) strip_url_path_trailing_slash (falcon.RequestOptions attribute) strong_compare() (falcon.ETag method) subdomain (falcon.asgi.Request attribute) (falcon.Request attribute) subprotocol (falcon.testing.ASGIWebSocketSimulator attribute) subprotocols (falcon.asgi.WebSocket attribute) suffix (falcon.inspect.RouteMethodInfo attribute) supports_accept_headers (falcon.asgi.WebSocket attribute) sync_to_async() (in module falcon)

T

tell() (falcon.asgi.BoundedStream method) TestCase (class in falcon.testing) TestClient (class in falcon.testing) text (falcon.asgi.Response attribute) (falcon.asgi.SSEvent attribute) (falcon.HTTPStatus attribute) (falcon.media.multipart.BodyPart attribute) (falcon.Response attribute) (falcon.testing.Result attribute)

TextBaseHandlerWS (class in falcon.media) TimezoneGMT (class in falcon) title (falcon.HTTPError attribute) to_dict() (falcon.HTTPError method) to_json() (falcon.HTTPError method) to_query_str() (in module falcon) to_string() (falcon.inspect.AppInfo method) to_xml() (falcon.HTTPError method) tzname() (falcon.TimezoneGMT method)

U

unaccepted (falcon.asgi.WebSocket attribute) unquote_string() (in module falcon.uri) unset_cookie() (falcon.asgi.Response method) (falcon.Response method) uri (falcon.asgi.Request attribute) (falcon.Request attribute) uri_template (falcon.asgi.Request attribute) (falcon.Request attribute)

url (falcon.asgi.Request attribute) (falcon.Request attribute) URLEncodedFormHandler (class in falcon.media) user_agent (falcon.asgi.Request attribute) (falcon.Request attribute) utcoffset() (falcon.TimezoneGMT method) UUIDConverter (class in falcon.routing)

V

validate() (in module falcon.media.validators.jsonschema) value (falcon.testing.Cookie attribute)

vary (falcon.asgi.Response property) (falcon.Response property)

W

wait_ready() (falcon.testing.ASGIWebSocketSimulator method) WebSocket (class in falcon.asgi) WebSocketDisconnected (class in falcon) WebSocketHandlerNotFound (class in falcon) WebSocketOptions (class in falcon.asgi) WebSocketPathNotFound (class in falcon)

WebSocketServerError (class in falcon) wrap_sync_to_async() (in module falcon) wrap_sync_to_async_unsafe() (in module falcon) writable() (falcon.asgi.BoundedStream method) (falcon.stream.BoundedStream method) write() (falcon.stream.BoundedStream method) ws_options (falcon.asgi.App attribute)