Use new major tri.declarative and tri.form

Author: boxed

HISTORY.rst

@@ -1,6 +1,16 @@
 Changelog
 ---------
 
+5.0.0 (2019-04-12)
+~~~~~~~~~~~~~~~~~~
+
+* Make `Variable` shortcuts compatible with subclassing
+
+* Use the new major tri.declarative, and update to follow the new style of class member shortcuts
+
+* Added missing `Variable.multi_choice` shortcut
+
+
 4.2.0 (2019-04-01)
 ~~~~~~~~~~~~~~~~~~
 

lib/tri/query/__init__.py

@@ -186,7 +186,7 @@ class Variable(RefinableObject):
         show=True,
         attr=MISSING,
         gui=Namespace(
-            call_target=Field,
+            call_target__cls=Field,
             show=False,
             required=False,
         ),
@@ -248,19 +248,21 @@ def value_to_q(variable, op, value_string_or_f):
         else:
             return r
 
-    @staticmethod
-    def from_model(model, field_name=None, model_field=None, **kwargs):
+    @classmethod
+    def from_model(cls, model, field_name=None, model_field=None, **kwargs):
         return member_from_model(
+            cls=cls,
             model=model,
             factory_lookup=_variable_factory_by_django_field_type,
             field_name=field_name,
             model_field=model_field,
             defaults_factory=lambda model_field: {},
             **kwargs)
 
