WTF module API

This is the flask_mongoengine WTF module API documentation.

flask_mongoengine.wtf.fields module

Flask-mongoengine with Flask models.

class flask_mongoengine.wtf.fields.MongoBooleanField(**kwargs)

Extends wtforms.fields.BooleanField. Handles None values correctly for MongoEngine boolean fields.

class flask_mongoengine.wtf.fields.MongoDateField(**kwargs)

Extends wtforms.fields.DateField. Handles None values correctly for MongoEngine date fields.

class flask_mongoengine.wtf.fields.MongoDateTimeField(**kwargs)

Extends wtforms.fields.DateTimeField. Handles None values correctly for MongoEngine datetime fields.

class flask_mongoengine.wtf.fields.MongoDecimalField(**kwargs)

Extends wtforms.fields.DecimalField. Handles None values correctly for MongoEngine decimal fields.

class flask_mongoengine.wtf.fields.MongoEmailField(**kwargs)

Extends wtforms.fields.EmailField. Handles None values and empty strings correctly.

class flask_mongoengine.wtf.fields.MongoFileField(**kwargs)

Extends wtforms.fields.FileField for MongoEngine GridFS file fields.

class flask_mongoengine.wtf.fields.MongoFloatField(**kwargs)

Extends wtforms.fields.FloatField with 'numbers' input type. Handles None values correctly.

class flask_mongoengine.wtf.fields.MongoIntField(**kwargs)

Extends wtforms.fields.IntegerField. Handles None values correctly for MongoEngine integer fields.

class flask_mongoengine.wtf.fields.MongoPasswordField(**kwargs)

Extends wtforms.fields.PasswordField. Handles None values and empty strings correctly.

class flask_mongoengine.wtf.fields.MongoSelectField(**kwargs)

Extends wtforms.fields.SelectField. Used for MongoEngine fields with choices option.

class flask_mongoengine.wtf.fields.MongoSelectMultipleField(**kwargs)

Extends wtforms.fields.SelectMultipleField. Used for MongoEngine list fields with choices and multiple option.

class flask_mongoengine.wtf.fields.MongoStringField(**kwargs)

Extends wtforms.fields.StringField. Handles None values and empty strings correctly. Used for StringField with max_length set.

class flask_mongoengine.wtf.fields.MongoTelField(**kwargs)

Extends MongoStringField with telephone input type.

class flask_mongoengine.wtf.fields.MongoTextAreaField(**kwargs)

Extends wtforms.fields.TextAreaField. Default field for StringField without max_length. Handles None values and empty strings correctly.

class flask_mongoengine.wtf.fields.MongoURLField(**kwargs)

Extends wtforms.fields.URLField. Handles None values and empty strings correctly.

class flask_mongoengine.wtf.fields.EmptyStringIsNoneMixin

Mixin that converts empty string values to None. Used as base for all Mongo string-based form fields. Can be used for custom field types.

flask_mongoengine.wtf.models module

class flask_mongoengine.wtf.models.ModelForm(formdata=None, obj=None, prefix='', data=None, meta=None, **kwargs)

A WTForms Form subclass with MongoEngine model support. Provides the save() method to persist form data to the database.

save(commit=True)

Save the model instance to the database.

Parameters:: commit — If True, calls .save() on the model instance before returning it.

Returns: The saved (or unsaved) model instance.

flask_mongoengine.wtf.orm module

function flask_mongoengine.wtf.orm.model_form(model, base_class=ModelForm, only=None, exclude=None, field_args=None, converter=None)

Create a WTForms Form class from a MongoEngine Document class.

Parameters:: model — The MongoEngine Document class.; base_class — The base form class. Defaults to ModelForm.; only — An optional iterable with field names to include.; exclude — An optional iterable with field names to exclude.; field_args — An optional dictionary of field name to keyword arguments for the form field.; converter — A custom field converter instance.

Returns: A ModelForm subclass.

function flask_mongoengine.wtf.orm.model_fields(model, only=None, exclude=None, field_args=None, converter=None)

Generate a dictionary of WTForms fields from a MongoEngine Document class. Similar to model_form but returns a field dictionary instead of a Form class.

Module contents

The flask_mongoengine.wtf package exposes the following at module level:

model_form — Generate a WTForms Form from a MongoEngine Document.
model_fields — Generate WTForms fields dict from a MongoEngine Document.

← Previous Next →