feat(api): add day_of_week.iso_index method for date and timestamp types

Author: kaijennissen

ibis/backends/polars/compiler.py

@@ -1103,6 +1103,7 @@ def extract_epoch_seconds(op, **kw):
     ops.Cos: operator.methodcaller("cos"),
     ops.Cot: lambda arg: 1.0 / arg.tan(),
     ops.DayOfWeekIndex: lambda arg: arg.dt.weekday() - 1,
+    ops.IsoDayOfWeekIndex: (lambda arg: arg.dt.weekday().cast(pl.Int16)),
     ops.Exp: operator.methodcaller("exp"),
     ops.Floor: lambda arg: arg.floor().cast(pl.Int64),
     ops.IsInf: operator.methodcaller("is_infinite"),

ibis/backends/sql/compilers/base.py

@@ -965,6 +965,9 @@ def visit_TimeTruncate(self, op, *, arg, unit):
     def visit_DayOfWeekIndex(self, op, *, arg):
         return (self.f.dayofweek(arg) + 6) % 7
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return ((self.f.dayofweek(arg) + 6) % 7) + 1
+
     def visit_DayOfWeekName(self, op, *, arg):
         # day of week number is 0-indexed
         # Sunday == 0

ibis/backends/sql/compilers/bigquery/__init__.py

@@ -464,6 +464,9 @@ def visit_StringJoin(self, op, *, arg, sep):
     def visit_DayOfWeekIndex(self, op, *, arg):
         return self.f.mod(self.f.extract(self.v.dayofweek, arg) + 5, 7)
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return self.f.mod(self.f.extract(self.v.dayofweek, arg) + 5, 7) + 1
+
     def visit_DayOfWeekName(self, op, *, arg):
         return self.f.initcap(sge.Cast(this=arg, to="STRING FORMAT 'DAY'"))
 

ibis/backends/sql/compilers/clickhouse.py

@@ -504,6 +504,9 @@ def visit_DayOfWeekIndex(self, op, *, arg):
         weekdays = len(calendar.day_name)
         return (((self.f.toDayOfWeek(arg) - 1) % weekdays) + weekdays) % weekdays
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return self.f.toDayOfWeek(arg)
+
     def visit_DayOfWeekName(self, op, *, arg):
         # ClickHouse 20 doesn't support dateName
         #

ibis/backends/sql/compilers/datafusion.py

