dbos 0.23.0a13__py3-none-any.whl → 0.24.0__py3-none-any.whl

dbos/_dbos_config.py

@@ -1,25 +1,61 @@
 import json
 import os
 import re
+import sys
 from importlib import resources
-from typing import Any, Dict, List, Optional, TypedDict, cast
+from typing import Any, Dict, List, Optional, TypedDict, Union, cast
+
+if sys.version_info < (3, 10):
+    from typing_extensions import TypeGuard
+else:
+    from typing import TypeGuard
 
 import yaml
 from jsonschema import ValidationError, validate
 from rich import print
-from sqlalchemy import URL
+from sqlalchemy import URL, make_url
 
 from ._db_wizard import db_wizard, load_db_connection
 from ._error import DBOSInitializationError
-from ._logger import config_logger, dbos_logger, init_logger
+from ._logger import dbos_logger
 
 DBOS_CONFIG_PATH = "dbos-config.yaml"
 
 
+class DBOSConfig(TypedDict, total=False):
+    """
+    Data structure containing the DBOS library configuration.
+
+    Attributes:
+        name (str): Application name
+        database_url (str): Database connection string
+        app_db_pool_size (int): Application database pool size
+        sys_db_name (str): System database name
+        sys_db_pool_size (int): System database pool size
+        log_level (str): Log level
+        otlp_traces_endpoints: List[str]: OTLP traces endpoints
+        otlp_logs_endpoints: List[str]: OTLP logs endpoints
+        admin_port (int): Admin port
+        run_admin_server (bool): Whether to run the DBOS admin server
+    """
+
+    name: str
+    database_url: Optional[str]
+    app_db_pool_size: Optional[int]
+    sys_db_name: Optional[str]
+    sys_db_pool_size: Optional[int]
+    log_level: Optional[str]
+    otlp_traces_endpoints: Optional[List[str]]
+    otlp_logs_endpoints: Optional[List[str]]
+    admin_port: Optional[int]
+    run_admin_server: Optional[bool]
+
+
 class RuntimeConfig(TypedDict, total=False):
     start: List[str]
     setup: Optional[List[str]]
     admin_port: Optional[int]
+    run_admin_server: Optional[bool]
 
 
 class DatabaseConfig(TypedDict, total=False):
@@ -29,18 +65,39 @@ class DatabaseConfig(TypedDict, total=False):
     password: str
     connectionTimeoutMillis: Optional[int]
     app_db_name: str
+    app_db_pool_size: Optional[int]
     sys_db_name: Optional[str]
+    sys_db_pool_size: Optional[int]
     ssl: Optional[bool]
     ssl_ca: Optional[str]
     local_suffix: Optional[bool]
-    app_db_client: Optional[str]
     migrate: Optional[List[str]]
     rollback: Optional[List[str]]
 
 
+def parse_database_url_to_dbconfig(database_url: str) -> DatabaseConfig:
+    db_url = make_url(database_url)
+    db_config = {
+        "hostname": db_url.host,
+        "port": db_url.port or 5432,
+        "username": db_url.username,
+        "password": db_url.password,
+        "app_db_name": db_url.database,
+    }
+    for key, value in db_url.query.items():
+        str_value = value[0] if isinstance(value, tuple) else value
+        if key == "connect_timeout":
+            db_config["connectionTimeoutMillis"] = int(str_value) * 1000
+        elif key == "sslmode":
+            db_config["ssl"] = str_value == "require"
+        elif key == "sslrootcert":
+            db_config["ssl_ca"] = str_value
+    return cast(DatabaseConfig, db_config)
+
+
 class OTLPExporterConfig(TypedDict, total=False):
-    logsEndpoint: Optional[str]
-    tracesEndpoint: Optional[str]
+    logsEndpoint: Optional[List[str]]
+    tracesEndpoint: Optional[List[str]]
 
 
 class LoggerConfig(TypedDict, total=False):
