feat(python): rename taskIdentifier to taskSlug (#187)

GitOrigin-RevId: 2967e7a87ecf72121819e1c5be51040ed306edc8

Author: blue-keleher

python/example/client/async_main.py

@@ -25,18 +25,18 @@ async def main():
     # Create client (uses RENDER_API_KEY from environment)
     render = RenderAsync()
 
-    # Replace with your workflow slug and task identifier
-    task_identifier = "my-workflow-slug/task-name"
+    # Replace with your workflow slug and task name
+    task_slug = "my-workflow-slug/task-name"
     # Input data can be specified as a list of positional arguments or a
     # dictionary of named arguments
     input_data: dict[str, Any] = {"arg1": 3}
 
     # run_task() starts a task and waits for the result in one call
-    result = await render.workflows.run_task(task_identifier, input_data)
+    result = await render.workflows.run_task(task_slug, input_data)
     print(f"Task completed: {result.status}, results: {result.results}")
 
     # start_task() returns an awaitable task run for fire-and-forget or deferred waiting
-    task_run = await render.workflows.start_task(task_identifier, input_data)
+    task_run = await render.workflows.start_task(task_slug, input_data)
     print(f"Task started with ID: {task_run.id}")
 
     # Wait for task completion by awaiting the task run
@@ -50,7 +50,7 @@ async def main():
 
     # Stream task run events directly. This is useful when you want to monitor
     # multiple task runs or handle events as they arrive.
-    task_run2 = await render.workflows.start_task(task_identifier, input_data)
+    task_run2 = await render.workflows.start_task(task_slug, input_data)
     print("Streaming task run events...")
     async for event in render.workflows.task_run_events([task_run2.id]):
         print(f"  Event: {event.id} status={event.status}")
@@ -62,7 +62,7 @@ async def main():
     print(f"Task run details: {details.id} status={details.status}")
 
     # Cancel a task run
-    task_run3 = await render.workflows.start_task(task_identifier, input_data)
+    task_run3 = await render.workflows.start_task(task_slug, input_data)
     await render.workflows.cancel_task_run(task_run3.id)
     print(f"Cancelled task run: {task_run3.id}")
 

python/example/client/main.py

@@ -21,37 +21,37 @@
 # Create client (uses RENDER_API_KEY from environment)
 render = Render()
 
-# Replace with your workflow slug and task identifier
-task_identifier = "my-workflow-slug/task-name"
+# Replace with your workflow slug and task name
+task_slug = "my-workflow-slug/task-name"
 # Input data can be specified as a list of positional arguments or a
 # dictionary of named arguments
 input_data: dict[str, Any] = {"arg1": 3}
 
 # run_task() starts a task and waits for the result in one call
 try:
-    result = render.workflows.run_task(task_identifier, input_data)
+    result = render.workflows.run_task(task_slug, input_data)
     print(f"Task completed: {result.status}, results: {result.results}")
 except TaskRunError as e:
     print(f"Task failed or was cancelled: {e}")
 except RenderError as e:
     print(f"Error running task: {e}")
 
 # start_task() starts a task without waiting for the result
-task_run = render.workflows.start_task(task_identifier, input_data)
+task_run = render.workflows.start_task(task_slug, input_data)
 print(f"Task started with ID: {task_run.id}")
 
 # Get task run details by ID
 details = render.workflows.get_task_run(task_run.id)
 print(f"Task run details: {details.id} status={details.status}")
 
 # Cancel a task run
-task_run2 = render.workflows.start_task(task_identifier, input_data)
+task_run2 = render.workflows.start_task(task_slug, input_data)
 render.workflows.cancel_task_run(task_run2.id)
 print(f"Cancelled task run: {task_run2.id}")
 
 # Stream task run events. This is useful when you want to monitor
 # multiple task runs or handle events as they arrive.
-task_run3 = render.workflows.start_task(task_identifier, input_data)
+task_run3 = render.workflows.start_task(task_slug, input_data)
 print("Streaming task run events...")
 for event in render.workflows.task_run_events([task_run3.id]):
     print(f"  Event: {event.id} status={event.status}")

python/render_sdk/client/__init__.py

@@ -10,10 +10,10 @@
     ListTaskRunsParams,
     OwnerIDParam,
     TaskData,
-    TaskIdentifier,
     TaskRun,
     TaskRunDetails,
     TaskRunStatus,
+    TaskSlug,
 )
 from render_sdk.client.workflows import WorkflowsService
 from render_sdk.client.workflows_sync import SyncWorkflowsService
@@ -38,7 +38,7 @@
     "WorkflowsService",
     "SyncWorkflowsService",
     "TaskData",
-    "TaskIdentifier",
+    "TaskSlug",
     "TaskRun",
     "TaskRunDetails",
     "TaskRunStatus",

python/render_sdk/client/types.py

@@ -10,7 +10,7 @@
 from render_sdk.public_api.models.task_run_status import TaskRunStatus as _TaskRunStatus
 
 # Type aliases to match Go client interface
-TaskIdentifier = str
+TaskSlug = str
 # TaskData can be either positional (list) or named (dict) parameters
 TaskData = list[Any] | dict[str, Any]
 
@@ -46,7 +46,7 @@ class TaskRunStatusValues:
 
     PENDING = "pending"
     RUNNING = "running"
-    COMPLETED = "completed"
+    COMPLETED = "completed"  # deprecated, use SUCCEEDED instead
     SUCCEEDED = "succeeded"
     FAILED = "failed"
     CANCELED = "canceled"

python/render_sdk/client/workflows.py

