werkzeug.sansio.response.Response

class documentation

class Response: (source)

Known subclasses: werkzeug.wrappers.response.Response

View In Hierarchy

Represents the non-IO parts of an HTTP response, specifically the status and headers but not the body. This class is not meant for general use. It should only be used when implementing WSGI, ASGI, or another HTTP application spec. Werkzeug provides a WSGI implementation at :cls:`werkzeug.wrappers.Response`. :param status: The status code for the response. Either an int, in which case the default status message is added, or a string in the form ``{code} {message}``, like ``404 Not Found``. Defaults to 200. :param headers: A :class:`~werkzeug.datastructures.Headers` object, or a list of ``(key, value)`` tuples that will be converted to a ``Headers`` object. :param mimetype: The mime type (content type without charset or other parameters) of the response. If the value starts with ``text/`` (or matches some other special cases), the charset will be added to create the ``content_type``. :param content_type: The full content type of the response. Overrides building the value from ``mimetype``. .. versionadded:: 2.0

Method __init__ Undocumented
Method __repr__ Undocumented
Method access_control_allow_credentials.setter Undocumented
Method content_range.setter Undocumented
Method content_security_policy.setter Undocumented
Method content_security_policy_report_only.setter Undocumented
Method delete_cookie Delete a cookie. Fails silently if key doesn't exist.
Method get_etag Return a tuple in the form ``(etag, is_weak)``. If there is no ETag the return value is ``(None, None)``.
Method mimetype.setter Undocumented
Method retry_after.setter Undocumented
Method set_cookie Sets a cookie.
Method set_etag Set the etag, and override the old one if there was one.
Method status.setter Undocumented
Method status_code.setter Undocumented
Class Variable accept_ranges Undocumented
Class Variable access_control_allow_headers Undocumented
Class Variable access_control_allow_methods Undocumented
Class Variable access_control_allow_origin Undocumented
Class Variable access_control_expose_headers Undocumented
Class Variable access_control_max_age Undocumented
Class Variable age Undocumented
Class Variable allow Undocumented
Class Variable charset Undocumented
Class Variable content_encoding Undocumented
Class Variable content_language Undocumented
Class Variable content_length Undocumented
Class Variable content_location Undocumented
Class Variable content_md5 Undocumented
Class Variable content_type Undocumented
Class Variable cross_origin_embedder_policy Undocumented
Class Variable cross_origin_opener_policy Undocumented
Class Variable date Undocumented
Class Variable default_mimetype Undocumented
Class Variable default_status Undocumented
Class Variable expires Undocumented
Class Variable last_modified Undocumented
Class Variable location Undocumented
Class Variable max_cookie_size Undocumented
Class Variable vary Undocumented
Instance Variable headers Undocumented
Property access_control_allow_credentials Whether credentials can be shared by the browser to JavaScript code. As part of the preflight request it indicates whether credentials can be used on the cross origin request.
Property cache_control The Cache-Control general-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
Property content_range The ``Content-Range`` header as a :class:`~werkzeug.datastructures.ContentRange` object. Available even if the header is not set.
Property content_security_policy The ``Content-Security-Policy`` header as a :class:`~werkzeug.datastructures.ContentSecurityPolicy` object. Available even if the header is not set.
Property content_security_policy_report_only The ``Content-Security-policy-report-only`` header as a :class:`~werkzeug.datastructures.ContentSecurityPolicy` object. Available even if the header is not set.
Property is_json Check if the mimetype indicates JSON data, either :mimetype:`application/json` or :mimetype:`application/*+json`.
Property mimetype The mimetype (content type without charset etc.)
Property mimetype_params The mimetype parameters as dict. For example if the content type is ``text/html; charset=utf-8`` the params would be ``{'charset': 'utf-8'}``.
Property retry_after The Retry-After response-header field can be used with a 503 (Service Unavailable) response to indicate how long the service is expected to be unavailable to the requesting client.
Property status The HTTP status code as a string.
Property status_code The HTTP status code as a number.
Property www_authenticate The ``WWW-Authenticate`` header in a parsed form.
Method _clean_status Undocumented
Instance Variable _status Undocumented
Instance Variable _status_code Undocumented
def __init__(self, status: t.Optional[t.Union[int, str, HTTPStatus]] = None, headers: t.Optional[t.Union[t.Mapping[str, t.Union[str, int, t.Iterable[t.Union[str, int]]]], t.Iterable[t.Tuple[str, t.Union[str, int]]]]] = None, mimetype: t.Optional[str] = None, content_type: t.Optional[str] = None): (source)
overridden in werkzeug.wrappers.response.Response

Undocumented

def __repr__(self) -> str: (source)
overridden in werkzeug.wrappers.response.Response

Undocumented

@access_control_allow_credentials.setter
def access_control_allow_credentials(self, value: t.Optional[bool]): (source)

Undocumented

@content_range.setter
def content_range(self, value: t.Optional[t.Union[ContentRange, str]]): (source)

Undocumented

@content_security_policy.setter
def content_security_policy(self, value: t.Optional[t.Union[ContentSecurityPolicy, str]]): (source)

Undocumented

@content_security_policy_report_only.setter
def content_security_policy_report_only(self, value: t.Optional[t.Union[ContentSecurityPolicy, str]]): (source)

Undocumented

def delete_cookie(self, key: str, path: str = '/', domain: t.Optional[str] = None, secure: bool = False, httponly: bool = False, samesite: t.Optional[str] = None): (source)

