dbos 0.5.0a11__py3-none-any.whl → 0.6.0a0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of dbos might be problematic. Click here for more details.

dbos/__init__.py CHANGED
@@ -1,18 +1,14 @@
1
1
  from . import error as error
2
- from .context import SetWorkflowID as SetWorkflowID
3
- from .dbos import DBOS as DBOS
4
- from .dbos import DBOSConfiguredInstance as DBOSConfiguredInstance
5
- from .dbos import WorkflowHandle as WorkflowHandle
6
- from .dbos import WorkflowStatus as WorkflowStatus
7
- from .dbos_config import ConfigFile as ConfigFile
8
- from .dbos_config import get_dbos_database_url, load_config
9
- from .system_database import GetWorkflowsInput as GetWorkflowsInput
10
- from .system_database import WorkflowStatusString as WorkflowStatusString
2
+ from .context import DBOSContextEnsure, SetWorkflowID
3
+ from .dbos import DBOS, DBOSConfiguredInstance, WorkflowHandle, WorkflowStatus
4
+ from .dbos_config import ConfigFile, get_dbos_database_url, load_config
5
+ from .system_database import GetWorkflowsInput, WorkflowStatusString
11
6
 
12
7
  __all__ = [
13
8
  "ConfigFile",
14
9
  "DBOS",
15
10
  "DBOSConfiguredInstance",
11
+ "DBOSContextEnsure",
16
12
  "GetWorkflowsInput",
17
13
  "SetWorkflowID",
18
14
  "WorkflowHandle",
dbos/admin_sever.py CHANGED
@@ -28,11 +28,11 @@ class AdminServer:
28
28
  self.server_thread = threading.Thread(target=self.server.serve_forever)
29
29
  self.server_thread.daemon = True
30
30
 
31
- dbos_logger.info("Starting DBOS admin server on port %d", self.port)
31
+ dbos_logger.debug("Starting DBOS admin server on port %d", self.port)
32
32
  self.server_thread.start()
33
33
 
34
34
  def stop(self) -> None:
35
- dbos_logger.info("Stopping DBOS admin server")
35
+ dbos_logger.debug("Stopping DBOS admin server")
36
36
  self.server.shutdown()
37
37
  self.server.server_close()
38
38
  self.server_thread.join()
dbos/cli.py CHANGED
@@ -119,7 +119,7 @@ def copy_template_dir(src_dir: str, dst_dir: str, ctx: dict[str, str]) -> None:
119
119
  shutil.copy(src, dst)
120
120
 
121
121
 
122
- def copy_template(src_dir: str, project_name: str) -> None:
122
+ def copy_template(src_dir: str, project_name: str, config_mode: bool) -> None:
123
123
 
124
124
  dst_dir = path.abspath(".")
125
125
 
@@ -131,10 +131,17 @@ def copy_template(src_dir: str, project_name: str) -> None:
131
131
  "db_name": db_name,
132
132
  }
133
133
 
134
- copy_template_dir(src_dir, dst_dir, ctx)
135
- copy_template_dir(
136
- path.join(src_dir, "__package"), path.join(dst_dir, package_name), ctx
137
- )
134
+ if config_mode:
135
+ copy_dbos_template(
136
+ os.path.join(src_dir, "dbos-config.yaml.dbos"),
137
+ os.path.join(dst_dir, "dbos-config.yaml"),
138
+ ctx,
139
+ )
140
+ else:
141
+ copy_template_dir(src_dir, dst_dir, ctx)
142
+ copy_template_dir(
143
+ path.join(src_dir, "__package"), path.join(dst_dir, package_name), ctx
144
+ )
138
145
 
139
146
 
140
147
  def get_project_name() -> typing.Union[str, None]:
@@ -173,6 +180,10 @@ def init(
173
180
  typing.Optional[str],
174
181
  typer.Option("--template", "-t", help="Specify template to use"),
175
182
  ] = None,
183
+ config: Annotated[
184
+ bool,
185
+ typer.Option("--config", "-c", help="Only add dbos-config.yaml"),
186
+ ] = False,
176
187
  ) -> None:
177
188
  try:
178
189
  if project_name is None:
@@ -199,7 +210,9 @@ def init(
199
210
  if template not in templates:
200
211
  raise Exception(f"template {template} not found in {templates_dir}")
201
212
 
202
- copy_template(path.join(templates_dir, template), project_name)
213
+ copy_template(
214
+ path.join(templates_dir, template), project_name, config_mode=config
215
+ )
203
216
  except Exception as e:
204
217
  print(f"[red]{e}[/red]")
205
218
 
dbos/context.py CHANGED
@@ -1,5 +1,6 @@
1
1
  from __future__ import annotations
2
2
 
3
+ import json
3
4
  import os
4
5
  import uuid
5
6
  from contextvars import ContextVar
@@ -39,6 +40,9 @@ class TracedAttributes(TypedDict, total=False):
39
40
  applicationID: Optional[str]
40
41
  applicationVersion: Optional[str]
41
42
  executorID: Optional[str]
43
+ authenticatedUser: Optional[str]
44
+ authenticatedUserRoles: Optional[str]
45
+ authenticatedUserAssumedRole: Optional[str]
42
46
 
43
47
 
44
48
  class DBOSContext:
@@ -159,6 +163,13 @@ class DBOSContext:
159
163
  attributes["operationUUID"] = (
160
164
  self.workflow_id if len(self.workflow_id) > 0 else None
161
165
  )
166
+ attributes["authenticatedUser"] = self.authenticated_user
167
+ attributes["authenticatedUserRoles"] = (
168
+ json.dumps(self.authenticated_roles)
169
+ if self.authenticated_roles is not None
170
+ else ""
171
+ )
172
+ attributes["authenticatedUserAssumedRole"] = self.assumed_role
162
173
  span = dbos_tracer.start_span(
163
174
  attributes, parent=self.spans[-1] if len(self.spans) > 0 else None
164
175
  )
@@ -178,6 +189,11 @@ class DBOSContext:
178
189
  ) -> None:
