werkzeug API reference

179 public APIs from werkzeug (pallets/werkzeug) — 53 classes, 30 functions, 96 methods. Signatures extracted by static analysis of the actual source.

Repository: pallets/werkzeug

Kind	Count
Classes	53
Functions	30
Methods	96

API list

funcsrc.werkzeug._reloader.ensure_echo_on() -> None

Ensure that echo mode is enabled.

methodsrc.werkzeug.datastructures.auth.Authorization.to_header() -> str

Convert to an ``Authorization`` header value.

classsrc.werkzeug.datastructures.cache_control.RequestCacheControl

A cache control for requests.

classsrc.werkzeug.datastructures.cache_control.ResponseCacheControl

A cache control for responses.

funcsrc.werkzeug.datastructures.csp.csp_property(key:str, deprecated:str | None=None) -> t.Any

Create a property for a CSP directive.

method

src.werkzeug.datastructures.file_storage.FileMultiDict.add_file(name:str, file:str | os.PathLike[str] | t.IO[bytes] | FileStorage, filename:str | None=None, content_type:str | None=None) -> None

Add a file to the given key.

methodsrc.werkzeug.datastructures.file_storage.FileMultiDict.clear() -> None

Call :meth:`close`, then remove all items.

methodsrc.werkzeug.datastructures.file_storage.FileStorage.close() -> None

Close the underlying file if possible.

methodsrc.werkzeug.datastructures.file_storage.FileStorage.content_length() -> int

The content-length sent in the header.

methodsrc.werkzeug.datastructures.file_storage.FileStorage.content_type() -> str | None

The content-type sent in the header.

methodsrc.werkzeug.datastructures.file_storage.FileStorage.mimetype_params() -> dict[str, str]

The mimetype parameters as dict.

classsrc.werkzeug.datastructures.headers.Headers

An object that stores some headers.

methodsrc.werkzeug.datastructures.headers.Headers.add(key:str, value:t.Any, **kwargs:t.Any) -> None

Add a new header tuple to the list.

methodsrc.werkzeug.datastructures.headers.Headers.add_header(key:str, value:t.Any, **kwargs:t.Any) -> None

Add a new header tuple to the list.

methodsrc.werkzeug.datastructures.headers.Headers.clear() -> None

Clears all headers.

methodsrc.werkzeug.datastructures.headers.Headers.get_all(name:str) -> list[str]

Return a list of all the values for the named field.

methodsrc.werkzeug.datastructures.headers.Headers.remove(key:str) -> None

Remove a key.

methodsrc.werkzeug.datastructures.headers.Headers.set(key:str, value:t.Any, **kwargs:t.Any) -> None

Remove all header tuples for `key` and add a new one.

methodsrc.werkzeug.datastructures.headers.Headers.setlist(key:str, values:cabc.Iterable[t.Any]) -> None

Remove any existing values for a header and add new ones.

classsrc.werkzeug.datastructures.mixins.ImmutableDictMixin

Makes a :class:`dict` immutable.

classsrc.werkzeug.datastructures.mixins.ImmutableHeadersMixin

Makes a :class:`Headers` immutable.

classsrc.werkzeug.datastructures.mixins.ImmutableListMixin

Makes a :class:`list` immutable.

classsrc.werkzeug.datastructures.mixins.ImmutableMultiDictMixin

Makes a :class:`MultiDict` immutable.

classsrc.werkzeug.datastructures.mixins.UpdateDictMixin

Makes dicts call `self.on_update` on modifications.

classsrc.werkzeug.datastructures.range.ContentRange

Represents the content range header.

method

src.werkzeug.datastructures.range.ContentRange.set(start:int | None, stop:int | None, length:int | None=None, units:str | None='bytes') -> None

Simple method to update the ranges.

methodsrc.werkzeug.datastructures.range.ContentRange.to_header() -> str

Convert to a ``Content-Range`` header value.

classsrc.werkzeug.datastructures.range.IfRange

A parsed ``If-Range`` header.