@@ -61,9 +118,9 @@ class ConfigFile(TypedDict, total=False):
 
     Attributes:
         name (str): Application name
-        language (str): The app language (probably `python`)
         runtimeConfig (RuntimeConfig): Configuration for request serving
         database (DatabaseConfig): Configuration for the application and system databases
+        database_url (str): Database connection string
         telemetry (TelemetryConfig): Configuration for tracing / logging
         env (Dict[str,str]): Environment varialbes
         application (Dict[str, Any]): Application-specific configuration section
@@ -71,15 +128,93 @@ class ConfigFile(TypedDict, total=False):
     """
 
     name: str
-    language: str
     runtimeConfig: RuntimeConfig
     database: DatabaseConfig
+    database_url: Optional[str]
     telemetry: Optional[TelemetryConfig]
     env: Dict[str, str]
-    application: Dict[str, Any]
 
 
-def _substitute_env_vars(content: str) -> str:
+def is_dbos_configfile(data: Union[ConfigFile, DBOSConfig]) -> TypeGuard[DBOSConfig]:
+    """
+    Type guard to check if the provided data is a DBOSConfig.
+
+    Args:
+        data: The configuration object to check
+
+    Returns:
+        True if the data is a DBOSConfig, False otherwise
+    """
+    return (
+        isinstance(data, dict)
+        and "name" in data
+        and (
+            "runtimeConfig" in data
+            or "database" in data
+            or "env" in data
+            or "telemetry" in data
+        )
+    )
+
+
+def translate_dbos_config_to_config_file(config: DBOSConfig) -> ConfigFile:
+    if "name" not in config:
+        raise DBOSInitializationError(f"Configuration must specify an application name")
+
+    translated_config: ConfigFile = {
+        "name": config["name"],
+    }
+
+    # Database config
+    db_config: DatabaseConfig = {}
+    database_url = config.get("database_url")
+    if database_url:
+        db_config = parse_database_url_to_dbconfig(database_url)
+    if "sys_db_name" in config:
+        db_config["sys_db_name"] = config.get("sys_db_name")
+    if "app_db_pool_size" in config:
+        db_config["app_db_pool_size"] = config.get("app_db_pool_size")
+    if "sys_db_pool_size" in config:
+        db_config["sys_db_pool_size"] = config.get("sys_db_pool_size")
+    if db_config:
+        translated_config["database"] = db_config
+
+    # Runtime config
+    translated_config["runtimeConfig"] = {"run_admin_server": True}
+    if "admin_port" in config:
+        translated_config["runtimeConfig"]["admin_port"] = config["admin_port"]
+    if "run_admin_server" in config:
+        translated_config["runtimeConfig"]["run_admin_server"] = config[
+            "run_admin_server"
+        ]
+
+    # Telemetry config
+    telemetry: TelemetryConfig = {
+        "OTLPExporter": {"tracesEndpoint": [], "logsEndpoint": []}
+    }
+    # For mypy
+    assert telemetry["OTLPExporter"] is not None
+
+    # Add OTLPExporter if traces endpoints exist
+    otlp_trace_endpoints = config.get("otlp_traces_endpoints")
+    if isinstance(otlp_trace_endpoints, list) and len(otlp_trace_endpoints) > 0:
+        telemetry["OTLPExporter"]["tracesEndpoint"] = otlp_trace_endpoints
+    # Same for the logs
+    otlp_logs_endpoints = config.get("otlp_logs_endpoints")
+    if isinstance(otlp_logs_endpoints, list) and len(otlp_logs_endpoints) > 0:
+        telemetry["OTLPExporter"]["logsEndpoint"] = otlp_logs_endpoints
+
+    # Default to INFO -- the logging seems to default to WARN otherwise.
+    log_level = config.get("log_level", "INFO")
+    if log_level:
+        telemetry["logs"] = {"logLevel": log_level}
+    if telemetry:
+        translated_config["telemetry"] = telemetry
+
+    return translated_config
+
+
+def _substitute_env_vars(content: str, silent: bool = False) -> str:
     regex = r"\$\{([^}]+)\}"  # Regex to match ${VAR_NAME} style placeholders
 
     def replace_func(match: re.Match[str]) -> str:
@@ -87,7 +222,7 @@ def _substitute_env_vars(content: str) -> str:
         value = os.environ.get(
             var_name, ""
         )  # If the env variable is not set, return an empty string
-        if value == "":
+        if value == "" and not silent:
             dbos_logger.warning(
                 f"Variable {var_name} would be substituted from the process environment into dbos-config.yaml, but is not defined"
             )
@@ -110,7 +245,7 @@ def get_dbos_database_url(config_file_path: str = DBOS_CONFIG_PATH) -> str:
         str: Database URL for the application database
 
     """
