Merge pull request #4675 from tiesjan/2.1.x

Document serialization of Decimal in JSONEncoder
pallets · Jul 6, 2022 · cafe68e · cafe68e
2 parents e4c4fd5 + 9dfcb90
commit cafe68e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -242,6 +242,7 @@ for easier customization. By default it handles some extra data types:
 
 -   :class:`datetime.datetime` and :class:`datetime.date` are serialized
     to :rfc:`822` strings. This is the same as the HTTP date format.
+-   :class:`decimal.Decimal` is serialized to a string.
 -   :class:`uuid.UUID` is serialized to a string.
 -   :class:`dataclasses.dataclass` is passed to
     :func:`dataclasses.asdict`.

diff --git a/src/flask/json/__init__.py b/src/flask/json/__init__.py
@@ -23,6 +23,7 @@ class JSONEncoder(_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:`decimal.Decimal` is serialized to a string.
     -   :class:`uuid.UUID` is serialized to a string.
     -   :class:`dataclasses.dataclass` is passed to
         :func:`dataclasses.asdict`.