methodsrc.werkzeug.datastructures.range.IfRange.to_header() -> str

Convert to an ``If-Range`` header value.

classsrc.werkzeug.datastructures.range.Range

Represents a ``Range`` header.

methodsrc.werkzeug.datastructures.range.Range.to_header() -> str

Convert to a ``Range`` header value.

classsrc.werkzeug.datastructures.structures.ImmutableDict

An immutable :class:`dict`.

methodsrc.werkzeug.datastructures.structures.ImmutableDict.copy() -> dict[K, V]

Return a shallow mutable copy of this object.

classsrc.werkzeug.datastructures.structures.ImmutableList

An immutable :class:`list`.

classsrc.werkzeug.datastructures.structures.ImmutableMultiDict

An immutable :class:`MultiDict`.

methodsrc.werkzeug.datastructures.structures.ImmutableMultiDict.copy() -> MultiDict[K, V]

Return a shallow mutable copy of this object.

methodsrc.werkzeug.datastructures.structures.MultiDict.add(key:K, value:V) -> None

Adds a new value for the key.

methodsrc.werkzeug.datastructures.structures.MultiDict.copy() -> te.Self

Return a shallow copy of this object.

methodsrc.werkzeug.datastructures.structures.MultiDict.deepcopy(memo:t.Any=None) -> te.Self

Return a deep copy of this object.

methodsrc.werkzeug.datastructures.structures.MultiDict.items(multi:bool=False) -> cabc.Iterable[tuple[K, V]]

Return an iterator of ``(key, value)`` pairs.

methodsrc.werkzeug.datastructures.structures.MultiDict.popitem() -> tuple[K, V]

Pop an item from the dict.

methodsrc.werkzeug.datastructures.structures.MultiDict.popitemlist() -> tuple[K, list[V]]

Pop a ``(key, list)`` tuple from the dict.

methodsrc.werkzeug.datastructures.structures.MultiDict.poplist(key:K) -> list[V]

Pop the list for a key from the dict.

methodsrc.werkzeug.datastructures.structures.MultiDict.setlist(key:K, new_list:cabc.Iterable[V]) -> None

Remove the old values for a key and add new ones.

method

src.werkzeug.datastructures.structures.MultiDict.setlistdefault(key:K, default_list:cabc.Iterable[V] | None=None) -> list[V]

Like `setdefault` but sets multiple values.

classsrc.werkzeug.debug.console.Console

An interactive console.

classsrc.werkzeug.debug.console.HTMLStringO

A StringO version that HTML escapes on write.

funcsrc.werkzeug.debug.repr.debug_repr(obj:object) -> str

Creates a debug repr of an object as HTML string.

classsrc.werkzeug.exceptions.BadHost

Raised if the submitted host is badly formatted.

classsrc.werkzeug.exceptions.HTTPException

The base class for all HTTP exceptions.

method

src.werkzeug.exceptions.HTTPException.get_body(environ:WSGIEnvironment | None=None, scope:dict[str, t.Any] | None=None) -> str

Get the HTML body.

method

src.werkzeug.exceptions.HTTPException.get_description(environ:WSGIEnvironment | None=None, scope:dict[str, t.Any] | None=None) -> str

Get the description.

method

src.werkzeug.exceptions.HTTPException.get_headers(environ:WSGIEnvironment | None=None, scope:dict[str, t.Any] | None=None) -> list[tuple[str, str]]

Get a list of headers.

methodsrc.werkzeug.exceptions.HTTPException.name() -> str

The status name.

classsrc.werkzeug.exceptions.RequestTimeout

*408* `Request Timeout` Raise to signalize a timeout.

classsrc.werkzeug.exceptions.SecurityError

Raised if something triggers a security error.

classsrc.werkzeug.formparser.FormDataParser

This class implements parsing of form data for Werkzeug.

classsrc.werkzeug.http.COEP

``Cross-Origin-Embedder-Policy`` header values.

classsrc.werkzeug.http.COOP

``Cross-Origin-Opener-Policy`` header values.

