flask.json

package documentation

(source)

Undocumented

Module	`provider`	No module docstring; 0/1 function, 2/2 classes documented
Module	`tag`	Tagged JSON ~~~~~~~~~~~

From __init__.py:

Class	`JSONDecoder`	The default JSON decoder.
Class	`JSONEncoder`	The default JSON encoder. Handles extra types compared to the built-in :class:`json.JSONEncoder`.
Function	`dump`	Serialize data as JSON and write to a file.
Function	`dumps`	Serialize data as JSON.
Function	`htmlsafe_dump`	Serialize an object to JSON written to a file object, replacing HTML-unsafe characters with Unicode escapes. See :func:`htmlsafe_dumps` and :func:`dumps`.
Function	`htmlsafe_dumps`	Serialize an object to a string of JSON with :func:`dumps`, then replace HTML-unsafe characters with Unicode escapes and mark the result safe with :class:`~markupsafe.Markup`.
Function	`jsonify`	Serialize the given arguments as JSON, and return a :class:`~flask.Response` object with the ``application/json`` mimetype. A dict or list returned from a view will be converted to a JSON response automatically without needing to call this.
Function	`load`	Deserialize data as JSON read from a file.
Function	`loads`	Deserialize data as JSON.

def dumps(obj: t.Any, *, app: Flask|None = None, **kwargs: t.Any) -> str: (source) ¶

Serialize data as JSON. If :data:`~flask.current_app` is available, it will use its :meth:`app.json.dumps() <flask.json.provider.JSONProvider.dumps>` method, otherwise it will use :func:`json.dumps`. :param obj: The data to serialize. :param kwargs: Arguments passed to the ``dumps`` implementation. .. versionchanged:: 2.2 Calls ``current_app.json.dumps``, allowing an app to override the behavior. .. versionchanged:: 2.2 The ``app`` parameter will be removed in Flask 2.3. .. versionchanged:: 2.0.2 :class:`decimal.Decimal` is supported by converting to a string. .. versionchanged:: 2.0 ``encoding`` will be removed in Flask 2.1. .. versionchanged:: 1.0.3 ``app`` can be passed directly, rather than requiring an app context for configuration.

def dump(obj: t.Any, fp: t.IO[str], *, app: Flask|None = None, **kwargs: t.Any): (source) ¶

Serialize data as JSON and write to a file. If :data:`~flask.current_app` is available, it will use its :meth:`app.json.dump() <flask.json.provider.JSONProvider.dump>` method, otherwise it will use :func:`json.dump`. :param obj: The data to serialize. :param fp: A file opened for writing text. Should use the UTF-8 encoding to be valid JSON. :param kwargs: Arguments passed to the ``dump`` implementation. .. versionchanged:: 2.2 Calls ``current_app.json.dump``, allowing an app to override the behavior. .. versionchanged:: 2.2 The ``app`` parameter will be removed in Flask 2.3. .. versionchanged:: 2.0 Writing to a binary file, and the ``encoding`` argument, will be removed in Flask 2.1.

def loads(s: str|bytes, *, app: Flask|None = None, **kwargs: t.Any) -> t.Any: (source) ¶

Deserialize data as JSON. If :data:`~flask.current_app` is available, it will use its :meth:`app.json.loads() <flask.json.provider.JSONProvider.loads>` method, otherwise it will use :func:`json.loads`. :param s: Text or UTF-8 bytes. :param kwargs: Arguments passed to the ``loads`` implementation. .. versionchanged:: 2.2 Calls ``current_app.json.loads``, allowing an app to override the behavior. .. versionchanged:: 2.2 The ``app`` parameter will be removed in Flask 2.3. .. versionchanged:: 2.0 ``encoding`` will be removed in Flask 2.1. The data must be a string or UTF-8 bytes. .. versionchanged:: 1.0.3 ``app`` can be passed directly, rather than requiring an app context for configuration.

def load(fp: t.IO[t.AnyStr], *, app: Flask|None = None, **kwargs: t.Any) -> t.Any: (source) ¶

Deserialize data as JSON read from a file. If :data:`~flask.current_app` is available, it will use its :meth:`app.json.load() <flask.json.provider.JSONProvider.load>` method, otherwise it will use :func:`json.load`. :param fp: A file opened for reading text or UTF-8 bytes. :param kwargs: Arguments passed to the ``load`` implementation. .. versionchanged:: 2.2 Calls ``current_app.json.load``, allowing an app to override the behavior. .. versionchanged:: 2.2 The ``app`` parameter will be removed in Flask 2.3. .. versionchanged:: 2.0 ``encoding`` will be removed in Flask 2.1. The file must be text mode, or binary mode with UTF-8 bytes.

def htmlsafe_dumps(obj: t.Any, **kwargs: t.Any) -> str: (source) ¶

Serialize an object to a string of JSON with :func:`dumps`, then replace HTML-unsafe characters with Unicode escapes and mark the result safe with :class:`~markupsafe.Markup`. This is available in templates as the ``|tojson`` filter. The returned string is safe to render in HTML documents and ``<script>`` tags. The exception is in HTML attributes that are double quoted; either use single quotes or the ``|forceescape`` filter. .. deprecated:: 2.2 Will be removed in Flask 2.3. This is built-in to Jinja now. .. versionchanged:: 2.0 Uses :func:`jinja2.utils.htmlsafe_json_dumps`. The returned value is marked safe by wrapping in :class:`~markupsafe.Markup`. .. versionchanged:: 0.10 Single quotes are escaped, making this safe to use in HTML, ``<script>`` tags, and single-quoted attributes without further escaping.

def htmlsafe_dump(obj: t.Any, fp: t.IO[str], **kwargs: t.Any): (source) ¶

Serialize an object to JSON written to a file object, replacing HTML-unsafe characters with Unicode escapes. See :func:`htmlsafe_dumps` and :func:`dumps`. .. deprecated:: 2.2 Will be removed in Flask 2.3.

def jsonify(*args: t.Any, **kwargs: t.Any) -> Response: (source) ¶

Serialize the given arguments as JSON, and return a :class:`~flask.Response` object with the ``application/json`` mimetype. A dict or list returned from a view will be converted to a JSON response automatically without needing to call this. This requires an active request or application context, and calls :meth:`app.json.response() <flask.json.provider.JSONProvider.response>`. In debug mode, the output is formatted with indentation to make it easier to read. This may also be controlled by the provider. Either positional or keyword arguments can be given, not both. If no arguments are given, ``None`` is serialized. :param args: A single value to serialize, or multiple values to treat as a list to serialize. :param kwargs: Treat as a dict to serialize. .. versionchanged:: 2.2 Calls ``current_app.json.response``, allowing an app to override the behavior. .. versionchanged:: 2.0.2 :class:`decimal.Decimal` is supported by converting to a string. .. versionchanged:: 0.11 Added support for serializing top-level arrays. This was a security risk in ancient browsers. See :ref:`security-json`. .. versionadded:: 0.2