dbos 1.8.0a5__tar.gz → 1.9.0__tar.gz

{dbos-1.8.0a5 → dbos-1.9.0}/PKG-INFO

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

{dbos-1.8.0a5 → dbos-1.9.0}/dbos/_core.py

@@ -49,6 +49,7 @@ from ._context import (
     get_local_dbos_context,
 )
 from ._error import (
+    DBOSAwaitedWorkflowCancelledError,
     DBOSException,
     DBOSMaxStepRetriesExceeded,
     DBOSNonExistentWorkflowError,
@@ -370,7 +371,7 @@ def _get_wf_invoke_func(
             r: R = dbos._sys_db.await_workflow_result(status["workflow_uuid"])
             return r
         except DBOSWorkflowCancelledError as error:
-            raise
+            raise DBOSAwaitedWorkflowCancelledError(status["workflow_uuid"])
         except Exception as error:
             if not dbos.debug_mode:
                 dbos._sys_db.update_workflow_outcome(

{dbos-1.8.0a5 → dbos-1.9.0}/dbos/_dbos.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import asyncio
-import atexit
 import hashlib
 import inspect
 import os
@@ -1219,39 +1218,40 @@ class DBOS:
         return rv
 
     @classproperty
-    def workflow_id(cls) -> str:
-        """Return the workflow ID for the current context, which must be executing a workflow function."""
-        ctx = assert_current_dbos_context()
-        assert (
-            ctx.is_within_workflow()
-        ), "workflow_id is only available within a DBOS operation."
-        return ctx.workflow_id
+    def workflow_id(cls) -> Optional[str]:
+        """Return the ID of the currently executing workflow. If a workflow is not executing, return None."""
+        ctx = get_local_dbos_context()
+        if ctx and ctx.is_within_workflow():
+            return ctx.workflow_id
+        else:
+            return None
 
     @classproperty
-    def step_id(cls) -> int:
-        """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_step() or ctx.is_transaction()
-        ), "step_id is only available within a DBOS step."
-        return ctx.function_id
+    def step_id(cls) -> Optional[int]:
+        """Return the step ID for the currently executing step. This is a unique identifier of the current step within the workflow. If a step is not currently executing, return None."""
+        ctx = get_local_dbos_context()
+        if ctx and (ctx.is_step() or ctx.is_transaction()):
+            return ctx.function_id
+        else:
+            return None
 
     @classproperty
-    def step_status(cls) -> StepStatus:
-        """Return the status of the currently executing step."""
-        ctx = assert_current_dbos_context()
-        assert ctx.is_step(), "step_status is only available within a DBOS step."
-        assert ctx.step_status is not None
-        return ctx.step_status
+    def step_status(cls) -> Optional[StepStatus]:
+        """Return the status of the currently executing step. If a step is not currently executing, return None."""
+        ctx = get_local_dbos_context()
+        if ctx and ctx.is_step():
+            return ctx.step_status
+        else:
+            return None
 
     @classproperty
     def parent_workflow_id(cls) -> str:
         """
-        Return the workflow ID for the parent workflow.
-
-        `parent_workflow_id` must be accessed from within a workflow function.
+        This method is deprecated and should not be used.
         """
-
+        dbos_logger.warning(
+            "DBOS.parent_workflow_id is deprecated and should not be used"
+        )
         ctx = assert_current_dbos_context()
         assert (
             ctx.is_within_workflow()
@@ -1376,31 +1376,3 @@ class DBOSConfiguredInstance:
     def __init__(self, config_name: str) -> None:
         self.config_name = config_name
         DBOS.register_instance(self)
-
-
-# Apps that import DBOS probably don't exit.  If they do, let's see if
-#   it looks like startup was abandoned or a call was forgotten...
-def _dbos_exit_hook() -> None:
-    if _dbos_global_registry is None:
-        # Probably used as or for a support module
-        return
-    if _dbos_global_instance is None:
-        print("DBOS exiting; functions were registered but DBOS() was not called")
-        dbos_logger.warning(
-            "DBOS exiting; functions were registered but DBOS() was not called"
-        )
-        return
-    if not _dbos_global_instance._launched:
-        if _dbos_global_instance.fastapi is not None:
-            # FastAPI lifespan middleware will call launch/destroy, so we can ignore this.
-            # This is likely to happen during fastapi dev runs, where the reloader loads the module multiple times.
-            return
-        print("DBOS exiting; DBOS exists but launch() was not called")
-        dbos_logger.warning("DBOS exiting; DBOS exists but launch() was not called")
-        return
-    # If we get here, we're exiting normally
-    _dbos_global_instance.destroy()
-
-
-# Register the exit hook
-atexit.register(_dbos_exit_hook)

{dbos-1.8.0a5 → dbos-1.9.0}/dbos/_error.py

@@ -55,7 +55,7 @@ class DBOSErrorCode(Enum):
     InitializationError = 3
     WorkflowFunctionNotFound = 4
     NonExistentWorkflowError = 5
-    DeadLetterQueueError = 6
+    MaxRecoveryAttemptsExceeded = 6
     MaxStepRetriesExceeded = 7
     NotAuthorized = 8
     ConflictingWorkflowError = 9
@@ -121,13 +121,13 @@ class DBOSNonExistentWorkflowError(DBOSException):
         )
 
 
-class DBOSDeadLetterQueueError(DBOSException):
-    """Exception raised when a workflow database record does not exist for a given ID."""
+class MaxRecoveryAttemptsExceededError(DBOSException):
+    """Exception raised when a workflow exceeds its max recovery attempts."""
 
     def __init__(self, wf_id: str, max_retries: int):
         super().__init__(
-            f"Workflow {wf_id} has been moved to the dead-letter queue after exceeding the maximum of {max_retries} retries",
-            dbos_error_code=DBOSErrorCode.DeadLetterQueueError.value,
+            f"Workflow {wf_id} has exceeded its maximum of {max_retries} execution or recovery attempts. Further attempts to execute or recover it will fail. See documentation for details: https://docs.dbos.dev/python/reference/decorators",
+            dbos_error_code=DBOSErrorCode.MaxRecoveryAttemptsExceeded.value,
         )
 
 

{dbos-1.8.0a5 → dbos-1.9.0}/dbos/_sys_db.py

@@ -37,12 +37,12 @@ from ._context import get_local_dbos_context
 from ._error import (
     DBOSAwaitedWorkflowCancelledError,
     DBOSConflictingWorkflowError,
-    DBOSDeadLetterQueueError,
     DBOSNonExistentWorkflowError,
     DBOSQueueDeduplicatedError,
     DBOSUnexpectedStepError,
     DBOSWorkflowCancelledError,
     DBOSWorkflowConflictIDError,
+    MaxRecoveryAttemptsExceededError,
 )
 from ._logger import dbos_logger
 from ._schemas.system_database import SystemSchema
@@ -57,20 +57,25 @@ class WorkflowStatusString(Enum):
     PENDING = "PENDING"
     SUCCESS = "SUCCESS"
     ERROR = "ERROR"
-    RETRIES_EXCEEDED = "RETRIES_EXCEEDED"
+    MAX_RECOVERY_ATTEMPTS_EXCEEDED = "MAX_RECOVERY_ATTEMPTS_EXCEEDED"
     CANCELLED = "CANCELLED"
     ENQUEUED = "ENQUEUED"
 
 
 WorkflowStatuses = Literal[
-    "PENDING", "SUCCESS", "ERROR", "RETRIES_EXCEEDED", "CANCELLED", "ENQUEUED"
+    "PENDING",
+    "SUCCESS",
+    "ERROR",
+    "MAX_RECOVERY_ATTEMPTS_EXCEEDED",
+    "CANCELLED",
+    "ENQUEUED",
 ]
 
 
 class WorkflowStatus:
     # The workflow ID
     workflow_id: str
-    # The workflow status. Must be one of ENQUEUED, PENDING, SUCCESS, ERROR, CANCELLED, or RETRIES_EXCEEDED
+    # The workflow status. Must be one of ENQUEUED, PENDING, SUCCESS, ERROR, CANCELLED, or MAX_RECOVERY_ATTEMPTS_EXCEEDED
     status: str
     # The name of the workflow function
     name: str
@@ -515,7 +520,7 @@ class SystemDatabase:
                 raise DBOSConflictingWorkflowError(status["workflow_uuid"], err_msg)
 
             # Every time we start executing a workflow (and thus attempt to insert its status), we increment `recovery_attempts` by 1.
-            # When this number becomes equal to `maxRetries + 1`, we mark the workflow as `RETRIES_EXCEEDED`.
+            # When this number becomes equal to `maxRetries + 1`, we mark the workflow as `MAX_RECOVERY_ATTEMPTS_EXCEEDED`.
             if (
                 (wf_status != "SUCCESS" and wf_status != "ERROR")
                 and max_recovery_attempts is not None
@@ -532,7 +537,7 @@ class SystemDatabase:
                         == WorkflowStatusString.PENDING.value
                     )
                     .values(
-                        status=WorkflowStatusString.RETRIES_EXCEEDED.value,
+                        status=WorkflowStatusString.MAX_RECOVERY_ATTEMPTS_EXCEEDED.value,
                         deduplication_id=None,
                         started_at_epoch_ms=None,
                         queue_name=None,
@@ -541,7 +546,7 @@ class SystemDatabase:
                 conn.execute(dlq_cmd)
                 # Need to commit here because we're throwing an exception
                 conn.commit()
-                raise DBOSDeadLetterQueueError(
+                raise MaxRecoveryAttemptsExceededError(
                     status["workflow_uuid"], max_recovery_attempts
                 )
 

{dbos-1.8.0a5 → dbos-1.9.0}/dbos/cli/cli.py

@@ -10,7 +10,7 @@ from typing import Any, Optional
 import jsonpickle  # type: ignore
 import sqlalchemy as sa
 import typer
-from rich import print
+from rich import print as richprint
 from rich.prompt import IntPrompt
 from typing_extensions import Annotated, List
 
@@ -196,7 +196,7 @@ def init(
                 path.join(templates_dir, template), project_name, config_mode=config
             )
     except Exception as e:
-        print(f"[red]{e}[/red]")
+        richprint(f"[red]{e}[/red]")
 
 
 def _resolve_project_name_and_template(
@@ -217,9 +217,9 @@ def _resolve_project_name_and_template(
         if template not in templates:
             raise Exception(f"Template {template} not found in {templates_dir}")
     else:
-        print("\n[bold]Available templates:[/bold]")
+        richprint("\n[bold]Available templates:[/bold]")
         for idx, template_name in enumerate(templates, 1):
-            print(f"  {idx}. {template_name}")
+            richprint(f"  {idx}. {template_name}")
         while True:
             try:
                 choice = IntPrompt.ask(
@@ -231,13 +231,13 @@ def _resolve_project_name_and_template(
                     template = templates[choice - 1]
                     break
                 else:
-                    print(
+                    richprint(
                         "[red]Invalid selection. Please choose a number from the list.[/red]"
                     )
             except (KeyboardInterrupt, EOFError):
                 raise typer.Abort()
             except ValueError:
-                print("[red]Please enter a valid number.[/red]")
+                richprint("[red]Please enter a valid number.[/red]")
 
     if template in git_templates:
         if project_name is None:
@@ -450,7 +450,7 @@ def list(
         typer.Option(
             "--status",
             "-S",
-            help="Retrieve workflows with this status (PENDING, SUCCESS, ERROR, RETRIES_EXCEEDED, ENQUEUED, or CANCELLED)",
+            help="Retrieve workflows with this status (PENDING, SUCCESS, ERROR, ENQUEUED, CANCELLED, or MAX_RECOVERY_ATTEMPTS_EXCEEDED)",
         ),
     ] = None,
     appversion: Annotated[
@@ -657,7 +657,7 @@ def list_queue(
         typer.Option(
             "--status",
             "-S",
-            help="Retrieve functions with this status (PENDING, SUCCESS, ERROR, RETRIES_EXCEEDED, ENQUEUED, or CANCELLED)",
+            help="Retrieve functions with this status (PENDING, SUCCESS, ERROR, ENQUEUED, CANCELLED, or MAX_RECOVERY_ATTEMPTS_EXCEEDED)",
         ),
     ] = None,
     queue_name: Annotated[

{dbos-1.8.0a5 → dbos-1.9.0}/pyproject.toml

@@ -27,7 +27,7 @@ dependencies = [
 ]
 requires-python = ">=3.9"
 readme = "README.md"
-version = "1.8.0a5"
+version = "1.9.0"
 
 [project.license]
 text = "MIT"

{dbos-1.8.0a5 → dbos-1.9.0}/tests/test_admin_server.py

@@ -20,7 +20,7 @@ from dbos import (
     WorkflowHandle,
     _workflow_commands,
 )
-from dbos._error import DBOSWorkflowCancelledError
+from dbos._error import DBOSAwaitedWorkflowCancelledError
 from dbos._schemas.system_database import SystemSchema
 from dbos._sys_db import SystemDatabase, WorkflowStatusString
 from dbos._utils import INTERNAL_QUEUE_NAME, GlobalParams
@@ -104,7 +104,7 @@ def test_deactivate(dbos: DBOS, config: DBOSConfig) -> None:
         assert event.is_set()
     # Verify the scheduled workflow does not run anymore
     time.sleep(5)
-    assert wf_counter <= val + 1
+    assert wf_counter <= val + 2
     # Enqueue a workflow, verify it still runs
     assert queue.enqueue(regular_workflow).get_result() == 5
 
@@ -142,7 +142,6 @@ def test_admin_recovery(config: DBOSConfig) -> None:
 
     @DBOS.workflow()
     def test_workflow(var: str, var2: str) -> str:
-        DBOS.logger.info("WFID: " + DBOS.workflow_id)
         nonlocal wf_counter
         wf_counter += 1
         res = test_step(var2)
@@ -307,7 +306,7 @@ def test_admin_workflow_resume(dbos: DBOS, sys_db: SystemDatabase) -> None:
     )
     assert response.status_code == 204
     event.set()
-    with pytest.raises(DBOSWorkflowCancelledError):
+    with pytest.raises(DBOSAwaitedWorkflowCancelledError):
         handle.get_result()
     info = _workflow_commands.get_workflow(sys_db, wfid)
     assert info is not None
@@ -464,7 +463,9 @@ def test_list_workflows(dbos: DBOS) -> None:
 
     @DBOS.workflow()
     def test_workflow_2(my_time: datetime) -> str:
-        return DBOS.workflow_id + " completed at " + my_time.isoformat()
+        workflow_id = DBOS.workflow_id
+        assert workflow_id is not None
+        return workflow_id + " completed at " + my_time.isoformat()
 
     # Start workflows
     handle_1 = DBOS.start_workflow(test_workflow_1)
@@ -656,7 +657,9 @@ def test_get_workflow_by_id(dbos: DBOS) -> None:
 
     @DBOS.workflow()
     def test_workflow_2(my_time: datetime) -> str:
-        return DBOS.workflow_id + " completed at " + my_time.isoformat()
+        workflow_id = DBOS.workflow_id
+        assert workflow_id is not None
+        return workflow_id + " completed at " + my_time.isoformat()
 
     # Start workflows
     handle_1 = DBOS.start_workflow(test_workflow_1)
@@ -713,7 +716,9 @@ def test_admin_garbage_collect(dbos: DBOS) -> None:
 
     @DBOS.workflow()
     def workflow() -> str:
-        return DBOS.workflow_id
+        workflow_id = DBOS.workflow_id
+        assert workflow_id is not None
+        return workflow_id
 
     workflow()
 
@@ -745,7 +750,7 @@ def test_admin_global_timeout(dbos: DBOS) -> None:
         timeout=5,
     )
     response.raise_for_status()
-    with pytest.raises(DBOSWorkflowCancelledError):
+    with pytest.raises(DBOSAwaitedWorkflowCancelledError):
         handle.get_result()
 
 

{dbos-1.8.0a5 → dbos-1.9.0}/tests/test_async.py

@@ -18,7 +18,7 @@ from dbos import (
 from dbos._context import assert_current_dbos_context
 from dbos._dbos import WorkflowHandle
 from dbos._dbos_config import ConfigFile
-from dbos._error import DBOSException, DBOSWorkflowCancelledError
+from dbos._error import DBOSAwaitedWorkflowCancelledError, DBOSException
 
 
 @pytest.mark.asyncio
@@ -32,12 +32,12 @@ async def test_async_workflow(dbos: DBOS) -> None:
         nonlocal wf_counter
         wf_counter += 1
         res1 = test_transaction(var1)
-        res2 = test_step(var2)
+        res2 = await test_step(var2)
         DBOS.logger.info("I'm test_workflow")
         return res1 + res2
 
     @DBOS.step()
-    def test_step(var: str) -> str:
+    async def test_step(var: str) -> str:
         nonlocal step_counter
         step_counter += 1
         DBOS.logger.info("I'm test_step")
@@ -73,6 +73,10 @@ async def test_async_workflow(dbos: DBOS) -> None:
     sync_handle = DBOS.start_workflow(test_workflow, "alice", "bob")
     assert sync_handle.get_result() == "alicetxn31bobstep3"  # type: ignore
 
+    # Test DBOS.start_workflow_async on steps
+    handle = await DBOS.start_workflow_async(test_step, "alice")
+    assert (await handle.get_result()) == "alicestep4"
+
 
 @pytest.mark.asyncio
 async def test_async_step(dbos: DBOS) -> None:
@@ -298,7 +302,9 @@ async def test_sleep(dbos: DBOS) -> None:
     @DBOS.workflow()
     async def test_sleep_workflow(secs: float) -> str:
         await dbos.sleep_async(secs)
-        return DBOS.workflow_id
+        workflow_id = DBOS.workflow_id
+        assert workflow_id is not None
+        return workflow_id
 
     start_time = time.time()
     sleep_uuid = await test_sleep_workflow(1.5)
@@ -486,20 +492,20 @@ async def test_workflow_timeout_async(dbos: DBOS) -> None:
             DBOS.sleep(0.1)
 
     with SetWorkflowTimeout(0.1):
-        with pytest.raises(DBOSWorkflowCancelledError):
+        with pytest.raises(DBOSAwaitedWorkflowCancelledError):
             await blocked_workflow()
         handle = await DBOS.start_workflow_async(blocked_workflow)
-        with pytest.raises(DBOSWorkflowCancelledError):
+        with pytest.raises(DBOSAwaitedWorkflowCancelledError):
             await handle.get_result()
 
     @DBOS.workflow()
     async def parent_workflow_with_timeout() -> None:
         assert assert_current_dbos_context().workflow_deadline_epoch_ms is None
         with SetWorkflowTimeout(0.1):
-            with pytest.raises(DBOSWorkflowCancelledError):
+            with pytest.raises(DBOSAwaitedWorkflowCancelledError):
                 await blocked_workflow()
             handle = await DBOS.start_workflow_async(blocked_workflow)
-            with pytest.raises(DBOSWorkflowCancelledError):
+            with pytest.raises(DBOSAwaitedWorkflowCancelledError):
                 await handle.get_result()
         assert assert_current_dbos_context().workflow_deadline_epoch_ms is None
 
@@ -520,7 +526,7 @@ async def test_workflow_timeout_async(dbos: DBOS) -> None:
     # Verify if a parent called with a timeout calls a blocked child
     # the deadline propagates and the children are also cancelled.
     with SetWorkflowTimeout(1.0):
-        with pytest.raises(DBOSWorkflowCancelledError):
+        with pytest.raises(DBOSAwaitedWorkflowCancelledError):
             await parent_workflow()
 
     with pytest.raises(Exception) as exc_info:

{dbos-1.8.0a5 → dbos-1.9.0}/tests/test_async_workflow_management.py

@@ -7,7 +7,7 @@ from typing import List
 import pytest
 
 from dbos import DBOS, Queue, SetWorkflowID
-from dbos._error import DBOSWorkflowCancelledError
+from dbos._error import DBOSAwaitedWorkflowCancelledError
 from dbos._sys_db import StepInfo, WorkflowStatus
 from tests.conftest import queue_entries_are_cleaned_up
 
@@ -46,7 +46,7 @@ async def test_cancel_workflow_async(dbos: DBOS) -> None:
     await DBOS.cancel_workflow_async(wfid)
     workflow_event.set()
 
-    with pytest.raises(DBOSWorkflowCancelledError):
+    with pytest.raises(DBOSAwaitedWorkflowCancelledError):
         handle.get_result()
     assert steps_completed == 1
 
@@ -85,7 +85,7 @@ async def test_resume_workflow_async(dbos: DBOS) -> None:
     DBOS.cancel_workflow(wfid)
     workflow_event.set()
 
-    with pytest.raises(DBOSWorkflowCancelledError):
+    with pytest.raises(DBOSAwaitedWorkflowCancelledError):
         handle.get_result()
     assert steps_completed == 1
 

{dbos-1.8.0a5 → dbos-1.9.0}/tests/test_classdecorators.py

@@ -10,6 +10,7 @@ from dbos import DBOS, DBOSConfiguredInstance, Queue, SetWorkflowID
 
 # Private API used because this is a test
 from dbos._context import DBOSContextEnsure, assert_current_dbos_context
+from dbos._dbos_config import DBOSConfig
 from tests.conftest import queue_entries_are_cleaned_up
 
 
@@ -884,3 +885,56 @@ def test_mixed_methods(dbos: DBOS) -> None:
     status = handle.get_status()
     assert status.class_name == None
     assert status.config_name == None
+
+
+def test_class_step_without_dbos(dbos: DBOS, config: DBOSConfig) -> None:
+    DBOS.destroy(destroy_registry=True)
+
+    @DBOS.dbos_class()
+    class TestClass(DBOSConfiguredInstance):
+        def __init__(self, x: int) -> None:
+            self.x = x
+            super().__init__("test")
+
+        @DBOS.step()
+        def step(self, x: int) -> int:
+            return self.x + x
+
+    input = 5
+    inst = TestClass(input)
+    assert inst.step(input) == input + input
+
+    DBOS(config=config)
+
+    assert inst.step(input) == input + input
+
+    DBOS.launch()
+
+    assert inst.step(input) == input + input
+
+
+def test_class_with_only_steps(dbos: DBOS) -> None:
+
+    class StepClass:
+        def __init__(self, x: int) -> None:
+            self.x = x
+
+        @DBOS.step()
+        def step(self, x: int, expr: Callable[[int, int], int]) -> int:
+            return expr(self.x, x)
+
+    input = 5
+    inst = StepClass(5)
+
+    l = lambda x, y: x + y
+
+    @DBOS.workflow()
+    def test_workflow() -> int:
+        return inst.step(input, l) + inst.step(input, l)
+
+    handle = DBOS.start_workflow(test_workflow)
+    assert handle.get_result() == input * 4
+
+    steps = DBOS.list_workflow_steps(handle.workflow_id)
+    assert len(steps) == 2
+    assert steps[1]["output"] == steps[1]["output"] == input * 2

{dbos-1.8.0a5 → dbos-1.9.0}/tests/test_concurrency.py

@@ -14,7 +14,9 @@ def test_concurrent_workflows(dbos: DBOS) -> None:
     @DBOS.workflow()
     def test_workflow() -> str:
         time.sleep(1)
-        return DBOS.workflow_id
+        workflow_id = DBOS.workflow_id
+        assert workflow_id is not None
+        return workflow_id
 
     def test_thread(id: str) -> str:
         with SetWorkflowID(id):
@@ -48,7 +50,9 @@ def test_concurrent_conflict_uuid(dbos: DBOS) -> None:
             condition.notify()
         condition.release()
 
-        return DBOS.workflow_id
+        workflow_id = DBOS.workflow_id
+        assert workflow_id is not None
+        return workflow_id
 
     @DBOS.workflow()
     def test_workflow() -> str:
@@ -74,7 +78,9 @@ def test_concurrent_conflict_uuid(dbos: DBOS) -> None:
             condition.notify()
         condition.release()
 
-        return DBOS.workflow_id
+        workflow_id = DBOS.workflow_id
+        assert workflow_id is not None
+        return workflow_id
 
     def test_txn_thread(id: str) -> str:
         with SetWorkflowID(id):