Dependencies: Update requirement flask~=2.2 (#6011)

In 508aeda, an upper limit was placed
on the `flask` dependency because `flask==2.2` removed the class
`flask.json.JSONEncoder`.

Here the upper limit is removed and the minimum requirement is updated.
The `JSONEncoder` is replaced with `flask.json.provider.DefaultJSONProvider`.

Co-authored-by: Marnik Bercx <mbercx@gmail.com>
Co-authored-by: Kristjan Eimre <eimrek@users.noreply.github.com>

aiida/restapi/common/utils.py

@@ -12,7 +12,7 @@
 import urllib.parse
 
 from flask import jsonify
-from flask.json import JSONEncoder
+from flask.json.provider import DefaultJSONProvider
 from wrapt import decorator
 
 from aiida.common.exceptions import InputValidationError, ValidationError
@@ -27,43 +27,43 @@
 
 
 ########################## Classes #####################
-class CustomJSONEncoder(JSONEncoder):
+class CustomJSONProvider(DefaultJSONProvider):
     """
     Custom json encoder for serialization.
     This has to be provided to the Flask app in order to replace the default
     encoder.
     """
 
-    def default(self, o):
-        # pylint: disable=method-hidden
+    def default(self, obj, **kwargs):
         """
-        Override default method from JSONEncoder to change serializer
-        :param o: Object e.g. dict, list that will be serialized
-        :return: serialized object
+        Override serialization of ``DefaultJSONProvider`` for ``datetime`` and ``bytes`` objects.
+
+        :param obj: Object e.g. dict, list that will be serialized.
+        :return: Serialized object as a string.
         """
 
         from aiida.restapi.common.config import SERIALIZER_CONFIG
 
         # Treat the datetime objects
-        if isinstance(o, datetime):
+        if isinstance(obj, datetime):
             if 'datetime_format' in SERIALIZER_CONFIG and SERIALIZER_CONFIG['datetime_format'] != 'default':
                 if SERIALIZER_CONFIG['datetime_format'] == 'asinput':
-                    if o.utcoffset() is not None:
-                        o = o - o.utcoffset()
-                        return '-'.join([str(o.year), str(o.month).zfill(2),
-                                         str(o.day).zfill(2)]) + 'T' + \
+                    if obj.utcoffset() is not None:
+                        obj = obj - obj.utcoffset()
+                        return '-'.join([str(obj.year), str(obj.month).zfill(2),
+                                         str(obj.day).zfill(2)]) + 'T' + \
                                ':'.join([str(
-                                   o.hour).zfill(2), str(o.minute).zfill(2),
-                                         str(o.second).zfill(2)])
+                                   obj.hour).zfill(2), str(obj.minute).zfill(2),
+                                         str(obj.second).zfill(2)])
 
         # To support bytes objects, try to decode to a string
         try:
-            return o.decode('utf-8')
+            return obj.decode('utf-8')
         except (UnicodeDecodeError, AttributeError):
             pass
 
         # If not returned yet, do it in the default way
-        return JSONEncoder.default(self, o)
+        return super().default(obj, **kwargs)
 
 
 class Utils:

aiida/restapi/run_api.py

@@ -95,8 +95,8 @@ def configure_api(flask_app=api_classes.App, flask_api=api_classes.AiidaApi, **k
 
     # Configure the serializer
     if config_module.SERIALIZER_CONFIG:
-        from aiida.restapi.common.utils import CustomJSONEncoder
-        app.json_encoder = CustomJSONEncoder
+        from aiida.restapi.common.utils import CustomJSONProvider
+        app.json = CustomJSONProvider(app)
 
     # Set up WSGI profiler if requested
     if wsgi_profile:

docs/source/nitpick-exceptions

@@ -160,7 +160,7 @@ py:class html.parser.HTMLParser
 py:class disk_objectstore.container.Container
 
 py:class flask.app.Flask
-py:class flask.json.JSONEncoder
+py:class Flask
 
 py:class pytest.tmpdir.TempPathFactory
 

pyproject.toml

@@ -70,7 +70,7 @@ ssh_kerberos = [
 rest = [
     "flask-cors~=3.0",
     "flask-restful~=0.3.7",
-    "flask~=2.0,<2.3",
+    "flask~=2.2",
     "pyparsing~=2.4",
     "python-memcached~=1.59",
     "seekpath~=1.9,>=1.9.3"

requirements/requirements-py-3.10.txt

@@ -33,7 +33,7 @@ disk-objectstore==0.6.0
 docstring-parser==0.15.0
 docutils==0.16
 entrypoints==0.3
-Flask==2.0.3
+Flask==2.2.0
 Flask-Cors==3.0.10
 Flask-RESTful==0.3.9
 fonttools==4.28.2

requirements/requirements-py-3.11.txt

@@ -37,7 +37,7 @@ docstring-parser==0.15.0
 docutils==0.16
 emmet-core==0.39.0
 fastjsonschema==2.16.2
-Flask==2.1.3
+Flask==2.2.0
 Flask-Cors==3.0.10
 Flask-RESTful==0.3.9
 fonttools==4.38.0

requirements/requirements-py-3.8.txt

@@ -33,7 +33,7 @@ disk-objectstore==0.6.0
 docstring-parser==0.15.0
 docutils==0.16
 entrypoints==0.3
-Flask==2.0.3
+Flask==2.2.0
 Flask-Cors==3.0.10
 Flask-RESTful==0.3.9
 fonttools==4.28.2

requirements/requirements-py-3.9.txt

@@ -33,7 +33,7 @@ disk-objectstore==0.6.0
 docstring-parser==0.15.0
 docutils==0.16
 entrypoints==0.3
-Flask==2.0.3
+Flask==2.2.0
 Flask-Cors==3.0.10
 Flask-RESTful==0.3.9
 fonttools==4.28.2