Rename timeout_ms to inactivity_gap_ms

Author: Remy Gwaramadze

quixstreams/dataframe/dataframe.py

@@ -1529,7 +1529,7 @@ def sliding_count_window(
 
     def session_window(
         self,
-        timeout_ms: Union[int, timedelta],
+        inactivity_gap_ms: Union[int, timedelta],
         grace_ms: Union[int, timedelta] = 0,
         name: Optional[str] = None,
         on_late: Optional[WindowOnLateCallback] = None,
@@ -1568,7 +1568,7 @@ def session_window(
         sdf = (
             # Define a session window with 30-second timeout and 10-second grace period
             sdf.session_window(
-                timeout_ms=timedelta(seconds=30),
+                inactivity_gap_ms=timedelta(seconds=30),
                 grace_ms=timedelta(seconds=10)
             )
 
@@ -1584,7 +1584,7 @@ def session_window(
         )
         ```
 
-        :param timeout_ms: The session timeout period.
+        :param inactivity_gap_ms: The session timeout period.
             If no new events arrive within this period, the session will be closed.
             Can be specified as either an `int` representing milliseconds
             or a `timedelta` object.
@@ -1613,11 +1613,11 @@ def session_window(
             This object can be further configured with aggregation functions
             like `sum`, `count`, etc. applied to the StreamingDataFrame.
         """
-        timeout_ms = ensure_milliseconds(timeout_ms)
+        inactivity_gap_ms = ensure_milliseconds(inactivity_gap_ms)
         grace_ms = ensure_milliseconds(grace_ms)
 
         return SessionWindowDefinition(
-            timeout_ms=timeout_ms,
+            inactivity_gap_ms=inactivity_gap_ms,
             grace_ms=grace_ms,
             dataframe=self,
             name=name,

quixstreams/dataframe/windows/definitions.py

@@ -548,38 +548,34 @@ class SessionWindowDefinition(WindowDefinition):
 
     def __init__(
         self,
-        timeout_ms: int,
+        inactivity_gap_ms: int,
         grace_ms: int,
         dataframe: "StreamingDataFrame",
         name: Optional[str] = None,
         on_late: Optional[WindowOnLateCallback] = None,
     ):
-        if not isinstance(timeout_ms, int):
+        if not isinstance(inactivity_gap_ms, int):
             raise TypeError("Session timeout must be an integer")
-        if timeout_ms < 1:
+        if inactivity_gap_ms < 1:
             raise ValueError("Session timeout cannot be smaller than 1ms")
         if grace_ms < 0:
             raise ValueError("Session grace cannot be smaller than 0ms")
 
         super().__init__(name, dataframe, on_late)
 
-        self._timeout_ms = timeout_ms
+        self._inactivity_gap_ms = inactivity_gap_ms
         self._grace_ms = grace_ms
 
-    @property
-    def timeout_ms(self) -> int:
-        return self._timeout_ms
-
     @property
     def grace_ms(self) -> int:
         return self._grace_ms
 
     def _get_name(self, func_name: Optional[str]) -> str:
         prefix = f"{self._name}_session_window" if self._name else "session_window"
         if func_name:
-            return f"{prefix}_{self._timeout_ms}_{func_name}"
+            return f"{prefix}_{self._inactivity_gap_ms}_{func_name}"
         else:
-            return f"{prefix}_{self._timeout_ms}"
+            return f"{prefix}_{self._inactivity_gap_ms}"
 
     def _create_window(
         self,
@@ -596,7 +592,7 @@ def _create_window(
             window_type = SessionWindowMultiAggregation
 
         return window_type(
-            timeout_ms=self._timeout_ms,
+            timeout_ms=self._inactivity_gap_ms,
             grace_ms=self._grace_ms,
             name=self._get_name(func_name=func_name),
             dataframe=self._dataframe,