Skip to content

FISCFED9/CLI / .agents/skills/plugins/antigravity-awesome-skills-claude/skills/dbos-python

dbos-python

Verified

Guide for building reliable, fault-tolerant Python applications with DBOS durable workflows. Use when adding DBOS to existing Python code, creating workflows and steps, or using queues for concurrency control.

FileKindSize
AGENTS.mdmarkdown2.7 KB
CLAUDE.mdmarkdown2.7 KB
SKILL.mdskill md2.6 KB
references/_sections.mdmarkdown1.4 KB
references/advanced-async.mdmarkdown2.5 KB
references/advanced-patching.mdmarkdown1.5 KB
references/advanced-versioning.mdmarkdown1.6 KB
references/client-enqueue.mdmarkdown1.4 KB
references/client-setup.mdmarkdown1.6 KB
references/comm-events.mdmarkdown1.5 KB
references/comm-messages.mdmarkdown1.5 KB
references/comm-streaming.mdmarkdown1.5 KB
references/lifecycle-config.mdmarkdown1.5 KB
references/lifecycle-fastapi.mdmarkdown1.5 KB
references/pattern-classes.mdmarkdown1.6 KB
references/pattern-debouncing.mdmarkdown1.6 KB
references/pattern-idempotency.mdmarkdown1.5 KB
references/pattern-scheduled.mdmarkdown1.5 KB
references/pattern-sleep.mdmarkdown1.3 KB
references/queue-basics.mdmarkdown1.3 KB
references/queue-concurrency.mdmarkdown1.3 KB
references/queue-deduplication.mdmarkdown1.6 KB
references/queue-listening.mdmarkdown1.6 KB
references/queue-partitioning.mdmarkdown1.8 KB
references/queue-priority.mdmarkdown1.5 KB
references/queue-rate-limiting.mdmarkdown1.3 KB
references/step-basics.mdmarkdown1.3 KB
references/step-retries.mdmarkdown1.4 KB
references/step-transactions.mdmarkdown1.7 KB
references/test-fixtures.mdmarkdown1.4 KB
references/workflow-background.mdmarkdown1.3 KB
references/workflow-constraints.mdmarkdown1.6 KB
references/workflow-control.mdmarkdown2.0 KB
references/workflow-determinism.mdmarkdown1.3 KB
references/workflow-introspection.mdmarkdown1.8 KB
references/workflow-timeout.mdmarkdown1.4 KB

references/pattern-classes.md

View on GitHub
---
title: Use DBOS Decorators with Classes
impact: MEDIUM
impactDescription: Enables stateful workflow patterns with class instances
tags: classes, dbos_class, instance, oop
---

## Use DBOS Decorators with Classes

DBOS decorators work with class methods. Workflow classes must inherit from `DBOSConfiguredInstance`.

**Incorrect (missing class setup):**

```python
class MyService:
    def __init__(self, url):
        self.url = url

    @DBOS.workflow()  # Won't work without proper setup
    def fetch_data(self):
        return self.fetch()
```

**Correct (proper class setup):**

```python
from dbos import DBOS, DBOSConfiguredInstance

@DBOS.dbos_class()
class URLFetcher(DBOSConfiguredInstance):
    def __init__(self, url: str):
        self.url = url
        # instance_name must be unique and passed to super()
        super().__init__(instance_name=url)

    @DBOS.workflow()
    def fetch_workflow(self):
        return self.fetch_url()

    @DBOS.step()
    def fetch_url(self):
        return requests.get(self.url).text

# Instantiate BEFORE DBOS.launch()
example_fetcher = URLFetcher("https://example.com")
api_fetcher = URLFetcher("https://api.example.com")

if __name__ == "__main__":
    DBOS.launch()
    print(example_fetcher.fetch_workflow())
```

Requirements:
- Class must be decorated with `@DBOS.dbos_class()`
- Class must inherit from `DBOSConfiguredInstance`
- `instance_name` must be unique and passed to `super().__init__()`
- All instances must be created before `DBOS.launch()`

Steps can be added to any class without these requirements.

Reference: [Python Classes](https://docs.dbos.dev/python/tutorials/classes)
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 318kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 318kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 318kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 318kUpdated Claude CodeCodexVerifiedInstall