quart package

Subpackages

• quart.flask_patch package
  • Submodules
    • quart.flask_patch.app module
      • Quart
    • quart.flask_patch.cli module
    • quart.flask_patch.globals module
    • quart.flask_patch.testing module
      • FlaskClient
  • Module contents
    • Blueprint
      • Blueprint.url_prefix
      • Blueprint.add_app_template_filter()
      • Blueprint.add_app_template_global()
      • Blueprint.add_app_template_test()
      • Blueprint.add_url_rule()
      • Blueprint.after_app_request()
      • Blueprint.after_app_serving()
      • Blueprint.after_app_websocket()
      • Blueprint.after_request_funcs
      • Blueprint.after_websocket_funcs
      • Blueprint.app_context_processor()
      • Blueprint.app_errorhandler()
      • Blueprint.app_template_filter()
      • Blueprint.app_template_global()
      • Blueprint.app_template_test()
      • Blueprint.app_url_defaults()
      • Blueprint.app_url_value_preprocessor()
      • Blueprint.before_app_first_request()
      • Blueprint.before_app_request()
      • Blueprint.before_app_serving()
      • Blueprint.before_app_websocket()
      • Blueprint.before_request_funcs
      • Blueprint.before_websocket_funcs
      • Blueprint.deferred_functions
      • Blueprint.error_handler_spec
      • Blueprint.make_setup_state()
      • Blueprint.name
      • Blueprint.record()
      • Blueprint.record_once()
      • Blueprint.register()
      • Blueprint.register_blueprint()
      • Blueprint.teardown_app_request()
      • Blueprint.teardown_app_websocket()
      • Blueprint.teardown_request_funcs
      • Blueprint.teardown_websocket_funcs
      • Blueprint.template_context_processors
      • Blueprint.url_default_functions
      • Blueprint.url_value_preprocessors
      • Blueprint.view_functions
      • Blueprint.warn_on_modifications
      • Blueprint.while_app_serving()
    • Config
      • Config.from_envvar()
      • Config.from_file()
      • Config.from_mapping()
      • Config.from_object()
      • Config.from_prefixed_env()
      • Config.from_pyfile()
      • Config.get_namespace()
    • Flask
    • Markup
      • Markup.capitalize()
      • Markup.casefold()
      • Markup.center()
      • Markup.escape()
      • Markup.expandtabs()
      • Markup.format()
      • Markup.format_map()
      • Markup.join()
      • Markup.ljust()
      • Markup.lower()
      • Markup.lstrip()
      • Markup.partition()
      • Markup.removeprefix()
      • Markup.removesuffix()
      • Markup.replace()
      • Markup.rjust()
      • Markup.rpartition()
      • Markup.rsplit()
      • Markup.rstrip()
      • Markup.split()
      • Markup.splitlines()
      • Markup.strip()
      • Markup.striptags()
      • Markup.swapcase()
      • Markup.title()
      • Markup.translate()
      • Markup.unescape()
      • Markup.upper()
      • Markup.zfill()
    • Request
      • Request.body_class
      • Request.form_data_parser_class
      • Request.body_class
      • Request.data
      • Request.files
      • Request.form
      • Request.form_data_parser_class
      • Request.get_data()
      • Request.get_json()
      • Request.json
      • Request.lock_class
      • Request.make_form_data_parser()
      • Request.on_json_loading_failed()
      • Request.send_push_promise()
      • Request.stream
      • Request.values
    • Response
      • Response.automatically_set_content_length
      • Response.default_status
      • Response.default_mimetype
      • Response.implicit_sequence_conversion
      • Response.add_etag()
      • Response.automatically_set_content_length
      • Response.data
      • Response.data_body_class
      • Response.default_mimetype
      • Response.file_body_class
      • Response.freeze()
      • Response.get_data()
      • Response.get_json()
      • Response.implicit_sequence_conversion
      • Response.io_body_class
      • Response.iter_encode()
      • Response.iterable_body_class
      • Response.json
      • Response.json_module
      • Response.make_conditional()
      • Response.make_sequence()
      • Response.max_cookie_size
      • Response.set_data()
    • abort()
    • after_this_request()
    • copy_current_request_context()
    • escape()
    • flash()
    • get_flashed_messages()
    • get_template_attribute()
    • has_app_context()
    • has_request_context()
    • jsonify()
    • make_response()
    • redirect()
    • render_template()
    • render_template_string()
    • send_file()
    • send_from_directory()
    • stream_with_context()
    • url_for()
