Contains and other filter modifiers

abondar · abondar · commit bd181fea23c7 · 2018-04-13T13:46:58.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+### 0.5.0
+
+Added `contains` and other filter modifiers.
+
+Field kwarg `default` not accepts functions.
+
+
 ### 0.4.0
 
 Immutable QuerySet. `unique` flag for fields
diff --git a/docs/models_and_fields.rst b/docs/models_and_fields.rst
@@ -145,5 +145,6 @@ Also all fields fields have this options:
 - ``source_field`` - field name in schema, can be different from field name
 - ``null`` - is field nullable
 - ``default`` - default value for field
+- ``unique`` - sets unique constraint for field
 - ``generated`` - flag that says that this field is read only and value should be generated in db. Normally, should be used only if you working on already created schema, not generated by tortoise.
 
diff --git a/docs/query.rst b/docs/query.rst
@@ -92,3 +92,29 @@ When you need to make ``OR`` query or something a little more challenging you co
         Q(id__in=[event_first.id, event_second.id]) | Q(name='3')
     )
 
+
+
+Filtering
+=========
+
+When using ``.filter()`` method you can use number of modifiers to field names to specify desired operation
+
+.. code-block:: python
+
+    teams = await Team.filter(name__icontains='CON')
+
+
+- ``in`` - checks if value of field is in passed list
+- ``not_in``
+- ``gte`` - greater or equals than passed value
+- ``gt`` - greater than passed value
+- ``lte`` - lower or equals than passed value
+- ``lt`` - lower than passed value
+- ``isnull`` - field is null
+- ``not_isnull``
+- ``contains`` - field contains specified substring
+- ``icontains`` - case insensitive ``contains``
+- ``startswith`` - if field starts with value
+- ``istartswith`` - case insensitive ``startswith``
+- ``endswith`` - if field ends with value
+- ``iendswith`` - case insensitive ``endswith``
diff --git a/examples/basic.py b/examples/basic.py
@@ -13,7 +13,7 @@
 
 class Event(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
 
     class Meta:
         table = 'event'
diff --git a/examples/complex_filtering.py b/examples/complex_filtering.py
@@ -16,15 +16,15 @@
 
 class Tournament(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
 
     def __str__(self):
         return self.name
 
 
 class Event(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
     tournament = fields.ForeignKeyField('models.Tournament', related_name='events')
     participants = fields.ManyToManyField('models.Team', related_name='events', through='event_team')
 
@@ -34,7 +34,7 @@ def __str__(self):
 
 class Team(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
 
     def __str__(self):
         return self.name
@@ -80,6 +80,12 @@ async def run():
         events__name__in=['1', '3']
     ).order_by('-events__participants__name').distinct()
 
+    teams = await Team.filter(name__icontains='CON')
+    assert len(teams) == 1 and teams[0].name == 'Second'
+
+    tournaments = await Tournament.filter(events__participants__name__startswith='Fir')
+    assert len(tournaments) == 1 and tournaments[0] == tournament
+
 
 if __name__ == '__main__':
     loop = asyncio.get_event_loop()
diff --git a/examples/relations.py b/examples/relations.py
@@ -18,15 +18,15 @@
 
 class Tournament(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
 
     def __str__(self):
         return self.name
 
 
 class Event(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
     tournament = fields.ForeignKeyField('models.Tournament', related_name='events')
     participants = fields.ManyToManyField('models.Team', related_name='events', through='event_team')
 
@@ -36,7 +36,7 @@ def __str__(self):
 
 class Team(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
 
     def __str__(self):
         return self.name
diff --git a/examples/schema_create.py b/examples/schema_create.py
@@ -1,6 +1,7 @@
 import asyncio
 
 import datetime
+import secrets
 
 from examples import get_db_name
 from tortoise import Tortoise, fields
@@ -11,20 +12,25 @@
 
 class Tournament(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
     created = fields.DatetimeField(auto_now_add=True)
 
     def __str__(self):
         return self.name
 
 
+def generate_token():
+    return secrets.token_hex(16)
+
+
 class Event(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField(unique=True)
+    name = fields.TextField(unique=True)
     tournament = fields.ForeignKeyField('models.Tournament', related_name='events')
     participants = fields.ManyToManyField('models.Team', related_name='events', through='event_team')
     modified = fields.DatetimeField(auto_now=True)
     prize = fields.DecimalField(max_digits=10, decimal_places=2, null=True)
+    token = fields.TextField(default=generate_token)
 
     def __str__(self):
         return self.name
@@ -53,6 +59,7 @@ async def run():
     event.name = 'Test 2'
     await event.save()
     assert event.modified > old_time
+    assert len(event.token) == 32
 
 
 if __name__ == '__main__':
diff --git a/examples/transactions.py b/examples/transactions.py
@@ -18,7 +18,7 @@
 
 class Event(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
 
     class Meta:
         table = 'event'
diff --git a/examples/two_databases.py b/examples/two_databases.py
@@ -21,7 +21,7 @@
 
 class Tournament(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
 
     def __str__(self):
         return self.name
@@ -32,7 +32,7 @@ class Meta:
 
 class Event(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
     tournament_id = fields.IntField()
     # Here we make link to events.Team, not models.Team
     participants = fields.ManyToManyField('events.Team', related_name='events', through='event_team')
@@ -46,7 +46,7 @@ class Meta:
 
 class Team(Model):
     id = fields.IntField(pk=True)
-    name = fields.StringField()
+    name = fields.TextField()
 
     def __str__(self):
         return self.name
diff --git a/setup.py b/setup.py
@@ -65,7 +65,7 @@ def version():
     # Details
     url="https://github.com/Zeliboba5/tortoise-orm",
 
-    description="Easy for use async ORM for python",
+    description="Easy async ORM for python, built with relations in mind",
     long_description=readme(),
 
     classifiers=[
diff --git a/tortoise/__init__.py b/tortoise/__init__.py
@@ -127,4 +127,4 @@ def init(cls, global_client=None, db_routing=None):
         cls._inited = True
 
 
-__version__ = "0.4.0"
+__version__ = "0.5.0"
diff --git a/tortoise/backends/base/schema_generator.py b/tortoise/backends/base/schema_generator.py
@@ -1,7 +1,7 @@
 from tortoise import fields
 
 TABLE_CREATE_TEMPLATE = 'CREATE TABLE "{}" ({});'
-FIELD_TEMPLATE = '"{name}" {type} {nullable} {unique} {default}'
+FIELD_TEMPLATE = '"{name}" {type} {nullable} {unique}'
 FK_TEMPLATE = ' REFERENCES "{table}" (id) ON DELETE {on_delete}'
 M2M_TABLE_TEMPLATE = (
     'CREATE TABLE "{backward_table}_{forward_table}" '
@@ -15,7 +15,8 @@ class BaseSchemaGenerator:
         fields.BooleanField: 'BOOL',
         fields.IntField: 'INT',
         fields.SmallIntField: 'SMALLINT',
-        fields.StringField: 'TEXT',
+        fields.TextField: 'TEXT',
+        fields.CharField: 'VARCHAR({})',
         fields.DatetimeField: 'TIMESTAMP',
         fields.DecimalField: 'DECIMAL({},{})',
         fields.DateField: 'DATE',
@@ -43,29 +44,18 @@ def _get_table_sql(self, model):
                 continue
             nullable = 'NOT NULL' if not field_object.null else ''
             unique = 'UNIQUE' if field_object.unique else ''
-            default_value_python = field_object.default if field_object.default is not None else None
-            if default_value_python is not None:
-                if isinstance(field_object, fields.StringField):
-                    default_value = "'{}'".format(default_value_python)
-                elif isinstance(field_object, fields.DatetimeField):
-                    default_value = default_value_python.isoformat()
-                else:
-                    default_value = str(default_value_python)
-            else:
-                default_value = ''
-            if default_value:
-                default_value = 'DEFAULT {}'.format(default_value)
 
             field_type = self.field_type_map[field_object.__class__]
             if isinstance(field_object, fields.DecimalField):
                 field_type = field_type.format(field_object.max_digits, field_object.decimal_places)
+            elif isinstance(field_object, fields.CharField):
+                field_type = field_type.format(field_object.max_length)
 
             field_creation_string = FIELD_TEMPLATE.format(
                 name=db_field,
                 type=field_type,
                 nullable=nullable,
                 unique=unique,
-                default=default_value,
             ).strip()
             if hasattr(field_object, 'reference') and field_object.reference:
                 field_creation_string += FK_TEMPLATE.format(
diff --git a/tortoise/fields.py b/tortoise/fields.py
@@ -11,6 +11,7 @@
 CASCADE = 'CASCADE'
 RESTRICT = 'RESTRICT'
 SET_NULL = 'SET NULL'
+SET_DEFAULT = 'SET DEFAULT'
 
 
 class Field:
@@ -38,7 +39,14 @@ def __init__(self, *args, **kwargs):
         super().__init__(int, *args, **kwargs)
 
 
-class StringField(Field):
+class CharField(Field):
+    def __init__(self, max_length, *args, **kwargs):
+        self.max_length = int(max_length)
+        assert self.max_length > 0
+        super().__init__(str, *args, **kwargs)
+
+
+class TextField(Field):
     def __init__(self, *args, **kwargs):
         super().__init__(str, *args, **kwargs)
 
@@ -229,3 +237,6 @@ async def remove(self, *instances, using_db=None):
             condition
         ).delete()
         await db.execute_query(str(query))
+
+
+StringField = TextField
diff --git a/tortoise/models.py b/tortoise/models.py
