Table of Contents

Other
- API Levels
- Application Deployment
- Application Dispatcher
- Application Profiler
- Basic HTTP Proxy
- BSD-3-Clause License
- CGI
- Context Locals
- Data Structures
- Dealing with Request Data
- Debugging Applications
- FastCGI
- HTTP Exceptions
- HTTP Proxying
- HTTP Utilities
- Important Terms
- Installation
- Middleware
- mod_wsgi (Apache)
- Quickstart
- Request / Response Objects
- Serve Shared Static Files
- Serving WSGI Applications
- Testing WSGI Applications
- Unicode
- URL Helpers
- URL Routing
- Utilities
- Werkzeug Tutorial
- WSGI Helpers
- WSGI Protocol Linter
- X-Forwarded-For Proxy Fix
werkzeug.datastructures
- Accept
- Accept.best_match()
- Accept.find()
- Accept.index()
- Accept.quality()
- Accept.to_header()
- Accept.values()
- Authorization
- Authorization.to_header()
- CharsetAccept
- CombinedMultiDict
- ContentRange
- ContentRange.set()
- ContentRange.unset()
- EnvironHeaders
- ETags
- ETags.as_set()
- ETags.contains()
- ETags.contains_raw()
- ETags.contains_weak()
- ETags.is_strong()
- ETags.is_weak()
- ETags.to_header()
- FileMultiDict
- FileMultiDict.add_file()
- FileStorage
- FileStorage.close()
- FileStorage.filename
- FileStorage.headers
- FileStorage.name
- FileStorage.save()
- FileStorage.stream
- Headers
- Headers.add()
- Headers.add_header()
- Headers.clear()
- Headers.extend()
- Headers.get()
- Headers.get_all()
- Headers.getlist()
- Headers.pop()
- Headers.popitem()
- Headers.remove()
- Headers.set()
- Headers.setdefault()
- Headers.setlist()
- Headers.setlistdefault()
- Headers.to_wsgi_list()
- Headers.update()
- HeaderSet
- HeaderSet.add()
- HeaderSet.as_set()
- HeaderSet.clear()
- HeaderSet.discard()
- HeaderSet.find()
- HeaderSet.index()
- HeaderSet.remove()
- HeaderSet.to_header()
- HeaderSet.update()
- IfRange
- IfRange.date
- IfRange.etag
- IfRange.to_header()
- ImmutableDict
- ImmutableDict.copy()
- ImmutableList
- ImmutableMultiDict
- ImmutableMultiDict.copy()
- ImmutableOrderedMultiDict
- ImmutableOrderedMultiDict.copy()
- ImmutableTypeConversionDict
- ImmutableTypeConversionDict.copy()
- LanguageAccept
- MIMEAccept
- MultiDict
- MultiDict.add()
- MultiDict.clear()
- MultiDict.copy()
- MultiDict.deepcopy()
- MultiDict.fromkeys()
- MultiDict.get()
- MultiDict.getlist()
- MultiDict.items()
- MultiDict.keys()
- MultiDict.lists()
- MultiDict.listvalues()
- MultiDict.pop()
- MultiDict.popitem()
- MultiDict.popitemlist()
- MultiDict.poplist()
- MultiDict.setdefault()
- MultiDict.setlist()
- MultiDict.setlistdefault()
- MultiDict.to_dict()
- MultiDict.update()
- MultiDict.values()
- OrderedMultiDict
- Range
- Range.make_content_range()
- Range.range_for_length()
- Range.ranges
- Range.to_content_range_header()
- Range.to_header()
- Range.units
- RequestCacheControl
- RequestCacheControl.max_age
- RequestCacheControl.no_cache
- RequestCacheControl.no_store
- RequestCacheControl.no_transform
- ResponseCacheControl
- ResponseCacheControl.max_age
- ResponseCacheControl.no_cache
- ResponseCacheControl.no_store
- ResponseCacheControl.no_transform
- TypeConversionDict
- TypeConversionDict.get()
- WWWAuthenticate
- WWWAuthenticate.auth_property()
- WWWAuthenticate.set_basic()
- WWWAuthenticate.set_digest()
- WWWAuthenticate.to_header()
werkzeug.debug
- DebuggedApplication
werkzeug.exceptions
- abort()
- Aborter
- HTTPException.__call__()
- HTTPException.get_response()
- InternalServerError.original_exception
werkzeug.formparser
- FormDataParser
- parse_form_data()
werkzeug.http
- dump_cookie()
- dump_header()
- generate_etag()
- http_date()
- is_byte_range_valid()
- is_entity_header()
- is_hop_by_hop_header()
- is_resource_modified()
- parse_accept_header()
- parse_authorization_header()
- parse_cache_control_header()
- parse_content_range_header()
- parse_cookie()
- parse_date()
- parse_dict_header()
- parse_etags()
- parse_if_range_header()
- parse_list_header()
- parse_options_header()
- parse_range_header()
- parse_set_header()
- parse_www_authenticate_header()
- quote_etag()
- quote_header_value()
- remove_entity_headers()
- remove_hop_by_hop_headers()
- unquote_etag()
- unquote_header_value()
werkzeug.local
- LocalManager
- LocalManager.cleanup()
- LocalManager.make_middleware()
- LocalManager.middleware()
- LocalProxy
- LocalProxy._get_current_object()
- LocalStack
- LocalStack.pop()
- LocalStack.push()
- release_local()
werkzeug.middleware.dispatcher
- DispatcherMiddleware
werkzeug.middleware.http_proxy
- ProxyMiddleware
werkzeug.middleware.lint
- LintMiddleware
werkzeug.middleware.profiler
- ProfilerMiddleware
werkzeug.middleware.proxy_fix
- ProxyFix
werkzeug.middleware.shared_data
- SharedDataMiddleware
- SharedDataMiddleware.is_allowed()
werkzeug.routing
- AnyConverter
- EndpointPrefix
- FloatConverter
- IntegerConverter
- Map
- Map.add()
- Map.bind()
- Map.bind_to_environ()
- Map.converters
- Map.default_converters
- Map.is_endpoint_expecting()
- Map.iter_rules()
- Map.lock_class()
- Map.update()
- MapAdapter
- MapAdapter.allowed_methods()
- MapAdapter.build()
- MapAdapter.dispatch()
- MapAdapter.get_host()
- MapAdapter.make_alias_redirect_url()
- MapAdapter.match()
- MapAdapter.test()
- PathConverter
- Rule
- Rule.empty()
- RuleFactory
- RuleFactory.get_rules()
- RuleTemplate
- Subdomain
- Submount
- UnicodeConverter
- UUIDConverter
werkzeug.security
- check_password_hash()
- generate_password_hash()
- safe_join()
werkzeug.serving
- is_running_from_reloader()
- make_ssl_devcert()
- run_simple()
werkzeug.test
- Client
- Client.delete()
- Client.delete_cookie()
- Client.get()
- Client.head()
- Client.open()
- Client.options()
- Client.patch()
- Client.post()
- Client.put()
- Client.set_cookie()
- Client.trace()
- create_environ()
- EnvironBuilder
- EnvironBuilder.close()
- EnvironBuilder.from_environ()
- EnvironBuilder.get_environ()
- EnvironBuilder.get_request()
- EnvironBuilder.json_dumps()
- EnvironBuilder.request_class
- EnvironBuilder.server_protocol
- EnvironBuilder.wsgi_version
- run_wsgi_app()
- TestResponse
- TestResponse.history
- TestResponse.request
werkzeug.testapp
- test_app()
werkzeug.urls
- BaseURL
- BaseURL.decode_netloc()
- BaseURL.decode_query()
- BaseURL.encode_netloc()
- BaseURL.get_file_location()
- BaseURL.join()
- BaseURL.replace()
- BaseURL.to_iri_tuple()
- BaseURL.to_uri_tuple()
- BaseURL.to_url()
- BytesURL
- BytesURL.decode()
- BytesURL.encode_netloc()
- iri_to_uri()
- uri_to_iri()
- URL
- URL.encode()
- url_decode()
- url_decode_stream()
- url_encode()
- url_encode_stream()
- url_fix()
- url_join()
- url_parse()
- url_quote()
- url_quote_plus()
- url_unparse()
- url_unquote()
- url_unquote_plus()
werkzeug.user_agent
- UserAgent
- UserAgent.browser
- UserAgent.language
- UserAgent.platform
- UserAgent.string
- UserAgent.to_header()
- UserAgent.version
werkzeug.utils
- append_slash_redirect()
- cached_property
- environ_property
- find_modules()
- header_property
- import_string()
- redirect()
- secure_filename()
- send_file()
werkzeug.wrappers
- Request
- Request._get_file_stream()
- Request.access_control_request_headers
- Request.access_control_request_method
- Request.application()
- Request.close()
- Request.content_encoding
- Request.content_md5
- Request.content_type
- Request.date
- Request.dict_storage_class
- Request.environ
- Request.form_data_parser_class
- Request.from_values()
- Request.get_data()
- Request.get_json()
- Request.headers
- Request.input_stream
- Request.is_multiprocess
- Request.is_multithread
- Request.is_run_once
- Request.json_module
- Request.list_storage_class
- Request.make_form_data_parser()
- Request.max_content_length
- Request.max_form_memory_size
- Request.max_forwards
- Request.method
- Request.on_json_loading_failed()
- Request.origin
- Request.parameter_storage_class
- Request.path
- Request.query_string
- Request.referrer
- Request.remote_addr
- Request.remote_user
- Request.root_path
- Request.scheme
- Request.server
- Request.shallow
- Request.user_agent_class
- Response
- Response.__call__()
- Response._ensure_sequence()
- Response.accept_ranges
- Response.access_control_allow_headers
- Response.access_control_allow_methods
- Response.access_control_allow_origin
- Response.access_control_expose_headers
- Response.access_control_max_age
- Response.add_etag()
- Response.age
- Response.autocorrect_location_header
- Response.automatically_set_content_length
- Response.calculate_content_length()
- Response.call_on_close()
- Response.close()
- Response.content_encoding
- Response.content_length
- Response.content_location
- Response.content_md5
- Response.content_type
- Response.cross_origin_embedder_policy
- Response.cross_origin_opener_policy
- Response.date
- Response.delete_cookie()
- Response.direct_passthrough
- Response.expires
- Response.force_type()
- Response.freeze()
- Response.from_app()
- Response.get_app_iter()
- Response.get_data()
- Response.get_etag()
- Response.get_json()
- Response.get_wsgi_headers()
- Response.get_wsgi_response()
- Response.implicit_sequence_conversion
- Response.iter_encoded()
- Response.json_module
- Response.last_modified
- Response.location
- Response.make_conditional()
- Response.make_sequence()
- Response.response
- Response.set_cookie()
- Response.set_data()
- Response.set_etag()
werkzeug.wsgi
- ClosingIterator
- extract_path_info()
- FileWrapper
- get_content_length()
- get_current_url()
- get_host()
- get_input_stream()
- get_path_info()
- get_query_string()
- get_script_name()
- host_is_trusted()
- LimitedStream
- LimitedStream.exhaust()
- LimitedStream.on_disconnect()
- LimitedStream.on_exhausted()
- LimitedStream.read()
- LimitedStream.readable()
- LimitedStream.readline()
- LimitedStream.readlines()
- LimitedStream.tell()
- make_chunk_iter()
- make_line_iter()
- peek_path_info()
- pop_path_info()
- responder()
- wrap_file()

Quickstart

This part of the documentation shows how to use the most important parts of Werkzeug. It’s intended as a starting point for developers with basic understanding of PEP 3333 (WSGI) and RFC 2616 (HTTP).

© 2007–2022 Pallets
Licensed under the BSD 3-clause License.
https://werkzeug.palletsprojects.com/en/2.1.x/quickstart/