@@ -258,6 +258,9 @@ def visit_ExtractDayOfYear(self, op, *, arg):
     def visit_DayOfWeekIndex(self, op, *, arg):
         return (self.f.date_part("dow", arg) + 6) % 7
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return ((self.f.date_part("dow", arg) + 6) % 7) + 1
+
     def visit_DayOfWeekName(self, op, *, arg):
         return sg.exp.Case(
             this=sge.paren(self.f.date_part("dow", arg) + 6, copy=False) % 7,

ibis/backends/sql/compilers/exasol.py

@@ -50,7 +50,6 @@ class ExasolCompiler(SQLGlotCompiler):
         ops.DateAdd,
         ops.DateSub,
         ops.DateFromYMD,
-        ops.DayOfWeekIndex,
         ops.ElementWiseVectorizedUDF,
         ops.IntervalFromInteger,
         ops.IsInf,
@@ -257,6 +256,12 @@ def visit_ExtractDayOfYear(self, op, *, arg):
     def visit_ExtractWeekOfYear(self, op, *, arg):
         return self.cast(self.f.to_char(arg, "IW"), op.dtype)
 
+    def visit_DayOfWeekIndex(self, op, *, arg):
+        return self.cast(self.f.to_char(arg, "ID"), op.dtype) - 1
+
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return self.cast(self.f.to_char(arg, "ID"), op.dtype)
+
     def visit_ExtractIsoYear(self, op, *, arg):
         return self.cast(self.f.to_char(arg, "IYYY"), op.dtype)
 

ibis/backends/sql/compilers/flink.py

@@ -451,6 +451,9 @@ def visit_ExtractMicrosecond(self, op, *, arg):
     def visit_DayOfWeekIndex(self, op, *, arg):
         return (self.f.anon.dayofweek(arg) + 5) % 7
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return ((self.f.dayofweek(arg) + 5) % 7) + 1
+
     def visit_DayOfWeekName(self, op, *, arg):
         index = self.cast(self.f.anon.dayofweek(self.cast(arg, dt.date)), op.dtype)
         lookup_table = self.f.anon.str_to_map(

ibis/backends/sql/compilers/impala.py

@@ -124,6 +124,9 @@ def visit_RandomScalar(self, op):
     def visit_DayOfWeekIndex(self, op, *, arg):
         return self.f.pmod(self.f.dayofweek(arg) - 2, 7)
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return self.f.pmod(self.f.dayofweek(arg) - 2, 7) + 1
+
     def visit_ExtractMillisecond(self, op, *, arg):
         return self.f.extract(self.v.millisecond, arg) % 1_000
 

ibis/backends/sql/compilers/mssql.py

@@ -240,6 +240,9 @@ def visit_ApproxQuantile(self, op, *, arg, quantile, where):
     def visit_DayOfWeekIndex(self, op, *, arg):
         return self.f.datepart(self.v.weekday, arg) - 1
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return self.f.datepart(self.v.weekday, arg)
+
     def visit_DayOfWeekName(self, op, *, arg):
         days = calendar.day_name
         return sge.Case(

ibis/backends/sql/compilers/mysql.py

@@ -166,6 +166,9 @@ def visit_GroupConcat(self, op, *, arg, sep, where, order_by):
     def visit_DayOfWeekIndex(self, op, *, arg):
         return (self.f.dayofweek(arg) + 5) % 7
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return ((self.f.dayofweek(arg) + 5) % 7) + 1
+
     def visit_Literal(self, op, *, value, dtype):
         # avoid casting NULL: the set of types allowed by MySQL and
         # MariaDB when casting is a strict subset of allowed types in other

ibis/backends/sql/compilers/postgres.py

@@ -623,6 +623,9 @@ def visit_TimestampBucket(self, op, *, arg, interval, offset):
     def visit_DayOfWeekIndex(self, op, *, arg):
         return self.cast(self.f.extract("dow", arg) + 6, dt.int16) % 7
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return self.cast(self.f.extract("isodow", arg), dt.int16)
+
     def visit_DayOfWeekName(self, op, *, arg):
         return self.f.trim(self.f.to_char(arg, "Day"), string.whitespace)
 

ibis/backends/sql/compilers/pyspark.py

@@ -177,6 +177,9 @@ def visit_IntervalFromInteger(self, op, *, arg, unit):
     def visit_DayOfWeekIndex(self, op, *, arg):
         return (self.f.dayofweek(arg) + 5) % 7
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return ((self.f.dayofweek(arg) + 5) % 7) + 1
+
     def visit_DayOfWeekName(self, op, *, arg):
         return sge.Case(
             this=(self.f.dayofweek(arg) + 5) % 7,

ibis/backends/sql/compilers/sqlite.py

@@ -473,6 +473,16 @@ def visit_DayOfWeekIndex(self, op, *, arg):
             self.f.mod(self.cast(self.f.strftime("%w", arg) + 6, dt.int64), 7), dt.int64
         )
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        # return self.cast(self.f.strftime("%u", arg), dt.int64)
+        return (
+            self.cast(
+                self.f.mod(self.cast(self.f.strftime("%w", arg) + 6, dt.int64), 7),
+                dt.int64,
+            )
+            + 1
+        )
+
     def visit_DayOfWeekName(self, op, *, arg):
         return sge.Case(
             this=self.f.strftime("%w", arg),

ibis/backends/sql/compilers/trino.py

@@ -276,6 +276,9 @@ def visit_UnwrapJSONBoolean(self, op, *, arg):
     def visit_DayOfWeekIndex(self, op, *, arg):
         return self.cast(sge.paren(self.f.anon.dow(arg) + 6, copy=False) % 7, op.dtype)
 
+    def visit_IsoDayOfWeekIndex(self, op, *, arg):
+        return self.cast(sge.paren(self.f.day_of_week(arg), copy=False), op.dtype)
+
     def visit_DayOfWeekName(self, op, *, arg):
         return self.f.date_format(arg, "%W")
 

ibis/backends/tests/test_temporal.py

@@ -200,7 +200,7 @@ def test_iso_year_does_not_match_date_year(con):
             id="day_of_week_index",
             marks=[
                 pytest.mark.notimpl(
-                    ["druid", "oracle", "exasol"], raises=com.OperationNotDefinedError
+                    ["druid", "oracle"], raises=com.OperationNotDefinedError
                 ),
             ],
         ),
@@ -1331,25 +1331,35 @@ def test_string_as_time(backend, alltypes):
 
 
 @pytest.mark.parametrize(
-    ("date", "expected_index", "expected_day"),
+    ("date", "expected_index", "expected_iso_index", "expected_day"),
     [
-        param("2017-01-01", 6, "Sunday", id="sunday"),
-        param("2017-01-02", 0, "Monday", id="monday"),
-        param("2017-01-03", 1, "Tuesday", id="tuesday"),
-        param("2017-01-04", 2, "Wednesday", id="wednesday"),
-        param("2017-01-05", 3, "Thursday", id="thursday"),
-        param("2017-01-06", 4, "Friday", id="friday"),
-        param("2017-01-07", 5, "Saturday", id="saturday"),
+        param("2017-01-01", 6, 7, "Sunday", id="sunday"),
+        param("2017-01-02", 0, 1, "Monday", id="monday"),
+        param("2017-01-03", 1, 2, "Tuesday", id="tuesday"),
+        param("2017-01-04", 2, 3, "Wednesday", id="wednesday"),
+        param("2017-01-05", 3, 4, "Thursday", id="thursday"),
+        param("2017-01-06", 4, 5, "Friday", id="friday"),
+        param("2017-01-07", 5, 6, "Saturday", id="saturday"),
     ],
 )
 @pytest.mark.notimpl(["druid", "oracle"], raises=com.OperationNotDefinedError)
 @pytest.mark.notimpl(["exasol"], raises=com.OperationNotDefinedError)
 @mark_notyet_risingwave_14670
-def test_day_of_week_scalar(con, date, expected_index, expected_day):
+@pytest.mark.broken(
+    ["risingwave"],
+    raises=AssertionError,
+    reason="Refer to https://github.com/risingwavelabs/risingwave/issues/14670",
+)
+def test_day_of_week_scalar(
+    con, date, expected_index, expected_iso_index, expected_day
+):
     expr = ibis.literal(date).cast(dt.date)
     result_index = con.execute(expr.day_of_week.index().name("tmp"))
     assert result_index == expected_index
 
+    result_iso_index = con.execute(expr.day_of_week.iso_index().name("tmp"))
+    assert result_iso_index == expected_iso_index
+
     result_day = con.execute(expr.day_of_week.full_name().name("tmp"))
     assert result_day.lower() == expected_day.lower()
 
@@ -1364,6 +1374,11 @@ def test_day_of_week_column(backend, alltypes, df):
 
     backend.assert_series_equal(result_index, expected_index, check_names=False)
 
+    result_iso_index = expr.iso_index().name("tmp").execute()
+    expected_iso_index = df.timestamp_col.dt.isocalendar().day.astype("int16")
+
+    backend.assert_series_equal(result_iso_index, expected_iso_index, check_names=False)
+
     result_day = expr.full_name().name("tmp").execute()
     expected_day = df.timestamp_col.dt.day_name()
 
@@ -1377,9 +1392,6 @@ def test_day_of_week_column(backend, alltypes, df):
             lambda t: t.timestamp_col.day_of_week.index().count(),
             lambda s: s.dt.dayofweek.count(),
             id="day_of_week_index",
-            marks=[
-                pytest.mark.notimpl(["exasol"], raises=com.OperationNotDefinedError)
-            ],
         ),
         param(
             lambda t: t.timestamp_col.day_of_week.full_name().length().sum(),

ibis/expr/operations/temporal.py

@@ -201,6 +201,13 @@ class DayOfWeekIndex(Unary):
     dtype = dt.int16
 
 
+@public
+class IsoDayOfWeekIndex(Unary):
+    arg: Value[dt.Date | dt.Timestamp]
+
+    dtype = dt.int16
+
+
 @public
 class DayOfWeekName(Unary):
     """Extract the name of the day of the week from a date or timestamp."""
@@ -210,6 +217,13 @@ class DayOfWeekName(Unary):
     dtype = dt.string
 
 
+@public
+class IsoDayOfWeekName(Unary):
+    arg: Value[dt.Date | dt.Timestamp]
+
+    dtype = dt.string
+
+
 @public
 class Time(Unary):
     """Extract the time from a timestamp."""

ibis/expr/types/temporal.py

@@ -103,8 +103,34 @@ def day_of_week(self) -> DayOfWeek:
         Returns
         -------
         DayOfWeek
-            An namespace expression containing methods to use to extract
+            A namespace expression with methods for extracting day-of-week
             information.
+
+        Examples
+        --------
+        >>> import ibis
+        >>> import datetime as dt
+        >>> from ibis import _
+        >>> ibis.options.interactive = True
+        >>> t = ibis.memtable({"date": [dt.datetime(2024, 4, x) for x in range(14, 21)]})
+        >>> t.mutate(
+        ...     day_of_week=_.date.day_of_week.index(),
+        ...     day_of_week_name=_.date.day_of_week.full_name(),
+        ...     iso_day_of_week=_.date.day_of_week.iso_index(),
+        ... )
+        ┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓
+        ┃ date                ┃ day_of_week ┃ day_of_week_name ┃ iso_day_of_week ┃
+        ┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩
+        │ timestamp           │ int16       │ string           │ int16           │
+        ├─────────────────────┼─────────────┼──────────────────┼─────────────────┤
+        │ 2024-04-14 00:00:00 │           6 │ Sunday           │               7 │
+        │ 2024-04-15 00:00:00 │           0 │ Monday           │               1 │
+        │ 2024-04-16 00:00:00 │           1 │ Tuesday          │               2 │
+        │ 2024-04-17 00:00:00 │           2 │ Wednesday        │               3 │
+        │ 2024-04-18 00:00:00 │           3 │ Thursday         │               4 │
+        │ 2024-04-19 00:00:00 │           4 │ Friday           │               5 │
+        │ 2024-04-20 00:00:00 │           5 │ Saturday         │               6 │
+        └─────────────────────┴─────────────┴──────────────────┴─────────────────┘
         """
         return DayOfWeek(self)
 
@@ -1497,3 +1523,13 @@ def full_name(self):
         └─────────────────────────┘
         """
         return ops.DayOfWeekName(self._expr).to_expr()
+
+    def iso_index(self):
+        """Get the index of the day of the week in iso-format (1=Monday, 7=Sunday).
+
+        Returns
+        -------
+        IntegerValue
+            The index of the day of the week in iso-format (1=Monday, 7=Sunday).
+        """
+        return ops.IsoDayOfWeekIndex(self._expr).to_expr()