-    @staticmethod
-    def expand_member(model, field_name=None, model_field=None, **kwargs):
+    @classmethod
+    def expand_member(cls, model, field_name=None, model_field=None, **kwargs):
         return expand_member(
+            cls=cls,
             model=model,
             factory_lookup=_variable_factory_by_django_field_type,
             field_name=field_name,
@@ -281,7 +283,7 @@ def case_sensitive(cls, call_target=None, **kwargs):
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.choice,
+        gui__call_target__attribute='choice',
     )
     def choice(cls, call_target=None, **kwargs):  # pragma: no cover
         """
@@ -295,7 +297,21 @@ def choice(cls, call_target=None, **kwargs):  # pragma: no cover
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.choice_queryset,
+        gui__call_target__attribute='multi_choice',
+    )
+    def multi_choice(cls, call_target=None, **kwargs):  # pragma: no cover
+        """
+        Field that has one value out of a set.
+        :type choices: list
+        """
+        setdefaults_path(kwargs, dict(
+            gui__choices=kwargs.get('choices'),
+        ))
+        return call_target(**kwargs)
+
+    @classmethod
+    @class_shortcut(
+        gui__call_target__attribute='choice_queryset',
         op_to_q_op=lambda op: 'exact',
         value_to_q_lookup='name',
         value_to_q=choice_queryset_value_to_q,
@@ -319,84 +335,109 @@ def choice_queryset(cls, choices, call_target=None, **kwargs):
 
     @classmethod
     @class_shortcut(
-        class_call_target="choice_queryset",
-        gui__call_target=Field.multi_choice_queryset,
+        call_target__attribute="choice_queryset",
+        gui__call_target__attribute='multi_choice_queryset',
     )
     def multi_choice_queryset(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.boolean,
+        gui__call_target__attribute='boolean',
         value_to_q=boolean_value_to_q,
     )
     def boolean(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.boolean_tristate,
+        gui__call_target__attribute='boolean_tristate',
         value_to_q=boolean_value_to_q,
     )
     def boolean_tristate(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.integer,
+        gui__call_target__attribute='integer',
     )
     def integer(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.float,
+        gui__call_target__attribute='float',
     )
     def float(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.url,
+        gui__call_target__attribute='url',
     )
     def url(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.time,
+        gui__call_target__attribute='time',
     )
     def time(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.datetime,
+        gui__call_target__attribute='datetime',
     )
     def datetime(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.date,
+        gui__call_target__attribute='date',
     )
     def date(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.email,
+        gui__call_target__attribute='email',
     )
     def email(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
     @classmethod
     @class_shortcut(
-        gui__call_target=Field.decimal,
+        gui__call_target__attribute='decimal',
     )
     def decimal(cls, call_target=None, **kwargs):
         return call_target(**kwargs)
 
+    @classmethod
+    @class_shortcut(
+        call_target__attribute='choice_queryset',
+    )
+    def foreign_key(cls, model_field, model, call_target, **kwargs):
+        del model
+        setdefaults_path(
+            kwargs,
+            choices=model_field.foreign_related_fields[0].model.objects.all(),
+        )
+        return call_target(model_field=model_field, **kwargs)
+
+    @classmethod
+    @class_shortcut(
+        call_target__attribute='multi_choice_queryset',
+    )
+    def many_to_many(cls, call_target, model_field, **kwargs):
+        setdefaults_path(
+            kwargs,
+            choices=model_field.remote_field.model.objects.all(),
+            extra__django_related_field=True,
+        )
+        kwargs['model'] = model_field.remote_field.model
+        return call_target(model_field=model_field, **kwargs)
+
 
 class StringValue(text_type):
     def __new__(cls, s):
@@ -446,6 +487,13 @@ class CarQuery(Query):
     endpoint = Refinable()
     """ :type: tri.declarative.Namespace """
 
+    member_class = Refinable()
+    form_class = Refinable()
+
+    class Meta:
+        member_class = Variable
+        form_class = Form
+
     @dispatch(
         gui__call_target=Form,
         endpoint_dispatch_prefix='query',

lib/tri/query/db_compat.py

@@ -1,4 +1,4 @@
-from tri.declarative import setdefaults_path
+from tri.declarative import Shortcut
 
 from tri.query import register_variable_factory
 
@@ -8,33 +8,24 @@ def setup_db_compat():
 
 
 def setup_db_compat_django():
-    from tri.query import Variable
-    from django.db.models import IntegerField, FloatField, TextField, BooleanField, AutoField, CharField, CommaSeparatedIntegerField, DateField, DateTimeField, DecimalField, EmailField, URLField, TimeField, ForeignKey, ManyToOneRel, ManyToManyField, ManyToManyRel
-
-    def foreign_key_factory(model_field, **kwargs):
-        setdefaults_path(kwargs, dict(
-            choices=model_field.foreign_related_fields[0].model.objects.all()
-        ))
-        return Variable.choice_queryset(**kwargs)
+    from django.db.models import IntegerField, FloatField, TextField, BooleanField, AutoField, CharField, DateField, DateTimeField, DecimalField, EmailField, URLField, TimeField, ForeignKey, ManyToOneRel, ManyToManyField, ManyToManyRel
 
     # The order here is significant because of inheritance structure. More specific must be below less specific.
-    register_variable_factory(CharField, Variable),
-    register_variable_factory(URLField, Variable.url),
-    register_variable_factory(TimeField, Variable.time),
-    register_variable_factory(EmailField, Variable.email),
-    register_variable_factory(DecimalField, Variable.decimal),
-    register_variable_factory(DateField, Variable.date),
-    register_variable_factory(DateTimeField, Variable.datetime),
-    register_variable_factory(BooleanField, Variable.boolean),
-    register_variable_factory(TextField, Variable.text),
-    register_variable_factory(FloatField, Variable.float),
-    register_variable_factory(IntegerField, Variable.integer),
-
-    register_variable_factory(CommaSeparatedIntegerField, lambda **kwargs: Variable.comma_separated(parent_field=Variable.integer(**kwargs))),
-    register_variable_factory(AutoField, lambda **kwargs: Variable.integer(**setdefaults_path(kwargs, dict(show=False)))),
-    register_variable_factory(ManyToManyField, lambda model_field, **kwargs: Variable.multi_choice_queryset(model_field=model_field, **setdefaults_path(kwargs, dict(choices=model_field.rel.to._default_manager.all())))),
+    register_variable_factory(CharField, Shortcut()),
+    register_variable_factory(URLField, Shortcut(call_target__attribute='url')),
+    register_variable_factory(TimeField, Shortcut(call_target__attribute='time')),
+    register_variable_factory(EmailField, Shortcut(call_target__attribute='email')),
+    register_variable_factory(DecimalField, Shortcut(call_target__attribute='decimal')),
+    register_variable_factory(DateField, Shortcut(call_target__attribute='date')),
+    register_variable_factory(DateTimeField, Shortcut(call_target__attribute='datetime')),
+    register_variable_factory(BooleanField, Shortcut(call_target__attribute='boolean')),
+    register_variable_factory(TextField, Shortcut(call_target__attribute='text')),
+    register_variable_factory(FloatField, Shortcut(call_target__attribute='float')),
+    register_variable_factory(IntegerField, Shortcut(call_target__attribute='integer')),
+
+    register_variable_factory(AutoField, Shortcut(call_target__attribute='integer', show=False))
+    register_variable_factory(ManyToManyField, Shortcut(call_target__attribute='many_to_many'))
 
     register_variable_factory(ManyToOneRel, None),
     register_variable_factory(ManyToManyRel, None),
-    # (ManyToManyRel_Related, None),
-    register_variable_factory(ForeignKey, foreign_key_factory),
+    register_variable_factory(ForeignKey, Shortcut(call_target__attribute='foreign_key'))

requirements.txt

@@ -1,6 +1,6 @@
-tri.declarative >= 1.2.0
+tri.declarative >= 2.0.0, < 3.0.0
 tri.named_struct
 tri.struct
-tri.form >= 5.2.2, < 6.0.0
+tri.form >= 6.0.0, < 7.0.0
 pyparsing
 six

tests/test_query.py

@@ -46,13 +46,6 @@ class ShowQuery(Query):
     assert [x.name for x in ShowQuery(request=Struct(GET=Data(foo='show'))).bound_variables] == ['foo', 'bar']
 
 
-def test_namespace_merge():
-    v = Variable(gui__show=True)
-    assert v.gui.call_target == Field
-    v = Variable(gui=Struct(show=True))
-    assert v.gui.call_target == Field
-
-
 def test_request_data():
     r = Struct(method='POST', POST='POST', GET='GET')
     assert request_data(r) == 'POST'