orbit-oss/flask
4
4
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

mention mimetype and is_json

Browse source
This commit is contained in:
David Lord 2017-06-02 10:17:40 -07:00
parent daf85d3725
commit 217d5f9bc0
No known key found for this signature in database
GPG key ID: 7A1C87E3F5BC42A8
1 changed files with 12 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

22
flask/wrappers.py
View file

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