Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow overriding field classes in ModelConverter #14

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow overriding field classes in ModelConverter #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 23 additions & 2 deletions tests/tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from wtforms.compat import text_type, iteritems
from wtforms_sqlalchemy.fields import QuerySelectField, QuerySelectMultipleField
from wtforms import Form, fields
from wtforms_sqlalchemy.orm import model_form, ModelConversionError, ModelConverter
from wtforms_sqlalchemy.orm import model_form, ModelConversionError, ModelConverter, converts
from wtforms.validators import Optional, Required, Regexp
from .common import DummyPostData, contains_validator

Expand All @@ -34,6 +34,21 @@ class AnotherInteger(sqla_types.Integer):
"""Use me to test if MRO works like we want"""


class FancyStringField(fields.StringField):
"""Use me to test overriding field classes"""


class FancyModelConverter(ModelConverter):
@converts('String')
def conv_String(
self, column, field_args,
field_class=FancyStringField,
**extra,
):
return super().conv_String(
column, field_args, field_class=field_class, **extra)


class TestBase(TestCase):
def _do_tables(self, mapper, engine):
metadata = MetaData()
Expand Down Expand Up @@ -107,7 +122,6 @@ class F(Form):
)
self.assertEqual(form.a(), [])


def test_with_query_factory(self):
sess = self.Session()
self._fill(sess)
Expand Down Expand Up @@ -429,6 +443,13 @@ def test_convert_types(self):

assert isinstance(form.date, fields.DateField)

def test_override_types(self):
converter = FancyModelConverter()
F = model_form(self.AllTypesModel, only=['string', 'integer'], converter=converter)
f = F()
assert isinstance(f.string, FancyStringField)
assert isinstance(f.integer, fields.IntegerField)