• quart.json package
  • Submodules
    • quart.json.provider module
      • DefaultJSONProvider
      • JSONProvider
    • quart.json.tag module
      • JSONTag
      • PassDict
      • PassList
      • TagBytes
      • TagDateTime
      • TagDict
      • TagMarkup
      • TagTuple
      • TagUUID
      • TaggedJSONSerializer
  • Module contents
    • dump()
    • dumps()
    • jsonify()
    • load()
    • loads()
• quart.testing package
  • Submodules
    • quart.testing.app module
      • LifespanError
      • TestApp
    • quart.testing.client module
      • QuartClient
    • quart.testing.connections module
      • HTTPDisconnectError
      • TestHTTPConnection
      • TestWebsocketConnection
      • WebsocketDisconnectError
      • WebsocketResponseError
    • quart.testing.utils module
      • make_test_body_with_headers()
      • make_test_headers_path_and_query_string()
      • make_test_scope()
      • no_op_push()
  • Module contents
    • QuartCliRunner
      • QuartCliRunner.invoke()
    • QuartClient
      • QuartClient.delete()
      • QuartClient.delete_cookie()
      • QuartClient.get()
      • QuartClient.head()
      • QuartClient.http_connection_class
      • QuartClient.open()
      • QuartClient.options()
      • QuartClient.patch()
      • QuartClient.post()
      • QuartClient.put()
      • QuartClient.request()
      • QuartClient.session_transaction()
      • QuartClient.set_cookie()
      • QuartClient.trace()
      • QuartClient.websocket()
      • QuartClient.websocket_connection_class
    • TestApp
      • TestApp.shutdown()
      • TestApp.startup()
      • TestApp.test_client()
    • WebsocketResponseError
    • make_test_body_with_headers()
    • make_test_headers_path_and_query_string()
    • make_test_scope()
    • no_op_push()
• quart.wrappers package
  • Submodules
    • quart.wrappers.base module
      • BaseRequestWebsocket
    • quart.wrappers.request module
      • Body
      • Request
    • quart.wrappers.response module
      • DataBody
      • FileBody
      • IOBody
      • IterableBody
      • Response
      • ResponseBody
    • quart.wrappers.websocket module
      • Websocket
  • Module contents
    • BaseRequestWebsocket
      • BaseRequestWebsocket.json_module
      • BaseRequestWebsocket.routing_exception
      • BaseRequestWebsocket.url_rule
      • BaseRequestWebsocket.view_args
      • BaseRequestWebsocket.blueprint
      • BaseRequestWebsocket.blueprints
      • BaseRequestWebsocket.endpoint
      • BaseRequestWebsocket.json_module
      • BaseRequestWebsocket.max_content_length
      • BaseRequestWebsocket.routing_exception
      • BaseRequestWebsocket.script_root
      • BaseRequestWebsocket.url_root
      • BaseRequestWebsocket.url_rule
      • BaseRequestWebsocket.view_args
    • Body
      • Body.append()
      • Body.clear()
      • Body.set_complete()
      • Body.set_result()
    • Request
      • Request.body_class
      • Request.form_data_parser_class
      • Request.body_class
      • Request.data
      • Request.files
      • Request.form
      • Request.form_data_parser_class
      • Request.get_data()
      • Request.get_json()
      • Request.json
      • Request.lock_class
      • Request.make_form_data_parser()
      • Request.on_json_loading_failed()
      • Request.send_push_promise()
      • Request.stream
      • Request.values
    • Response
      • Response.automatically_set_content_length
      • Response.default_status
      • Response.default_mimetype
      • Response.implicit_sequence_conversion
      • Response.add_etag()
      • Response.automatically_set_content_length
      • Response.data
      • Response.data_body_class
      • Response.default_mimetype
      • Response.file_body_class
      • Response.freeze()
      • Response.get_data()
      • Response.get_json()
      • Response.headers
      • Response.implicit_sequence_conversion
      • Response.io_body_class
      • Response.iter_encode()
      • Response.iterable_body_class
      • Response.json
      • Response.json_module
      • Response.make_conditional()
      • Response.make_sequence()
      • Response.max_cookie_size
      • Response.response
      • Response.set_data()
      • Response.timeout
    • Websocket
      • Websocket.accept()
      • Websocket.close()
      • Websocket.receive()
      • Websocket.receive_json()
      • Websocket.requested_subprotocols
      • Websocket.send()
      • Websocket.send_json()

