Use new tri.declarative major

Author: boxed

HISTORY.rst

@@ -1,10 +1,21 @@
 Changelog
 ---------
 
+6.0.0 (2019-04-12)
+~~~~~~~~~~~~~~~~~~
+
+* Make `Field` shortcuts compatible with subclassing. Previous fix didn't work all the way.
+
+* Use the new major tri.declarative, and update to follow the new style of class member shortcuts
+
+* Major fixes to how `from_model` works. Subclassing `Form` and `Field` now works like you'd expect. This is a breaking change.
+
+* Removed `Field.comma_separated` shortcut. This was never used, and poorly tested.
+
 5.4.0 (2019-04-01)
 ~~~~~~~~~~~~~~~~~~
 
-* Make Field shortcuts compatible with subclassing
+* Make `Field` shortcuts compatible with subclassing
 
 
 5.3.1 (2019-03-20)

lib/tri/form/__init__.py

@@ -181,7 +181,7 @@ def member_from_model(cls, model, factory_lookup, defaults_factory, factory_look
                 factory_lookup=factory_lookup,
                 defaults_factory=defaults_factory,
                 factory_lookup_register_function=factory_lookup_register_function,
-                field_name=sub_field_name,
+                field_name=field_path_rest,
                 **kwargs)
             result.name = field_name
             result.attr = field_name
@@ -191,6 +191,7 @@ def member_from_model(cls, model, factory_lookup, defaults_factory, factory_look
         kwargs,
         defaults_factory(model_field),
         name=field_name,
+        call_target__cls=cls,
     )
 
     factory = factory_lookup.get(type(model_field), MISSING)
