Copy fields generation basic parameters from orm.py (For existed fields)

Author: insspb

flask_mongoengine/db_fields.py

@@ -41,14 +41,19 @@
     "URLField",
     "UUIDField",
 ]
+import decimal
 from typing import Callable, List, Optional, Union
 
+from bson import ObjectId
 from mongoengine import fields
 
 try:
     from wtforms import fields as wtf_fields
     from wtforms import validators as wtf_validators
+
+    from flask_mongoengine.wtf import fields as custom_fields
 except ImportError:  # pragma: no cover
+    custom_fields = None
     wtf_fields = None
     wtf_validators = None
 
@@ -57,22 +62,34 @@ class WtfFieldMixin:
     """
     Extension wrapper class for mongoengine BaseField.
 
-    This enables flask-mongoengine  wtf to extend the
-    number of field parameters, and settings on behalf
-    of document model form generator for WTForm.
+    This enables flask-mongoengine wtf to extend the number of field parameters, and
+    settings on behalf of document model form generator for WTForm.
+
+    **Class variables:**
 
-    :param validators:  wtf model form field validators.
-    :param filters:     wtf model form field filters.
-    :param kwargs: keyword arguments silently bypassed to normal mongoengine fields
+    :cvar DEFAULT_WTF_CHOICES_FIELD: Default WTForms Field used for db fields when
+        **choices** option specified.
+    :cvar DEFAULT_WTF_FIELD: Default WTForms Field used for db field.
     """
 
+    DEFAULT_WTF_FIELD = None
+    DEFAULT_WTF_CHOICES_FIELD = wtf_fields.SelectField if wtf_fields else None
+    DEFAULT_WTF_CHOICES_FIELD_COERCE = str
+
     def __init__(
         self,
         *,
         validators: Optional[Union[List, Callable]] = None,
         filters: Optional[Union[List, Callable]] = None,
         **kwargs,
     ):
+        """
+        Extended :func:`__init__` method for mongoengine db field with WTForms options.
+
+        :param validators:  wtf model form field validators.
+        :param filters:     wtf model form field filters.
+        :param kwargs: keyword arguments silently bypassed to normal mongoengine fields
+        """
         self.validators = self._ensure_callable_or_list(validators, "validators")
         self.filters = self._ensure_callable_or_list(filters, "filters")
 
@@ -118,6 +135,8 @@ class BinaryField(WtfFieldMixin, fields.BinaryField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = custom_fields.BinaryField if custom_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -135,6 +154,9 @@ class BooleanField(WtfFieldMixin, fields.BooleanField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.BooleanField if wtf_fields else None
+    DEFAULT_WTF_CHOICES_FIELD_COERCE = bool
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -186,6 +208,8 @@ class DateField(WtfFieldMixin, fields.DateField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.DateField if wtf_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -203,6 +227,8 @@ class DateTimeField(WtfFieldMixin, fields.DateTimeField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.DateTimeField if wtf_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -220,6 +246,9 @@ class DecimalField(WtfFieldMixin, fields.DecimalField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.DecimalField if wtf_fields else None
+    DEFAULT_WTF_CHOICES_FIELD_COERCE = decimal.Decimal
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -237,6 +266,8 @@ class DictField(WtfFieldMixin, fields.DictField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = custom_fields.DictField if custom_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -269,8 +300,14 @@ class EmailField(WtfFieldMixin, fields.EmailField):
 
     For full list of arguments and keyword arguments, look parent field docs.
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
+
+    .. versionchanged:: 2.0.0
+        Default field output changed from :class:`.NoneStringField` to
+        :class:`wtforms.fields.EmailField`
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.EmailField if wtf_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -288,6 +325,8 @@ class EmbeddedDocumentField(WtfFieldMixin, fields.EmbeddedDocumentField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.FormField if wtf_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -339,6 +378,8 @@ class FileField(WtfFieldMixin, fields.FileField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.FileField if wtf_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -356,6 +397,9 @@ class FloatField(WtfFieldMixin, fields.FloatField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.FloatField if wtf_fields else None
+    DEFAULT_WTF_CHOICES_FIELD_COERCE = float
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -475,6 +519,9 @@ class IntField(WtfFieldMixin, fields.IntField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.IntegerField if wtf_fields else None
+    DEFAULT_WTF_CHOICES_FIELD_COERCE = int
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -526,6 +573,8 @@ class ListField(WtfFieldMixin, fields.ListField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.FieldList if wtf_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -628,6 +677,8 @@ class ObjectIdField(WtfFieldMixin, fields.ObjectIdField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_CHOICES_FIELD_COERCE = ObjectId
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -679,6 +730,8 @@ class ReferenceField(WtfFieldMixin, fields.ReferenceField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = custom_fields.ModelSelectField if custom_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -713,6 +766,8 @@ class SortedListField(WtfFieldMixin, fields.SortedListField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.FieldList if wtf_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -730,6 +785,8 @@ class StringField(WtfFieldMixin, fields.StringField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = wtf_fields.TextAreaField if wtf_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.
@@ -747,6 +804,8 @@ class URLField(WtfFieldMixin, fields.URLField):
     All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
+    DEFAULT_WTF_FIELD = custom_fields.NoneStringField if custom_fields else None
+
     def to_wtf_field(self, model, field_kwargs):
         """
         Protection from execution of :func:`to_wtf_field` in form generation.