Submodules

• quart.app module
  • Quart
    • Quart.aborter_class
    • Quart.app_ctx_globals_class
    • Quart.asgi_http_class
    • Quart.asgi_lifespan_class
    • Quart.asgi_websocket_class
    • Quart.config_class
    • Quart.env
    • Quart.debug
    • Quart.jinja_environment
    • Quart.jinja_options
    • Quart.permanent_session_lifetime
    • Quart.request_class
    • Quart.response_class
    • Quart.secret_key
    • Quart.session_cookie_name
    • Quart.session_interface
    • Quart.url_map_class
    • Quart.url_rule_class
    • Quart.websocket_class
    • Quart.aborter_class
    • Quart.add_background_task()
    • Quart.add_template_filter()
    • Quart.add_template_global()
    • Quart.add_template_test()
    • Quart.add_url_rule()
    • Quart.after_serving()
    • Quart.app_context()
    • Quart.app_ctx_globals_class
    • Quart.asgi_app()
    • Quart.asgi_http_class
    • Quart.asgi_lifespan_class
    • Quart.asgi_websocket_class
    • Quart.auto_find_instance_path()
    • Quart.before_first_request()
    • Quart.before_serving()
    • Quart.config_class
    • Quart.create_global_jinja_loader()
    • Quart.create_jinja_environment()
    • Quart.create_url_adapter()
    • Quart.debug
    • Quart.dispatch_request()
    • Quart.dispatch_websocket()
    • Quart.do_teardown_appcontext()
    • Quart.do_teardown_request()
    • Quart.do_teardown_websocket()
    • Quart.ensure_async()
    • Quart.env
    • Quart.finalize_request()
    • Quart.finalize_websocket()
    • Quart.full_dispatch_request()
    • Quart.full_dispatch_websocket()
    • Quart.got_first_request
    • Quart.handle_background_exception()
    • Quart.handle_exception()
    • Quart.handle_http_exception()
    • Quart.handle_request()
    • Quart.handle_url_build_error()
    • Quart.handle_user_exception()
    • Quart.handle_websocket()
    • Quart.handle_websocket_exception()
    • Quart.inject_url_defaults()
    • Quart.iter_blueprints()
    • Quart.jinja_env
    • Quart.jinja_environment
    • Quart.jinja_options
    • Quart.json_provider_class
    • Quart.lock_class
    • Quart.log_exception()
    • Quart.logger
    • Quart.make_aborter()
    • Quart.make_config()
    • Quart.make_default_options_response()
    • Quart.make_response()
    • Quart.make_shell_context()
    • Quart.name
    • Quart.open_instance_resource()
    • Quart.permanent_session_lifetime
    • Quart.postprocess_websocket()
    • Quart.preprocess_request()
    • Quart.preprocess_websocket()
    • Quart.preserve_context_on_exception
    • Quart.process_response()
    • Quart.propagate_exceptions
    • Quart.raise_routing_exception()
    • Quart.redirect()
    • Quart.register_blueprint()
    • Quart.request_class
    • Quart.request_context()
    • Quart.response_class
    • Quart.run()
    • Quart.run_task()
    • Quart.secret_key
    • Quart.select_jinja_autoescape()
    • Quart.send_file_max_age_default
    • Quart.session_cookie_name
    • Quart.session_interface
    • Quart.shell_context_processor()
    • Quart.shutdown()
    • Quart.startup()
    • Quart.sync_to_async()
    • Quart.teardown_appcontext()
    • Quart.template_filter()
    • Quart.template_global()
    • Quart.template_test()
    • Quart.templates_auto_reload
    • Quart.test_app()
    • Quart.test_app_class
    • Quart.test_cli_runner()
    • Quart.test_cli_runner_class
    • Quart.test_client()
    • Quart.test_client_class
    • Quart.test_request_context()
    • Quart.testing
    • Quart.trap_http_exception()
    • Quart.try_trigger_before_first_request_functions()
    • Quart.update_template_context()
    • Quart.url_for()
    • Quart.url_map_class
    • Quart.url_rule_class
    • Quart.websocket_class
    • Quart.websocket_context()
    • Quart.while_serving()
