Add default field options generation to WtfFieldMixin

Author: insspb

flask_mongoengine/db_fields.py

@@ -43,11 +43,13 @@
 ]
 import decimal
 import warnings
-from typing import Callable, Dict, List, Optional, Type, Union
+from typing import Callable, List, Optional, Type, Union
 
 from bson import ObjectId
 from mongoengine import fields
 
+from flask_mongoengine.decorators import wtf_required
+
 try:
     from wtforms import fields as wtf_fields
     from wtforms import validators as wtf_validators_
@@ -75,7 +77,7 @@ class WtfFieldMixin:
 
     DEFAULT_WTF_FIELD = None
     DEFAULT_WTF_CHOICES_FIELD = wtf_fields.SelectField if wtf_fields else None
-    DEFAULT_WTF_CHOICES_FIELD_COERCE = str
+    DEFAULT_WTF_CHOICES_COERCE = str
 
     def __init__(
         self,
@@ -85,7 +87,8 @@ def __init__(
         wtf_field_class: Optional[Type] = None,
         wtf_filters: Optional[Union[List, Callable]] = None,
         wtf_validators: Optional[Union[List, Callable]] = None,
-        wtf_options: Optional[Dict] = None,
+        wtf_choices_coerce: Optional[Callable] = None,
+        wtf_options: Optional[dict] = None,
         **kwargs,
     ):
         """
@@ -98,6 +101,8 @@ def __init__(
             :attr:`DEFAULT_WTF_FIELD`  and :attr:`DEFAULT_WTF_CHOICES_FIELD`
         :param wtf_filters:     wtf form field filters.
         :param wtf_validators:  wtf form field validators.
+        :param wtf_choices_coerce: Callable function to replace
+            :attr:`DEFAULT_WTF_CHOICES_COERCE` for choices fields.
         :param wtf_options: Dictionary with WTForm Field settings.
             Applied last, takes precedence over any generated field options.
         :param kwargs: keyword arguments silently bypassed to normal mongoengine fields
@@ -131,7 +136,7 @@ def __init__(
             wtf_filters or filters, "wtf_filters"
         )
         self.wtf_options = wtf_options
-
+        self.wtf_choices_coerce = wtf_choices_coerce or self.DEFAULT_WTF_CHOICES_COERCE
         # Some attributes that will be updated by parent methods
         self.required = False
         self.default = None
@@ -140,7 +145,6 @@ def __init__(
 
         # Internals
         self._wtf_field_class = wtf_field_class
-        self._wtf_options = {}
 
         super().__init__(**kwargs)
 
@@ -153,6 +157,47 @@ def wtf_field_class(self):
             return self.DEFAULT_WTF_CHOICES_FIELD
         return self.DEFAULT_WTF_FIELD
 
+    @property
+    @wtf_required
+    def wtf_generated_options(self) -> dict:
+        """
+        WTForm Field options generated by class, not updated by user provided :attr:`wtf_options`.
+        """
+        wtf_field_kwargs: dict = {
+            "label": getattr(self, "verbose_name", self.name),
+            "description": getattr(self, "help_text", None) or "",
+            "default": self.default,
+            # Create a copy of the lists with list() call, since we will be modifying it
+            "validators": list(self.wtf_validators) or [],
+            "filters": list(self.wtf_filters) or [],
+        }
+
+        if self.required:
+            wtf_field_kwargs["validators"].append(wtf_validators_.InputRequired())
+        else:
+            wtf_field_kwargs["validators"].append(wtf_validators_.Optional())
+
+        if self.choices:
+            wtf_field_kwargs["choices"] = self.choices
+            wtf_field_kwargs["coerce"] = self.wtf_choices_coerce
+
+        return wtf_field_kwargs
+
+    @property
+    @wtf_required
+    def wtf_field_options(self):
+        """
+        Final WTForm Field options that will be applied as :attr:`wtf_field_class` kwargs.
+
+        It is not recommended to overwrite this property, for logic update overwrite
+        :attr:`wtf_generated_options`
+        """
+        wtf_field_kwargs = self.wtf_generated_options
+        if self.wtf_options is not None:
+            wtf_field_kwargs.update(self.wtf_options)
+
+        return wtf_field_kwargs
+
     @staticmethod
     def _ensure_callable_or_list(argument, msg_flag: str) -> Optional[List]:
         """
@@ -162,7 +207,7 @@ def _ensure_callable_or_list(argument, msg_flag: str) -> Optional[List]:
         :param msg_flag: Argument string name for error message.
         """
         if argument is None:
-            return None
+            return []
 
         if callable(argument):
             return [argument]
@@ -208,7 +253,7 @@ class BooleanField(WtfFieldMixin, fields.BooleanField):
     """
 
     DEFAULT_WTF_FIELD = wtf_fields.BooleanField if wtf_fields else None
-    DEFAULT_WTF_CHOICES_FIELD_COERCE = bool
+    DEFAULT_WTF_CHOICES_COERCE = bool
 
     def to_wtf_field(self, model, field_kwargs):
         """
@@ -300,7 +345,7 @@ class DecimalField(WtfFieldMixin, fields.DecimalField):
     """
 
     DEFAULT_WTF_FIELD = wtf_fields.DecimalField if wtf_fields else None
-    DEFAULT_WTF_CHOICES_FIELD_COERCE = decimal.Decimal
+    DEFAULT_WTF_CHOICES_COERCE = decimal.Decimal
 
     def to_wtf_field(self, model, field_kwargs):
         """
@@ -451,7 +496,7 @@ class FloatField(WtfFieldMixin, fields.FloatField):
     """
 
     DEFAULT_WTF_FIELD = wtf_fields.FloatField if wtf_fields else None
-    DEFAULT_WTF_CHOICES_FIELD_COERCE = float
+    DEFAULT_WTF_CHOICES_COERCE = float
 
     def to_wtf_field(self, model, field_kwargs):
         """
@@ -573,7 +618,7 @@ class IntField(WtfFieldMixin, fields.IntField):
     """
 
     DEFAULT_WTF_FIELD = wtf_fields.IntegerField if wtf_fields else None
-    DEFAULT_WTF_CHOICES_FIELD_COERCE = int
+    DEFAULT_WTF_CHOICES_COERCE = int
 
     def to_wtf_field(self, model, field_kwargs):
         """
@@ -730,7 +775,7 @@ class ObjectIdField(WtfFieldMixin, fields.ObjectIdField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
-    DEFAULT_WTF_CHOICES_FIELD_COERCE = ObjectId
+    DEFAULT_WTF_CHOICES_COERCE = ObjectId
 
     def to_wtf_field(self, model, field_kwargs):
         """

tests/test_db_fields.py

@@ -100,7 +100,7 @@ def test__init__set_additional_instance_arguments(self, db, mocker: MockerFixtur
     def test__ensure_callable_or_list__return_none_if_argument_is_none(self):
         assert (
             db_fields.WtfFieldMixin._ensure_callable_or_list(argument=None, msg_flag="")
-            is None
+            == []
         )
 
     def test__ensure_callable_or_list__return_callable_argument_as_list(self):