Add toYearWeek datetime functionality

CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.5.0
+
+- feat: #129: Add `toYearWeek` datetime functionality
+
 ### 1.4.0
 
 - feat: #119 Allow query results returned in columns and deserialized to `numpy` objects

clickhouse_backend/models/functions/datetime.py

@@ -14,6 +14,7 @@
     "toYYYYMM",
     "toYYYYMMDD",
     "toYYYYMMDDhhmmss",
+    "toYearWeek",
 ]
 
 
@@ -77,3 +78,25 @@ class toStartOfFifteenMinutes(toStartOfMinute):
 
 class toStartOfHour(toStartOfMinute):
     pass
+
+
+class toYearWeek(Func):
+    output_field = fields.UInt32Field()
+
+    def __init__(self, *expressions):
+        arity = len(expressions)
+        if arity < 1 or arity > 3:
+            raise TypeError(
+                "'%s' takes between 1 and 3 arguments (%s given)"
+                % (
+                    self.__class__.__name__,
+                    len(expressions),
+                )
+            )
+
+        expressions = (
+            expressions[0],
+            *(models.Value(expr) for expr in expressions[1:]),
+        )
+
+        super().__init__(*expressions)

tests/clickhouse_functions/test_datetime.py

@@ -27,6 +27,13 @@ def setUpTestData(cls):
                 datetime(2023, 11, 30, hour=16, minute=59, second=59), is_dst=False
             ),
         )
+        cls.sarah = Author.objects.create(
+            name="Sarah Connor",
+            alias="sconnor",
+            birthday=pytz.utc.localize(
+                datetime(2023, 12, 31, hour=23, minute=30, second=00), is_dst=False
+            ),
+        )
 
     def test_yyyymm(self):
         john = Author.objects.annotate(v=models.toYYYYMM("birthday")).get(
@@ -177,3 +184,19 @@ def test_tostartofhour(self):
             elena.v,
             datetime(2023, 11, 30, hour=10, minute=00, second=00),
         )
+
+    def test_toyearweek(self):
+        sarah = Author.objects.annotate(v=models.toYearWeek("birthday")).get(
+            id=self.sarah.id
+        )
+        self.assertEqual(sarah.v, 202353)
+
+        sarah = Author.objects.annotate(v=models.toYearWeek("birthday", 1)).get(
+            id=self.sarah.id
+        )
+        self.assertEqual(sarah.v, 202352)
+
+        sarah = Author.objects.annotate(
+            v=models.toYearWeek("birthday", 1, "Pacific/Kiritimati")
+        ).get(id=self.sarah.id)
+        self.assertEqual(sarah.v, 202401)