179
190
  self.authenticated_user = user
180
191
  self.authenticated_roles = roles
192
+ if user is not None and len(self.spans) > 0:
193
+ self.spans[-1].set_attribute("authenticatedUser", user)
194
+ self.spans[-1].set_attribute(
195
+ "authenticatedUserRoles", json.dumps(roles) if roles is not None else ""
196
+ )
181
197
 
182
198
 
183
199
  ##############################################################
@@ -217,13 +233,13 @@ class DBOSContextEnsure:
217
233
  def __init__(self) -> None:
218
234
  self.created_ctx = False
219
235
 
220
- def __enter__(self) -> DBOSContextEnsure:
236
+ def __enter__(self) -> DBOSContext:
221
237
  # Code to create a basic context
222
238
  ctx = get_local_dbos_context()
223
239
  if ctx is None:
224
240
  self.created_ctx = True
225
241
  set_local_dbos_context(DBOSContext())
226
- return self
242
+ return assert_current_dbos_context()
227
243
 
228
244
  def __exit__(
229
245
  self,
dbos/core.py CHANGED
@@ -1,9 +1,20 @@
1
+ import json
1
2
  import sys
2
3
  import time
3
4
  import traceback
4
5
  from concurrent.futures import Future
5
6
  from functools import wraps
6
- from typing import TYPE_CHECKING, Any, Callable, Generic, Optional, Tuple, TypeVar, cast
7
+ from typing import (
8
+ TYPE_CHECKING,
9
+ Any,
10
+ Callable,
11
+ Generic,
12
+ List,
13
+ Optional,
14
+ Tuple,
15
+ TypeVar,
16
+ cast,
17
+ )
7
18
 
8
19
  from dbos.application_database import ApplicationDatabase, TransactionResultInternal
9
20
 
@@ -134,6 +145,11 @@ def _init_workflow(
134
145
  "executor_id": ctx.executor_id,
135
146
  "request": (utils.serialize(ctx.request) if ctx.request is not None else None),
136
147
  "recovery_attempts": None,
148
+ "authenticated_user": ctx.authenticated_user,
149
+ "authenticated_roles": (
150
+ json.dumps(ctx.authenticated_roles) if ctx.authenticated_roles else None
151
+ ),
152
+ "assumed_role": ctx.assumed_role,
137
153
  }
138
154
 
139
155
  # If we have a class name, the first arg is the instance and do not serialize
dbos/dbos.py CHANGED
@@ -1,6 +1,7 @@
1
1
  from __future__ import annotations
2
2
 
3
3
  import atexit
4
+ import json
4
5
  import os
5
6
  import sys
6
7
  import threading
@@ -19,6 +20,7 @@ from typing import (
19
20
  Tuple,
20
21
  Type,
21
22
  TypeVar,
23
+ cast,
22
24
  )
23
25
 
24
26
  from opentelemetry.trace import Span
@@ -53,6 +55,7 @@ from .tracer import dbos_tracer
53
55
  if TYPE_CHECKING:
54
56
  from fastapi import FastAPI
55
57
  from .request import Request
58
+ from flask import Flask
56
59
 
57
60
  from sqlalchemy.orm import Session
58
61
 
@@ -205,6 +208,7 @@ class DBOS:
205
208
  *,
206
209
  config: Optional[ConfigFile] = None,
207
210
  fastapi: Optional["FastAPI"] = None,
211
+ flask: Optional["Flask"] = None,
208
212
  ) -> DBOS:
209
213
  global _dbos_global_instance
210
214
  global _dbos_global_registry
@@ -219,7 +223,7 @@ class DBOS:
219
223
  )
220
224
  config = _dbos_global_registry.config
221
225
  _dbos_global_instance = super().__new__(cls)
222
- _dbos_global_instance.__init__(fastapi=fastapi, config=config) # type: ignore
226
+ _dbos_global_instance.__init__(fastapi=fastapi, config=config, flask=flask) # type: ignore
223
227
  else:
224
228
  if (config is not None and _dbos_global_instance.config is not config) or (
225
229
  _dbos_global_instance.fastapi is not fastapi
@@ -243,6 +247,7 @@ class DBOS:
243
247
  *,
244
248
  config: Optional[ConfigFile] = None,
245
249
  fastapi: Optional["FastAPI"] = None,
250
+ flask: Optional["Flask"] = None,
246
251
  ) -> None:
247
252
  if hasattr(self, "_initialized") and self._initialized:
248
253
  return
@@ -264,14 +269,44 @@ class DBOS:
264
269
  self._admin_server: Optional[AdminServer] = None
265
270
  self.stop_events: List[threading.Event] = []
266
271
  self.fastapi: Optional["FastAPI"] = fastapi
272
+ self.flask: Optional["Flask"] = flask
267
273
  self._executor: Optional[ThreadPoolExecutor] = None
274
+
275
+ # If using FastAPI, set up middleware and lifecycle events
268
276
  if self.fastapi is not None:
277
+ from fastapi.requests import Request as FARequest
278
+ from fastapi.responses import JSONResponse
279
+
280
+ async def dbos_error_handler(
281
+ request: FARequest, gexc: Exception
282
+ ) -> JSONResponse:
283
+ exc: DBOSException = cast(DBOSException, gexc)
284
+ status_code = 500
285
+ if exc.status_code is not None:
286
+ status_code = exc.status_code
287
+ return JSONResponse(
288
+ status_code=status_code,
289
+ content={
290
+ "message": str(exc.message),
291
+ "dbos_error_code": str(exc.dbos_error_code),
292
+ "dbos_error": str(exc.__class__.__name__),
293
+ },
294
+ )
295
+
296
+ self.fastapi.add_exception_handler(DBOSException, dbos_error_handler)
297
+
269
298
  from dbos.fastapi import setup_fastapi_middleware