classsrc.werkzeug.http.CORP

``Cross-Origin-Resource-Policy`` header values.

classsrc.werkzeug.http.SecFetchDest

``Sec-Fetch-Dest`` header values.

classsrc.werkzeug.http.SecFetchMode

``Sec-Fetch-Mode`` header values.

classsrc.werkzeug.http.SecFetchSite

``Sec-Fetch-Site`` header values.

funcsrc.werkzeug.http.dump_age(age:timedelta | int | None=None) -> str | None

Formats the duration as a base-10 integer.

funcsrc.werkzeug.http.generate_etag(data:bytes) -> str

Generate a strong ETag value by hashing the given data.

funcsrc.werkzeug.http.is_entity_header(header:str) -> bool

Check if a header is an entity header.

funcsrc.werkzeug.http.is_hop_by_hop_header(header:str) -> bool

Check if a header is an HTTP/1.1 "Hop-by-Hop" header.

funcsrc.werkzeug.http.parse_age(value:str | None=None) -> timedelta | None

Parses a base-10 integer count of seconds into a timedelta.

funcsrc.werkzeug.http.quote_etag(etag:str, weak:bool=False) -> str

Quote an etag.

funcsrc.werkzeug.http.quote_header_value(value:t.Any, allow_token:bool=True) -> str

Add double quotes around a header value.

funcsrc.werkzeug.http.unquote_header_value(value:str) -> str

Remove double quotes and backslash escapes from a header value.

classsrc.werkzeug.local.Local

Create a namespace of context-local data.

methodsrc.werkzeug.local.LocalManager.cleanup() -> None

Release the data in the locals for this context.

classsrc.werkzeug.local.LocalProxy

A proxy to the object bound to a context-local object.

classsrc.werkzeug.local.LocalStack

Create a stack of context-local data.

methodsrc.werkzeug.local.LocalStack.pop() -> T | None

Remove the top item from the stack and return it.

methodsrc.werkzeug.local.LocalStack.push(obj:T) -> list[T]

Add a new item to the top of the stack.

methodsrc.werkzeug.local.LocalStack.top() -> T | None

The topmost item on the stack.

classsrc.werkzeug.middleware.lint.HTTPWarning

Warning class for HTTP warnings.

classsrc.werkzeug.middleware.lint.WSGIWarning

Warning class for WSGI warnings.

classsrc.werkzeug.routing.converters.AnyConverter

Matches one of the items provided.

classsrc.werkzeug.routing.converters.BaseConverter

Base class for all converters.

classsrc.werkzeug.routing.converters.NumberConverter

Baseclass for `IntegerConverter` and `FloatConverter`.

classsrc.werkzeug.routing.converters.ValidationError

Validation error.

classsrc.werkzeug.routing.exceptions.RequestPath

Internal exception.

classsrc.werkzeug.routing.exceptions.RequestRedirect

Raise if the map requests a redirect.

methodsrc.werkzeug.routing.map.Map.add(rulefactory:RuleFactory) -> None

Add a new rule or factory to the map and bind it.

methodsrc.werkzeug.routing.map.Map.iter_rules(endpoint:t.Any | None=None) -> t.Iterator[Rule]

Iterate over all rules or the rules of an endpoint.

classsrc.werkzeug.routing.matcher.State

A representation of a rule state.

classsrc.werkzeug.routing.rules.Rule

A Rule represents one URL pattern.

methodsrc.werkzeug.routing.rules.Rule.build_compare_key() -> tuple[int, int, int]

The build compare key for sorting.

methodsrc.werkzeug.routing.rules.Rule.compile() -> None

Compiles the regular expression and stores it.

methodsrc.werkzeug.routing.rules.Rule.empty() -> Rule

Return an unbound copy of this rule.

methodsrc.werkzeug.routing.rules.Rule.is_duplicate(other:Rule) -> bool

Check if this rule would match in the same way as another rule.

methodsrc.werkzeug.routing.rules.Rule.provides_defaults_for(rule:Rule) -> bool