• quart.asgi module
  • ASGIHTTPConnection
    • ASGIHTTPConnection.handle_messages()
    • ASGIHTTPConnection.handle_request()
  • ASGILifespan
  • ASGIWebsocketConnection
    • ASGIWebsocketConnection.accept_connection()
    • ASGIWebsocketConnection.close_connection()
    • ASGIWebsocketConnection.handle_messages()
    • ASGIWebsocketConnection.handle_websocket()
    • ASGIWebsocketConnection.send_data()
• quart.blueprints module
  • Blueprint
    • Blueprint.url_prefix
    • Blueprint.add_app_template_filter()
    • Blueprint.add_app_template_global()
    • Blueprint.add_app_template_test()
    • Blueprint.add_url_rule()
    • Blueprint.after_app_request()
    • Blueprint.after_app_serving()
    • Blueprint.after_app_websocket()
    • Blueprint.app_context_processor()
    • Blueprint.app_errorhandler()
    • Blueprint.app_template_filter()
    • Blueprint.app_template_global()
    • Blueprint.app_template_test()
    • Blueprint.app_url_defaults()
    • Blueprint.app_url_value_preprocessor()
    • Blueprint.before_app_first_request()
    • Blueprint.before_app_request()
    • Blueprint.before_app_serving()
    • Blueprint.before_app_websocket()
    • Blueprint.make_setup_state()
    • Blueprint.record()
    • Blueprint.record_once()
    • Blueprint.register()
    • Blueprint.register_blueprint()
    • Blueprint.teardown_app_request()
    • Blueprint.teardown_app_websocket()
    • Blueprint.warn_on_modifications
    • Blueprint.while_app_serving()
  • BlueprintSetupState
    • BlueprintSetupState.first_registration
    • BlueprintSetupState.add_url_rule()
    • BlueprintSetupState.register_template_filter()
    • BlueprintSetupState.register_template_global()
    • BlueprintSetupState.register_template_test()
• quart.cli module
  • AppGroup
    • AppGroup.command()
    • AppGroup.group()
  • NoAppException
  • QuartGroup
    • QuartGroup.get_command()
    • QuartGroup.list_commands()
    • QuartGroup.make_context()
    • QuartGroup.parse_args()
  • ScriptInfo
    • ScriptInfo.load_app()
  • find_app_by_string()
  • find_best_app()
  • get_version()
  • load_dotenv()
  • locate_app()
  • main()
  • prepare_import()
  • with_appcontext()
