dbos 0.26.0a22__py3-none-any.whl → 0.26.0a24__py3-none-any.whl

dbos/_dbos.py

@@ -33,11 +33,7 @@ from opentelemetry.trace import Span
 from dbos._conductor.conductor import ConductorWebsocket
 from dbos._sys_db import WorkflowStatus
 from dbos._utils import INTERNAL_QUEUE_NAME, GlobalParams
-from dbos._workflow_commands import (
-    fork_workflow,
-    list_queued_workflows,
-    list_workflows,
-)
+from dbos._workflow_commands import fork_workflow, list_queued_workflows, list_workflows
 
 from ._classproperty import classproperty
 from ._core import (
@@ -351,6 +347,9 @@ class DBOS:
             # If no config is provided, load it from dbos-config.yaml
             unvalidated_config = load_config(run_process_config=False)
         elif is_dbos_configfile(config):
+            dbos_logger.warning(
+                "ConfigFile config strutcture detected. This will be deprecated in favor of DBOSConfig in an upcoming release."
+            )
             unvalidated_config = cast(ConfigFile, config)
             if os.environ.get("DBOS__CLOUD") == "true":
                 unvalidated_config = overwrite_config(unvalidated_config)

dbos/_dbos_config.py

@@ -1,3 +1,4 @@
+import inspect
 import json
 import os
 import re
@@ -58,19 +59,28 @@ class RuntimeConfig(TypedDict, total=False):
 
 
 class DatabaseConfig(TypedDict, total=False):
-    hostname: str
-    port: int
-    username: str
-    password: str
-    connectionTimeoutMillis: Optional[int]
-    app_db_name: str
+    """
+    Internal data structure containing the DBOS database configuration.
+    Attributes:
+        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
+        migrate (List[str]): Migration commands to run on startup
+    """
+
+    hostname: str  # Will be removed in a future version
+    port: int  # Will be removed in a future version
+    username: str  # Will be removed in a future version
+    password: str  # Will be removed in a future version
+    connectionTimeoutMillis: Optional[int]  # Will be removed in a future version
+    app_db_name: str  # Will be removed in a future version
     app_db_pool_size: Optional[int]
     sys_db_name: Optional[str]
     sys_db_pool_size: Optional[int]
-    ssl: Optional[bool]
-    ssl_ca: Optional[str]
+    ssl: Optional[bool]  # Will be removed in a future version
+    ssl_ca: Optional[str]  # Will be removed in a future version
     migrate: Optional[List[str]]
-    rollback: Optional[List[str]]
+    rollback: Optional[List[str]]  # Will be removed in a future version
 
 
 def parse_database_url_to_dbconfig(database_url: str) -> DatabaseConfig:
@@ -117,7 +127,7 @@ class ConfigFile(TypedDict, total=False):
     Attributes:
         name (str): Application name
         runtimeConfig (RuntimeConfig): Configuration for request serving
-        database (DatabaseConfig): Configuration for the application and system databases
+        database (DatabaseConfig): Configure pool sizes, migrate commands
         database_url (str): Database connection string
         telemetry (TelemetryConfig): Configuration for tracing / logging
         env (Dict[str,str]): Environment varialbes
@@ -301,6 +311,17 @@ def load_config(
 
     """
 
+    # Get the current call stack
+    frame_records = inspect.stack()
+    called_from_cli = False
+    for frame_record in frame_records:
+        if "dbos/cli/cli.py" in frame_record.filename:
+            called_from_cli = True
+    if not called_from_cli and not silent:
+        dbos_logger.warning(
+            "This function is deprecated and will be removed in a future version. Use `DBOS.config` instead."
+        )
+
     with open(config_file_path, "r") as file:
         content = file.read()
         substituted_content = _substitute_env_vars(content, silent=silent)

dbos/dbos-config.schema.json

@@ -24,43 +24,51 @@
         "additionalProperties": false,
         "properties": {
           "hostname": {
-            "type": "string",
-            "description": "The hostname or IP address of the application database"
+            "type": ["string", "null"],
+            "description": "The hostname or IP address of the application database. DEPRECATED: Use database_url instead",
+            "deprecated": true
           },
           "port": {
-            "type": "number",
-            "description": "The port number of the application database"
+            "type": ["number", "null"],
+            "description": "The port number of the application database. DEPRECATED: Use database_url instead",
+            "deprecated": true
           },
           "username": {
-            "type": "string",
-            "description": "The username to use when connecting to the application database",
+            "type": ["string", "null"],
+            "description": "The username to use when connecting to the application database. DEPRECATED: Use database_url instead",
             "not": {
               "enum": ["dbos"]
-            }
+            },
+            "deprecated": true
           },
           "password": {
             "type": ["string", "null"],
-            "description": "The password to use when connecting to the application database. Developers are strongly encouraged to use environment variable substitution (${VAR_NAME}) or Docker secrets (${DOCKER_SECRET:SECRET_NAME}) to avoid storing secrets in source."
+            "description": "The password to use when connecting to the application database. Developers are strongly encouraged to use environment variable substitution (${VAR_NAME}) or Docker secrets (${DOCKER_SECRET:SECRET_NAME}) to avoid storing secrets in source. DEPRECATED: Use database_url instead",
+            "deprecated": true
           },
           "connectionTimeoutMillis": {
-            "type": "number",
-            "description": "The number of milliseconds the system waits before timing out when connecting to the application database"
+            "type": ["number", "null"],
+            "description": "The number of milliseconds the system waits before timing out when connecting to the application database. DEPRECATED: Use database_url instead",
+            "deprecated": true
           },
           "app_db_name": {
-            "type": "string",
-            "description": "The name of the application database"
+            "type": ["string", "null"],
+            "description": "The name of the application database. DEPRECATED: Use database_url instead",
+            "deprecated": true
           },
           "sys_db_name": {
             "type": "string",
             "description": "The name of the system database"
           },
           "ssl": {
-            "type": "boolean",
-            "description": "Use SSL/TLS to securely connect to the database (default: true)"
+            "type": ["boolean", "null"],
+            "description": "Use SSL/TLS to securely connect to the database (default: true). DEPRECATED: Use database_url instead",
+            "deprecated": true
           },
           "ssl_ca": {
-            "type": "string",
-            "description": "If using SSL/TLS to securely connect to a database, path to an SSL root certificate file"
+            "type": ["string", "null"],
+            "description": "If using SSL/TLS to securely connect to a database, path to an SSL root certificate file. DEPRECATED: Use database_url instead",
+            "deprecated": true
           },
           "app_db_client": {
             "type": "string",
@@ -78,7 +86,8 @@
           },
           "rollback": {
             "type": "array",
-            "description": "Specify a list of user DB rollback commands to run"
+            "description": "Specify a list of user DB rollback commands to run. DEPRECATED",
+            "deprecated": true
           }
         }
       },

{dbos-0.26.0a22.dist-info → dbos-0.26.0a24.dist-info}/METADATA

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

{dbos-0.26.0a22.dist-info → dbos-0.26.0a24.dist-info}/RECORD

@@ -1,7 +1,7 @@
-dbos-0.26.0a22.dist-info/METADATA,sha256=Tc4eDxO8J5OnULO6LrEY6mzhVwYZfmFN_okn3ZnSRLc,5554
-dbos-0.26.0a22.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
-dbos-0.26.0a22.dist-info/entry_points.txt,sha256=_QOQ3tVfEjtjBlr1jS4sHqHya9lI2aIEIWkz8dqYp14,58
-dbos-0.26.0a22.dist-info/licenses/LICENSE,sha256=VGZit_a5-kdw9WT6fY5jxAWVwGQzgLFyPWrcVVUhVNU,1067
+dbos-0.26.0a24.dist-info/METADATA,sha256=wCAgHzO-rzittv1AnMKmQijAxHI9UMJ8pLiSIOJ-wZo,5554
+dbos-0.26.0a24.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
+dbos-0.26.0a24.dist-info/entry_points.txt,sha256=_QOQ3tVfEjtjBlr1jS4sHqHya9lI2aIEIWkz8dqYp14,58
+dbos-0.26.0a24.dist-info/licenses/LICENSE,sha256=VGZit_a5-kdw9WT6fY5jxAWVwGQzgLFyPWrcVVUhVNU,1067
 dbos/__init__.py,sha256=VoGS7H9GVtNAnD2S4zseIEioS1dNIJXRovQ4oHlg8og,842
 dbos/__main__.py,sha256=G7Exn-MhGrVJVDbgNlpzhfh8WMX_72t3_oJaFT9Lmt8,653
 dbos/_admin_server.py,sha256=RrbABfR1D3p9c_QLrCSrgFuYce6FKi0fjMRIYLjO_Y8,9038
@@ -13,8 +13,8 @@ dbos/_conductor/protocol.py,sha256=zEKIuOQdIaSduNqfZKpo8PSD9_1oNpKIPnBNCu3RUyE,6
 dbos/_context.py,sha256=aHzJxO7LLAz9w3G2dkZnOcFW_GG-Yaxd02AaoLu4Et8,21861
 dbos/_core.py,sha256=ylTVSv02h2M5SmDgYEJAZmNiKX35zPq0z-9WA-f4byY,47900
 dbos/_croniter.py,sha256=XHAyUyibs_59sJQfSNWkP7rqQY6_XrlfuuCxk4jYqek,47559
-dbos/_dbos.py,sha256=bbio_FjBfU__Zk1BFegfS16IrPPejFxOKm5rUg5nW1o,47185
-dbos/_dbos_config.py,sha256=m05IFjM0jSwZBsnFMF_4qP2JkjVFc0gqyM2tnotXq20,20636
+dbos/_dbos.py,sha256=zE-4CcTQo8ICz-6Ng776IUKdur4qOt3bb810fUAhQc0,47343
+dbos/_dbos_config.py,sha256=IEcCU4DdkUfSvNZGoEeJfSSu1c41hYHOo-0WvWkXY08,21745
 dbos/_debug.py,sha256=MNlQVZ6TscGCRQeEEL0VE8Uignvr6dPeDDDefS3xgIE,1823
 dbos/_docker_pg_helper.py,sha256=NmcgqmR5rQA_4igfeqh8ugNT2z3YmoOvuep_MEtxTiY,5854
 dbos/_error.py,sha256=9ITvFsN_Udpx0xXtYQHXXXb6PjPr3TmMondGmprV-L0,7003
@@ -63,7 +63,7 @@ dbos/_workflow_commands.py,sha256=7wyxTfIyh2IVIqlkaTr8CMBq8yxWP3Hhddyv1YJY8zE,35
 dbos/cli/_github_init.py,sha256=Y_bDF9gfO2jB1id4FV5h1oIxEJRWyqVjhb7bNEa5nQ0,3224
 dbos/cli/_template_init.py,sha256=-WW3kbq0W_Tq4WbMqb1UGJG3xvJb3woEY5VspG95Srk,2857
 dbos/cli/cli.py,sha256=1qCTs__A9LOEfU44XZ6TufwmRwe68ZEwbWEPli3vnVM,17873
-dbos/dbos-config.schema.json,sha256=i7jcxXqByKq0Jzv3nAUavONtj03vTwj6vWP4ylmBr8o,5694
+dbos/dbos-config.schema.json,sha256=8KcwJb_sQc4-6tQG2TLmjE_nratfrQa0qVLl9XPsvWE,6367
 dbos/py.typed,sha256=QfzXT1Ktfk3Rj84akygc7_42z0lRpCq0Ilh8OXI6Zas,44
 version/__init__.py,sha256=L4sNxecRuqdtSFdpUGX3TtBi9KL3k7YsZVIvv-fv9-A,1678
-dbos-0.26.0a22.dist-info/RECORD,,
+dbos-0.26.0a24.dist-info/RECORD,,