@skipIf(
sys.version_info < (3, 6),
Expand Down
113 changes: 85 additions & 28 deletions wtforms_sqlalchemy/orm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from wtforms import fields as wtforms_fields
from wtforms import validators
from wtforms.form import Form

from .fields import QuerySelectField, QuerySelectMultipleField

__all__ = (
Expand Down Expand Up @@ -161,86 +162,142 @@ def _string_common(cls, column, field_args, **extra):
field_args['validators'].append(validators.Length(max=column.type.length))

@converts('String') # includes Unicode
def conv_String(self, column, field_args, **extra):
def conv_String(
self, column, field_args, *,
field_class=wtforms_fields.StringField,
**extra,
):
self._string_common(column=column, field_args=field_args, **extra)
self._nullable_required(column=column, field_args=field_args, **extra)
return wtforms_fields.StringField(**field_args)
return field_class(**field_args)

@converts('Text', 'LargeBinary', 'Binary') # includes UnicodeText
def conv_Text(self, column, field_args, **extra):
def conv_Text(
self, column, field_args, *,
field_class=wtforms_fields.TextAreaField,
**extra,
):
self._string_common(column=column, field_args=field_args, **extra)
self._nullable_required(column=column, field_args=field_args, **extra)
return wtforms_fields.TextAreaField(**field_args)
return field_class(**field_args)

@converts('Boolean', 'dialects.mssql.base.BIT')
def conv_Boolean(self, column, field_args, **extra):
return wtforms_fields.BooleanField(**field_args)
def conv_Boolean(
self, column, field_args, *,
field_class=wtforms_fields.BooleanField,
**extra,
):
return field_class(**field_args)

@converts('Date')
def conv_Date(self, column, field_args, **extra):
def conv_Date(
self, column, field_args, *,
field_class=wtforms_fields.DateField,
**extra,
):
self._nullable_required(column=column, field_args=field_args, **extra)
return wtforms_fields.DateField(**field_args)
return field_class(**field_args)

@converts('DateTime')
def conv_DateTime(self, column, field_args, **extra):
def conv_DateTime(
self, column, field_args, *,
field_class=wtforms_fields.DateTimeField,
**extra,
):
self._nullable_required(column=column, field_args=field_args, **extra)
return wtforms_fields.DateTimeField(**field_args)
return field_class(**field_args)

@converts('Enum')
def conv_Enum(self, column, field_args, **extra):
def conv_Enum(
self, column, field_args, *,
field_class=wtforms_fields.SelectField,
**extra,
):
self._nullable_required(column=column, field_args=field_args, **extra)
field_args['choices'] = [(e, e) for e in column.type.enums]
return wtforms_fields.SelectField(**field_args)
return field_class(**field_args)

@converts('Integer') # includes BigInteger and SmallInteger
def handle_integer_types(self, column, field_args, **extra):
def handle_integer_types(
self, column, field_args, *,
field_class=wtforms_fields.IntegerField,
**extra,
):
self._nullable_required(column=column, field_args=field_args, **extra)
unsigned = getattr(column.type, 'unsigned', False)
if unsigned:
field_args['validators'].append(validators.NumberRange(min=0))
return wtforms_fields.IntegerField(**field_args)
return field_class(**field_args)

@converts('Numeric') # includes DECIMAL, Float/FLOAT, REAL, and DOUBLE
def handle_decimal_types(self, column, field_args, **extra):
def handle_decimal_types(
self, column, field_args, *,
field_class=wtforms_fields.DecimalField,
**extra,
):
self._nullable_required(column=column, field_args=field_args, **extra)
# override default decimal places limit, use database defaults instead
field_args.setdefault('places', None)
return wtforms_fields.DecimalField(**field_args)
return field_class(**field_args)

@converts('dialects.mysql.types.YEAR', 'dialects.mysql.base.YEAR')
def conv_MSYear(self, column, field_args, **extra):
def conv_MSYear(
self, column, field_args, *,
field_class=wtforms_fields.StringField,
**extra,
):
self._nullable_required(column=column, field_args=field_args, **extra)
field_args['validators'].append(validators.NumberRange(min=1901, max=2155))
return wtforms_fields.StringField(**field_args)
return field_class(**field_args)

@converts('dialects.postgresql.base.INET')
def conv_PGInet(self, column, field_args, **extra):
def conv_PGInet(
self, column, field_args, *,
field_class=wtforms_fields.StringField,
**extra,
):
self._nullable_required(column=column, field_args=field_args, **extra)
field_args.setdefault('label', 'IP Address')
field_args['validators'].append(validators.IPAddress())
return wtforms_fields.StringField(**field_args)
return field_class(**field_args)

@converts('dialects.postgresql.base.MACADDR')
def conv_PGMacaddr(self, column, field_args, **extra):
def conv_PGMacaddr(
self, column, field_args, *,
field_class=wtforms_fields.StringField,
**extra,
):
self._nullable_required(column=column, field_args=field_args, **extra)
field_args.setdefault('label', 'MAC Address')
field_args['validators'].append(validators.MacAddress())
return wtforms_fields.StringField(**field_args)
return field_class(**field_args)

@converts('dialects.postgresql.base.UUID')
def conv_PGUuid(self, column, field_args, **extra):
def conv_PGUuid(
self, column, field_args, *,
field_class=wtforms_fields.StringField,
**extra,
):
self._nullable_required(column=column, field_args=field_args, **extra)
field_args.setdefault('label', 'UUID')
field_args['validators'].append(validators.UUID())
return wtforms_fields.StringField(**field_args)
return field_class(**field_args)

@converts('MANYTOONE')
def conv_ManyToOne(self, column, field_args, **extra):
return QuerySelectField(**field_args)
def conv_ManyToOne(
self, column, field_args, *,
field_class=QuerySelectField,
**extra,
):
return field_class(**field_args)

@converts('MANYTOMANY', 'ONETOMANY')
def conv_ManyToMany(self, column, field_args, **extra):
return QuerySelectMultipleField(**field_args)
def conv_ManyToMany(
self, column, field_args, *,
field_class=QuerySelectMultipleField,
**extra,
):
return field_class(**field_args)


def model_fields(model, db_session=None, only=None, exclude=None,
Expand Down