Browse Source

mention mimetype and is_json

pull/2353/head
David Lord 8 years ago
parent
commit
217d5f9bc0
No known key found for this signature in database
GPG Key ID: 7A1C87E3F5BC42A8
  1. 22
      flask/wrappers.py

22
flask/wrappers.py

@ -97,8 +97,9 @@ class Request(RequestBase):
@property @property
def json(self): def json(self):
"""If self.is_json would return true, this will contain the """If the request has a JSON mimetype like :mimetype:`application/json`
parsed JSON data. Otherwise this will be ``None``. (see :meth:`is_json`), this will contain the parsed JSON data.
Otherwise this will be ``None``.
The :meth:`get_json` method should be used instead. The :meth:`get_json` method should be used instead.
""" """
@ -109,7 +110,7 @@ class Request(RequestBase):
@property @property
def is_json(self): def is_json(self):
"""Indicates if this request is JSON or not. By default a request """Indicates if this request is JSON or not. By default a request
is considered to include JSON data if the mimetype is is considered to include JSON data if the mimetype is
:mimetype:`application/json` or :mimetype:`application/*+json`. :mimetype:`application/json` or :mimetype:`application/*+json`.
@ -123,17 +124,18 @@ class Request(RequestBase):
return False return False
def get_json(self, force=False, silent=False, cache=True): def get_json(self, force=False, silent=False, cache=True):
"""Parses the incoming JSON request data and returns it. By default """Parses the incoming JSON request data and returns it. By default
this function will return ``None`` if self.is_json would return false, this function will return ``None`` if the request does not use a JSON
but this can be overridden by the ``force`` parameter. If parsing mimetype like :mimetype:`application/json`. See :meth:`is_json`. This
fails, the :meth:`on_json_loading_failed` method on the request object can be overridden by the ``force`` parameter. If parsing fails,
will be invoked. the :meth:`on_json_loading_failed` method on the request object will be
invoked.
:param force: if set to ``True`` the mimetype is ignored. :param force: if set to ``True`` the mimetype is ignored.
:param silent: if set to ``True`` this method will fail silently :param silent: if set to ``True`` this method will fail silently
and return ``None``. and return ``None``.
:param cache: if set to ``True`` the parsed JSON data is remembered :param cache: if set to ``True`` the parsed JSON data is remembered
on the request. on the request.
""" """
rv = getattr(self, '_cached_json', _missing) rv = getattr(self, '_cached_json', _missing)
# We return cached JSON only when the cache is enabled. # We return cached JSON only when the cache is enabled.

Loading…
Cancel
Save