Merge pull request #491 from MongoEngine/deprecate_orm

Deprecated: ORM module and forms generation with model_form, model_fields

Author: insspb

flask_mongoengine/decorators.py

@@ -1,5 +1,7 @@
+"""Collection of project wide decorators."""
 import functools
 import logging
+import warnings
 
 try:
     import wtforms  # noqa
@@ -23,3 +25,25 @@ def wrapped(*args, **kwargs):
         return func(*args, **kwargs)
 
     return wrapped
+
+
+def orm_deprecated(func):
+    """Warning about usage of deprecated functions, that will be removed in the future."""
+
+    @functools.wraps(func)
+    def wrapped(*args, **kwargs):
+        # TODO: Insert URL
+        warnings.warn(
+            (
+                f"ORM module and function '{func.__name__}' are deprecated and will be "
+                "removed in version 3.0.0. Please switch to form generation from full "
+                "model nesting. Support and bugfixes are not available for stalled code. "
+                "Please read: "
+            ),
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
+        return func(*args, **kwargs)
+
+    return wrapped

flask_mongoengine/wtf/orm.py

@@ -11,6 +11,7 @@
 from wtforms import fields as f
 from wtforms import validators
 
+from flask_mongoengine.decorators import orm_deprecated
 from flask_mongoengine.wtf.fields import (
     BinaryField,
     DictField,
@@ -26,6 +27,7 @@
 )
 
 
+@orm_deprecated
 def converts(*args):
     def _inner(func):
         func._converter_for = frozenset(args)
@@ -35,6 +37,7 @@ def _inner(func):
 
 
 class ModelConverter(object):
+    @orm_deprecated
     def __init__(self, converters=None):
         if not converters:
             converters = {}
@@ -47,6 +50,7 @@ def __init__(self, converters=None):
 
         self.converters = converters
 
+    @orm_deprecated
     def _generate_convert_base_kwargs(self, field, field_args) -> dict:
         kwargs: dict = {
             "label": getattr(field, "verbose_name", field.name),
@@ -70,6 +74,7 @@ def _generate_convert_base_kwargs(self, field, field_args) -> dict:
 
         return kwargs
 
+    @orm_deprecated
     def _process_convert_for_choice_fields(self, field, field_class, kwargs):
         kwargs["choices"] = field.choices
         kwargs["coerce"] = self.coerce(field_class)
@@ -79,6 +84,7 @@ def _process_convert_for_choice_fields(self, field, field_class, kwargs):
             return f.RadioField(**kwargs)
         return f.SelectField(**kwargs)
 
+    @orm_deprecated
     def convert(self, model, field, field_args):
         if hasattr(field, "to_form_field"):
             return field.to_form_field(model, field_args)
@@ -235,6 +241,7 @@ def conv_GenericReference(self, model, field, kwargs):
     def conv_File(self, model, field, kwargs):
         return f.FileField(**kwargs)
 
+    @orm_deprecated
     def coerce(self, field_type):
         coercions = {
             "IntField": int,
@@ -246,6 +253,7 @@ def coerce(self, field_type):
         return coercions.get(field_type, str)
 
 
+@orm_deprecated
 def _get_fields_names(
     model,
     only: Optional[List[str]],
@@ -269,6 +277,7 @@ def _get_fields_names(
     return field_names
 
 
+@orm_deprecated
 def model_fields(
     model: Type[BaseDocument],
     only: Optional[List[str]] = None,
@@ -300,6 +309,7 @@ def model_fields(
     return form_fields_dict
 
 
+@orm_deprecated
 def model_form(
     model: Type[BaseDocument],
     base_class: Type[ModelForm] = ModelForm,

tests/test_decorators.py

@@ -0,0 +1,17 @@
+"""Tests for project wide decorators."""
+from flask_mongoengine.decorators import orm_deprecated
+
+
+def test__orm_deprecated(recwarn):
+    @orm_deprecated
+    def func(a, b):
+        """Function example."""
+        return a + b
+
+    assert func(1, 1) == 2
+    assert str(recwarn.list[0].message) == (
+        "ORM module and function 'func' are deprecated and will be removed in version 3.0.0. "
+        "Please switch to form generation from full model nesting. "
+        "Support and bugfixes are not available for stalled code. "
+        "Please read: "
+    )