Added TimeField (#1090)

* feat: Added `TimeField`. (#1054)

* fix: test cases

* fix: MySQL `TimeField`

* fix: test_concurrent_get_or_create

* style: fix black

Author: long2ice

CHANGELOG.rst

@@ -16,17 +16,18 @@ Added
 - Added a new unified and robust connection management interface to access DB connections which includes support for
   lazy connection creation and much more. For more details,
   check out this `PR <https://github.com/tortoise/tortoise-orm/pull/1001>`_
+- Added `TimeField`. (#1054)
 Fixed
 ^^^^^
 - Fix `bulk_create` doesn't work correctly with more than 1 update_fields. (#1046)
 - Fix `bulk_update` errors when setting null for a smallint column on postgres. (#1086)
 Deprecated
-^^^^^
+^^^^^^^^^^
 - Existing connection management interface and related public APIs which are deprecated:
  - `Tortoise.get_connection`
  - `Tortoise.close_connections`
 Changed
-^^^^^
+^^^^^^^
 - Refactored `tortoise.transactions.get_connection` method to `tortoise.transactions._get_connection`.
  Note that this method has now been marked **private to this module and is not part of the public API**
 

docs/timezone.rst

@@ -11,15 +11,15 @@ The design of timezone is inspired by `Django` but also has differences. There a
 use_tz
 ------
 When set `use_tz = True`, `tortoise` will always store `UTC` time in database no matter what `timezone` set. And `MySQL` use field type `DATETIME(6)`, `PostgreSQL` use `TIMESTAMPTZ`, `SQLite` use `TIMESTAMP` when generate schema.
+For `TimeField`, `MySQL` use `TIME(6)`, `PostgreSQL` use `TIMETZ` and `SQLite` use `TIME`.
 
 timezone
 --------
-The `timezone` determine what `timezone` is when select datetime field from database, no matter what `timezone` your database is. And you should use `tortoise.timezone.now()` get aware time instead of native time `datetime.datetime.now()`.
+The `timezone` determine what `timezone` is when select `DateTimeField` and `TimeField` from database, no matter what `timezone` your database is. And you should use `tortoise.timezone.now()` get aware time instead of native time `datetime.datetime.now()`.
 
 Reference
 =========
 
 .. automodule:: tortoise.timezone
     :members:
     :undoc-members:
-

poetry.lock

@@ -35,7 +35,7 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.7"
-pypika-tortoise = "^0.1.3"
+pypika-tortoise = { git = "https://github.com/tortoise/pypika-tortoise.git", branch = "main" }
 iso8601 = "^1.0.2"
 aiosqlite = ">=0.16.0, <0.18.0"
 pytz = "*"
@@ -44,8 +44,8 @@ uvloop = { version = "*", markers = "sys_platform != 'win32' and implementation_
 orjson = { version = "*", optional = true }
 asyncpg = { version = "*", optional = true }
 aiomysql = { version = "*", optional = true }
-asyncmy = { version = "*", optional = true }
-psycopg = {extras = ["pool", "binary"], version = "*", optional = true }
+asyncmy = { git = "https://github.com/long2ice/asyncmy.git", branch = "dev" }
+psycopg = { extras = ["pool", "binary"], version = "*", optional = true }
 
 [tool.poetry.dev-dependencies]
 # Linter tools

pyproject.toml

@@ -1,5 +1,5 @@
 import os
-from datetime import date, datetime, timedelta
+from datetime import date, datetime, time, timedelta
 from time import sleep
 
 import pytz
@@ -148,6 +148,35 @@ async def test_timezone(self):
         os.environ["USE_TZ"] = old_use_tz
 
 
+class TestTimeFields(test.TestCase):
+    async def test_create(self):
+        now = timezone.now().timetz()
+        obj = await testmodels.TimeFields.create(time=now)
+        self.assertEqual(obj.time, now)
+
+    async def test_cast(self):
+        obj = await testmodels.TimeFields.create(time="21:00+00:00")
+        self.assertEqual(obj.time, time.fromisoformat("21:00+00:00"))
+
+    async def test_values(self):
+        now = timezone.now().timetz()
+        obj0 = await testmodels.TimeFields.create(time=now)
+        values = await testmodels.TimeFields.get(id=obj0.id).values("time")
+        self.assertEqual(values["time"], now)
+
+    async def test_values_list(self):
+        now = timezone.now().timetz()
+        obj0 = await testmodels.TimeFields.create(time=now)
+        values = await testmodels.TimeFields.get(id=obj0.id).values_list("time", flat=True)
+        self.assertEqual(values, now)
+
+    async def test_get(self):
+        now = timezone.now().timetz()
+        await testmodels.TimeFields.create(time=now)
+        obj = await testmodels.TimeFields.get(time=now)
+        self.assertEqual(obj.time, now)
+
+
 class TestDateFields(test.TestCase):
     async def test_empty(self):
         with self.assertRaises(IntegrityError):

tests/fields/test_time.py

@@ -254,6 +254,12 @@ class DateFields(Model):
     date_null = fields.DateField(null=True)
 
 
+class TimeFields(Model):
+    id = fields.IntField(pk=True)
+    time = fields.TimeField()
+    time_null = fields.TimeField(null=True)
+
+
 class FloatFields(Model):
     id = fields.IntField(pk=True)
     floatnum = fields.FloatField()

tests/testmodels.py

@@ -14,6 +14,7 @@
     DecimalField,
     IntField,
     SmallIntField,
+    TimeField,
 )
 
 
@@ -54,11 +55,30 @@ def to_db_datetime(
     return None
 
 
+def to_db_time(
+    self: TimeField, value: Optional[datetime.time], instance: Union[Type[Model], Model]
+) -> Optional[str]:
+    if hasattr(instance, "_saved_in_db") and (
+        self.auto_now
+        or (self.auto_now_add and getattr(instance, self.model_field_name, None) is None)
+    ):
+        if timezone.get_use_tz():
+            value = datetime.datetime.now(tz=pytz.utc).time()
+        else:
+            value = datetime.datetime.now(tz=timezone.get_default_timezone()).time()
+        setattr(instance, self.model_field_name, value)
+        return value.isoformat()
+    if isinstance(value, datetime.time):
+        return value.isoformat()
+    return None
+
+
 class SqliteExecutor(BaseExecutor):
     TO_DB_OVERRIDE = {
         fields.BooleanField: to_db_bool,
         fields.DecimalField: to_db_decimal,
         fields.DatetimeField: to_db_datetime,
+        fields.TimeField: to_db_time,
     }
     EXPLAIN_PREFIX = "EXPLAIN QUERY PLAN"
     DB_NATIVE = {bytes, str, int, float}

tortoise/backends/sqlite/executor.py

@@ -15,6 +15,7 @@
     SmallIntField,
     TextField,
     TimeDeltaField,
+    TimeField,
     UUIDField,
 )
 from tortoise.fields.relational import (
@@ -44,6 +45,7 @@
     "CharField",
     "DateField",
     "DatetimeField",
+    "TimeField",
     "DecimalField",
     "FloatField",
     "IntEnumField",