maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

Remove _missing sentinel and update docs

Browse source
This commit is contained in:
Adam Byrtek 2015-09-28 22:20:11 +02:00 • committed by Markus Unterwaditzer
parent 5ebdd5dd74
commit 866118302e
1 changed files with 16 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

31
flask/wrappers.py
View file

@ -15,21 +15,21 @@ from werkzeug.exceptions import BadRequest
from . import json from . import json
from .globals import _app_ctx_stack from .globals import _app_ctx_stack
_missing = object()
class JSONMixin(object): class JSONMixin(object):
"""Mixin for both request and response classes to provide JSON parsing """Common mixin for both request and response objects to provide JSON
capabilities. parsing capabilities.
.. versionadded:: 0.12 .. versionadded:: 0.12
""" """
@property @property
def is_json(self): def is_json(self):
"""Indicates if this request/response is JSON or not. By default it """Indicates if this request/response is in JSON format or not. By
is considered to include JSON data if the mimetype is default it is considered to include JSON data if the mimetype is
:mimetype:`application/json` or :mimetype:`application/*+json`. :mimetype:`application/json` or :mimetype:`application/*+json`.
.. versionadded:: 1.0
""" """
mt = self.mimetype mt = self.mimetype
if mt == 'application/json': if mt == 'application/json':
@ -40,14 +40,14 @@ class JSONMixin(object):
@property @property
def json(self): def json(self):
"""If the mimetype is :mimetype:`application/json` this will contain the """If this request/response is in JSON format then this property will
parsed JSON data. Otherwise this will be ``None``. contain the parsed JSON data. Otherwise it will be ``None``.
The :meth:`get_json` method should be used instead. The :meth:`get_json` method should be used instead.
""" """
from warnings import warn from warnings import warn
warn(DeprecationWarning('json is deprecated. ' warn(DeprecationWarning(
'Use get_json() instead.'), stacklevel=2) 'json is deprecated. Use get_json() instead.'), stacklevel=2)
return self.get_json() return self.get_json()
def _get_data_for_json(self, cache): def _get_data_for_json(self, cache):
@ -68,16 +68,17 @@ class JSONMixin(object):
: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 object.
""" """
rv = getattr(self, '_cached_json', _missing) try:
if rv is not _missing: return getattr(self, '_cached_json')
return rv except AttributeError:
pass
if not (force or self.is_json): if not (force or self.is_json):
return None return None
# We accept a request charset against the specification as certain # We accept MIME charset header against the specification as certain
# clients have been using this in the past. For responses, we assume # clients have been using this in the past. For responses, we assume
# that if the response charset was set explicitly then the data had # that if the response charset was set explicitly then the data had
# been encoded correctly as well. # been encoded correctly as well.