Table of Contents

Additional Information
- Dealing with Request Data
- Important Terms
- Unicode
Contributed Modules
- Atom Syndication
- Cache
- Contributed Modules
- Extra Wrappers
- Fixers
- Iter IO
- Lint Validation Middleware
- Request / Response Objects
- Secure Cookie
- Sessions
- WSGI Application Profiler
Deployment
- Application Deployment
- CGI
- FastCGI
- HTTP Proxying
- mod_wsgi (Apache)
Getting Started
- API Levels
- Installation
- Quickstart
- Transition to Werkzeug 1.0
- Werkzeug Tutorial
Reference
- Application Dispatcher
- Application Profiler
- Basic HTTP Proxy
- Context Locals
- Data Structures
- Filesystem Utilities
- HTTP Exceptions
- HTTP Utilities
- Middleware
- Serve Shared Static Files
- URL Helpers
- URL Routing
- Utilities
- WSGI Helpers
- WSGI Protocol Linter
- X-Forwarded-For Proxy Fix
Serving and Testing
- Debugging Applications
- Serving WSGI Applications
- Test Utilities
werkzeug.contrib.atom
- AtomFeed
- AtomFeed.add()
- AtomFeed.generate()
- AtomFeed.get_response()
- AtomFeed.to_string()
- FeedEntry
werkzeug.contrib.cache
- BaseCache
- BaseCache.add()
- BaseCache.clear()
- BaseCache.dec()
- BaseCache.delete()
- BaseCache.delete_many()
- BaseCache.get()
- BaseCache.get_dict()
- BaseCache.get_many()
- BaseCache.has()
- BaseCache.inc()
- BaseCache.set()
- BaseCache.set_many()
- FileSystemCache
- GAEMemcachedCache
- MemcachedCache
- NullCache
- RedisCache
- SimpleCache
- UWSGICache
werkzeug.contrib.fixers
- CGIRootFix
- HeaderRewriterFix
- InternetExplorerFix
- PathInfoFromRequestUriFix
- ProxyFix
werkzeug.contrib.iterio
- IterIO
werkzeug.contrib.profiler
- MergeStream
werkzeug.contrib.securecookie
- SecureCookie
- SecureCookie.hash_method()
- SecureCookie.load_cookie()
- SecureCookie.modified
- SecureCookie.new
- SecureCookie.quote()
- SecureCookie.quote_base64
- SecureCookie.save_cookie()
- SecureCookie.serialization_method
- SecureCookie.serialize()
- SecureCookie.should_save
- SecureCookie.unquote()
- SecureCookie.unserialize()
werkzeug.contrib.sessions
- FilesystemSessionStore
- FilesystemSessionStore.list()
- Session
- Session.modified
- Session.new
- Session.should_save
- Session.sid
- SessionMiddleware
- SessionStore
- SessionStore.delete()
- SessionStore.generate_key()
- SessionStore.get()
- SessionStore.is_valid_key()
- SessionStore.new()
- SessionStore.save()
- SessionStore.save_if_modified()
werkzeug.contrib.wrappers
- DynamicCharsetRequestMixin
- DynamicCharsetRequestMixin.charset
- DynamicCharsetRequestMixin.default_charset
- DynamicCharsetRequestMixin.unknown_charset()
- DynamicCharsetResponseMixin
- DynamicCharsetResponseMixin.charset
- DynamicCharsetResponseMixin.default_charset
- JSONRequestMixin
- ProtobufRequestMixin
- ProtobufRequestMixin.parse_protobuf()
- ProtobufRequestMixin.protobuf_check_initialization
- ReverseSlashBehaviorRequestMixin
- ReverseSlashBehaviorRequestMixin.path
- ReverseSlashBehaviorRequestMixin.script_root
- RoutingArgsRequestMixin
- RoutingArgsRequestMixin.routing_args
- RoutingArgsRequestMixin.routing_vars
werkzeug.datastructures
- Accept
- Accept.best
- Accept.best_match()
- Accept.find()
- Accept.index()
- Accept.quality()
- Accept.to_header()
- Accept.values()
- Authorization
- Authorization.cnonce
- Authorization.nc
- Authorization.nonce
- Authorization.opaque
- Authorization.password
- Authorization.qop
- Authorization.realm
- Authorization.response
- Authorization.uri
- Authorization.username
- CharsetAccept
- CombinedMultiDict
- ContentRange
- ContentRange.length
- ContentRange.set()
- ContentRange.start
- ContentRange.stop
- ContentRange.units
- 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.content_length
- FileStorage.content_type
- FileStorage.filename
- FileStorage.headers
- FileStorage.mimetype
- FileStorage.mimetype_params
- FileStorage.name
- FileStorage.save()
- FileStorage.stream
- Headers
- Headers.add()
- Headers.add_header()
- Headers.clear()
- Headers.extend()
- Headers.get()
- Headers.get_all()
- Headers.getlist()
- Headers.has_key()
- Headers.pop()
- Headers.popitem()
- Headers.remove()
- Headers.set()
- Headers.setdefault()
- Headers.to_list()
- Headers.to_wsgi_list()
- 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
- MIMEAccept.accept_html
- MIMEAccept.accept_json
- MIMEAccept.accept_xhtml
- 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.max_stale
- RequestCacheControl.min_fresh
- RequestCacheControl.no_cache
- RequestCacheControl.no_store
- RequestCacheControl.no_transform
- RequestCacheControl.only_if_cached
- ResponseCacheControl
- ResponseCacheControl.max_age
- ResponseCacheControl.must_revalidate
- ResponseCacheControl.no_cache
- ResponseCacheControl.no_store
- ResponseCacheControl.no_transform
- ResponseCacheControl.private
- ResponseCacheControl.proxy_revalidate
- ResponseCacheControl.public
- ResponseCacheControl.s_maxage
- TypeConversionDict
- TypeConversionDict.get()
- WWWAuthenticate
- WWWAuthenticate.algorithm
- WWWAuthenticate.auth_property()
- WWWAuthenticate.domain
- WWWAuthenticate.nonce
- WWWAuthenticate.opaque
- WWWAuthenticate.qop
- WWWAuthenticate.realm
- WWWAuthenticate.set_basic()
- WWWAuthenticate.set_digest()
- WWWAuthenticate.stale
- WWWAuthenticate.to_header()
- WWWAuthenticate.type
werkzeug.debug
- DebuggedApplication
werkzeug.exceptions
- abort()
- Aborter
- HTTPException.__call__()
- HTTPException.get_response()
werkzeug.filesystem
- BrokenFilesystemWarning
- get_filesystem_encoding()
werkzeug.formparser
- FormDataParser
- parse_form_data()
- parse_multipart_headers()
werkzeug.http
- cookie_date()
- 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.get_ident()
- LocalManager.make_middleware()
- LocalManager.middleware()
- LocalProxy
- LocalProxy._get_current_object()
- LocalStack
- LocalStack.pop()
- LocalStack.push()
- LocalStack.top
- 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.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()
- pbkdf2_bin()
- pbkdf2_hex()
- safe_join()
- safe_str_cmp()
werkzeug.serving
- is_running_from_reloader()
- make_ssl_devcert()
- run_simple()
werkzeug.test
- Client
- Client.delete()
- Client.get()
- Client.head()
- Client.open()
- Client.options()
- Client.patch()
- Client.post()
- Client.put()
- Client.trace()
- create_environ()
- EnvironBuilder
- EnvironBuilder.args
- EnvironBuilder.base_url
- EnvironBuilder.charset
- EnvironBuilder.close()
- EnvironBuilder.content_length
- EnvironBuilder.content_type
- EnvironBuilder.environ_base
- EnvironBuilder.environ_overrides
- EnvironBuilder.errors_stream
- EnvironBuilder.files
- EnvironBuilder.form
- EnvironBuilder.from_environ()
- EnvironBuilder.get_environ()
- EnvironBuilder.get_request()
- EnvironBuilder.headers
- EnvironBuilder.input_stream
- EnvironBuilder.json_dumps()
- EnvironBuilder.mimetype
- EnvironBuilder.mimetype_params
- EnvironBuilder.multiprocess
- EnvironBuilder.multithread
- EnvironBuilder.path
- EnvironBuilder.query_string
- EnvironBuilder.request_class
- EnvironBuilder.server_name
- EnvironBuilder.server_port
- EnvironBuilder.server_protocol
- EnvironBuilder.wsgi_version
- run_wsgi_app()
werkzeug.testapp
- test_app()
werkzeug.urls
- BaseURL
- BaseURL.ascii_host
- BaseURL.auth
- BaseURL.decode_netloc()
- BaseURL.decode_query()
- BaseURL.get_file_location()
- BaseURL.host
- BaseURL.join()
- BaseURL.password
- BaseURL.port
- BaseURL.raw_password
- BaseURL.raw_username
- BaseURL.replace()
- BaseURL.to_iri_tuple()
- BaseURL.to_uri_tuple()
- BaseURL.to_url()
- BaseURL.username
- BytesURL
- BytesURL.decode()
- BytesURL.encode_netloc()
- Href
- iri_to_uri()
- uri_to_iri()
- URL
- URL.encode()
- URL.encode_netloc()
- 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.useragents
- UserAgent
- UserAgent.browser
- UserAgent.language
- UserAgent.platform
- UserAgent.string
- UserAgent.version
werkzeug.utils
- append_slash_redirect()
- bind_arguments()
- cached_property
- environ_property
- escape()
- find_modules()
- header_property
- HTMLBuilder
- import_string()
- redirect()
- secure_filename()
- unescape()
- validate_arguments()
werkzeug.wrappers
- AcceptMixin
- AcceptMixin.accept_charsets
- AcceptMixin.accept_encodings
- AcceptMixin.accept_languages
- AcceptMixin.accept_mimetypes
- AuthorizationMixin
- AuthorizationMixin.authorization
- BaseRequest
- BaseRequest._get_file_stream()
- BaseRequest.access_route
- BaseRequest.application()
- BaseRequest.args
- BaseRequest.base_url
- BaseRequest.charset
- BaseRequest.close()
- BaseRequest.cookies
- BaseRequest.data
- BaseRequest.dict_storage_class
- BaseRequest.disable_data_descriptor
- BaseRequest.encoding_errors
- BaseRequest.environ
- BaseRequest.files
- BaseRequest.form
- BaseRequest.form_data_parser_class
- BaseRequest.from_values()
- BaseRequest.full_path
- BaseRequest.get_data()
- BaseRequest.headers
- BaseRequest.host
- BaseRequest.host_url
- BaseRequest.is_multiprocess
- BaseRequest.is_multithread
- BaseRequest.is_run_once
- BaseRequest.is_secure
- BaseRequest.is_xhr
- BaseRequest.list_storage_class
- BaseRequest.make_form_data_parser()
- BaseRequest.max_content_length
- BaseRequest.max_form_memory_size
- BaseRequest.method
- BaseRequest.parameter_storage_class
- BaseRequest.path
- BaseRequest.query_string
- BaseRequest.remote_addr
- BaseRequest.remote_user
- BaseRequest.scheme
- BaseRequest.script_root
- BaseRequest.shallow
- BaseRequest.stream
- BaseRequest.trusted_hosts
- BaseRequest.url
- BaseRequest.url_charset
- BaseRequest.url_root
- BaseRequest.values
- BaseRequest.want_form_data_parsed
- BaseResponse
- BaseResponse.__call__()
- BaseResponse._ensure_sequence()
- BaseResponse.autocorrect_location_header
- BaseResponse.automatically_set_content_length
- BaseResponse.calculate_content_length()
- BaseResponse.call_on_close()
- BaseResponse.charset
- BaseResponse.close()
- BaseResponse.data
- BaseResponse.default_mimetype
- BaseResponse.default_status
- BaseResponse.delete_cookie()
- BaseResponse.direct_passthrough
- BaseResponse.force_type()
- BaseResponse.freeze()
- BaseResponse.from_app()
- BaseResponse.get_app_iter()
- BaseResponse.get_data()
- BaseResponse.get_wsgi_headers()
- BaseResponse.get_wsgi_response()
- BaseResponse.headers
- BaseResponse.implicit_sequence_conversion
- BaseResponse.is_sequence
- BaseResponse.is_streamed
- BaseResponse.iter_encoded()
- BaseResponse.make_sequence()
- BaseResponse.max_cookie_size
- BaseResponse.response
- BaseResponse.set_cookie()
- BaseResponse.set_data()
- BaseResponse.status
- BaseResponse.status_code
- CommonRequestDescriptorsMixin
- CommonRequestDescriptorsMixin.content_encoding
- CommonRequestDescriptorsMixin.content_length
- CommonRequestDescriptorsMixin.content_md5
- CommonRequestDescriptorsMixin.content_type
- CommonRequestDescriptorsMixin.date
- CommonRequestDescriptorsMixin.max_forwards
- CommonRequestDescriptorsMixin.mimetype
- CommonRequestDescriptorsMixin.mimetype_params
- CommonRequestDescriptorsMixin.pragma
- CommonRequestDescriptorsMixin.referrer
- CommonResponseDescriptorsMixin
- CommonResponseDescriptorsMixin.age
- CommonResponseDescriptorsMixin.allow
- CommonResponseDescriptorsMixin.content_encoding
- CommonResponseDescriptorsMixin.content_language
- CommonResponseDescriptorsMixin.content_length
- CommonResponseDescriptorsMixin.content_location
- CommonResponseDescriptorsMixin.content_md5
- CommonResponseDescriptorsMixin.content_type
- CommonResponseDescriptorsMixin.date
- CommonResponseDescriptorsMixin.expires
- CommonResponseDescriptorsMixin.last_modified
- CommonResponseDescriptorsMixin.location
- CommonResponseDescriptorsMixin.mimetype
- CommonResponseDescriptorsMixin.mimetype_params
- CommonResponseDescriptorsMixin.retry_after
- CommonResponseDescriptorsMixin.vary
- ETagRequestMixin
- ETagRequestMixin.cache_control
- ETagRequestMixin.if_match
- ETagRequestMixin.if_modified_since
- ETagRequestMixin.if_none_match
- ETagRequestMixin.if_range
- ETagRequestMixin.if_unmodified_since
- ETagRequestMixin.range
- ETagResponseMixin
- ETagResponseMixin.accept_ranges
- ETagResponseMixin.add_etag()
- ETagResponseMixin.cache_control
- ETagResponseMixin.content_range
- ETagResponseMixin.freeze()
- ETagResponseMixin.get_etag()
- ETagResponseMixin.make_conditional()
- ETagResponseMixin.set_etag()
- Request
- Response
- ResponseStreamMixin
- ResponseStreamMixin.stream
- UserAgentMixin
- UserAgentMixin.user_agent
- WWWAuthenticateMixin
- WWWAuthenticateMixin.www_authenticate
werkzeug.wrappers.json
- JSONMixin
- JSONMixin.get_json()
- JSONMixin.is_json
- JSONMixin.json
- JSONMixin.json_module
- JSONMixin.on_json_loading_failed()
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.is_exhausted
- 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()

Lint Validation Middleware

Warning

werkzeug.contrib.lint has moved to werkzeug.middleware.lint. The old import is deprecated as of version 0.15 and will be removed in version 1.0.

© 2007–2020 Pallets
Licensed under the BSD 3-clause License.
https://werkzeug.palletsprojects.com/en/0.16.x/contrib/lint/