Deprecate validators and filters keyword arguments

Author: insspb

flask_mongoengine/db_fields.py

@@ -42,6 +42,7 @@
     "UUIDField",
 ]
 import decimal
+import warnings
 from typing import Callable, List, Optional, Union
 
 from bson import ObjectId
@@ -81,17 +82,47 @@ def __init__(
         *,
         validators: Optional[Union[List, Callable]] = None,
         filters: Optional[Union[List, Callable]] = None,
+        wtf_filters: Optional[Union[List, Callable]] = None,
+        wtf_validators: 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 filters:     DEPRECATED: wtf form field filters.
+        :param validators:  DEPRECATED: wtf form field validators.
+        :param wtf_filters:     wtf form field filters.
+        :param wtf_validators:  wtf form field validators.
         :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")
+        if validators is not None:
+            warnings.warn(
+                (
+                    "Passing 'validators' keyword argument to field definition is "
+                    "deprecated and will be removed in version 3.0.0. "
+                    "Please rename 'validators' to 'wtf_validators'. "
+                    "If both values set, 'wtf_validators' is used."
+                ),
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        if filters is not None:
+            warnings.warn(
+                (
+                    "Passing 'filters' keyword argument to field definition is "
+                    "deprecated and will be removed in version 3.0.0. "
+                    "Please rename 'filters' to 'wtf_filters'. "
+                    "If both values set, 'wtf_filters' is used."
+                ),
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        self.wtf_validators = self._ensure_callable_or_list(
+            wtf_validators or validators, "wtf_validators"
+        )
+        self.wtf_filters = self._ensure_callable_or_list(
+            wtf_filters or filters, "wtf_filters"
+        )
 
         # Some attributes that will be updated by parent methods
         self.required = False

flask_mongoengine/wtf/orm.py

@@ -55,8 +55,12 @@ def _generate_convert_base_kwargs(self, field, field_args) -> dict:
         kwargs: dict = {
             "label": getattr(field, "verbose_name", field.name),
             "description": getattr(field, "help_text", None) or "",
-            "validators": getattr(field, "validators", None) or [],
-            "filters": getattr(field, "filters", None) or [],
+            "validators": getattr(field, "wtf_validators", None)
+            or getattr(field, "validators", None)
+            or [],
+            "filters": getattr(field, "wtf_filters", None)
+            or getattr(field, "filters", None)
+            or [],
             "default": field.default,
         }
         if field_args:

tests/test_db_fields.py

@@ -92,8 +92,8 @@ def test__init__set_additional_instance_arguments(self, db, mocker: MockerFixtur
         checker_spy = mocker.spy(db_fields.WtfFieldMixin, "_ensure_callable_or_list")
 
         string = db.StringField(validators=[1, 2], filters=[1, 2])
-        assert string.validators == [1, 2]
-        assert string.filters == [1, 2]
+        assert string.wtf_validators == [1, 2]
+        assert string.wtf_filters == [1, 2]
         checker_spy.assert_called()
         assert checker_spy.call_count == 2