Check if this rule has defaults for a given rule.

methodsrc.werkzeug.routing.rules.Rule.refresh() -> None

Rebinds and refreshes the URL.

classsrc.werkzeug.routing.rules.RulePart

A part of a rule.

classsrc.werkzeug.routing.rules.RuleTemplateFactory

A factory that fills in template variables into rules.

classsrc.werkzeug.sansio.multipart.MultipartDecoder

Decodes a multipart message as bytes into Python events.

methodsrc.werkzeug.sansio.request.Request.base_url() -> str

Like :attr:`url` but without the query string.

methodsrc.werkzeug.sansio.request.Request.full_path() -> str

Requested path, including the query string.

methodsrc.werkzeug.sansio.request.Request.host_url() -> str

The request URL scheme and host only.

methodsrc.werkzeug.sansio.request.Request.if_match() -> ETags

ETags parsed from the ``If-Match`` header.

methodsrc.werkzeug.sansio.request.Request.if_none_match() -> ETags

ETags parsed from the ``If-None-Match`` header.

methodsrc.werkzeug.sansio.request.Request.if_range() -> IfRange

The parsed ``If-Range`` header.

methodsrc.werkzeug.sansio.request.Request.mimetype_params() -> dict[str, str]

The mimetype parameters as dict.

methodsrc.werkzeug.sansio.request.Request.pragma() -> HeaderSet

The ``Pragma`` header.

methodsrc.werkzeug.sansio.request.Request.range() -> Range | None

The parsed `Range` header.

methodsrc.werkzeug.sansio.request.Request.root_url() -> str

The request URL scheme, host, and root path.

methodsrc.werkzeug.sansio.request.Request.user_agent() -> UserAgent

The user agent.

method

src.werkzeug.sansio.response.Response.delete_cookie(key:str, path:str | None='/', domain:str | None=None, secure:bool=False, httponly:bool=False, samesite:str | None=None, partitioned:bool=False) -> None

Delete a cookie.

methodsrc.werkzeug.sansio.response.Response.mimetype() -> str | None

The mimetype (content type without charset etc.)

methodsrc.werkzeug.sansio.response.Response.mimetype_params() -> dict[str, str]

The mimetype parameters as dict.

method

src.werkzeug.sansio.response.Response.set_cookie(key:str, value:str='', max_age:timedelta | int | None=None, expires:str | datetime | int | float | None=None, path:str | None='/', domain:str | None=None, secure:bool=False, httponly:bool=False, samesite:str | None=None, partitioned:bool=False) -> None

Sets a cookie.

methodsrc.werkzeug.sansio.response.Response.set_etag(etag:str, weak:bool=False) -> None

Set the etag, and override the old one if there was one.

methodsrc.werkzeug.sansio.response.Response.status() -> str

The HTTP status code as a string.

methodsrc.werkzeug.sansio.response.Response.status_code() -> int

The HTTP status code as a number.

func

src.werkzeug.sansio.utils.get_content_length(http_content_length:str | None=None, http_transfer_encoding:str | None=None) -> int | None

Return the ``Content-Length`` header value as an int.

func

src.werkzeug.sansio.utils.get_current_url(scheme:str, host:str, root_path:str | None=None, path:str | None=None, query_string:bytes | None=None) -> str

Recreate the URL for a request.

funcsrc.werkzeug.sansio.utils.host_is_trusted(hostname:str | None, trusted_list:t.Collection[str] | None=None) -> bool

Perform some checks on a ``Host`` header ``host:port``.

funcsrc.werkzeug.security.generate_password_hash(password:str, method:str='scrypt', salt_length:int=16) -> str

Securely hash a password for storage.

classsrc.werkzeug.serving.BaseWSGIServer

A WSGI server that that handles one request at a time.

classsrc.werkzeug.serving.DechunkedInput

An input stream that handles Transfer-Encoding 'chunked'

classsrc.werkzeug.serving.WSGIRequestHandler

A request handler that implements WSGI dispatching.