270
299
 
271
300
  setup_fastapi_middleware(self.fastapi)
272
301
  self.fastapi.on_event("startup")(self._launch)
273
302
  self.fastapi.on_event("shutdown")(self._destroy)
274
303
 
304
+ # If using Flask, set up middleware
305
+ if self.flask is not None:
306
+ from dbos.flask import setup_flask_middleware
307
+
308
+ setup_flask_middleware(self.flask)
309
+
275
310
  # Register send_stub as a workflow
276
311
  def send_temp_workflow(
277
312
  destination_id: str, message: Any, topic: Optional[str]
@@ -502,9 +537,13 @@ class DBOS:
502
537
  recovery_attempts=stat["recovery_attempts"],
503
538
  class_name=stat["class_name"],
504
539
  config_name=stat["config_name"],
505
- authenticated_user=None,
506
- assumed_role=None,
507
- authenticatedRoles=None,
540
+ authenticated_user=stat["authenticated_user"],
541
+ assumed_role=stat["assumed_role"],
542
+ authenticated_roles=(
543
+ json.loads(stat["authenticated_roles"])
544
+ if stat["authenticated_roles"] is not None
545
+ else None
546
+ ),
508
547
  )
509
548
 
510
549
  @classmethod
@@ -663,6 +702,27 @@ class DBOS:
663
702
  ctx = assert_current_dbos_context()
664
703
  return ctx.request
665
704
 
705
+ @classproperty
706
+ def authenticated_user(cls) -> Optional[str]:
707
+ """Return the current authenticated user, if any, associated with the current context."""
708
+ ctx = assert_current_dbos_context()
709
+ return ctx.authenticated_user
710
+
711
+ @classproperty
712
+ def authenticated_roles(cls) -> Optional[List[str]]:
713
+ """Return the roles granted to the current authenticated user, if any, associated with the current context."""
714
+ ctx = assert_current_dbos_context()
715
+ return ctx.authenticated_roles
716
+
717
+ @classmethod
718
+ def set_authentication(
719
+ cls, authenticated_user: Optional[str], authenticated_roles: Optional[List[str]]
720
+ ) -> None:
721
+ """Set the current authenticated user and granted roles into the current context."""
722
+ ctx = assert_current_dbos_context()
723
+ ctx.authenticated_user = authenticated_user
724
+ ctx.authenticated_roles = authenticated_roles
725
+
666
726
 
667
727
  @dataclass
668
728
  class WorkflowStatus:
@@ -679,7 +739,7 @@ class WorkflowStatus:
679
739
  config_name(str): For instance member functions, the name of the class instance for the execution
680
740
  authenticated_user(str): The user who invoked the workflow
681
741
  assumed_role(str): The access role used by the user to allow access to the workflow function
682
- authenticatedRoles(List[str]): List of all access roles available to the authenticated user
742
+ authenticated_roles(List[str]): List of all access roles available to the authenticated user
683
743
  recovery_attempts(int): Number of times the workflow has been restarted (usually by recovery)
684
744
 
