dbos 0.26.0a9__tar.gz → 0.26.0a11__tar.gz

{dbos-0.26.0a9 → dbos-0.26.0a11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dbos
-Version: 0.26.0a9
+Version: 0.26.0a11
 Summary: Ultra-lightweight durable execution in Python
 Author-Email: "DBOS, Inc." <contact@dbos.dev>
 License: MIT

{dbos-0.26.0a9 → dbos-0.26.0a11}/dbos/_client.py

@@ -1,7 +1,7 @@
 import asyncio
 import sys
 import uuid
-from typing import Any, Generic, Optional, TypedDict, TypeVar
+from typing import Any, Generic, List, Optional, TypedDict, TypeVar
 
 if sys.version_info < (3, 11):
     from typing_extensions import NotRequired
@@ -15,7 +15,12 @@ from dbos._error import DBOSNonExistentWorkflowError
 from dbos._registrations import DEFAULT_MAX_RECOVERY_ATTEMPTS
 from dbos._serialization import WorkflowInputs
 from dbos._sys_db import SystemDatabase, WorkflowStatusInternal, WorkflowStatusString
-from dbos._workflow_commands import WorkflowStatus, get_workflow
+from dbos._workflow_commands import (
+    WorkflowStatus,
+    get_workflow,
+    list_queued_workflows,
+    list_workflows,
+)
 
 R = TypeVar("R", covariant=True)  # A generic type for workflow return values
 
@@ -202,3 +207,119 @@ class DBOSClient:
         return await asyncio.to_thread(
             self.get_event, workflow_id, key, timeout_seconds
         )
+
+    def cancel_workflow(self, workflow_id: str) -> None:
+        self._sys_db.cancel_workflow(workflow_id)
+
+    async def cancel_workflow_async(self, workflow_id: str) -> None:
+        await asyncio.to_thread(self.cancel_workflow, workflow_id)
+
+    def resume_workflow(self, workflow_id: str) -> None:
+        self._sys_db.resume_workflow(workflow_id)
+
+    async def resume_workflow_async(self, workflow_id: str) -> None:
+        await asyncio.to_thread(self.resume_workflow, workflow_id)
+
+    def list_workflows(
+        self,
+        *,
+        workflow_ids: Optional[List[str]] = None,
+        status: Optional[str] = None,
+        start_time: Optional[str] = None,
+        end_time: Optional[str] = None,
+        name: Optional[str] = None,
+        app_version: Optional[str] = None,
+        user: Optional[str] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        sort_desc: bool = False,
+    ) -> List[WorkflowStatus]:
+        return list_workflows(
+            self._sys_db,
+            workflow_ids=workflow_ids,
+            status=status,
+            start_time=start_time,
+            end_time=end_time,
+            name=name,
+            app_version=app_version,
+            user=user,
+            limit=limit,
+            offset=offset,
+            sort_desc=sort_desc,
+        )
+
+    async def list_workflows_async(
+        self,
+        *,
+        workflow_ids: Optional[List[str]] = None,
+        status: Optional[str] = None,
+        start_time: Optional[str] = None,
+        end_time: Optional[str] = None,
+        name: Optional[str] = None,
+        app_version: Optional[str] = None,
+        user: Optional[str] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        sort_desc: bool = False,
+    ) -> List[WorkflowStatus]:
+        return await asyncio.to_thread(
+            self.list_workflows,
+            workflow_ids=workflow_ids,
+            status=status,
+            start_time=start_time,
+            end_time=end_time,
+            name=name,
+            app_version=app_version,
+            user=user,
+            limit=limit,
+            offset=offset,
+            sort_desc=sort_desc,
+        )
+
+    def list_queued_workflows(
+        self,
+        *,
+        queue_name: Optional[str] = None,
+        status: Optional[str] = None,
+        start_time: Optional[str] = None,
+        end_time: Optional[str] = None,
+        name: Optional[str] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        sort_desc: bool = False,
+    ) -> List[WorkflowStatus]:
+        return list_queued_workflows(
+            self._sys_db,
+            queue_name=queue_name,
+            status=status,
+            start_time=start_time,
+            end_time=end_time,
+            name=name,
+            limit=limit,
+            offset=offset,
+            sort_desc=sort_desc,
+        )
+
+    async def list_queued_workflows_async(
+        self,
+        *,
+        queue_name: Optional[str] = None,
+        status: Optional[str] = None,
+        start_time: Optional[str] = None,
+        end_time: Optional[str] = None,
+        name: Optional[str] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        sort_desc: bool = False,
+    ) -> List[WorkflowStatus]:
+        return await asyncio.to_thread(
+            self.list_queued_workflows,
+            queue_name=queue_name,
+            status=status,
+            start_time=start_time,
+            end_time=end_time,
+            name=name,
+            limit=limit,
+            offset=offset,
+            sort_desc=sort_desc,
+        )

{dbos-0.26.0a9 → dbos-0.26.0a11}/dbos/_dbos.py

@@ -1061,11 +1061,11 @@ class DBOS:
 
     @classproperty
     def step_id(cls) -> int:
-        """Return the step ID for the current context. This is a unique identifier of the current step within the workflow."""
+        """Return the step ID for the currently executing step. This is a unique identifier of the current step within the workflow."""
         ctx = assert_current_dbos_context()
         assert (
-            ctx.is_within_workflow()
-        ), "step_id is only available within a DBOS workflow."
+            ctx.is_step() or ctx.is_transaction()
+        ), "step_id is only available within a DBOS step."
         return ctx.function_id
 
     @classproperty