method

src.werkzeug.serving.WSGIRequestHandler.connection_dropped(error:BaseException, environ:WSGIEnvironment | None=None) -> None

Called if the connection was closed by the client.

methodsrc.werkzeug.serving.WSGIRequestHandler.handle() -> None

Handles a request ignoring dropped connections.

funcsrc.werkzeug.serving.get_interface_ip(family:socket.AddressFamily) -> str

Get the IP address of an external interface.

funcsrc.werkzeug.serving.is_ssl_error(error:Exception | None=None) -> bool

Checks if the given error (or the current one) is an SSL error.

funcsrc.werkzeug.serving.make_ssl_devcert(base_path:str, host:str | None=None, cn:str | None=None) -> tuple[str, str]

Creates an SSL key for development.

methodsrc.werkzeug.test.Client.delete(*args:t.Any, **kw:t.Any) -> TestResponse

Call :meth:`open` with ``method`` set to ``DELETE``.

methodsrc.werkzeug.test.Client.delete_cookie(key:str, *domain:str='localhost', *path:str='/') -> None

Delete a cookie if it exists.

methodsrc.werkzeug.test.Client.get(*args:t.Any, **kw:t.Any) -> TestResponse

Call :meth:`open` with ``method`` set to ``GET``.

methodsrc.werkzeug.test.Client.get_cookie(key:str, domain:str='localhost', path:str='/') -> Cookie | None

Return a :class:`.Cookie` if it exists.

methodsrc.werkzeug.test.Client.head(*args:t.Any, **kw:t.Any) -> TestResponse

Call :meth:`open` with ``method`` set to ``HEAD``.

methodsrc.werkzeug.test.Client.options(*args:t.Any, **kw:t.Any) -> TestResponse

Call :meth:`open` with ``method`` set to ``OPTIONS``.

methodsrc.werkzeug.test.Client.patch(*args:t.Any, **kw:t.Any) -> TestResponse

Call :meth:`open` with ``method`` set to ``PATCH``.

methodsrc.werkzeug.test.Client.post(*args:t.Any, **kw:t.Any) -> TestResponse

Call :meth:`open` with ``method`` set to ``POST``.

methodsrc.werkzeug.test.Client.put(*args:t.Any, **kw:t.Any) -> TestResponse

Call :meth:`open` with ``method`` set to ``PUT``.

methodsrc.werkzeug.test.Client.query(*args:t.Any, **kw:t.Any) -> TestResponse

Call :meth:`open` with ``method`` set to ``QUERY``.

method

src.werkzeug.test.Client.set_cookie(key:str, value:str='', *domain:str='localhost', *origin_only:bool=True, *path:str='/', **kwargs:t.Any) -> None

Set a cookie to be sent in subsequent requests.

methodsrc.werkzeug.test.Client.trace(*args:t.Any, **kw:t.Any) -> TestResponse

Call :meth:`open` with ``method`` set to ``TRACE``.

classsrc.werkzeug.test.Cookie

A cookie key, value, and parameters.

funcsrc.werkzeug.test.create_environ(*args:t.Any, **kwargs:t.Any) -> WSGIEnvironment

Create a new WSGI environ dict based on the values passed.

funcsrc.werkzeug.urls.iri_to_uri(iri:str) -> str

Convert an IRI to a URI.

funcsrc.werkzeug.urls.uri_to_iri(uri:str) -> str

Convert a URI to an IRI.

classsrc.werkzeug.user_agent.UserAgent

Represents a parsed user agent header value.

methodsrc.werkzeug.user_agent.UserAgent.to_header() -> str

Convert to a header value.

classsrc.werkzeug.utils.ImportStringError

Provides information about a failed :func:`import_string` attempt.

funcsrc.werkzeug.utils.append_slash_redirect(environ:WSGIEnvironment, code:int=308) -> Response

Redirect to the current URL with a slash appended.

classsrc.werkzeug.utils.cached_property

A :func:`property` that is only evaluated once.