-    dbos_config = load_config(config_file_path)
+    dbos_config = load_config(config_file_path, run_process_config=True)
     db_url = URL.create(
         "postgresql+psycopg",
         username=dbos_config["database"]["username"],
@@ -125,6 +260,7 @@ def get_dbos_database_url(config_file_path: str = DBOS_CONFIG_PATH) -> str:
 def load_config(
     config_file_path: str = DBOS_CONFIG_PATH,
     *,
+    run_process_config: bool = True,
     use_db_wizard: bool = True,
     silent: bool = False,
 ) -> ConfigFile:
@@ -141,13 +277,17 @@ def load_config(
 
     """
 
-    init_logger()
-
     with open(config_file_path, "r") as file:
         content = file.read()
-        substituted_content = _substitute_env_vars(content)
+        substituted_content = _substitute_env_vars(content, silent=silent)
         data = yaml.safe_load(substituted_content)
 
+    if not isinstance(data, dict):
+        raise DBOSInitializationError(
+            f"dbos-config.yaml must contain a dictionary, not {type(data)}"
+        )
+    data = cast(Dict[str, Any], data)
+
     # Load the JSON schema relative to the package root
     schema_file = resources.files("dbos").joinpath("dbos-config.schema.json")
     with schema_file.open("r") as f:
@@ -159,55 +299,69 @@ def load_config(
     except ValidationError as e:
         raise DBOSInitializationError(f"Validation error: {e}")
 
-    if "database" not in data:
-        data["database"] = {}
+    # Special case: convert logsEndpoint and tracesEndpoint from strings to lists of strings, if present
+    if "telemetry" in data and "OTLPExporter" in data["telemetry"]:
+        if "logsEndpoint" in data["telemetry"]["OTLPExporter"]:
+            data["telemetry"]["OTLPExporter"]["logsEndpoint"] = [
+                data["telemetry"]["OTLPExporter"]["logsEndpoint"]
+            ]
+        if "tracesEndpoint" in data["telemetry"]["OTLPExporter"]:
+            data["telemetry"]["OTLPExporter"]["tracesEndpoint"] = [
+                data["telemetry"]["OTLPExporter"]["tracesEndpoint"]
+            ]
 
-    if "name" not in data:
-        raise DBOSInitializationError(
-            f"dbos-config.yaml must specify an application name"
-        )
-
-    if "language" not in data:
-        raise DBOSInitializationError(
-            f"dbos-config.yaml must specify the application language is Python"
-        )
+    data = cast(ConfigFile, data)
+    if run_process_config:
+        data = process_config(data=data, use_db_wizard=use_db_wizard, silent=silent)
+    return data  # type: ignore
 
-    if data["language"] != "python":
-        raise DBOSInitializationError(
-            f'dbos-config.yaml specifies invalid language { data["language"] }'
-        )
 
-    if "runtimeConfig" not in data or "start" not in data["runtimeConfig"]:
-        raise DBOSInitializationError(f"dbos-config.yaml must specify a start command")
+def process_config(
+    *,
+    use_db_wizard: bool = True,
+    data: ConfigFile,
+    silent: bool = False,
+) -> ConfigFile:
+    if "name" not in data:
+        raise DBOSInitializationError(f"Configuration must specify an application name")
 
     if not _is_valid_app_name(data["name"]):
         raise DBOSInitializationError(
             f'Invalid app name {data["name"]}.  App names must be between 3 and 30 characters long and contain only lowercase letters, numbers, dashes, and underscores.'
         )
 
-    if "app_db_name" not in data["database"]:
+    if data.get("telemetry") is None:
+        data["telemetry"] = {}
+    telemetry = cast(TelemetryConfig, data["telemetry"])
+    if telemetry.get("logs") is None:
+        telemetry["logs"] = {}
+    logs = cast(LoggerConfig, telemetry["logs"])
+    if logs.get("logLevel") is None:
+        logs["logLevel"] = "INFO"
+
+    if "database" not in data:
+        data["database"] = {}
+
+    # database_url takes precedence over database config, but we need to preserve rollback and migrate if they exist
+    migrate = data["database"].get("migrate", False)
+    rollback = data["database"].get("rollback", False)
+    local_suffix = data["database"].get("local_suffix", False)
+    if data.get("database_url"):
+        dbconfig = parse_database_url_to_dbconfig(cast(str, data["database_url"]))
+        if migrate:
+            dbconfig["migrate"] = cast(List[str], migrate)
+        if rollback:
+            dbconfig["rollback"] = cast(List[str], rollback)
+        if local_suffix:
+            dbconfig["local_suffix"] = cast(bool, local_suffix)
+        data["database"] = dbconfig
+
+    if "app_db_name" not in data["database"] or not (data["database"]["app_db_name"]):
         data["database"]["app_db_name"] = _app_name_to_db_name(data["name"])
 
-    # Load the DB connection file. Use its values for missing fields from dbos-config.yaml. Use defaults otherwise.
-    data = cast(ConfigFile, data)
+    # Load the DB connection file. Use its values for missing connection parameters. Use defaults otherwise.
     db_connection = load_db_connection()
-    if not silent:
-        if os.getenv("DBOS_DBHOST"):
-            print(
-                "[bold blue]Loading database connection parameters from debug environment variables[/bold blue]"
-            )
-        elif data["database"].get("hostname"):
-            print(
-                "[bold blue]Loading database connection parameters from dbos-config.yaml[/bold blue]"
-            )
-        elif db_connection.get("hostname"):
-            print(
-                "[bold blue]Loading database connection parameters from .dbos/db_connection[/bold blue]"
-            )
-        else:
-            print(
-                "[bold blue]Using default database connection parameters (localhost)[/bold blue]"
-            )
+    connection_passed_in = data["database"].get("hostname", None) is not None
 
     dbos_dbport: Optional[int] = None
     dbport_env = os.getenv("DBOS_DBPORT")
@@ -252,26 +406,60 @@ def load_config(
     dbcon_local_suffix = db_connection.get("local_suffix")
     if dbcon_local_suffix is not None:
         local_suffix = dbcon_local_suffix
-    if data["database"].get("local_suffix") is not None:
-        local_suffix = data["database"].get("local_suffix")
+    db_local_suffix = data["database"].get("local_suffix")
+    if db_local_suffix is not None:
+        local_suffix = db_local_suffix
     if dbos_dblocalsuffix is not None:
         local_suffix = dbos_dblocalsuffix
     data["database"]["local_suffix"] = local_suffix
 
-    # Configure the DBOS logger
-    config_logger(data)
+    if not data["database"].get("app_db_pool_size"):
+        data["database"]["app_db_pool_size"] = 20
+    if not data["database"].get("sys_db_pool_size"):
+        data["database"]["sys_db_pool_size"] = 20
+    if not data["database"].get("connectionTimeoutMillis"):
+        data["database"]["connectionTimeoutMillis"] = 10000
+
+    if not data.get("runtimeConfig"):
+        data["runtimeConfig"] = {
+            "run_admin_server": True,
+        }
+    elif "run_admin_server" not in data["runtimeConfig"]:
+        data["runtimeConfig"]["run_admin_server"] = True
 
     # Check the connectivity to the database and make sure it's properly configured
     # Note, never use db wizard if the DBOS is running in debug mode (i.e. DBOS_DEBUG_WORKFLOW_ID env var is set)
     debugWorkflowId = os.getenv("DBOS_DEBUG_WORKFLOW_ID")
+
+    # Pretty-print where we've loaded database connection information from, respecting the log level
+    if not silent and logs["logLevel"] == "INFO" or logs["logLevel"] == "DEBUG":
+        d = data["database"]
+        conn_string = f"postgresql://{d['username']}:*****@{d['hostname']}:{d['port']}/{d['app_db_name']}"
+        if os.getenv("DBOS_DBHOST"):
+            print(
+                f"[bold blue]Loading database connection string from debug environment variables: {conn_string}[/bold blue]"
+            )
+        elif connection_passed_in:
+            print(
+                f"[bold blue]Using database connection string: {conn_string}[/bold blue]"
+            )
+        elif db_connection.get("hostname"):
+            print(
+                f"[bold blue]Loading database connection string from .dbos/db_connection: {conn_string}[/bold blue]"
+            )
+        else:
+            print(
+                f"[bold blue]Using default database connection string: {conn_string}[/bold blue]"
+            )
+
     if use_db_wizard and debugWorkflowId is None:
-        data = db_wizard(data, config_file_path)
+        data = db_wizard(data)
 
     if "local_suffix" in data["database"] and data["database"]["local_suffix"]:
         data["database"]["app_db_name"] = f"{data['database']['app_db_name']}_local"
 
     # Return data as ConfigFile type
-    return data  # type: ignore
+    return data
 
 
 def _is_valid_app_name(name: str) -> bool:
@@ -291,3 +479,109 @@ def set_env_vars(config: ConfigFile) -> None:
     for env, value in config.get("env", {}).items():
         if value is not None:
             os.environ[env] = str(value)
+
+
+def overwrite_config(provided_config: ConfigFile) -> ConfigFile:
+    # Load the DBOS configuration file and force the use of:
+    # 1. The database connection parameters (sub the file data to the provided config)
+    # 2. OTLP traces endpoints (add the config data to the provided config)
+    # 3. Use the application name from the file. This is a defensive measure to ensure the application name is whatever it was registered with in the cloud
+    # 4. Remove admin_port is provided in code
+    # 5. Remove env vars if provided in code
+    # Optimistically assume that expected fields in config_from_file are present
+
+    config_from_file = load_config(run_process_config=False)
+    # Be defensive
+    if config_from_file is None:
+        return provided_config
+
+    # Name
+    provided_config["name"] = config_from_file["name"]
+
+    # Database config. Note we disregard a potential database_url in config_from_file because it is not expected from DBOS Cloud
+    if "database" not in provided_config:
+        provided_config["database"] = {}
+    provided_config["database"]["hostname"] = config_from_file["database"]["hostname"]
+    provided_config["database"]["port"] = config_from_file["database"]["port"]
+    provided_config["database"]["username"] = config_from_file["database"]["username"]
+    provided_config["database"]["password"] = config_from_file["database"]["password"]
+    provided_config["database"]["app_db_name"] = config_from_file["database"][
+        "app_db_name"
+    ]
+    provided_config["database"]["sys_db_name"] = config_from_file["database"][
+        "sys_db_name"
+    ]
+    provided_config["database"]["ssl"] = config_from_file["database"]["ssl"]
+    provided_config["database"]["ssl_ca"] = config_from_file["database"]["ssl_ca"]
+
+    # Telemetry config
+    if "telemetry" not in provided_config or provided_config["telemetry"] is None:
+        provided_config["telemetry"] = {
+            "OTLPExporter": {"tracesEndpoint": [], "logsEndpoint": []},
+        }
+    elif "OTLPExporter" not in provided_config["telemetry"]:
+        provided_config["telemetry"]["OTLPExporter"] = {
+            "tracesEndpoint": [],
+            "logsEndpoint": [],
+        }
+
+    # This is a super messy from a typing perspective.
+    # Some of ConfigFile keys are optional -- but in practice they'll always be present in hosted environments
+    # So, for Mypy, we have to (1) check the keys are present in config_from_file and (2) cast telemetry/otlp_exporters to Dict[str, Any]
+    # (2) is required because, even tho we resolved these keys earlier, mypy doesn't remember that
+    if (
+        config_from_file.get("telemetry")
+        and config_from_file["telemetry"]
+        and config_from_file["telemetry"].get("OTLPExporter")
+    ):
+
+        telemetry = cast(Dict[str, Any], provided_config["telemetry"])
+        otlp_exporter = cast(Dict[str, Any], telemetry["OTLPExporter"])
+
+        # Merge the logsEndpoint and tracesEndpoint lists from the file with what we have
+        source_otlp = config_from_file["telemetry"]["OTLPExporter"]
+        if source_otlp:
+            tracesEndpoint = source_otlp.get("tracesEndpoint")
+            if tracesEndpoint:
+                otlp_exporter["tracesEndpoint"].extend(tracesEndpoint)
+            logsEndpoint = source_otlp.get("logsEndpoint")
+            if logsEndpoint:
+                otlp_exporter["logsEndpoint"].extend(logsEndpoint)
+
+    # Runtime config
+    if "runtimeConfig" in provided_config:
+        if "admin_port" in provided_config["runtimeConfig"]:
+            del provided_config["runtimeConfig"][
+                "admin_port"
+            ]  # Admin port is expected to be 3001 (the default in dbos/_admin_server.py::__init__ ) by DBOS Cloud
+        if "run_admin_server" in provided_config["runtimeConfig"]:
+            del provided_config["runtimeConfig"]["run_admin_server"]
+
+    # Env should be set from the hosting provider (e.g., DBOS Cloud)
+    if "env" in provided_config:
+        del provided_config["env"]
+
+    return provided_config
+
+
+def check_config_consistency(
+    *,
+    name: str,
+    config_file_path: str = DBOS_CONFIG_PATH,
+) -> None:
+    # First load the config file and check whether it is present
+    try:
+        config = load_config(config_file_path, silent=True, run_process_config=False)
+    except FileNotFoundError:
+        dbos_logger.debug(
+            f"No configuration file {config_file_path} found. Skipping consistency check with provided config."
+        )
+        return
+    except Exception as e:
+        raise e
+
+    # Check the name
+    if name != config["name"]:
+        raise DBOSInitializationError(
+            f"Provided app name '{name}' does not match the app name '{config['name']}' in {config_file_path}."
+        )

dbos/_debug.py

@@ -1,8 +1,11 @@
 import re
 import runpy
 import sys
+from pathlib import Path
 from typing import Union
 
+from fastapi_cli.discover import get_module_data_from_path
+
 from dbos import DBOS
 
 
@@ -33,7 +36,10 @@ def debug_workflow(workflow_id: str, entrypoint: Union[str, PythonModule]) -> No
 def parse_start_command(command: str) -> Union[str, PythonModule]:
     match = re.match(r"fastapi\s+run\s+(\.?[\w/]+\.py)", command)
     if match:
-        return match.group(1)
+        # Mirror the logic in fastapi's run command by converting the path argument to a module
+        mod_data = get_module_data_from_path(Path(match.group(1)))
+        sys.path.insert(0, str(mod_data.extra_sys_path))
+        return PythonModule(mod_data.module_import_str)
     match = re.match(r"python3?\s+(\.?[\w/]+\.py)", command)
     if match:
         return match.group(1)

dbos/_error.py

@@ -1,7 +1,7 @@
 """Errors thrown by DBOS."""
 
 from enum import Enum
-from typing import Optional
+from typing import Any, Optional
 
 
 class DBOSException(Exception):
@@ -124,12 +124,18 @@ class DBOSNotAuthorizedError(DBOSException):
 class DBOSMaxStepRetriesExceeded(DBOSException):
     """Exception raised when a step was retried the maximimum number of times without success."""
 
-    def __init__(self) -> None:
+    def __init__(self, step_name: str, max_retries: int) -> None:
+        self.step_name = step_name
+        self.max_retries = max_retries
         super().__init__(
-            "Step reached maximum retries.",
+            f"Step {step_name} has exceeded its maximum of {max_retries} retries",
             dbos_error_code=DBOSErrorCode.MaxStepRetriesExceeded.value,
         )
 
+    def __reduce__(self) -> Any:
+        # Tell jsonpickle how to reconstruct this object
+        return (self.__class__, (self.step_name, self.max_retries))
+
 
 class DBOSWorkflowCancelledError(DBOSException):
     """Exception raised when the workflow has already been cancelled."""

dbos/_logger.py

@@ -56,10 +56,10 @@ def config_logger(config: "ConfigFile") -> None:
         dbos_logger.setLevel(log_level)
 
     # Log to the OTLP endpoint if provided
-    otlp_logs_endpoint = (
+    otlp_logs_endpoints = (
         config.get("telemetry", {}).get("OTLPExporter", {}).get("logsEndpoint")  # type: ignore
     )
-    if otlp_logs_endpoint:
+    if otlp_logs_endpoints:
         log_provider = PatchedOTLPLoggerProvider(
             Resource.create(
                 attributes={
@@ -68,12 +68,13 @@ def config_logger(config: "ConfigFile") -> None:
             )
         )
         set_logger_provider(log_provider)
-        log_provider.add_log_record_processor(
-            BatchLogRecordProcessor(
-                OTLPLogExporter(endpoint=otlp_logs_endpoint),
-                export_timeout_millis=5000,
+        for e in otlp_logs_endpoints:
+            log_provider.add_log_record_processor(
+                BatchLogRecordProcessor(
+                    OTLPLogExporter(endpoint=e),
+                    export_timeout_millis=5000,
+                )
             )
-        )
         global _otlp_handler
         _otlp_handler = LoggingHandler(logger_provider=log_provider)
 

dbos/_queue.py

@@ -1,16 +1,16 @@
 import threading
 import traceback
-from typing import TYPE_CHECKING, Optional, TypedDict
+from typing import TYPE_CHECKING, Any, Coroutine, Optional, TypedDict
 
 from psycopg import errors
 from sqlalchemy.exc import OperationalError
 
 from dbos._utils import GlobalParams
 
-from ._core import P, R, execute_workflow_by_id, start_workflow
+from ._core import P, R, execute_workflow_by_id, start_workflow, start_workflow_async
 
 if TYPE_CHECKING:
-    from ._dbos import DBOS, Workflow, WorkflowHandle
+    from ._dbos import DBOS, Workflow, WorkflowHandle, WorkflowHandleAsync
 
 
 class QueueRateLimit(TypedDict):
@@ -66,6 +66,17 @@ class Queue:
         dbos = _get_dbos_instance()
         return start_workflow(dbos, func, self.name, False, *args, **kwargs)
 
+    async def enqueue_async(
+        self,
+        func: "Workflow[P, Coroutine[Any, Any, R]]",
+        *args: P.args,
+        **kwargs: P.kwargs,
+    ) -> "WorkflowHandleAsync[R]":
+        from ._dbos import _get_dbos_instance
+
+        dbos = _get_dbos_instance()
+        return await start_workflow_async(dbos, func, self.name, False, *args, **kwargs)
+
 
 def queue_thread(stop_event: threading.Event, dbos: "DBOS") -> None:
     while not stop_event.is_set():