{dbos-0.26.0a9 → dbos-0.26.0a11}/dbos/_sys_db.py

@@ -1569,7 +1569,9 @@ class SystemDatabase:
 
     def call_function_as_step(self, fn: Callable[[], T], function_name: str) -> T:
         ctx = get_local_dbos_context()
-        if ctx and ctx.is_within_workflow():
+        if ctx and ctx.is_transaction():
+            raise Exception(f"Invalid call to `{function_name}` inside a transaction")
+        if ctx and ctx.is_workflow():
             ctx.function_id += 1
             res = self.check_operation_execution(
                 ctx.workflow_id, ctx.function_id, function_name
@@ -1587,7 +1589,7 @@ class SystemDatabase:
                         f"Recorded output and error are both None for {function_name}"
                     )
         result = fn()
-        if ctx and ctx.is_within_workflow():
+        if ctx and ctx.is_workflow():
             self.record_operation_result(
                 {
                     "workflow_uuid": ctx.workflow_id,

{dbos-0.26.0a9 → dbos-0.26.0a11}/pyproject.toml

@@ -28,7 +28,7 @@ dependencies = [
 ]
 requires-python = ">=3.9"
 readme = "README.md"
-version = "0.26.0a9"
+version = "0.26.0a11"
 
 [project.license]
 text = "MIT"

{dbos-0.26.0a9 → dbos-0.26.0a11}/tests/test_workflow_introspection.py

@@ -990,3 +990,39 @@ def test_list_workflows_as_step(dbos: DBOS) -> None:
     workflow_event.set()
     assert handle.get_result() == 1
     assert handle_two.get_result() == 1
+
+
+def test_call_as_step_within_step(
+    dbos: DBOS, sys_db: SystemDatabase, app_db: ApplicationDatabase
+) -> None:
+    # If we call any util functions within a step, it should be called directly without checkpointing
+
+    @DBOS.step()
+    def getStatus(workflow_id: str) -> str:
+        status = DBOS.get_workflow_status(workflow_id)
+        assert status is not None
+        return status.status
+
+    @DBOS.workflow()
+    def getStatusWorkflow() -> str:
+        return getStatus(DBOS.workflow_id)
+
+    @DBOS.transaction()
+    def transactionStatus() -> None:
+        DBOS.get_workflow_status(DBOS.workflow_id)
+
+    wfid = str(uuid.uuid4())
+    with SetWorkflowID(wfid):
+        status = getStatusWorkflow()
+        assert status == WorkflowStatusString.PENDING.value
+
+    steps = _workflow_commands.list_workflow_steps(sys_db, app_db, wfid)
+
+    assert len(steps) == 1
+    assert steps[0]["function_name"] == getStatus.__qualname__
+
+    with pytest.raises(Exception) as exc_info:
+        transactionStatus()
+    assert "Invalid call to `DBOS.getStatus` inside a transaction" in str(
+        exc_info.value
+    )