@@ -207,16 +208,9 @@ def member_from_model(cls, model, factory_lookup, defaults_factory, factory_look
             message += ' Register a factory with %s, you can also register one that returns None to not handle this field type' % factory_lookup_register_function.__name__
         raise AssertionError(message)
 
-    def call_target(*call_target_args, **call_target_kwargs):
-        class_call_target = call_target_kwargs.pop('class_call_target', None)
-        if class_call_target:
-            return getattr(cls, class_call_target)(*call_target_args, **call_target_kwargs)
-        else:
-            return cls(*call_target_args, **call_target_kwargs)
-
     if factory:
         factory = evaluate(factory, model_field=model_field, field_name=field_name)
-    return factory(call_target=call_target, model_field=model_field, model=model, **kwargs) if factory else None
+    return factory(model_field=model_field, model=model, **kwargs) if factory is not None else None
 
 
 @dispatch(
@@ -967,7 +961,7 @@ def _choice_post_validation(form, field):
 
     @classmethod
     @class_shortcut(
-        class_call_target="choice",
+        call_target__attribute="choice",
         choices=[True, False],
         parse=choice_parse,
         choice_to_option=lambda form, field, choice, **_: (
@@ -983,7 +977,7 @@ def boolean_tristate(cls, call_target=None, **kwargs):
 
     @classmethod
     @class_shortcut(
-        class_call_target="choice",
+        call_target__attribute="choice",
         parse=choice_queryset_parse,
         choice_to_option=choice_queryset_choice_to_option,
         endpoint_path=choice_queryset_endpoint_path,
@@ -1011,7 +1005,7 @@ def choice_queryset(cls, choices, call_target=None, **kwargs):
 
     @classmethod
     @class_shortcut(
-        class_call_target="choice",
+        call_target__attribute="choice",
         attrs__multiple=True,
         choice_to_option=multi_choice_choice_to_option,
         is_list=True,
@@ -1021,7 +1015,7 @@ def multi_choice(cls, call_target=None, **kwargs):
 
     @classmethod
     @class_shortcut(
-        class_call_target="choice_queryset",
+        call_target__attribute="choice_queryset",
         attrs__multiple=True,
         choice_to_option=multi_choice_queryset_choice_to_option,
         is_list=True,
@@ -1031,7 +1025,7 @@ def multi_choice_queryset(cls, call_target=None, **kwargs):
 
     @classmethod
     @class_shortcut(
-        class_call_target="choice",
+        call_target__attribute="choice",
         input_template='tri_form/radio.html',
     )
     def radio(cls, call_target=None, **kwargs):
@@ -1131,7 +1125,7 @@ def phone_number(cls, call_target=None, **kwargs):
 
     @classmethod
     @class_shortcut(
-        class_call_target='choice_queryset',
+        call_target__attribute='choice_queryset',
     )
     def foreign_key(cls, model_field, model, call_target, **kwargs):
         del model
@@ -1143,7 +1137,7 @@ def foreign_key(cls, model_field, model, call_target, **kwargs):
 
     @classmethod
     @class_shortcut(
-        class_call_target='multi_choice_queryset',
+        call_target__attribute='multi_choice_queryset',
     )
     def many_to_many(cls, call_target, model_field, **kwargs):
         setdefaults_path(
@@ -1156,50 +1150,6 @@ def many_to_many(cls, call_target, model_field, **kwargs):
         kwargs['model'] = model_field.remote_field.model
         return call_target(model_field=model_field, **kwargs)
 
-    @classmethod
-    @class_shortcut(
-        nested=EMPTY,
-    )
-    def comma_separated(cls, call_target, nested, **kwargs):
-        """
-        Shortcut to create a comma separated list of something. You can use this to create a comma separated text input that gives nice validation errors easily. Example:
-
-        .. code:: python
-
-            Field.comma_separated(nested=Field.email)
-        """
-        if 'call_target' in nested:
-            nested = nested()
-        else:
-            nested = nested(class_call_target_class=cls)
-
-        def parse_comma_separated(form, field, string_value):
-            errors = []
-            result = []
-            for x in string_value.split(','):
-                x = x.strip()
-                try:
-                    result.append(nested.parse(form=form, field=field, string_value=x.strip()))
-                except ValueError as e:
-                    errors.append('Invalid value "%s": %s' % (x, e))
-                except ValidationError as e:
-                    for message in e.messages:
-                        errors.append('Invalid value "%s": %s' % (x, message))
-            if errors:
-                raise ValidationError(errors)
-            return ', '.join(result)
-
-        def is_valid_comma_separated(form, field, parsed_data):
-            errors = set()
-            for x in parsed_data.split(','):
-                x = x.strip()
-                is_valid, error = nested.is_valid(form=form, field=field, parsed_data=x)
-                if not is_valid:
-                    errors.add('Invalid value "%s": %s' % (x, error))
-            return errors == set(), errors
-
-        return call_target(is_valid=is_valid_comma_separated, parse=parse_comma_separated, **kwargs)
-
 
 def get_fields(model):
     # noinspection PyProtectedMember

lib/tri/form/compat.py

@@ -29,38 +29,34 @@ def get_template_from_string(template_code, origin=None, name=None):
     def setup_db_compat():
         from tri.form import register_field_factory
         from django.db.models import IntegerField, FloatField, TextField, BooleanField, AutoField, CharField, \
-            CommaSeparatedIntegerField, DateField, DateTimeField, DecimalField, EmailField, URLField, TimeField, \
+            DateField, DateTimeField, DecimalField, EmailField, URLField, TimeField, \
             ForeignKey, ManyToManyField, FileField, ManyToOneRel, ManyToManyRel
 
         # The order here is significant because of inheritance structure. More specific must be below less specific.
-        register_field_factory(CharField, Shortcut(class_call_target=''))
-        register_field_factory(URLField, Shortcut(class_call_target='url'))
-        register_field_factory(TimeField, Shortcut(class_call_target='time'))
-        register_field_factory(EmailField, Shortcut(class_call_target='email'))
-        register_field_factory(DecimalField, Shortcut(class_call_target='decimal'))
-        register_field_factory(DateField, Shortcut(class_call_target='date'))
-        register_field_factory(DateTimeField, Shortcut(class_call_target='datetime'))
-        register_field_factory(
-            CommaSeparatedIntegerField,
-            Shortcut(class_call_target='comma_separated', nested=Shortcut(class_call_target='integer')),
-        )
+        register_field_factory(CharField, Shortcut())
+        register_field_factory(URLField, Shortcut(call_target__attribute='url'))
+        register_field_factory(TimeField, Shortcut(call_target__attribute='time'))
+        register_field_factory(EmailField, Shortcut(call_target__attribute='email'))
+        register_field_factory(DecimalField, Shortcut(call_target__attribute='decimal'))
+        register_field_factory(DateField, Shortcut(call_target__attribute='date'))
+        register_field_factory(DateTimeField, Shortcut(call_target__attribute='datetime'))
         register_field_factory(
             BooleanField,
             lambda model_field, **kwargs: (
-                Shortcut(class_call_target='boolean')
+                Shortcut(call_target__attribute='boolean')
                 if not model_field.null
-                else Shortcut(class_call_target='boolean_tristate')
+                else Shortcut(call_target__attribute='boolean_tristate')
             )
         )
-        register_field_factory(TextField, Shortcut(class_call_target='text'))
-        register_field_factory(FloatField, Shortcut(class_call_target='float'))
-        register_field_factory(IntegerField, Shortcut(class_call_target='integer'))
-        register_field_factory(AutoField, Shortcut(class_call_target='integer', show=False))
+        register_field_factory(TextField, Shortcut(call_target__attribute='text'))
+        register_field_factory(FloatField, Shortcut(call_target__attribute='float'))
+        register_field_factory(IntegerField, Shortcut(call_target__attribute='integer'))
+        register_field_factory(AutoField, Shortcut(call_target__attribute='integer', show=False))
         register_field_factory(ManyToOneRel, None)
         register_field_factory(ManyToManyRel, None)
-        register_field_factory(FileField, Shortcut(class_call_target='file'))
-        register_field_factory(ForeignKey, Shortcut(class_call_target='foreign_key'))
-        register_field_factory(ManyToManyField, Shortcut(class_call_target='many_to_many'))
+        register_field_factory(FileField, Shortcut(call_target__attribute='file'))
+        register_field_factory(ForeignKey, Shortcut(call_target__attribute='foreign_key'))
+        register_field_factory(ManyToManyField, Shortcut(call_target__attribute='many_to_many'))
 
     def field_defaults_factory(model_field):
         from tri.form import capitalize

requirements.txt

@@ -1,3 +1,3 @@
-tri.declarative >=1.2.0
+tri.declarative >=2.0.0,<3.0.0
 tri.struct >= 2.5.3
 six

tests/test_forms.py

@@ -307,43 +307,6 @@ def test_email_field():
     assert Form(data=dict(foo='foo@example.com'), fields=[Field.email(name='foo')]).is_valid()
 
 
-def test_multi_email():
-    assert Form(data=dict(foo='foo@example.com, foo@example.com'), fields=[Field.comma_separated(nested=Field.email, name='foo')]).is_valid()
-
-
-def test_comma_separated_errors_on_parse():
-    def raise_always_value_error(string_value, **_):
-        raise ValueError('foo %s!' % string_value)
-
-    def raise_always_validation_error(string_value, **_):
-        raise ValidationError(['foo %s!' % string_value, 'bar %s!' % string_value])
-
-    assert Form(
-        data=dict(foo='5, 7'),
-        fields=[Field.comma_separated(name='foo', nested__parse=raise_always_value_error)]).fields[0].errors == {
-            u'Invalid value "5": foo 5!',
-            u'Invalid value "7": foo 7!',
-    }
-
-    assert Form(
-        data=dict(foo='5, 7'),
-        fields=[Field.comma_separated(name='foo', nested__parse=raise_always_validation_error)]).fields[0].errors == {
-            u'Invalid value "5": foo 5!',
-            u'Invalid value "5": bar 5!',
-            u'Invalid value "7": foo 7!',
-            u'Invalid value "7": bar 7!',
-    }
-
-
-def test_comma_separated_errors_on_validation():
-    assert Form(
-        data=dict(foo='5, 7'),
-        fields=[Field.comma_separated(name='foo', nested__is_valid=lambda parsed_data, **_: (False, 'foo %s!' % parsed_data))]).fields[0].errors == {
-            u'Invalid value "5": foo 5!',
-            u'Invalid value "7": foo 7!',
-    }
-
-
 def test_phone_field():
     assert Form(data=dict(foo=' asdasd  '), fields=[Field.phone_number(name='foo')]).fields[0].errors == {u'Please use format +<country code> (XX) XX XX. Example of US number: +1 (212) 123 4567 or +1 212 123 4567'}
     assert Form(data=dict(foo='+1 (212) 123 4567'), fields=[Field.phone_number(name='foo')]).is_valid()