docs(temporal): add Literal annotation to display possible units fo…

…r `delta` method
ibis-project · Nov 10, 2023 · ee94cb5 · ee94cb5
1 parent ed3b017
commit ee94cb5
Showing 1 changed file with 25 additions and 3 deletions.
diff --git a/ibis/expr/types/temporal.py b/ibis/expr/types/temporal.py
@@ -255,7 +255,12 @@ def __rsub__(self, other: ops.Value[dt.Interval | dt.Time, ds.Any]):
     rsub = __rsub__
 
     def delta(
-        self, other: datetime.time | Value[dt.Time], part: str
+        self,
+        other: datetime.time | Value[dt.Time],
+        part: Literal[
+            "hour", "minute", "second", "millisecond", "microsecond", "nanosecond"
+        ]
+        | Value[dt.String],
     ) -> ir.IntegerValue:
         """Compute the number of `part`s between two times.
 
@@ -401,7 +406,9 @@ def __rsub__(self, other: ops.Value[dt.Date | dt.Interval, ds.Any]):
     rsub = __rsub__
 
     def delta(
-        self, other: datetime.date | Value[dt.Date], part: str
+        self,
+        other: datetime.date | Value[dt.Date],
+        part: Literal["year", "quarter", "month", "week", "day"] | Value[dt.String],
     ) -> ir.IntegerValue:
         """Compute the number of `part`s between two dates.
 
@@ -678,7 +685,22 @@ def __rsub__(self, other: ops.Value[dt.Timestamp | dt.Interval, ds.Any]):
     rsub = __rsub__
 
     def delta(
-        self, other: datetime.datetime | Value[dt.Timestamp], part: str
+        self,
+        other: datetime.datetime | Value[dt.Timestamp],
+        part: Literal[
+            "year",
+            "quarter",
+            "month",
+            "week",
+            "day",
+            "hour",
+            "minute",
+            "second",
+            "millisecond",
+            "microsecond",
+            "nanosecond",
+        ]
+        | Value[dt.String],
     ) -> ir.IntegerValue:
         """Compute the number of `part`s between two timestamps.