Skip to content

Step input is pickled only when called outside a workflow #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Step input is pickled only when called outside a workflow #304

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f173e39
Step input is not serialized
jkline-trustle Feb 14, 2025
e1dfdc6
Serializable input for steps called outside workflows
jkline-trustle Feb 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/python/tutorials/step-tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Steps
When using DBOS workflows, we recommend annotating any function that performs complex operations or accesses external APIs or services as a _step_.

You can turn **any** Python function into a step by annotating it with the [`@DBOS.step`](../reference/decorators.md#step) decorator.
The only requirement is that its inputs and outputs should be serializable ([pickle](https://docs.python.org/3/library/pickle.html)-able).
The only requirement is that its outputs should be serializable ([pickle](https://docs.python.org/3/library/pickle.html)-able).
Here's a simple example:

```python
Expand All @@ -24,6 +24,8 @@ Therefore, making a function a step guarantees that a workflow will never re-exe

2. DBOS provides [configurable automatic retries](#configurable-retries) for steps to more easily handle transient errors.

(A `step` called from outside a `workflow` will be upgraded to `workflow` and
therefore the inputs must also be serializable.)

### Configurable Retries

Expand Down Expand Up @@ -62,4 +64,4 @@ async def example_step():
async with aiohttp.ClientSession() as session:
async with session.get("https://example.com") as response:
return await response.text()
```
```