classsrc.werkzeug.utils.environ_property

Maps request attributes to environment variables.

funcsrc.werkzeug.utils.find_modules(import_path:str, include_packages:bool=False, recursive:bool=False) -> t.Iterator[str]

Finds all the modules below a package.

funcsrc.werkzeug.utils.get_content_type(mimetype:str, charset:str) -> str

Returns the full content type string with charset for a mimetype.

classsrc.werkzeug.utils.header_property

Like `environ_property` but for headers.

funcsrc.werkzeug.utils.import_string(import_name:str, silent:bool=False) -> t.Any

Imports an object based on a string.

funcsrc.werkzeug.utils.secure_filename(filename:str) -> str

Pass it a filename and it will return a secure version of it.

methodsrc.werkzeug.wrappers.request.Request.close() -> None

Closes associated resources of this request object.

methodsrc.werkzeug.wrappers.request.Request.data() -> bytes

The raw data read from :attr:`stream`.

methodsrc.werkzeug.wrappers.request.Request.from_values(*args:t.Any, **kwargs:t.Any) -> te.Self

Create a new request object based on the values provided.

methodsrc.werkzeug.wrappers.request.Request.make_form_data_parser() -> FormDataParser

Creates the form data parser.

methodsrc.werkzeug.wrappers.request.Request.on_json_loading_failed(e:ValueError | None) -> t.Any

Called if :meth:`get_json` fails and isn't silenced.

methodsrc.werkzeug.wrappers.request.Request.script_root() -> str

Alias for :attr:`self.root_path`.

methodsrc.werkzeug.wrappers.request.Request.stream() -> t.IO[bytes]

The WSGI input stream, with safety checks.

methodsrc.werkzeug.wrappers.request.Request.url_root() -> str

Alias for :attr:`root_url`.

methodsrc.werkzeug.wrappers.request.Request.want_form_data_parsed() -> bool

``True`` if the request method carries content.

methodsrc.werkzeug.wrappers.response.Response.add_etag(overwrite:bool=False, weak:bool=False) -> None

Add an ETag by hashing this response's data.

methodsrc.werkzeug.wrappers.response.Response.close() -> None

Close the wrapped response if possible.

methodsrc.werkzeug.wrappers.response.Response.freeze() -> None

Make the response object ready to be pickled.

methodsrc.werkzeug.wrappers.response.Response.get_app_iter(environ:WSGIEnvironment) -> t.Iterable[bytes]

Returns the application iterator for the given environ.

method

src.werkzeug.wrappers.response.Response.get_wsgi_response(environ:WSGIEnvironment) -> tuple[t.Iterable[bytes], str, list[tuple[str, str]]]

Returns the final WSGI response as tuple.

methodsrc.werkzeug.wrappers.response.Response.make_sequence() -> None

Converts the response iterator in a list.

methodsrc.werkzeug.wrappers.response.Response.set_data(value:bytes | str) -> None

Sets a new string as response.

methodsrc.werkzeug.wrappers.response.Response.stream() -> ResponseStream

The response iterable as write-only stream.

classsrc.werkzeug.wsgi.LimitedStream

Wrap a stream so that it doesn't read more than a given limit.

methodsrc.werkzeug.wsgi.LimitedStream.tell() -> int

Return the current stream position.

funcsrc.werkzeug.wsgi.get_content_length(environ:WSGIEnvironment) -> int | None

Return the ``Content-Length`` header value as an int.

funcsrc.werkzeug.wsgi.get_path_info(environ:WSGIEnvironment) -> str

Return ``PATH_INFO`` from the WSGI environment.

funcsrc.werkzeug.wsgi.responder(f:t.Callable[..., WSGIApplication]) -> WSGIApplication

Marks a function as responder.

funcsrc.werkzeug.wsgi.wrap_file(environ:WSGIEnvironment, file:t.IO[bytes], buffer_size:int=8192) -> t.Iterable[bytes]

Wraps a file.

About this data

These signatures were extracted from the public source of pallets/werkzeug using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries