OpenQuizz
Une application de gestion des contenus pédagogiques
werkzeug.http Namespace Reference

Functions

def wsgi_to_bytes (data)
 
def bytes_to_wsgi (data)
 
def quote_header_value (value, extra_chars="", allow_token=True)
 
def unquote_header_value (value, is_filename=False)
 
def dump_options_header (header, options)
 
def dump_header (iterable, allow_token=True)
 
def dump_csp_header (header)
 
def parse_list_header (value)
 
def parse_dict_header (value, cls=dict)
 
def parse_options_header (value, multiple=False)
 
def parse_accept_header (value, cls=None)
 
def parse_cache_control_header (value, on_update=None, cls=None)
 
def parse_csp_header (value, on_update=None, cls=None)
 
def parse_set_header (value, on_update=None)
 
def parse_authorization_header (value)
 
def parse_www_authenticate_header (value, on_update=None)
 
def parse_if_range_header (value)
 
def parse_range_header (value, make_inclusive=True)
 
def parse_content_range_header (value, on_update=None)
 
def quote_etag (etag, weak=False)
 
def unquote_etag (etag)
 
def parse_etags (value)
 
def generate_etag (data)
 
def parse_date (value)
 
def cookie_date (expires=None)
 
def http_date (timestamp=None)
 
def parse_age (value=None)
 
def dump_age (age=None)
 
def is_resource_modified (environ, etag=None, data=None, last_modified=None, ignore_if_range=True)
 
def remove_entity_headers (headers, allowed=("expires", "content-location"))
 
def remove_hop_by_hop_headers (headers)
 
def is_entity_header (header)
 
def is_hop_by_hop_header (header)
 
def parse_cookie (header, charset="utf-8", errors="replace", cls=None)
 
def dump_cookie (key, value="", max_age=None, expires=None, path="/", domain=None, secure=False, httponly=False, charset="utf-8", sync_expires=True, max_size=4093, samesite=None)
 
def is_byte_range_valid (start, stop, length)
 

Variables

 flags
 
 HTTP_STATUS_CODES
 

Function Documentation

◆ bytes_to_wsgi()

def werkzeug.http.bytes_to_wsgi (   data)

◆ cookie_date()

def werkzeug.http.cookie_date (   expires = None)
Formats the time to ensure compatibility with Netscape's cookie
standard.

Accepts a floating point number expressed in seconds since the epoch in, a
datetime object or a timetuple.  All times in UTC.  The :func:`parse_date`
function can be used to parse such a date.

Outputs a string in the format ``Wdy, DD-Mon-YYYY HH:MM:SS GMT``.

:param expires: If provided that date is used, otherwise the current.

◆ dump_age()

def werkzeug.http.dump_age (   age = None)
Formats the duration as a base-10 integer.

:param age: should be an integer number of seconds,
            a :class:`datetime.timedelta` object, or,
            if the age is unknown, `None` (default).

◆ dump_cookie()

def werkzeug.http.dump_cookie (   key,
  value = "",
  max_age = None,
  expires = None,
  path = "/",
  domain = None,
  secure = False,
  httponly = False,
  charset = "utf-8",
  sync_expires = True,
  max_size = 4093,
  samesite = None 
)
Creates a new Set-Cookie header without the ``Set-Cookie`` prefix
The parameters are the same as in the cookie Morsel object in the
Python standard library but it accepts unicode data, too.

On Python 3 the return value of this function will be a unicode
string, on Python 2 it will be a native string.  In both cases the
return value is usually restricted to ascii as the vast majority of
values are properly escaped, but that is no guarantee.  If a unicode
string is returned it's tunneled through latin1 as required by
PEP 3333.

The return value is not ASCII safe if the key contains unicode
characters.  This is technically against the specification but
happens in the wild.  It's strongly recommended to not use
non-ASCII values for the keys.

:param max_age: should be a number of seconds, or `None` (default) if
                the cookie should last only as long as the client's
                browser session.  Additionally `timedelta` objects
                are accepted, too.
:param expires: should be a `datetime` object or unix timestamp.
:param path: limits the cookie to a given path, per default it will
             span the whole domain.
:param domain: Use this if you want to set a cross-domain cookie. For
               example, ``domain=".example.com"`` will set a cookie
               that is readable by the domain ``www.example.com``,
               ``foo.example.com`` etc. Otherwise, a cookie will only
               be readable by the domain that set it.
:param secure: The cookie will only be available via HTTPS
:param httponly: disallow JavaScript to access the cookie.  This is an
                 extension to the cookie standard and probably not
                 supported by all browsers.
:param charset: the encoding for unicode values.
:param sync_expires: automatically set expires if max_age is defined
                     but expires not.
:param max_size: Warn if the final header value exceeds this size. The
    default, 4093, should be safely `supported by most browsers
    <cookie_>`_. Set to 0 to disable this check.
:param samesite: Limits the scope of the cookie such that it will
    only be attached to requests if those requests are same-site.

.. _`cookie`: http://browsercookielimits.squawky.net/

.. versionchanged:: 1.0.0
    The string ``'None'`` is accepted for ``samesite``.

◆ dump_csp_header()

def werkzeug.http.dump_csp_header (   header)
Dump a Content Security Policy header.

These are structured into policies such as "default-src 'self';
script-src 'self'".

.. versionadded:: 1.0.0
   Support for Content Security Policy headers was added.

◆ dump_header()

def werkzeug.http.dump_header (   iterable,
  allow_token = True 
)
Dump an HTTP header again.  This is the reversal of
:func:`parse_list_header`, :func:`parse_set_header` and
:func:`parse_dict_header`.  This also quotes strings that include an
equals sign unless you pass it as dict of key, value pairs.

>>> dump_header({'foo': 'bar baz'})
'foo="bar baz"'
>>> dump_header(('foo', 'bar baz'))
'foo, "bar baz"'

:param iterable: the iterable or dict of values to quote.
:param allow_token: if set to `False` tokens as values are disallowed.
                    See :func:`quote_header_value` for more details.

◆ dump_options_header()

def werkzeug.http.dump_options_header (   header,
  options 
)
The reverse function to :func:`parse_options_header`.

:param header: the header to dump
:param options: a dict of options to append.

◆ generate_etag()

def werkzeug.http.generate_etag (   data)
Generate an etag for some data.

◆ http_date()

def werkzeug.http.http_date (   timestamp = None)
Formats the time to match the RFC1123 date format.

Accepts a floating point number expressed in seconds since the epoch in, a
datetime object or a timetuple.  All times in UTC.  The :func:`parse_date`
function can be used to parse such a date.

Outputs a string in the format ``Wdy, DD Mon YYYY HH:MM:SS GMT``.

:param timestamp: If provided that date is used, otherwise the current.

◆ is_byte_range_valid()

def werkzeug.http.is_byte_range_valid (   start,
  stop,
  length 
)
Checks if a given byte content range is valid for the given length.

.. versionadded:: 0.7

◆ is_entity_header()

def werkzeug.http.is_entity_header (   header)
Check if a header is an entity header.

.. versionadded:: 0.5

:param header: the header to test.
:return: `True` if it's an entity header, `False` otherwise.

◆ is_hop_by_hop_header()

def werkzeug.http.is_hop_by_hop_header (   header)
Check if a header is an HTTP/1.1 "Hop-by-Hop" header.

.. versionadded:: 0.5

:param header: the header to test.
:return: `True` if it's an HTTP/1.1 "Hop-by-Hop" header, `False` otherwise.

◆ is_resource_modified()

def werkzeug.http.is_resource_modified (   environ,
  etag = None,
  data = None,
  last_modified = None,
  ignore_if_range = True 
)
Convenience method for conditional requests.

:param environ: the WSGI environment of the request to be checked.
:param etag: the etag for the response for comparison.
:param data: or alternatively the data of the response to automatically
             generate an etag using :func:`generate_etag`.
:param last_modified: an optional date of the last modification.
:param ignore_if_range: If `False`, `If-Range` header will be taken into
                        account.
:return: `True` if the resource was modified, otherwise `False`.

.. versionchanged:: 1.0.0
    The check is run for methods other than ``GET`` and ``HEAD``.

◆ parse_accept_header()

def werkzeug.http.parse_accept_header (   value,
  cls = None 
)
Parses an HTTP Accept-* header.  This does not implement a complete
valid algorithm but one that supports at least value and quality
extraction.

Returns a new :class:`Accept` object (basically a list of ``(value, quality)``
tuples sorted by the quality with some additional accessor methods).

The second parameter can be a subclass of :class:`Accept` that is created
with the parsed values and returned.

:param value: the accept header string to be parsed.
:param cls: the wrapper class for the return value (can be
                     :class:`Accept` or a subclass thereof)
:return: an instance of `cls`.

◆ parse_age()

def werkzeug.http.parse_age (   value = None)
Parses a base-10 integer count of seconds into a timedelta.

If parsing fails, the return value is `None`.

:param value: a string consisting of an integer represented in base-10
:return: a :class:`datetime.timedelta` object or `None`.

◆ parse_authorization_header()

def werkzeug.http.parse_authorization_header (   value)
Parse an HTTP basic/digest authorization header transmitted by the web
browser.  The return value is either `None` if the header was invalid or
not given, otherwise an :class:`~werkzeug.datastructures.Authorization`
object.

:param value: the authorization header to parse.
:return: a :class:`~werkzeug.datastructures.Authorization` object or `None`.

◆ parse_cache_control_header()

def werkzeug.http.parse_cache_control_header (   value,
  on_update = None,
  cls = None 
)
Parse a cache control header.  The RFC differs between response and
request cache control, this method does not.  It's your responsibility
to not use the wrong control statements.

.. versionadded:: 0.5
   The `cls` was added.  If not specified an immutable
   :class:`~werkzeug.datastructures.RequestCacheControl` is returned.

:param value: a cache control header to be parsed.
:param on_update: an optional callable that is called every time a value
                  on the :class:`~werkzeug.datastructures.CacheControl`
                  object is changed.
:param cls: the class for the returned object.  By default
            :class:`~werkzeug.datastructures.RequestCacheControl` is used.
:return: a `cls` object.

◆ parse_content_range_header()

def werkzeug.http.parse_content_range_header (   value,
  on_update = None 
)
Parses a range header into a
:class:`~werkzeug.datastructures.ContentRange` object or `None` if
parsing is not possible.

.. versionadded:: 0.7

:param value: a content range header to be parsed.
:param on_update: an optional callable that is called every time a value
                  on the :class:`~werkzeug.datastructures.ContentRange`
                  object is changed.

◆ parse_cookie()

def werkzeug.http.parse_cookie (   header,
  charset = "utf-8",
  errors = "replace",
  cls = None 
)
Parse a cookie from a string or WSGI environ.

The same key can be provided multiple times, the values are stored
in-order. The default :class:`MultiDict` will have the first value
first, and all values can be retrieved with
:meth:`MultiDict.getlist`.

:param header: The cookie header as a string, or a WSGI environ dict
    with a ``HTTP_COOKIE`` key.
:param charset: The charset for the cookie values.
:param errors: The error behavior for the charset decoding.
:param cls: A dict-like class to store the parsed cookies in.
    Defaults to :class:`MultiDict`.

.. versionchanged:: 1.0.0
    Returns a :class:`MultiDict` instead of a
    ``TypeConversionDict``.

.. versionchanged:: 0.5
   Returns a :class:`TypeConversionDict` instead of a regular dict.
   The ``cls`` parameter was added.

◆ parse_csp_header()

def werkzeug.http.parse_csp_header (   value,
  on_update = None,
  cls = None 
)
Parse a Content Security Policy header.

.. versionadded:: 1.0.0
   Support for Content Security Policy headers was added.

:param value: a csp header to be parsed.
:param on_update: an optional callable that is called every time a value
                  on the object is changed.
:param cls: the class for the returned object.  By default
            :class:`~werkzeug.datastructures.ContentSecurityPolicy` is used.
:return: a `cls` object.

◆ parse_date()

def werkzeug.http.parse_date (   value)
Parse one of the following date formats into a datetime object:

.. sourcecode:: text

    Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
    Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
    Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format

If parsing fails the return value is `None`.

:param value: a string with a supported date format.
:return: a :class:`datetime.datetime` object.

◆ parse_dict_header()

def werkzeug.http.parse_dict_header (   value,
  cls = dict 
)
Parse lists of key, value pairs as described by RFC 2068 Section 2 and
convert them into a python dict (or any other mapping object created from
the type with a dict like interface provided by the `cls` argument):

>>> d = parse_dict_header('foo="is a fish", bar="as well"')
>>> type(d) is dict
True
>>> sorted(d.items())
[('bar', 'as well'), ('foo', 'is a fish')]

If there is no value for a key it will be `None`:

>>> parse_dict_header('key_without_value')
{'key_without_value': None}

To create a header from the :class:`dict` again, use the
:func:`dump_header` function.

.. versionchanged:: 0.9
   Added support for `cls` argument.

:param value: a string with a dict header.
:param cls: callable to use for storage of parsed results.
:return: an instance of `cls`

◆ parse_etags()

def werkzeug.http.parse_etags (   value)
Parse an etag header.

:param value: the tag header to parse
:return: an :class:`~werkzeug.datastructures.ETags` object.

◆ parse_if_range_header()

def werkzeug.http.parse_if_range_header (   value)
Parses an if-range header which can be an etag or a date.  Returns
a :class:`~werkzeug.datastructures.IfRange` object.

.. versionadded:: 0.7

◆ parse_list_header()

def werkzeug.http.parse_list_header (   value)
Parse lists as described by RFC 2068 Section 2.

In particular, parse comma-separated lists where the elements of
the list may include quoted-strings.  A quoted-string could
contain a comma.  A non-quoted string could have quotes in the
middle.  Quotes are removed automatically after parsing.

It basically works like :func:`parse_set_header` just that items
may appear multiple times and case sensitivity is preserved.

The return value is a standard :class:`list`:

>>> parse_list_header('token, "quoted value"')
['token', 'quoted value']

To create a header from the :class:`list` again, use the
:func:`dump_header` function.

:param value: a string with a list header.
:return: :class:`list`

◆ parse_options_header()

def werkzeug.http.parse_options_header (   value,
  multiple = False 
)
Parse a ``Content-Type`` like header into a tuple with the content
type and the options:

>>> parse_options_header('text/html; charset=utf8')
('text/html', {'charset': 'utf8'})

This should not be used to parse ``Cache-Control`` like headers that use
a slightly different format.  For these headers use the
:func:`parse_dict_header` function.

.. versionchanged:: 0.15
    :rfc:`2231` parameter continuations are handled.

.. versionadded:: 0.5

:param value: the header to parse.
:param multiple: Whether try to parse and return multiple MIME types
:return: (mimetype, options) or (mimetype, options, mimetype, options, …)
         if multiple=True

◆ parse_range_header()

def werkzeug.http.parse_range_header (   value,
  make_inclusive = True 
)
Parses a range header into a :class:`~werkzeug.datastructures.Range`
object.  If the header is missing or malformed `None` is returned.
`ranges` is a list of ``(start, stop)`` tuples where the ranges are
non-inclusive.

.. versionadded:: 0.7

◆ parse_set_header()

def werkzeug.http.parse_set_header (   value,
  on_update = None 
)
Parse a set-like header and return a
:class:`~werkzeug.datastructures.HeaderSet` object:

>>> hs = parse_set_header('token, "quoted value"')

The return value is an object that treats the items case-insensitively
and keeps the order of the items:

>>> 'TOKEN' in hs
True
>>> hs.index('quoted value')
1
>>> hs
HeaderSet(['token', 'quoted value'])

To create a header from the :class:`HeaderSet` again, use the
:func:`dump_header` function.

:param value: a set header to be parsed.
:param on_update: an optional callable that is called every time a
                  value on the :class:`~werkzeug.datastructures.HeaderSet`
                  object is changed.
:return: a :class:`~werkzeug.datastructures.HeaderSet`

◆ parse_www_authenticate_header()

def werkzeug.http.parse_www_authenticate_header (   value,
  on_update = None 
)
Parse an HTTP WWW-Authenticate header into a
:class:`~werkzeug.datastructures.WWWAuthenticate` object.

:param value: a WWW-Authenticate header to parse.
:param on_update: an optional callable that is called every time a value
                  on the :class:`~werkzeug.datastructures.WWWAuthenticate`
                  object is changed.
:return: a :class:`~werkzeug.datastructures.WWWAuthenticate` object.

◆ quote_etag()

def werkzeug.http.quote_etag (   etag,
  weak = False 
)
Quote an etag.

:param etag: the etag to quote.
:param weak: set to `True` to tag it "weak".

◆ quote_header_value()

def werkzeug.http.quote_header_value (   value,
  extra_chars = "",
  allow_token = True 
)
Quote a header value if necessary.

.. versionadded:: 0.5

:param value: the value to quote.
:param extra_chars: a list of extra characters to skip quoting.
:param allow_token: if this is enabled token values are returned
                    unchanged.

◆ remove_entity_headers()

def werkzeug.http.remove_entity_headers (   headers,
  allowed = ("expires", "content-location") 
)
Remove all entity headers from a list or :class:`Headers` object.  This
operation works in-place.  `Expires` and `Content-Location` headers are
by default not removed.  The reason for this is :rfc:`2616` section
10.3.5 which specifies some entity headers that should be sent.

.. versionchanged:: 0.5
   added `allowed` parameter.

:param headers: a list or :class:`Headers` object.
:param allowed: a list of headers that should still be allowed even though
                they are entity headers.

◆ remove_hop_by_hop_headers()

def werkzeug.http.remove_hop_by_hop_headers (   headers)
Remove all HTTP/1.1 "Hop-by-Hop" headers from a list or
:class:`Headers` object.  This operation works in-place.

.. versionadded:: 0.5

:param headers: a list or :class:`Headers` object.

◆ unquote_etag()

def werkzeug.http.unquote_etag (   etag)
Unquote a single etag:

>>> unquote_etag('W/"bar"')
('bar', True)
>>> unquote_etag('"bar"')
('bar', False)

:param etag: the etag identifier to unquote.
:return: a ``(etag, weak)`` tuple.

◆ unquote_header_value()

def werkzeug.http.unquote_header_value (   value,
  is_filename = False 
)
Unquotes a header value.  (Reversal of :func:`quote_header_value`).
This does not use the real unquoting but what browsers are actually
using for quoting.

.. versionadded:: 0.5

:param value: the header value to unquote.

◆ wsgi_to_bytes()

def werkzeug.http.wsgi_to_bytes (   data)
coerce wsgi unicode represented bytes to real ones

Variable Documentation

◆ flags

flags

◆ HTTP_STATUS_CODES

HTTP_STATUS_CODES