hatchet-sdk 1.9.1__py3-none-any.whl → 1.10.1__py3-none-any.whl

hatchet_sdk/__init__.py

@@ -130,7 +130,7 @@ from hatchet_sdk.clients.rest.models.workflow_version_definition import (
     WorkflowVersionDefinition,
 )
 from hatchet_sdk.clients.rest.models.workflow_version_meta import WorkflowVersionMeta
-from hatchet_sdk.config import ClientConfig
+from hatchet_sdk.config import ClientConfig, ClientTLSConfig, OpenTelemetryConfig
 from hatchet_sdk.context.context import Context, DurableContext
 from hatchet_sdk.context.worker_context import WorkerContext
 from hatchet_sdk.contracts.workflows_pb2 import (
@@ -149,6 +149,7 @@ from hatchet_sdk.runnables.types import (
     TaskDefaults,
     WorkflowConfig,
 )
+from hatchet_sdk.utils.opentelemetry import OTelAttribute
 from hatchet_sdk.waits import (
     Condition,
     OrGroup,
@@ -271,4 +272,7 @@ __all__ = [
     "BulkCancelReplayOpts",
     "RunFilter",
     "V1TaskStatus",
+    "OTelAttribute",
+    "OpenTelemetryConfig",
+    "ClientTLSConfig",
 ]

hatchet_sdk/client.py

@@ -5,6 +5,7 @@ from hatchet_sdk.clients.listeners.run_event_listener import RunEventListenerCli
 from hatchet_sdk.clients.listeners.workflow_listener import PooledWorkflowRunListener
 from hatchet_sdk.config import ClientConfig
 from hatchet_sdk.features.cron import CronClient
+from hatchet_sdk.features.filters import FiltersClient
 from hatchet_sdk.features.logs import LogsClient
 from hatchet_sdk.features.metrics import MetricsClient
 from hatchet_sdk.features.rate_limits import RateLimitsClient
@@ -34,6 +35,7 @@ class Client:
         self.debug = debug
 
         self.cron = CronClient(self.config)
+        self.filters = FiltersClient(self.config)
         self.logs = LogsClient(self.config)
         self.metrics = MetricsClient(self.config)
         self.rate_limits = RateLimitsClient(self.config)

hatchet_sdk/clients/admin.py

@@ -46,9 +46,7 @@ class ScheduleTriggerWorkflowOptions(BaseModel):
 
 
 class TriggerWorkflowOptions(ScheduleTriggerWorkflowOptions):
-    additional_metadata: JSONSerializableMapping = Field(default_factory=dict)
     desired_worker_id: str | None = None
-    namespace: str | None = None
     sticky: bool = False
     key: str | None = None
 
@@ -253,8 +251,7 @@ class AdminClient:
         try:
             namespace = options.namespace or self.namespace
 
-            if namespace != "" and not name.startswith(self.namespace):
-                name = f"{namespace}{name}"
+            name = self.config.apply_namespace(name, namespace)
 
             request = self._prepare_schedule_workflow_request(
                 name, schedules, input, options
@@ -312,8 +309,7 @@ class AdminClient:
 
         namespace = options.namespace or self.namespace
 
-        if namespace != "" and not workflow_name.startswith(self.namespace):
-            workflow_name = f"{namespace}{workflow_name}"
+        workflow_name = self.config.apply_namespace(workflow_name, namespace)
 
         return self._prepare_workflow_request(workflow_name, input, trigger_options)
 

hatchet_sdk/clients/dispatcher/action_listener.py

@@ -3,7 +3,7 @@ import json
 import time
 from dataclasses import field
 from enum import Enum
-from typing import Any, AsyncGenerator, cast
+from typing import TYPE_CHECKING, Any, AsyncGenerator, cast
 
 import grpc
 import grpc.aio
@@ -18,7 +18,6 @@ from hatchet_sdk.clients.events import proto_timestamp_now
 from hatchet_sdk.clients.listeners.run_event_listener import (
     DEFAULT_ACTION_LISTENER_RETRY_INTERVAL,
 )
-from hatchet_sdk.config import ClientConfig
 from hatchet_sdk.connection import new_conn
 from hatchet_sdk.contracts.dispatcher_pb2 import ActionType as ActionTypeProto
 from hatchet_sdk.contracts.dispatcher_pb2 import (
@@ -32,9 +31,14 @@ from hatchet_sdk.contracts.dispatcher_pb2_grpc import DispatcherStub
 from hatchet_sdk.logger import logger
 from hatchet_sdk.metadata import get_metadata
 from hatchet_sdk.utils.backoff import exp_backoff_sleep
+from hatchet_sdk.utils.opentelemetry import OTelAttribute
 from hatchet_sdk.utils.proto_enums import convert_proto_enum_to_python
 from hatchet_sdk.utils.typing import JSONSerializableMapping
 
+if TYPE_CHECKING:
+    from hatchet_sdk.config import ClientConfig
+
+
 DEFAULT_ACTION_TIMEOUT = 600  # seconds
 DEFAULT_ACTION_LISTENER_RETRY_COUNT = 15
 
@@ -73,14 +77,27 @@ class ActionPayload(BaseModel):
     step_run_errors: dict[str, str] = Field(default_factory=dict)
     triggered_by: str | None = None
     triggers: JSONSerializableMapping = Field(default_factory=dict)
+    filter_payload: JSONSerializableMapping = Field(default_factory=dict)
 
     @field_validator(
-        "input", "parents", "overrides", "user_data", "step_run_errors", mode="before"
+        "input",
+        "parents",
+        "overrides",
+        "user_data",
+        "step_run_errors",
+        "filter_payload",
+        mode="before",
     )
     @classmethod
     def validate_fields(cls, v: Any) -> Any:
         return v or {}
 
+    @model_validator(mode="after")
+    def validate_filter_payload(self) -> "ActionPayload":
+        self.filter_payload = self.triggers.get("filter_payload", {})
+
+        return self
+
 
 class ActionType(str, Enum):
     START_STEP_RUN = "START_STEP_RUN"
@@ -121,32 +138,35 @@ class Action(BaseModel):
         except Exception:
             return str(self.action_payload)
 
-    @property
-    def otel_attributes(self) -> dict[str, str | int]:
+    def get_otel_attributes(self, config: "ClientConfig") -> dict[str, str | int]:
         try:
             payload_str = json.dumps(self.action_payload.model_dump(), default=str)
         except Exception:
             payload_str = str(self.action_payload)
 
-        attrs: dict[str, str | int | None] = {
-            "hatchet.tenant_id": self.tenant_id,
-            "hatchet.worker_id": self.worker_id,
-            "hatchet.workflow_run_id": self.workflow_run_id,
-            "hatchet.step_id": self.step_id,
-            "hatchet.step_run_id": self.step_run_id,
-            "hatchet.retry_count": self.retry_count,
-            "hatchet.parent_workflow_run_id": self.parent_workflow_run_id,
-            "hatchet.child_workflow_index": self.child_workflow_index,
-            "hatchet.child_workflow_key": self.child_workflow_key,
-            "hatchet.action_payload": payload_str,
-            "hatchet.workflow_name": self.job_name,
-            "hatchet.action_name": self.action_id,
-            "hatchet.get_group_key_run_id": self.get_group_key_run_id,
-            "hatchet.workflow_id": self.workflow_id,
-            "hatchet.workflow_version_id": self.workflow_version_id,
+        attrs: dict[OTelAttribute, str | int | None] = {
+            OTelAttribute.TENANT_ID: self.tenant_id,
+            OTelAttribute.WORKER_ID: self.worker_id,
+            OTelAttribute.WORKFLOW_RUN_ID: self.workflow_run_id,
+            OTelAttribute.STEP_ID: self.step_id,
+            OTelAttribute.STEP_RUN_ID: self.step_run_id,
+            OTelAttribute.RETRY_COUNT: self.retry_count,
+            OTelAttribute.PARENT_WORKFLOW_RUN_ID: self.parent_workflow_run_id,
+            OTelAttribute.CHILD_WORKFLOW_INDEX: self.child_workflow_index,
+            OTelAttribute.CHILD_WORKFLOW_KEY: self.child_workflow_key,
+            OTelAttribute.ACTION_PAYLOAD: payload_str,
+            OTelAttribute.WORKFLOW_NAME: self.job_name,
+            OTelAttribute.ACTION_NAME: self.action_id,
+            OTelAttribute.GET_GROUP_KEY_RUN_ID: self.get_group_key_run_id,
+            OTelAttribute.WORKFLOW_ID: self.workflow_id,
+            OTelAttribute.WORKFLOW_VERSION_ID: self.workflow_version_id,
         }
 
-        return {k: v for k, v in attrs.items() if v}
+        return {
+            f"hatchet.{k.value}": v
+            for k, v in attrs.items()
+            if v and k not in config.otel.excluded_attributes
+        }
 
     @property
     def key(self) -> ActionKey:
@@ -172,7 +192,7 @@ def parse_additional_metadata(additional_metadata: str) -> JSONSerializableMappi
 
 
 class ActionListener:
-    def __init__(self, config: ClientConfig, worker_id: str) -> None:
+    def __init__(self, config: "ClientConfig", worker_id: str) -> None:
         self.config = config
         self.worker_id = worker_id
 

hatchet_sdk/clients/events.py

@@ -6,7 +6,12 @@ from typing import List, cast
 from google.protobuf import timestamp_pb2
 from pydantic import BaseModel, Field
 
+from hatchet_sdk.clients.rest.api.event_api import EventApi
+from hatchet_sdk.clients.rest.api.workflow_runs_api import WorkflowRunsApi
+from hatchet_sdk.clients.rest.api_client import ApiClient
+from hatchet_sdk.clients.rest.models.v1_event_list import V1EventList
 from hatchet_sdk.clients.rest.tenacity_utils import tenacity_retry
+from hatchet_sdk.clients.v1.api_client import BaseRestClient
 from hatchet_sdk.config import ClientConfig
 from hatchet_sdk.connection import new_conn
 from hatchet_sdk.contracts.events_pb2 import (
@@ -33,6 +38,8 @@ def proto_timestamp_now() -> timestamp_pb2.Timestamp:
 class PushEventOptions(BaseModel):
     additional_metadata: JSONSerializableMapping = Field(default_factory=dict)
     namespace: str | None = None
+    priority: int | None = None
+    scope: str | None = None
 
 
 class BulkPushEventOptions(BaseModel):
@@ -43,16 +50,26 @@ class BulkPushEventWithMetadata(BaseModel):
     key: str
     payload: JSONSerializableMapping = Field(default_factory=dict)
     additional_metadata: JSONSerializableMapping = Field(default_factory=dict)
+    priority: int | None = None
+    scope: str | None = None
 
 
-class EventClient:
+class EventClient(BaseRestClient):
     def __init__(self, config: ClientConfig):
+        super().__init__(config)
+
         conn = new_conn(config, False)
-        self.client = EventsServiceStub(conn)
+        self.events_service_client = EventsServiceStub(conn)
 
         self.token = config.token
         self.namespace = config.namespace
 
+    def _wra(self, client: ApiClient) -> WorkflowRunsApi:
+        return WorkflowRunsApi(client)
+
+    def _ea(self, client: ApiClient) -> EventApi:
+        return EventApi(client)
+
     async def aio_push(
         self,
         event_key: str,
@@ -79,7 +96,7 @@ class EventClient:
         options: PushEventOptions = PushEventOptions(),
     ) -> Event:
         namespace = options.namespace or self.namespace
-        namespaced_event_key = namespace + event_key
+        namespaced_event_key = self.client_config.apply_namespace(event_key, namespace)
 
         try:
             meta_bytes = json.dumps(options.additional_metadata)
@@ -96,16 +113,21 @@ class EventClient:
             payload=payload_str,
             eventTimestamp=proto_timestamp_now(),
             additionalMetadata=meta_bytes,
+            priority=options.priority,
+            scope=options.scope,
         )
 
-        return cast(Event, self.client.Push(request, metadata=get_metadata(self.token)))
+        return cast(
+            Event,
+            self.events_service_client.Push(request, metadata=get_metadata(self.token)),
+        )
 
     def _create_push_event_request(
         self,
         event: BulkPushEventWithMetadata,
         namespace: str,
     ) -> PushEventRequest:
-        event_key = namespace + event.key
+        event_key = self.client_config.apply_namespace(event.key, namespace)
         payload = event.payload
 
         meta = event.additional_metadata
@@ -125,6 +147,8 @@ class EventClient:
             payload=serialized_payload,
             eventTimestamp=proto_timestamp_now(),
             additionalMetadata=meta_str,
+            priority=event.priority,
+            scope=event.scope,
         )
 
     ## IMPORTANT: Keep this method's signature in sync with the wrapper in the OTel instrumentor
@@ -145,7 +169,9 @@ class EventClient:
         return list(
             cast(
                 Events,
-                self.client.BulkPush(bulk_request, metadata=get_metadata(self.token)),
+                self.events_service_client.BulkPush(
+                    bulk_request, metadata=get_metadata(self.token)
+                ),
             ).events
         )
 
@@ -157,7 +183,7 @@ class EventClient:
             message=message,
         )
 
-        self.client.PutLog(request, metadata=get_metadata(self.token))
+        self.events_service_client.PutLog(request, metadata=get_metadata(self.token))
 
     @tenacity_retry
     def stream(self, data: str | bytes, step_run_id: str) -> None:
@@ -174,4 +200,28 @@ class EventClient:
             message=data_bytes,
         )
 
-        self.client.PutStreamEvent(request, metadata=get_metadata(self.token))
+        self.events_service_client.PutStreamEvent(
+            request, metadata=get_metadata(self.token)
+        )
+
+    async def aio_list(
+        self,
+        offset: int | None = None,
+        limit: int | None = None,
+        keys: list[str] | None = None,
+    ) -> V1EventList:
+        return await asyncio.to_thread(self.list, offset=offset, limit=limit, keys=keys)
+
+    def list(
+        self,
+        offset: int | None = None,
+        limit: int | None = None,
+        keys: list[str] | None = None,
+    ) -> V1EventList:
+        with self.client() as client:
+            return self._ea(client).v1_event_list(
+                tenant=self.client_config.tenant_id,
+                offset=offset,
+                limit=limit,
+                keys=keys,
+            )

hatchet_sdk/clients/rest/__init__.py

@@ -20,6 +20,7 @@ __version__ = "1.0.0"
 from hatchet_sdk.clients.rest.api.api_token_api import APITokenApi
 from hatchet_sdk.clients.rest.api.default_api import DefaultApi
 from hatchet_sdk.clients.rest.api.event_api import EventApi
+from hatchet_sdk.clients.rest.api.filter_api import FilterApi
 from hatchet_sdk.clients.rest.api.github_api import GithubApi
 from hatchet_sdk.clients.rest.api.healthcheck_api import HealthcheckApi
 from hatchet_sdk.clients.rest.api.log_api import LogApi
@@ -229,7 +230,17 @@ from hatchet_sdk.clients.rest.models.user_tenant_memberships_list import (
 )
 from hatchet_sdk.clients.rest.models.user_tenant_public import UserTenantPublic
 from hatchet_sdk.clients.rest.models.v1_cancel_task_request import V1CancelTaskRequest
+from hatchet_sdk.clients.rest.models.v1_create_filter_request import (
+    V1CreateFilterRequest,
+)
 from hatchet_sdk.clients.rest.models.v1_dag_children import V1DagChildren
+from hatchet_sdk.clients.rest.models.v1_event import V1Event
+from hatchet_sdk.clients.rest.models.v1_event_list import V1EventList
+from hatchet_sdk.clients.rest.models.v1_event_workflow_run_summary import (
+    V1EventWorkflowRunSummary,
+)
+from hatchet_sdk.clients.rest.models.v1_filter import V1Filter
+from hatchet_sdk.clients.rest.models.v1_filter_list import V1FilterList
 from hatchet_sdk.clients.rest.models.v1_log_line import V1LogLine
 from hatchet_sdk.clients.rest.models.v1_log_line_level import V1LogLineLevel
 from hatchet_sdk.clients.rest.models.v1_log_line_list import V1LogLineList

hatchet_sdk/clients/rest/api/__init__.py

@@ -4,6 +4,7 @@
 from hatchet_sdk.clients.rest.api.api_token_api import APITokenApi
 from hatchet_sdk.clients.rest.api.default_api import DefaultApi
 from hatchet_sdk.clients.rest.api.event_api import EventApi
+from hatchet_sdk.clients.rest.api.filter_api import FilterApi
 from hatchet_sdk.clients.rest.api.github_api import GithubApi
 from hatchet_sdk.clients.rest.api.healthcheck_api import HealthcheckApi
 from hatchet_sdk.clients.rest.api.log_api import LogApi