• quart.config module
  • Config
    • Config.from_envvar()
    • Config.from_file()
    • Config.from_mapping()
    • Config.from_object()
    • Config.from_prefixed_env()
    • Config.from_pyfile()
    • Config.get_namespace()
  • ConfigAttribute
• quart.ctx module
  • AppContext
    • AppContext.app
    • AppContext.url_adapter
    • AppContext.g
    • AppContext.copy()
    • AppContext.pop()
    • AppContext.push()
  • RequestContext
    • RequestContext._after_request_functions
    • RequestContext.pop()
    • RequestContext.push()
    • RequestContext.request
  • WebsocketContext
    • WebsocketContext._after_websocket_functions
    • WebsocketContext.pop()
    • WebsocketContext.push()
    • WebsocketContext.websocket
  • after_this_request()
  • after_this_websocket()
  • copy_current_app_context()
  • copy_current_request_context()
  • copy_current_websocket_context()
  • has_app_context()
  • has_request_context()
  • has_websocket_context()
• quart.debug module
  • traceback_response()
• quart.formparser module
  • FormDataParser
    • FormDataParser.file_storage_class
    • FormDataParser.get_parse_func()
    • FormDataParser.parse()
    • FormDataParser.parse_functions
  • MultiPartParser
    • MultiPartParser.fail()
    • MultiPartParser.get_part_charset()
    • MultiPartParser.parse()
    • MultiPartParser.start_file_streaming()
• quart.globals module
• quart.helpers module
  • abort()
  • find_package()
  • flash()
  • get_debug_flag()
  • get_env()
  • get_flashed_messages()
  • get_load_dotenv()
  • get_root_path()
  • get_template_attribute()
  • make_push_promise()
  • make_response()
  • redirect()
  • send_file()
  • send_from_directory()
  • stream_with_context()
  • url_for()
• quart.logging module
  • LocalQueueHandler
    • LocalQueueHandler.prepare()
  • create_logger()
  • has_level_handler()
• quart.routing module
  • QuartMap
    • QuartMap.bind_to_request()
  • QuartRule
• quart.scaffold module
  • Scaffold
    • Scaffold.add_url_rule()
    • Scaffold.add_websocket()
    • Scaffold.after_request()
    • Scaffold.after_websocket()
    • Scaffold.before_request()
    • Scaffold.before_websocket()
    • Scaffold.context_processor()
    • Scaffold.delete()
    • Scaffold.endpoint()
    • Scaffold.errorhandler()
    • Scaffold.get()
    • Scaffold.get_send_file_max_age()
    • Scaffold.has_static_folder
    • Scaffold.jinja_loader
    • Scaffold.name
    • Scaffold.open_resource()
    • Scaffold.patch()
    • Scaffold.post()
    • Scaffold.put()
    • Scaffold.register_error_handler()
    • Scaffold.route()
    • Scaffold.send_static_file()
    • Scaffold.static_folder
    • Scaffold.static_url_path
    • Scaffold.teardown_request()
    • Scaffold.teardown_websocket()
    • Scaffold.url_defaults()
    • Scaffold.url_value_preprocessor()
    • Scaffold.websocket()
  • setupmethod()