685
745
  """
@@ -691,7 +751,7 @@ class WorkflowStatus:
691
751
  config_name: Optional[str]
692
752
  authenticated_user: Optional[str]
693
753
  assumed_role: Optional[str]
694
- authenticatedRoles: Optional[List[str]]
754
+ authenticated_roles: Optional[List[str]]
695
755
  recovery_attempts: Optional[int]
696
756
 
697
757
 
dbos/dbos_config.py CHANGED
@@ -2,7 +2,7 @@ import json
2
2
  import os
3
3
  import re
4
4
  from importlib import resources
5
- from typing import Any, Dict, List, Optional, TypedDict
5
+ from typing import Dict, List, Optional, TypedDict
6
6
 
7
7
  import yaml
8
8
  from jsonschema import ValidationError, validate
dbos/error.py CHANGED
@@ -17,6 +17,7 @@ class DBOSException(Exception):
17
17
  def __init__(self, message: str, dbos_error_code: Optional[int] = None):
18
18
  self.message = message
19
19
  self.dbos_error_code = dbos_error_code
20
+ self.status_code: Optional[int] = None
20
21
  super().__init__(self.message)
21
22
 
22
23
  def __str__(self) -> str:
@@ -104,6 +105,7 @@ class DBOSNotAuthorizedError(DBOSException):
104
105
  msg,
105
106
  dbos_error_code=DBOSErrorCode.NotAuthorized.value,
106
107
  )
108
+ self.status_code = 403
107
109
 
108
110
 
109
111
  class DBOSMaxStepRetriesExceeded(DBOSException):
dbos/fastapi.py CHANGED
@@ -11,9 +11,7 @@ from .context import (
11
11
  TracedAttributes,
12
12
  assert_current_dbos_context,
13
13
  )
14
- from .request import Address, Request
15
-
16
- request_id_header = "x-request-id"
14
+ from .request import Address, Request, request_id_header
17
15
 
18
16
 
19
17
  def get_or_generate_request_id(request: FastAPIRequest) -> str:
dbos/flask.py ADDED
@@ -0,0 +1,79 @@
1
+ import uuid
2
+ from typing import Any
3
+ from urllib.parse import urlparse
4
+
5
+ from flask import Flask, request
6
+ from werkzeug.wrappers import Request as WRequest
7
+
8
+ from dbos.context import (
9
+ EnterDBOSHandler,
10
+ OperationType,
11
+ SetWorkflowID,
12
+ TracedAttributes,
13
+ assert_current_dbos_context,
14
+ )
15
+
16
+ from .request import Address, Request, request_id_header
17
+
18
+
19
+ class FlaskMiddleware:
20
+ def __init__(self, app: Any) -> None:
21
+ self.app = app
22
+
23
+ def __call__(self, environ: Any, start_response: Any) -> Any:
24
+ request = WRequest(environ)
25
+ attributes: TracedAttributes = {
26
+ "name": urlparse(request.url).path,
27
+ "requestID": get_or_generate_request_id(request),
28
+ "requestIP": (
29
+ request.remote_addr if request.remote_addr is not None else None
30
+ ),
31
+ "requestURL": request.url,
32
+ "requestMethod": request.method,
33
+ "operationType": OperationType.HANDLER.value,
34
+ }
35
+ with EnterDBOSHandler(attributes):
36
+ ctx = assert_current_dbos_context()
37
+ ctx.request = make_request(request)
38
+ workflow_id = request.headers.get("dbos-idempotency-key", "")
39
+ with SetWorkflowID(workflow_id):
40
+ response = self.app(environ, start_response)
41
+ return response
42
+
43
+
44
+ def get_or_generate_request_id(request: WRequest) -> str:
45
+ request_id = request.headers.get(request_id_header, None)
46
+ if request_id is not None:
47
+ return request_id
48
+ else:
49
+ return str(uuid.uuid4())
50
+
51
+
52
+ def make_request(request: WRequest) -> Request:
53
+ parsed_url = urlparse(request.url)
54
+ base_url = f"{parsed_url.scheme}://{parsed_url.netloc}"
55
+
56
+ client = None
57
+ if request.remote_addr:
58
+ hostname = request.remote_addr
59
+ port = request.environ.get("REMOTE_PORT")
60
+ if port:
61
+ client = Address(hostname=hostname, port=int(port))
62
+ else:
63
+ # If port is not available, use 0 as a placeholder
64
+ client = Address(hostname=hostname, port=0)
65
+
66
+ return Request(
67
+ headers=dict(request.headers),
68
+ path_params={},
69
+ query_params=dict(request.args),
70
+ url=request.url,
71
+ base_url=base_url,
72
+ client=client,
73
+ cookies=dict(request.cookies),
74
+ method=request.method,
75
+ )
76
+
77
+
78
+ def setup_flask_middleware(app: Flask) -> None:
79
+ app.wsgi_app = FlaskMiddleware(app.wsgi_app) # type: ignore
dbos/request.py CHANGED
@@ -1,6 +1,8 @@
1
1
  from dataclasses import dataclass
2
2
  from typing import Any, Mapping, NamedTuple, Optional
3
3
 
4
+ request_id_header = "x-request-id"
5
+
4
6
 
5
7
  class Address(NamedTuple):
6
8
  hostname: str
dbos/roles.py CHANGED
@@ -4,7 +4,7 @@ from typing import TYPE_CHECKING, Any, Callable, List, Optional, Type, TypeVar,
4
4
  from dbos.error import DBOSNotAuthorizedError
5
5
 
6
6
  if TYPE_CHECKING:
7
- from dbos.dbos import DBOS, _DBOSRegistry
7
+ from dbos.dbos import _DBOSRegistry
8
8
 
9
9
  from dbos.context import DBOSAssumeRole, get_local_dbos_context
10
10
  from dbos.registrations import (
dbos/system_database.py CHANGED
@@ -4,18 +4,7 @@ import select
4
4
  import threading
5
5
  import time
6
6
  from enum import Enum
7
- from typing import (
8
- TYPE_CHECKING,
9
- Any,
10
- Dict,
11
- List,
12
- Literal,
13
- Optional,
14
- Sequence,
15
- Set,
16
- TypedDict,
17
- cast,
18
- )
7
+ from typing import Any, Dict, List, Literal, Optional, Sequence, Set, TypedDict, cast
19
8
 
20
9
  import psycopg2
21
10
  import sqlalchemy as sa
@@ -69,6 +58,9 @@ class WorkflowStatusInternal(TypedDict):
69
58
  app_id: Optional[str]
70
59
  request: Optional[str] # JSON (jsonpickle)
71
60
  recovery_attempts: Optional[int]
61
+ authenticated_user: Optional[str]
62
+ assumed_role: Optional[str]
63
+ authenticated_roles: Optional[str] # JSON list of roles.
72
64
 
73
65
 
74
66
  class RecordedResult(TypedDict):
@@ -136,7 +128,7 @@ class WorkflowInformation(TypedDict, total=False):
136
128
  authenticated_user: str # The user who ran the workflow. Empty string if not set.
137
129
  assumed_role: str
138
130
  # The role used to run this workflow. Empty string if authorization is not required.
139
- authenticatedRoles: List[str]
131
+ authenticated_roles: List[str]
140
132
  # All roles the authenticated user has, if any.
141
133
  input: Optional[WorkflowInputs]
142
134
  output: Optional[str]
@@ -230,7 +222,7 @@ class SystemDatabase:
230
222
  def wait_for_buffer_flush(self) -> None:
231
223
  # Wait until the buffers are flushed.
232
224
  while self._is_flushing_status_buffer or not self._is_buffers_empty:
233
- dbos_logger.info("Waiting for system buffers to be exported")
225
+ dbos_logger.debug("Waiting for system buffers to be exported")
234
226
  time.sleep(1)
235
227
 
236
228
  def update_workflow_status(
@@ -252,6 +244,9 @@ class SystemDatabase:
252
244
  application_version=status["app_version"],
253
245
  application_id=status["app_id"],
254
246
  request=status["request"],
247
+ authenticated_user=status["authenticated_user"],
248
+ authenticated_roles=status["authenticated_roles"],
249
+ assumed_role=status["assumed_role"],
255
250
  )
256
251
  if replace:
257
252
  cmd = cmd.on_conflict_do_update(
@@ -322,6 +317,9 @@ class SystemDatabase:
322
317
  SystemSchema.workflow_status.c.recovery_attempts,
323
318
  SystemSchema.workflow_status.c.config_name,
324
319
  SystemSchema.workflow_status.c.class_name,
320
+ SystemSchema.workflow_status.c.authenticated_user,
321
+ SystemSchema.workflow_status.c.authenticated_roles,
322
+ SystemSchema.workflow_status.c.assumed_role,
325
323
  ).where(SystemSchema.workflow_status.c.workflow_uuid == workflow_uuid)
326
324
  ).fetchone()
327
325
  if row is None:
@@ -339,6 +337,9 @@ class SystemDatabase:
339
337
  "executor_id": None,
340
338
  "request": row[2],
341
339
  "recovery_attempts": row[3],
340
+ "authenticated_user": row[6],
341
+ "authenticated_roles": row[7],
342
+ "assumed_role": row[8],
342
343
  }
343
344
  return status
344
345
 
@@ -375,6 +376,9 @@ class SystemDatabase:
375
376
  SystemSchema.workflow_status.c.error,
376
377
  SystemSchema.workflow_status.c.config_name,
377
378
  SystemSchema.workflow_status.c.class_name,
379
+ SystemSchema.workflow_status.c.authenticated_user,
380
+ SystemSchema.workflow_status.c.authenticated_roles,
381
+ SystemSchema.workflow_status.c.assumed_role,
378
382
  ).where(SystemSchema.workflow_status.c.workflow_uuid == workflow_uuid)
379
383
  ).fetchone()
380
384
  if row is None:
@@ -392,6 +396,9 @@ class SystemDatabase:
392
396
  "executor_id": None,
393
397
  "request": row[2],
394
398
  "recovery_attempts": None,
399
+ "authenticated_user": row[7],
400
+ "authenticated_roles": row[8],
401
+ "assumed_role": row[9],
395
402
  }
396
403
  return status
397
404
 
dbos/tracer.py CHANGED
@@ -19,6 +19,7 @@ class DBOSTracer:
19
19
  self.app_id = os.environ.get("DBOS__APPID", None)
20
20
  self.app_version = os.environ.get("DBOS__APPVERSION", None)
21
21
  self.executor_id = os.environ.get("DBOS__VMID", "local")
22
+ self.provider: Optional[TracerProvider] = None
22
23
 
23
24
  def config(self, config: ConfigFile) -> None:
24
25
  if not isinstance(trace.get_tracer_provider(), TracerProvider):
@@ -36,10 +37,17 @@ class DBOSTracer:
36
37
  provider.add_span_processor(processor)
37
38
  trace.set_tracer_provider(provider)
38
39
 
40
+ def set_provider(self, provider: Optional[TracerProvider]) -> None:
41
+ self.provider = provider
42
+
39
43
  def start_span(
40
44
  self, attributes: "TracedAttributes", parent: Optional[Span] = None
41
45
  ) -> Span:
42
- tracer = trace.get_tracer("dbos-tracer")
46
+ tracer = (
47
+ self.provider.get_tracer("dbos-tracer")
48
+ if self.provider is not None
49
+ else trace.get_tracer("dbos-tracer")
50
+ )
43
51
  context = trace.set_span_in_context(parent) if parent else None
44
52
  span: Span = tracer.start_span(name=attributes["name"], context=context)
45
53
  attributes["applicationID"] = self.app_id
@@ -0,0 +1,130 @@
1
+ Metadata-Version: 2.1
2
+ Name: dbos
3
+ Version: 0.6.0a0
4
+ Summary: Ultra-lightweight durable execution in Python
5
+ Author-Email: "DBOS, Inc." <contact@dbos.dev>
6
+ License: MIT
7
+ Requires-Python: >=3.9
8
+ Requires-Dist: pyyaml>=6.0.2
9
+ Requires-Dist: jsonschema>=4.23.0
10
+ Requires-Dist: alembic>=1.13.2
11
+ Requires-Dist: psycopg2-binary>=2.9.9
12
+ Requires-Dist: typing-extensions>=4.12.2; python_version < "3.10"
13
+ Requires-Dist: typer>=0.12.3
14
+ Requires-Dist: jsonpickle>=3.2.2
15
+ Requires-Dist: opentelemetry-api>=1.26.0
16
+ Requires-Dist: opentelemetry-sdk>=1.26.0
17
+ Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.26.0
18
+ Requires-Dist: python-dateutil>=2.9.0.post0
19
+ Requires-Dist: fastapi[standard]>=0.112.1
20
+ Requires-Dist: psutil>=6.0.0
21
+ Requires-Dist: tomlkit>=0.13.2
22
+ Description-Content-Type: text/markdown
23
+
24
+ ## 🚀 DBOS Transact - Ultra-Lightweight Durable Execution in Python 🚀
25
+
26
+ ---
27
+
28
+ 📚 **Documentation**: Under Construction 🚧
29
+
30
+ 💬 **Join the Discussion**: [Discord Community](https://discord.gg/fMwQjeW5zg)
31
+
32
+ ---
33
+
34
+
35
+ **DBOS Python is under construction! 🚧🚧🚧 Check back regularly for updates, release coming in mid-September!**
36
+
37
+ DBOS Transact is a **Python library** providing ultra-lightweight durable execution.
38
+ For example:
39
+
40
+ ```python
41
+ @DBOS.step()
42
+ def step_one():
43
+ ...
44
+
45
+ @DBOS.step()
46
+ def step_two():
47
+ ...
48
+
49
+ @DBOS.workflow()
50
+ def workflow()
51
+ step_one()
52
+ step_two()
53
+ ```
54
+
55
+ Durable execution means your program is **resilient to any failure**.
56
+ If it is ever interrupted or crashes, all your workflows will automatically resume from the last completed step.
57
+ If you want to see durable execution in action, check out [this demo app](https://demo-widget-store.cloud.dbos.dev/) (source code [here](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python/widget-store)).
58
+ No matter how many times you try to crash it, it always resumes from exactly where it left off!
59
+
60
+ Under the hood, DBOS Transact works by storing your program's execution state (which workflows are currently executing and which steps they've completed) in a Postgres database.
61
+ So all you need to use it is a Postgres database to connect to&mdash;there's no need for a "workflow server."
62
+ This approach is also incredibly fast, for example [25x faster than AWS Step Functions](https://www.dbos.dev/blog/dbos-vs-aws-step-functions-benchmark).
63
+
64
+ Some more cool features include:
65
+
66
+ - Scheduled jobs&mdash;run your workflows exactly-once per time interval.
67
+ - Exactly-once event processing&mdash;use workflows to process incoming events (for example, from a Kafka topic) exactly-once.
68
+ - Observability&mdash;all workflows automatically emit [OpenTelemetry](https://opentelemetry.io/) traces.
69
+
70
+ ## Getting Started
71
+
72
+ To try out the latest pre-release version, install and configure with:
73
+
74
+ ```shell
75
+ pip install --pre dbos
76
+ dbos init --config
77
+ ```
78
+
79
+ Try it out with this simple program (requires Postgres):
80
+
81
+ ```python
82
+ from fastapi import FastAPI
83
+ from dbos import DBOS
84
+
85
+ app = FastAPI()
86
+ DBOS(fastapi=app)
87
+
88
+ @DBOS.step()
89
+ def step_one():
90
+ print("Step one completed!")
91
+
92
+ @DBOS.step()
93
+ def step_two():
94
+ print("Step two completed!")
95
+
96
+ @DBOS.workflow()
97
+ def workflow():
98
+ step_one()
99
+ for _ in range(5):
100
+ print("Press Control + \ to stop the app...")
101
+ DBOS.sleep(1)
102
+ step_two()
103
+
104
+ @app.get("/")
105
+ def endpoint():
106
+ workflow()
107
+ ```
108
+
109
+ Save the program into `main.py`, tell it your local Postgres password via `export PGPASSWORD=<your password>` and start it with `fastapi run`.
110
+ Visit `localhost:8000` in your browser (or curl it) to start the workflow.
111
+ When prompted, press `Control + \` to force quit your application.
112
+ It should crash midway through the workflow, having completed step one but not step two.
113
+ Then, restart your app with `fastapi run`.
114
+ It should resume the workflow from where it left off, completing step two without re-executing step one.
115
+
116
+ To learn how to build more complex examples, see our programming guide (coming soon).
117
+
118
+ ## Documentation
119
+
120
+ Coming soon! 🚧
121
+
122
+ ## Examples
123
+
124
+ Check out some cool demo apps here: [https://github.com/dbos-inc/dbos-demo-apps/tree/main/python](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python)
125
+
126
+ ## Community
127
+
128
+ If you're interested in building with us, please star our repository and join our community on [Discord](https://discord.gg/fMwQjeW5zg)!
129
+ If you see a bug or have a feature request, don't hesitate to open an issue here on GitHub.
130
+ If you're interested in contributing, check out our [contributions guide](./CONTRIBUTING.md).
@@ -1,19 +1,20 @@
1
- dbos-0.5.0a11.dist-info/METADATA,sha256=zWq1cPyLlyR1-qJrUhSwbURRvDUOI9LfxIg3M0kVFC0,5421
2
- dbos-0.5.0a11.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
3
- dbos-0.5.0a11.dist-info/entry_points.txt,sha256=3PmOPbM4FYxEmggRRdJw0oAsiBzKR8U0yx7bmwUmMOM,39
4
- dbos-0.5.0a11.dist-info/licenses/LICENSE,sha256=VGZit_a5-kdw9WT6fY5jxAWVwGQzgLFyPWrcVVUhVNU,1067
5
- dbos/__init__.py,sha256=X1LdP36NomDtvPfFwoMNtgXf81TO05jj7vltsp79UUw,787
6
- dbos/admin_sever.py,sha256=KtzH6aKyskCm4h3yulpy9jb5PIqRlYI2sjctw5mvaKY,3395
1
+ dbos-0.6.0a0.dist-info/METADATA,sha256=yZxiID1qC-U9PUOX1bPV0Dt1ve_jEI2VCxiasiSxvQM,4443
2
+ dbos-0.6.0a0.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
3
+ dbos-0.6.0a0.dist-info/entry_points.txt,sha256=3PmOPbM4FYxEmggRRdJw0oAsiBzKR8U0yx7bmwUmMOM,39
4
+ dbos-0.6.0a0.dist-info/licenses/LICENSE,sha256=VGZit_a5-kdw9WT6fY5jxAWVwGQzgLFyPWrcVVUhVNU,1067
5
+ dbos/__init__.py,sha256=s3nYPf5yGR4XxiXS_JQbL8WVTjnnwr5EpFoCaCMrFxg,582
6
+ dbos/admin_sever.py,sha256=Qg5T3YRrbPW05PR_99yAaxgo1ugQrAp_uTeTqSfjm_k,3397
7
7
  dbos/application_database.py,sha256=1K3kE96BgGi_QWOd2heXluyNTwFAwlUVuAR6JKKUqf0,5659
8
- dbos/cli.py,sha256=QnbGtZ8S963q3iyFvXNBcL4DB35r4SFMarlb5DRqN6M,7915
9
- dbos/context.py,sha256=qAVj_pAIV4YBOAbI0WCv-Roq7aNwPzAoj3CeQaVqlrU,15666
10
- dbos/core.py,sha256=HfKnPpIaQqIBAHzP2hD67aSIchTHp87NgD21CcujKkE,28300
8
+ dbos/cli.py,sha256=YARlQiWHUwFni-fEOr0k5P_-pqPS4xkywj_B0oTMXn0,8318
9
+ dbos/context.py,sha256=NVMGyvAa2RIiBVspvDz-8MBk_BQyGyYdPdorgO-GSng,16407
10
+ dbos/core.py,sha256=jeqO8DABPAUrFlJXOfRfFDSnA8BGwiPnMa1JNbGuYLs,28584
11
11
  dbos/dbos-config.schema.json,sha256=azpfmoDZg7WfSy3kvIsk9iEiKB_-VZt03VEOoXJAkqE,5331
12
- dbos/dbos.py,sha256=bDp-m25V_CkaR4hsr4VmCFCZbDQ4V99Um9bDUxahpag,26561
13
- dbos/dbos_config.py,sha256=EkO0c0xaIM7_vAAqqnvNNEAKG5fOJbmmalqnZvaKYZA,5312
12
+ dbos/dbos.py,sha256=zOTolY-lpDwpSO2ORrtIIRjIdi6JsQc9ovQDmvlc47I,28985
13
+ dbos/dbos_config.py,sha256=SJ_UI4pHVKKjZDjge9Abm0HgcdQ6aDBO8QKBYujEPeE,5307
14
14
  dbos/decorators.py,sha256=lbPefsLK6Cya4cb7TrOcLglOpGT3pc6qjZdsQKlfZLg,629
15
- dbos/error.py,sha256=nBdLC4hxGO_K9V26YbDGOo7xi1CKuN4PsE_cBv7K8Cc,3798
16
- dbos/fastapi.py,sha256=LkARLITiN_NuQh4g2QL7sfK0oG1GvJjj2tvU7WWO8f8,1898
15
+ dbos/error.py,sha256=DDhB0VHmoZE_CP51ICdFMZSL2gmVS3Dm0aPNWncci94,3876
16
+ dbos/fastapi.py,sha256=s7LnwwYVpJm_QZZwBW5um8NV2Q2Qx85uVZqGcKlSZAo,1881
17
+ dbos/flask.py,sha256=azr4geMEGuuTBCyxIZmgDmmP-6s_pTIF-lGyp9Q4IB8,2430
17
18
  dbos/logger.py,sha256=D-aFSZUCHBP34J1IZ5YNkTrJW-rDiH3py_v9jLU4Yrk,3565
18
19
  dbos/migrations/env.py,sha256=38SIGVbmn_VV2x2u1aHLcPOoWgZ84eCymf3g_NljmbU,1626
19
20
  dbos/migrations/script.py.mako,sha256=MEqL-2qATlST9TAOeYgscMn1uy6HUS9NFvDgl93dMj8,635
@@ -22,14 +23,14 @@ dbos/migrations/versions/a3b18ad34abe_added_triggers.py,sha256=Rv0ZsZYZ_WdgGEULY
22
23
  dbos/py.typed,sha256=QfzXT1Ktfk3Rj84akygc7_42z0lRpCq0Ilh8OXI6Zas,44
23
24
  dbos/recovery.py,sha256=xfwQFWNuD8DXg5HD5_-3tG7Neo9j-x1lrqiwtn5FSh8,2015
24
25
  dbos/registrations.py,sha256=gMI-u05tv5bpvyddQGtoUgCsqARx51aOY7p0JXPafQo,6539
25
- dbos/request.py,sha256=FTjmgzqWwKKTSf6PKPdlQ4Ssp39PATQukYmMOW_xP7k,892
26
- dbos/roles.py,sha256=9u0z4CWmXPeqIKzQWEzaOKIlzOuaagBtMiB-swqjX_U,2291
26
+ dbos/request.py,sha256=-FIwtknayvRl6OjvqO4V2GySVzSdP1Ft3cc9ZBS-PLY,928
27
+ dbos/roles.py,sha256=7Lh7uwUq1dpa6TXCOHre4mPTd5qmXzK_QPkvYR52DXg,2285
27
28
  dbos/scheduler/croniter.py,sha256=hbhgfsHBqclUS8VeLnJ9PSE9Z54z6mi4nnrr1aUXn0k,47561
28
29
  dbos/scheduler/scheduler.py,sha256=uO4_9jmWW2rLv1ODL3lc1cE_37ZaVTgnvmFx_FAlN50,1472
29
30
  dbos/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
30
31
  dbos/schemas/application_database.py,sha256=q_Wr2XbiZNBYFkOtu7uKavo1T_cSOBblxKGHThYGGsY,962
31
32
  dbos/schemas/system_database.py,sha256=5V3vqnEzry0Hn7ZbVS9Gs_dJKia8uX8p7mGC82Ru8rk,4303
32
- dbos/system_database.py,sha256=84c53iAel113SRb7DcgFJ8XQNWBhD4VrCRCb0s5Oe8Y,39635
33
+ dbos/system_database.py,sha256=BZ8yE79FH9NZhEt8AAYNXy0-wMcKLBAq8VPdZbfidR4,40564
33
34
  dbos/templates/hello/README.md,sha256=GhxhBj42wjTt1fWEtwNriHbJuKb66Vzu89G4pxNHw2g,930
34
35
  dbos/templates/hello/__package/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
35
36
  dbos/templates/hello/__package/main.py,sha256=LFN48qBWt-xsf21Cg1llf5Grr0e7Il_7lcyi60sK4ec,2984
@@ -40,7 +41,7 @@ dbos/templates/hello/migrations/env.py.dbos,sha256=CsiFOea3ZIsahqkfYtioha0ewmlGR
40
41
  dbos/templates/hello/migrations/script.py.mako,sha256=MEqL-2qATlST9TAOeYgscMn1uy6HUS9NFvDgl93dMj8,635
41
42
  dbos/templates/hello/migrations/versions/2024_07_31_180642_init.py,sha256=rcubrMdw-NUKnrY0Qsftgz4is1OEqWXf6Skcv4PVdME,914
42
43
  dbos/templates/hello/start_postgres_docker.py,sha256=lQVLlYO5YkhGPEgPqwGc7Y8uDKse9HsWv5fynJEFJHM,1681
43
- dbos/tracer.py,sha256=RPW9oxmX9tSc0Yq7O-FAhpQWBg1QT7Ni1Q06uwhtNDk,2237
44
+ dbos/tracer.py,sha256=GaXDhdKKF_IQp5SAMipGXiDVwteRKjNbrXyYCH1mor0,2520
44
45
  dbos/utils.py,sha256=hWj9iWDrby2cVEhb0pG-IdnrxLqP64NhkaWUXiLc8bA,402
45
46
  version/__init__.py,sha256=L4sNxecRuqdtSFdpUGX3TtBi9KL3k7YsZVIvv-fv9-A,1678
46
- dbos-0.5.0a11.dist-info/RECORD,,
47
+ dbos-0.6.0a0.dist-info/RECORD,,
@@ -1,78 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: dbos
3
- Version: 0.5.0a11
4
- Summary: A Python framework for backends that scale
5
- Author-Email: "DBOS, Inc." <contact@dbos.dev>
6
- License: MIT
7
- Requires-Python: >=3.9
8
- Requires-Dist: pyyaml>=6.0.2
9
- Requires-Dist: jsonschema>=4.23.0
10
- Requires-Dist: alembic>=1.13.2
11
- Requires-Dist: psycopg2-binary>=2.9.9
12
- Requires-Dist: typing-extensions>=4.12.2; python_version < "3.10"
13
- Requires-Dist: typer>=0.12.3
14
- Requires-Dist: jsonpickle>=3.2.2
15
- Requires-Dist: opentelemetry-api>=1.26.0
16
- Requires-Dist: opentelemetry-sdk>=1.26.0
17
- Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.26.0
18
- Requires-Dist: python-dateutil>=2.9.0.post0
19
- Requires-Dist: fastapi[standard]>=0.112.1
20
- Requires-Dist: psutil>=6.0.0
21
- Requires-Dist: tomlkit>=0.13.2
22
- Description-Content-Type: text/markdown
23
-
24
- # DBOS Transact Python
25
-
26
- **DBOS Python is under construction! 🚧🚧🚧 Check back regularly for updates, release coming in mid-September!**
27
-
28
- DBOS Transact is a **Python library** for building durable and scalable applications.
29
-
30
- You want to use DBOS Transact in your application because you need:
31
-
32
- - **Resilience to any failure**. If your app is interrupted for any reason, it automatically resumes from where it left off. Reliable message delivery is built in. Idempotency is built in.
33
- - **Reliable event processing**. Need to consume Kafka events exactly-once? Just add one line of code to your app. Need to run a task exactly once per hour, day, or month? Just one more line of code.
34
- - **Built-in observability**. Automatically emit [OpenTelemetry](https://opentelemetry.io/)-compatible logs and traces from any application. Query your app's history from the command line or with SQL.
35
- - **Blazing-fast, developer-friendly serverless**. Develop your project locally and run it anywhere. When you're ready, [deploy it for free to DBOS Cloud](https://docs.dbos.dev/getting-started/quickstart#deploying-to-dbos-cloud) and we'll host it for you, [25x faster](https://www.dbos.dev/blog/dbos-vs-aws-step-functions-benchmark) and [15x cheaper](https://www.dbos.dev/blog/dbos-vs-lambda-cost) than AWS Lambda.
36
-
37
- ## Getting Started
38
-
39
- To try out the latest pre-release version, install with:
40
-
41
- ```shell
42
- pip install --pre dbos
43
- ```
44
-
45
- ## Documentation
46
-
47
- Coming soon! 🚧
48
-
49
- But we have some cool demo apps for you to check out: [https://github.com/dbos-inc/dbos-demo-apps/tree/main/python](https://github.com/dbos-inc/dbos-demo-apps/tree/main/python)
50
-
51
- ## Main Features
52
-
53
- Here are some of the core features of DBOS Transact:
54
-
55
- | Feature | Description
56
- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
57
- | [Transactions](https://www.dbos.dev/dbos-transact-python) | Easily and safely query your application database using [SQLAlchemy](https://www.sqlalchemy.org/) or raw SQL.
58
- | [Workflows](https://www.dbos.dev/dbos-transact-python) | Reliable workflow orchestration&#8212;resume your program after any failure.
59
- | [Idempotency](https://www.dbos.dev/dbos-transact-python) | Automatically make any request idempotent, so your requests happen exactly once.
60
- | [Authentication and Authorization](https://www.dbos.dev/dbos-transact-python) | Secure your HTTP endpoints so only authorized users can access them.
61
- | [Kafka Integration](https://www.dbos.dev/dbos-transact-python) | Consume Kafka messages exactly-once with transactions or workflows.
62
- | [Scheduled Workflows](https://www.dbos.dev/dbos-transact-python) | Schedule your workflows to run exactly-once per time interval with cron-like syntax.
63
- | [Self-Hosting](https://www.dbos.dev/dbos-transact-python) | Host your applications anywhere, as long as they have a Postgres database to connect to.
64
-
65
- And DBOS Cloud:
66
-
67
- | Feature | Description
68
- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
69
- | [Serverless App Deployment](https://docs.dbos.dev/cloud-tutorials/application-management) | Deploy apps to DBOS Cloud in minutes.
70
- | [Interactive Time Travel](https://docs.dbos.dev/cloud-tutorials/interactive-timetravel) | Query your application database as of any past point in time.
71
- | [Cloud Database Management](https://docs.dbos.dev/cloud-tutorials/database-management) | Provision cloud Postgres instances for your applications. Alternatively, [bring your own database](https://docs.dbos.dev/cloud-tutorials/byod-management).
72
- | [Built-in Observability](https://docs.dbos.dev/cloud-tutorials/monitoring-dashboard) | Built-in log capture, request tracing, and dashboards.
73
-
74
- ## Community
75
-
76
- If you're interested in building with us, please star our repository and join our community on [Discord](https://discord.gg/fMwQjeW5zg)!
77
- If you see a bug or have a feature request, don't hesitate to open an issue here on GitHub.
78
- If you're interested in contributing, check out our [contributions guide](./CONTRIBUTING.md).