import io import json as _json import typing as t import uuid import warnings from datetime import date from jinja2.utils import htmlsafe_json_dumps as _jinja_htmlsafe_dumps from werkzeug.http import http_date from ..globals import current_app from ..globals import request if t.TYPE_CHECKING: from ..app import Flask from ..wrappers import Response try: import dataclasses except ImportError: # Python < 3.7 dataclasses = None # type: ignore class JSONEncoder(_json.JSONEncoder): """The default JSON encoder. Handles extra types compared to the built-in :class:`json.JSONEncoder`. - :class:`datetime.datetime` and :class:`datetime.date` are serialized to :rfc:`822` strings. This is the same as the HTTP date format. - :class:`uuid.UUID` is serialized to a string. - :class:`dataclasses.dataclass` is passed to :func:`dataclasses.asdict`. - :class:`~markupsafe.Markup` (or any object with a ``__html__`` method) will call the ``__html__`` method to get a string. Assign a subclass of this to :attr:`flask.Flask.json_encoder` or :attr:`flask.Blueprint.json_encoder` to override the default. """ def default(self, o: t.Any) -> t.Any: """Convert ``o`` to a JSON serializable type. See :meth:`json.JSONEncoder.default`. Python does not support overriding how basic types like ``str`` or ``list`` are serialized, they are handled before this method. """ if isinstance(o, date): return http_date(o) if isinstance(o, uuid.UUID): return str(o) if dataclasses and dataclasses.is_dataclass(o): return dataclasses.asdict(o) if hasattr(o, "__html__"): return str(o.__html__()) return super().default(o) class JSONDecoder(_json.JSONDecoder): """The default JSON decoder. This does not change any behavior from the built-in :class:`json.JSONDecoder`. Assign a subclass of this to :attr:`flask.Flask.json_decoder` or :attr:`flask.Blueprint.json_decoder` to override the default. """ def _dump_arg_defaults( kwargs: t.Dict[str, t.Any], app: t.Optional["Flask"] = None ) -> None: """Inject default arguments for dump functions.""" if app is None: app = current_app if app: cls = app.json_encoder bp = app.blueprints.get(request.blueprint) if request else None # type: ignore if bp is not None and bp.json_encoder is not None: cls = bp.json_encoder kwargs.setdefault("cls", cls) kwargs.setdefault("ensure_ascii", app.config["JSON_AS_ASCII"]) kwargs.setdefault("sort_keys", app.config["JSON_SORT_KEYS"]) else: kwargs.setdefault("sort_keys", True) kwargs.setdefault("cls", JSONEncoder) def _load_arg_defaults( kwargs: t.Dict[str, t.Any], app: t.Optional["Flask"] = None ) -> None: """Inject default arguments for load functions.""" if app is None: app = current_app if app: cls = app.json_decoder bp = app.blueprints.get(request.blueprint) if request else None # type: ignore if bp is not None and bp.json_decoder is not None: cls = bp.json_decoder kwargs.setdefault("cls", cls) else: kwargs.setdefault("cls", JSONDecoder) def dumps(obj: t.Any, app: t.Optional["Flask"] = None, **kwargs: t.Any) -> str: """Serialize an object to a string of JSON. Takes the same arguments as the built-in :func:`json.dumps`, with some defaults from application configuration. :param obj: Object to serialize to JSON. :param app: Use this app's config instead of the active app context or defaults. :param kwargs: Extra arguments passed to :func:`json.dumps`. .. versionchanged:: 2.0 ``encoding`` is deprecated and will be removed in Flask 2.1. .. versionchanged:: 1.0.3 ``app`` can be passed directly, rather than requiring an app context for configuration. """ _dump_arg_defaults(kwargs, app=app) encoding = kwargs.pop("encoding", None) rv = _json.dumps(obj, **kwargs) if encoding is not None: warnings.warn( "'encoding' is deprecated and will be removed in Flask 2.1.", DeprecationWarning, stacklevel=2, ) if isinstance(rv, str): return rv.encode(encoding) # type: ignore return rv def dump( obj: t.Any, fp: t.IO[str], app: t.Optional["Flask"] = None, **kwargs: t.Any ) -> None: """Serialize an object to JSON written to a file object. Takes the same arguments as the built-in :func:`json.dump`, with some defaults from application configuration. :param obj: Object to serialize to JSON. :param fp: File object to write JSON to. :param app: Use this app's config instead of the active app context or defaults. :param kwargs: Extra arguments passed to :func:`json.dump`. .. versionchanged:: 2.0 Writing to a binary file, and the ``encoding`` argument, is deprecated and will be removed in Flask 2.1. """ _dump_arg_defaults(kwargs, app=app) encoding = kwargs.pop("encoding", None) show_warning = encoding is not None try: fp.write("") except TypeError: show_warning = True fp = io.TextIOWrapper(fp, encoding or "utf-8") # type: ignore if show_warning: warnings.warn( "Writing to a binary file, and the 'encoding' argument, is" " deprecated and will be removed in Flask 2.1.", DeprecationWarning, stacklevel=2, ) _json.dump(obj, fp, **kwargs) def loads(s: str, app: t.Optional["Flask"] = None, **kwargs: t.Any) -> t.Any: """Deserialize an object from a string of JSON. Takes the same arguments as the built-in :func:`json.loads`, with some defaults from application configuration. :param s: JSON string to deserialize. :param app: Use this app's config instead of the active app context or defaults. :param kwargs: Extra arguments passed to :func:`json.loads`. .. versionchanged:: 2.0 ``encoding`` is deprecated and 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. """ _load_arg_defaults(kwargs, app=app) encoding = kwargs.pop("encoding", None) if encoding is not None: warnings.warn( "'encoding' is deprecated and will be removed in Flask 2.1." " The data must be a string or UTF-8 bytes.", DeprecationWarning, stacklevel=2, ) if isinstance(s, bytes): s = s.decode(encoding) return _json.loads(s, **kwargs) def load(fp: t.IO[str], app: t.Optional["Flask"] = None, **kwargs: t.Any) -> t.Any: """Deserialize an object from JSON read from a file object. Takes the same arguments as the built-in :func:`json.load`, with some defaults from application configuration. :param fp: File object to read JSON from. :param app: Use this app's config instead of the active app context or defaults. :param kwargs: Extra arguments passed to :func:`json.load`. .. versionchanged:: 2.0 ``encoding`` is deprecated and will be removed in Flask 2.1. The file must be text mode, or binary mode with UTF-8 bytes. """ _load_arg_defaults(kwargs, app=app) encoding = kwargs.pop("encoding", None) if encoding is not None: warnings.warn( "'encoding' is deprecated and will be removed in Flask 2.1." " The file must be text mode, or binary mode with UTF-8" " bytes.", DeprecationWarning, stacklevel=2, ) if isinstance(fp.read(0), bytes): fp = io.TextIOWrapper(fp, encoding) # type: ignore return _json.load(fp, **kwargs) def htmlsafe_dumps(obj: t.Any, **kwargs: t.Any) -> str: """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 ``