• quart.sessions module
  • NullSession
    • NullSession.clear()
    • NullSession.pop()
    • NullSession.popitem()
    • NullSession.setdefault()
    • NullSession.update()
  • SecureCookieSession
    • SecureCookieSession.clear()
    • SecureCookieSession.get()
    • SecureCookieSession.pop()
    • SecureCookieSession.popitem()
    • SecureCookieSession.setdefault()
    • SecureCookieSession.update()
  • SecureCookieSessionInterface
    • SecureCookieSessionInterface.digest_method()
    • SecureCookieSessionInterface.get_signing_serializer()
    • SecureCookieSessionInterface.key_derivation
    • SecureCookieSessionInterface.open_session()
    • SecureCookieSessionInterface.salt
    • SecureCookieSessionInterface.save_session()
    • SecureCookieSessionInterface.serializer
    • SecureCookieSessionInterface.session_class
  • SessionInterface
    • SessionInterface.null_session_class
    • SessionInterface.pickle_based
    • SessionInterface.get_cookie_domain()
    • SessionInterface.get_cookie_httponly()
    • SessionInterface.get_cookie_name()
    • SessionInterface.get_cookie_path()
    • SessionInterface.get_cookie_samesite()
    • SessionInterface.get_cookie_secure()
    • SessionInterface.get_expiration_time()
    • SessionInterface.is_null_session()
    • SessionInterface.make_null_session()
    • SessionInterface.null_session_class
    • SessionInterface.open_session()
    • SessionInterface.pickle_based
    • SessionInterface.save_session()
    • SessionInterface.should_set_cookie()
  • SessionMixin
    • SessionMixin.accessed
    • SessionMixin.modified
    • SessionMixin.new
    • SessionMixin.accessed
    • SessionMixin.modified
    • SessionMixin.new
    • SessionMixin.permanent
• quart.signals module
  • AsyncNamedSignal
    • AsyncNamedSignal.connect()
    • AsyncNamedSignal.send()
  • AsyncNamespace
    • AsyncNamespace.signal()
• quart.templating module
  • DispatchingJinjaLoader
    • DispatchingJinjaLoader.get_source()
    • DispatchingJinjaLoader.list_templates()
  • Environment
  • render_template()
  • render_template_string()
  • stream_template()
  • stream_template_string()
• quart.typing module
  • ASGIHTTPProtocol
  • ASGILifespanProtocol
  • ASGIWebsocketProtocol
  • Event
    • Event.is_set()
  • TestAppProtocol
    • TestAppProtocol.shutdown()
    • TestAppProtocol.startup()
    • TestAppProtocol.test_client()
  • TestClientProtocol
    • TestClientProtocol.app
    • TestClientProtocol.cookie_jar
    • TestClientProtocol.delete()
    • TestClientProtocol.delete_cookie()
    • TestClientProtocol.get()
    • TestClientProtocol.head()
    • TestClientProtocol.http_connection_class
    • TestClientProtocol.open()
    • TestClientProtocol.options()
    • TestClientProtocol.patch()
    • TestClientProtocol.post()
    • TestClientProtocol.push_promises
    • TestClientProtocol.put()
    • TestClientProtocol.request()
    • TestClientProtocol.session_transaction()
    • TestClientProtocol.set_cookie()
    • TestClientProtocol.trace()
    • TestClientProtocol.websocket()
    • TestClientProtocol.websocket_connection_class
  • TestHTTPConnectionProtocol
    • TestHTTPConnectionProtocol.as_response()
    • TestHTTPConnectionProtocol.disconnect()
    • TestHTTPConnectionProtocol.push_promises
    • TestHTTPConnectionProtocol.receive()
    • TestHTTPConnectionProtocol.send()
    • TestHTTPConnectionProtocol.send_complete()
  • TestWebsocketConnectionProtocol
    • TestWebsocketConnectionProtocol.close()
    • TestWebsocketConnectionProtocol.disconnect()
    • TestWebsocketConnectionProtocol.receive()
    • TestWebsocketConnectionProtocol.receive_json()
    • TestWebsocketConnectionProtocol.send()
    • TestWebsocketConnectionProtocol.send_json()
• quart.utils module
  • MustReloadError
  • decode_headers()
  • encode_headers()
  • file_path_to_path()
  • is_coroutine_function()
  • observe_changes()
  • restart()
  • run_sync()
  • run_sync_iterable()
• quart.views module
  • MethodView
    • MethodView.dispatch_request()
  • View
    • View.decorators
    • View.methods
    • View.provide_automatic_options
    • View.init_every_request
    • View.as_view()
    • View.decorators
    • View.dispatch_request()
    • View.init_every_request
    • View.methods
    • View.provide_automatic_options

Module contents