@@ -13,10 +13,10 @@
 from render_sdk.client.types import (
     ListTaskRunsParams,
     TaskData,
-    TaskIdentifier,
     TaskRun,
     TaskRunDetails,
     TaskRunStatusValues,
+    TaskSlug,
 )
 from render_sdk.client.util import (
     handle_http_error,
@@ -181,7 +181,7 @@ async def task_run_events(
 
     async def start_task(
         self,
-        task_identifier: TaskIdentifier,
+        task_slug: TaskSlug,
         input_data: TaskData,
     ) -> AwaitableTaskRun:
         """Start a task and return an awaitable task run without waiting for completion.
@@ -198,7 +198,7 @@ async def start_task(
         This corresponds to POST /task-runs in the API.
 
         Args:
-            task_identifier: The identifier of the task to run
+            task_slug: The task slug (workflow-slug/task-name)
             input_data: The input data for the task. Can be either:
                 - A list for positional arguments: [arg1, arg2, arg3]
                 - A dict for named parameters: {"param1": value1, "param2": value2}
@@ -211,15 +211,13 @@ async def start_task(
             ServerError: For 5xx server errors and network failures
             TimeoutError: If the request times out
         """
-        response = (
-            await self._create_task_api_call(task_identifier, input_data)
-        ).parsed
+        response = (await self._create_task_api_call(task_slug, input_data)).parsed
 
         return AwaitableTaskRun(response, self)
 
     async def run_task(
         self,
-        task_identifier: TaskIdentifier,
+        task_slug: TaskSlug,
         input_data: TaskData,
     ) -> TaskRunDetails:
         """Start a task and wait for it to complete, returning the result.
@@ -228,7 +226,7 @@ async def run_task(
         waits for the task to complete.
 
         Args:
-            task_identifier: The identifier of the task to run
+            task_slug: The task slug (workflow-slug/task-name)
             input_data: The input data for the task. Can be either:
                 - A list for positional arguments: [arg1, arg2, arg3]
                 - A dict for named parameters: {"param1": value1, "param2": value2}
@@ -242,12 +240,12 @@ async def run_task(
             TimeoutError: If the request times out
             TaskRunError: If the task run fails with an error
         """
-        task_run = await self.start_task(task_identifier, input_data)
+        task_run = await self.start_task(task_slug, input_data)
         return await task_run
 
     @handle_http_errors("create task")
     async def _create_task_api_call(
-        self, task_identifier: TaskIdentifier, input_data: TaskData
+        self, task_slug: TaskSlug, input_data: TaskData
     ) -> Response[Error | TaskRun]:
         """Internal method to make the create task API call."""
         # Convert dict to TaskDataType1 for named parameters
@@ -259,7 +257,7 @@ async def _create_task_api_call(
 
         # Create the request body
         run_task = RunTask(
-            task=task_identifier,
+            task=task_slug,
             input_=task_data_input,
         )
 

python/render_sdk/client/workflows_sync.py

@@ -14,10 +14,10 @@
 from render_sdk.client.types import (
     ListTaskRunsParams,
     TaskData,
-    TaskIdentifier,
     TaskRun,
     TaskRunDetails,
     TaskRunStatusValues,
+    TaskSlug,
 )
 from render_sdk.client.util import handle_http_error, handle_httpx_exception
 from render_sdk.client.util_sync import handle_http_errors, retry_with_backoff
@@ -102,7 +102,7 @@ def task_run_events(
 
     def start_task(
         self,
-        task_identifier: TaskIdentifier,
+        task_slug: TaskSlug,
         input_data: TaskData,
     ) -> TaskRun:
         """Start a task and return the task run without waiting for completion.
@@ -113,7 +113,7 @@ def start_task(
         This corresponds to POST /task-runs in the API.
 
         Args:
-            task_identifier: The identifier of the task to run
+            task_slug: The task slug (workflow-slug/task-name)
             input_data: The input data for the task. Can be either:
                 - A list for positional arguments: [arg1, arg2, arg3]
                 - A dict for named parameters: {"param1": value1, "param2": value2}
@@ -126,19 +126,19 @@ def start_task(
             ServerError: For 5xx server errors and network failures
             TimeoutError: If the request times out
         """
-        return self._create_task_api_call(task_identifier, input_data).parsed
+        return self._create_task_api_call(task_slug, input_data).parsed
 
     def run_task(
         self,
-        task_identifier: TaskIdentifier,
+        task_slug: TaskSlug,
         input_data: TaskData,
     ) -> TaskRunDetails:
         """Start a task and wait for it to complete, returning the result.
 
         This corresponds to POST /task-runs in the API.
 
         Args:
-            task_identifier: The identifier of the task to run
+            task_slug: The task slug (workflow-slug/task-name)
             input_data: The input data for the task. Can be either:
                 - A list for positional arguments: [arg1, arg2, arg3]
                 - A dict for named parameters: {"param1": value1, "param2": value2}
@@ -152,7 +152,7 @@ def run_task(
             TimeoutError: If the request times out
             TaskRunError: If the task run fails with an error
         """
-        task_run = self.start_task(task_identifier, input_data)
+        task_run = self.start_task(task_slug, input_data)
 
         # If already in a terminal state, just get the details
         status = task_run.status.value
@@ -182,7 +182,7 @@ def _task_run_completed_with_sse(self, task_run_id: str) -> TaskRunDetails:
 
     @handle_http_errors("create task")
     def _create_task_api_call(
-        self, task_identifier: TaskIdentifier, input_data: TaskData
+        self, task_slug: TaskSlug, input_data: TaskData
     ) -> Response[Error | TaskRun]:
         """Internal method to make the create task API call."""
         # Convert dict to TaskDataType1 for named parameters
@@ -194,7 +194,7 @@ def _create_task_api_call(
 
         # Create the request body
         run_task = RunTask(
-            task=task_identifier,
+            task=task_slug,
             input_=task_data_input,
         )