Delete a cookie. Fails silently if key doesn't exist. :param key: the key (name) of the cookie to be deleted. :param path: if the cookie that should be deleted was limited to a path, the path has to be defined here. :param domain: if the cookie that should be deleted was limited to a domain, that domain has to be defined here. :param secure: If ``True``, the cookie will only be available via HTTPS. :param httponly: Disallow JavaScript access to the cookie. :param samesite: Limit the scope of the cookie to only be attached to requests that are "same-site".

def get_etag(self) -> t.Union[t.Tuple[str, bool], t.Tuple[None, None]]: (source)

Return a tuple in the form ``(etag, is_weak)``. If there is no ETag the return value is ``(None, None)``.

@mimetype.setter
def mimetype(self, value: str): (source)

Undocumented

@retry_after.setter
def retry_after(self, value: t.Optional[t.Union[datetime, int, str]]): (source)

Undocumented

def set_cookie(self, key: str, value: str = '', max_age: t.Optional[t.Union[timedelta, int]] = None, expires: t.Optional[t.Union[str, datetime, int, float]] = None, path: t.Optional[str] = '/', domain: t.Optional[str] = None, secure: bool = False, httponly: bool = False, samesite: t.Optional[str] = None): (source)

Sets a cookie. A warning is raised if the size of the cookie header exceeds :attr:`max_cookie_size`, but the header will still be set. :param key: the key (name) of the cookie to be set. :param value: the value of the cookie. :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. :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: 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: If ``True``, the cookie will only be available via HTTPS. :param httponly: Disallow JavaScript access to the cookie. :param samesite: Limit the scope of the cookie to only be attached to requests that are "same-site".

def set_etag(self, etag: str, weak: bool = False): (source)

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

@status.setter
def status(self, value: t.Union[str, int, HTTPStatus]): (source)

Undocumented

@status_code.setter
def status_code(self, code: int): (source)

Undocumented

accept_ranges = (source)

Undocumented

access_control_allow_headers = (source)

Undocumented

access_control_allow_methods = (source)

Undocumented

access_control_allow_origin = (source)

Undocumented

access_control_expose_headers = (source)

Undocumented

access_control_max_age = (source)

Undocumented

age = (source)

Undocumented

allow = (source)

Undocumented

charset: str = (source)

Undocumented

content_encoding = (source)

Undocumented

content_language = (source)

Undocumented

content_length = (source)

Undocumented

content_location = (source)

Undocumented

content_md5 = (source)

Undocumented

content_type = (source)

Undocumented

cross_origin_embedder_policy = (source)

Undocumented

cross_origin_opener_policy = (source)

Undocumented

date = (source)

Undocumented

default_mimetype: t.Optional[str] = (source)
overridden in werkzeug.test.TestResponse

Undocumented

default_status: int = (source)

Undocumented

expires = (source)

Undocumented

last_modified = (source)

Undocumented

location = (source)

Undocumented

max_cookie_size: int = (source)

Undocumented

vary = (source)

Undocumented

headers = (source)

Undocumented

@property
access_control_allow_credentials: bool = (source)

Whether credentials can be shared by the browser to JavaScript code. As part of the preflight request it indicates whether credentials can be used on the cross origin request.

@property
cache_control: ResponseCacheControl = (source)

The Cache-Control general-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.

@property
content_range: ContentRange = (source)
overridden in werkzeug.wrappers.response.Response

The ``Content-Range`` header as a :class:`~werkzeug.datastructures.ContentRange` object. Available even if the header is not set. .. versionadded:: 0.7

@property
content_security_policy: ContentSecurityPolicy = (source)

The ``Content-Security-Policy`` header as a :class:`~werkzeug.datastructures.ContentSecurityPolicy` object. Available even if the header is not set. The Content-Security-Policy header adds an additional layer of security to help detect and mitigate certain types of attacks.

@property
content_security_policy_report_only: ContentSecurityPolicy = (source)

The ``Content-Security-policy-report-only`` header as a :class:`~werkzeug.datastructures.ContentSecurityPolicy` object. Available even if the header is not set. The Content-Security-Policy-Report-Only header adds a csp policy that is not enforced but is reported thereby helping detect certain types of attacks.

@property
is_json: bool = (source)

Check if the mimetype indicates JSON data, either :mimetype:`application/json` or :mimetype:`application/*+json`.

@property
mimetype: t.Optional[str] = (source)

The mimetype (content type without charset etc.)

@property
mimetype_params: t.Dict[str, str] = (source)

The mimetype parameters as dict. For example if the content type is ``text/html; charset=utf-8`` the params would be ``{'charset': 'utf-8'}``. .. versionadded:: 0.5

@property
retry_after: t.Optional[datetime] = (source)

The Retry-After response-header field can be used with a 503 (Service Unavailable) response to indicate how long the service is expected to be unavailable to the requesting client. Time in seconds until expiration or date. .. versionchanged:: 2.0 The datetime object is timezone-aware.

@property
status: str = (source)

The HTTP status code as a string.

@property
status_code: int = (source)
overridden in werkzeug.wrappers.response.Response

The HTTP status code as a number.

@property
www_authenticate: WWWAuthenticate = (source)

The ``WWW-Authenticate`` header in a parsed form.

def _clean_status(self, value: t.Union[str, int, HTTPStatus]) -> t.Tuple[str, int]: (source)

Undocumented

_status = (source)

Undocumented

_status_code = (source)

Undocumented