Let CLI package use custom Marshmallow Field definitions

flexmeasures/api/__init__.py

@@ -6,9 +6,9 @@
 from flexmeasures import __version__ as flexmeasures_version
 from flexmeasures.data.models.user import User
 from flexmeasures.api.common.utils.args_parsing import (
-    FMValidationError,
     validation_error_handler,
 )
+from flexmeasures.data.schemas.utils import FMValidationError
 
 # The api blueprint. It is registered with the Flask app (see app.py)
 flexmeasures_api = Blueprint("flexmeasures_api", __name__)

flexmeasures/api/common/utils/args_parsing.py

@@ -1,4 +1,5 @@
 from flask import jsonify
+from flexmeasures.data.schemas.utils import FMValidationError
 from webargs.multidictproxy import MultiDictProxy
 from webargs import ValidationError
 from webargs.flaskparser import parser
@@ -18,18 +19,6 @@ def handle_error(error, req, schema, *, error_status_code, error_headers):
     raise error
 
 
-class FMValidationError(ValidationError):
-    """
-    Custom validation error class.
-    It differs from the classic validation error by having two
-    attributes, according to the USEF 2015 reference implementation.
-    Subclasses of this error might adjust the `status` attribute accordingly.
-    """
-
-    result = "Rejected"
-    status = "UNPROCESSABLE_ENTITY"
-
-
 def validation_error_handler(error: FMValidationError):
     """Handles errors during parsing.
     Aborts the current HTTP request and responds with a 422 error.

flexmeasures/api/common/utils/validators.py

@@ -16,7 +16,7 @@
 
 from webargs.flaskparser import parser
 
-from flexmeasures.api.common.schemas.times import DurationField
+from flexmeasures.data.schemas.times import DurationField
 from flexmeasures.api.common.responses import (  # noqa: F401
     required_info_missing,
     invalid_horizon,

flexmeasures/api/dev/sensors.py

@@ -7,7 +7,7 @@
 from webargs.flaskparser import use_kwargs
 from werkzeug.exceptions import abort
 
-from flexmeasures.api.common.schemas.times import AwareDateTimeField
+from flexmeasures.data.schemas.times import AwareDateTimeField
 from flexmeasures.data.models.time_series import Sensor
 
 

flexmeasures/data/models/fields.py

@@ -0,0 +1,10 @@
+import click
+import marshmallow as ma
+
+
+class MarshmallowClickMixin(click.ParamType):
+    def convert(self, value, param, ctx, **kwargs):
+        try:
+            return self.deserialize(value, **kwargs)
+        except ma.exceptions.ValidationError as e:
+            raise click.exceptions.BadParameter(e, ctx=ctx, param=param)

flexmeasures/api/common/schemas/tests/test_times.py → flexmeasures/data/schemas/tests/test_times.py

@@ -4,7 +4,7 @@
 import pytz
 import isodate
 
-from flexmeasures.api.common.schemas.times import DurationField, DurationValidationError
+from flexmeasures.data.schemas.times import DurationField, DurationValidationError
 
 
 @pytest.mark.parametrize(

flexmeasures/api/common/schemas/times.py → flexmeasures/data/schemas/times.py

@@ -6,14 +6,15 @@
 from isodate.isoerror import ISO8601Error
 import pandas as pd
 
-from flexmeasures.api.common.utils.args_parsing import FMValidationError
+from flexmeasures.data.schemas.utils import FMValidationError
+from flexmeasures.data.models.fields import MarshmallowClickMixin
 
 
 class DurationValidationError(FMValidationError):
     status = "INVALID_PERIOD"  # USEF error status
 
 
-class DurationField(fields.Str):
+class DurationField(fields.Str, MarshmallowClickMixin):
     """Field that deserializes to a ISO8601 Duration
     and serializes back to a string."""
 
@@ -64,7 +65,7 @@ def ground_from(
         return duration
 
 
-class AwareDateTimeField(fields.AwareDateTime):
+class AwareDateTimeField(fields.AwareDateTime, MarshmallowClickMixin):
     """Field that deserializes to a timezone aware datetime
     and serializes back to a string."""
 

flexmeasures/data/schemas/utils.py

@@ -0,0 +1,13 @@
+from marshmallow import ValidationError
+
+
+class FMValidationError(ValidationError):
+    """
+    Custom validation error class.
+    It differs from the classic validation error by having two
+    attributes, according to the USEF 2015 reference implementation.
+    Subclasses of this error might adjust the `status` attribute accordingly.
+    """
+
+    result = "Rejected"
+    status = "UNPROCESSABLE_ENTITY"

flexmeasures/ui/views/charts.py

@@ -6,7 +6,7 @@
 
 from flexmeasures.api.v2_0 import flexmeasures_api as flexmeasures_api_v2_0
 from flexmeasures.api.v2_0.routes import v2_0_service_listing
-from flexmeasures.api.common.schemas.times import DurationField
+from flexmeasures.data.schemas.times import DurationField
 from flexmeasures.data.queries.analytics import get_power_data
 from flexmeasures.ui.views.analytics import make_power_figure
 

flexmeasures/ui/views/sensors.py

@@ -5,7 +5,7 @@
 from marshmallow import fields
 from webargs.flaskparser import use_kwargs
 
-from flexmeasures.api.common.schemas.times import AwareDateTimeField
+from flexmeasures.data.schemas.times import AwareDateTimeField
 from flexmeasures.api.dev.sensors import SensorAPI
 from flexmeasures.ui.utils.view_utils import render_flexmeasures_template