feat(CDF-19308): Add timezone as an optional param to WorkflowScheduledTriggerRule (#2200)

Co-authored-by: erlendvollset <erlendvollset@gmail.com>

Author: JustAnotherNormalDev

CHANGELOG.md

@@ -17,6 +17,10 @@ Changes are grouped as follows
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
+## [7.83.0] - 2025-08-28
+### Added
+- Add `timezone` as an optional param to the WorkflowScheduledTriggerRule.
+
 ## [7.82.1] - 2025-08-28
 ### Fixed
 - Fix documentation of files.upload_content. It does not support directories. Use more meaningful errors when the path is not a file. 

cognite/client/_api/workflows.py

@@ -81,11 +81,12 @@ def upsert(
 
                 >>> from cognite.client import CogniteClient
                 >>> from cognite.client.data_classes.workflows import WorkflowTriggerUpsert, WorkflowScheduledTriggerRule
+                >>> from zoneinfo import ZoneInfo
                 >>> client = CogniteClient()
                 >>> client.workflows.triggers.upsert(
                 ...     WorkflowTriggerUpsert(
                 ...         external_id="my_trigger",
-                ...         trigger_rule=WorkflowScheduledTriggerRule(cron_expression="0 0 * * *"),
+                ...         trigger_rule=WorkflowScheduledTriggerRule(cron_expression="0 0 * * *", timezone=ZoneInfo("UTC")),
                 ...         workflow_external_id="my_workflow",
                 ...         workflow_version="1",
                 ...         input={"a": 1, "b": 2},

cognite/client/_version.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
 
-__version__ = "7.82.1"
+__version__ = "7.83.0"
 
 __api_subversion__ = "20230101"

cognite/client/data_classes/workflows.py

@@ -28,6 +28,7 @@
 
 if TYPE_CHECKING:
     from cognite.client import CogniteClient
+from zoneinfo import ZoneInfo
 
 TaskStatus: TypeAlias = Literal[
     "in_progress",
@@ -1415,16 +1416,30 @@ class WorkflowScheduledTriggerRule(WorkflowTriggerRule):
 
     Args:
         cron_expression (str): The cron specification for the scheduled trigger.
+        timezone (ZoneInfo | None): The timezone in which the scheduled trigger should be evaluated.
+            If not provided, UTC will be used as the default timezone on the server side.
     """
 
     _trigger_type = "schedule"
 
-    def __init__(self, cron_expression: str) -> None:
+    def __init__(self, cron_expression: str, timezone: ZoneInfo | None = None) -> None:
         self.cron_expression = cron_expression
+        self.timezone = timezone
+
+    def dump(self, camel_case: bool = True) -> dict[str, Any]:
+        # Override dump to handle timezone field specially:
+        # 1. Only include timezone key when it has a value (avoid "timezone": null)
+        # 2. Convert ZoneInfo object to its string key representation
+        item = super().dump(camel_case)
+        if self.timezone:
+            item["timezone"] = self.timezone.key
+        return item
 
     @classmethod
     def _load_trigger(cls, data: dict) -> WorkflowScheduledTriggerRule:
-        return cls(cron_expression=data["cronExpression"])
+        # Convert timezone to ZoneInfo
+        timezone = ZoneInfo(data["timezone"]) if "timezone" in data else None
+        return cls(cron_expression=data["cronExpression"], timezone=timezone)
 
 
 class WorkflowDataModelingTriggerRule(WorkflowTriggerRule):
@@ -1525,6 +1540,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
             "workflow_external_id": self.workflow_external_id,
             "workflow_version": self.workflow_version,
         }
+
         if self.input:
             item["input"] = self.input
         if self.metadata:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cognite-sdk"
-version = "7.82.1"
+version = "7.83.0"
 
 description = "Cognite Python SDK"
 readme = "README.md"

tests/tests_integration/test_api/test_workflows.py

@@ -2,6 +2,7 @@
 
 import time
 import unittest
+from zoneinfo import ZoneInfo
 
 import pytest
 
@@ -593,7 +594,7 @@ def test_create_update_scheduled_trigger(
             created = cognite_client.workflows.triggers.upsert(existing)
 
             update = WorkflowTriggerUpsert._load(existing.dump())
-            new_rule = WorkflowScheduledTriggerRule(cron_expression="0 * * * *")
+            new_rule = WorkflowScheduledTriggerRule(cron_expression="0 * * * *", timezone=ZoneInfo("Europe/Oslo"))
             update.trigger_rule = new_rule
 
             updated = cognite_client.workflows.triggers.upsert(update)

tests/utils.py

@@ -18,6 +18,7 @@
 from pathlib import Path
 from types import UnionType
 from typing import TYPE_CHECKING, Any, Literal, TypeVar, cast, get_args, get_origin, get_type_hints
+from zoneinfo import ZoneInfo
 
 from cognite.client import CogniteClient
 from cognite.client._api_client import APIClient
@@ -538,6 +539,9 @@ def create_value(self, type_: Any, var_name: str | None = None) -> Any:
             return {self._random_string(10): self._random_string(10) for _ in range(self._random.randint(1, 3))}
         elif type_ is CogniteClient:
             return self._cognite_client
+        elif type_ is ZoneInfo:
+            # Special case for ZoneInfo - provide a default timezone
+            return ZoneInfo("UTC")
         elif inspect.isclass(type_) and any(base is abc.ABC for base in type_.__bases__):
             implementations = all_concrete_subclasses(type_)
             if type_ is Filter: