Add protection warning to docstrings

Author: insspb

flask_mongoengine/db_fields.py

@@ -115,6 +115,7 @@ class BinaryField(WtfFieldMixin, fields.BinaryField):
     Extends :class:`mongoengine.fields.BinaryField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -131,6 +132,7 @@ class BooleanField(WtfFieldMixin, fields.BooleanField):
     Extends :class:`mongoengine.fields.BooleanField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -147,6 +149,7 @@ class CachedReferenceField(WtfFieldMixin, fields.CachedReferenceField):
     Extends :class:`mongoengine.fields.CachedReferenceField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -163,6 +166,7 @@ class ComplexDateTimeField(WtfFieldMixin, fields.ComplexDateTimeField):
     Extends :class:`mongoengine.fields.ComplexDateTimeField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -179,6 +183,7 @@ class DateField(WtfFieldMixin, fields.DateField):
     Extends :class:`mongoengine.fields.DateField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -195,6 +200,7 @@ class DateTimeField(WtfFieldMixin, fields.DateTimeField):
     Extends :class:`mongoengine.fields.DateTimeField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -211,6 +217,7 @@ class DecimalField(WtfFieldMixin, fields.DecimalField):
     Extends :class:`mongoengine.fields.DecimalField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -227,6 +234,7 @@ class DictField(WtfFieldMixin, fields.DictField):
     Extends :class:`mongoengine.fields.DictField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -243,6 +251,7 @@ class DynamicField(WtfFieldMixin, fields.DynamicField):
     Extends :class:`mongoengine.fields.DynamicField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -259,6 +268,7 @@ class EmailField(WtfFieldMixin, fields.EmailField):
     Extends :class:`mongoengine.fields.EmailField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -275,6 +285,7 @@ class EmbeddedDocumentField(WtfFieldMixin, fields.EmbeddedDocumentField):
     Extends :class:`mongoengine.fields.EmbeddedDocumentField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -291,6 +302,7 @@ class EmbeddedDocumentListField(WtfFieldMixin, fields.EmbeddedDocumentListField)
     Extends :class:`mongoengine.fields.EmbeddedDocumentListField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -307,6 +319,7 @@ class EnumField(WtfFieldMixin, fields.EnumField):
     Extends :class:`mongoengine.fields.EnumField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -323,6 +336,7 @@ class FileField(WtfFieldMixin, fields.FileField):
     Extends :class:`mongoengine.fields.FileField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -339,6 +353,7 @@ class FloatField(WtfFieldMixin, fields.FloatField):
     Extends :class:`mongoengine.fields.FloatField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -355,6 +370,7 @@ class GenericEmbeddedDocumentField(WtfFieldMixin, fields.GenericEmbeddedDocument
     Extends :class:`mongoengine.fields.GenericEmbeddedDocumentField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -371,6 +387,7 @@ class GenericLazyReferenceField(WtfFieldMixin, fields.GenericLazyReferenceField)
     Extends :class:`mongoengine.fields.GenericLazyReferenceField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -387,6 +404,7 @@ class GenericReferenceField(WtfFieldMixin, fields.GenericReferenceField):
     Extends :class:`mongoengine.fields.GenericReferenceField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -403,6 +421,7 @@ class GeoJsonBaseField(WtfFieldMixin, fields.GeoJsonBaseField):
     Extends :class:`mongoengine.fields.GeoJsonBaseField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -419,6 +438,7 @@ class GeoPointField(WtfFieldMixin, fields.GeoPointField):
     Extends :class:`mongoengine.fields.GeoPointField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -435,6 +455,7 @@ class ImageField(WtfFieldMixin, fields.ImageField):
     Extends :class:`mongoengine.fields.ImageField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -451,6 +472,7 @@ class IntField(WtfFieldMixin, fields.IntField):
     Extends :class:`mongoengine.fields.IntField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -467,6 +489,7 @@ class LazyReferenceField(WtfFieldMixin, fields.LazyReferenceField):
     Extends :class:`mongoengine.fields.LazyReferenceField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -483,6 +506,7 @@ class LineStringField(WtfFieldMixin, fields.LineStringField):
     Extends :class:`mongoengine.fields.LineStringField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -499,6 +523,7 @@ class ListField(WtfFieldMixin, fields.ListField):
     Extends :class:`mongoengine.fields.ListField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -515,6 +540,7 @@ class LongField(WtfFieldMixin, fields.LongField):
     Extends :class:`mongoengine.fields.LongField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -531,6 +557,7 @@ class MapField(WtfFieldMixin, fields.MapField):
     Extends :class:`mongoengine.fields.MapField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -547,6 +574,7 @@ class MultiLineStringField(WtfFieldMixin, fields.MultiLineStringField):
     Extends :class:`mongoengine.fields.MultiLineStringField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -563,6 +591,7 @@ class MultiPointField(WtfFieldMixin, fields.MultiPointField):
     Extends :class:`mongoengine.fields.MultiPointField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -579,6 +608,7 @@ class MultiPolygonField(WtfFieldMixin, fields.MultiPolygonField):
     Extends :class:`mongoengine.fields.MultiPolygonField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -595,6 +625,7 @@ class ObjectIdField(WtfFieldMixin, fields.ObjectIdField):
     Extends :class:`mongoengine.fields.ObjectIdField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -611,6 +642,7 @@ class PointField(WtfFieldMixin, fields.PointField):
     Extends :class:`mongoengine.fields.PointField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -627,6 +659,7 @@ class PolygonField(WtfFieldMixin, fields.PolygonField):
     Extends :class:`mongoengine.fields.PolygonField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -643,6 +676,7 @@ class ReferenceField(WtfFieldMixin, fields.ReferenceField):
     Extends :class:`mongoengine.fields.ReferenceField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -659,6 +693,7 @@ class SequenceField(WtfFieldMixin, fields.SequenceField):
     Extends :class:`mongoengine.fields.SequenceField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -675,6 +710,7 @@ class SortedListField(WtfFieldMixin, fields.SortedListField):
     Extends :class:`mongoengine.fields.SortedListField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -691,6 +727,7 @@ class StringField(WtfFieldMixin, fields.StringField):
     Extends :class:`mongoengine.fields.StringField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -707,6 +744,7 @@ class URLField(WtfFieldMixin, fields.URLField):
     Extends :class:`mongoengine.fields.URLField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):
@@ -723,6 +761,7 @@ class UUIDField(WtfFieldMixin, fields.UUIDField):
     Extends :class:`mongoengine.fields.UUIDField` with wtf required parameters.
 
     For full list of arguments and keyword arguments, look parent field docs.
+    All arguments should be passed as keyword arguments, to exclude unexpected behaviour.
     """
 
     def to_wtf_field(self, model, field_kwargs):