Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
0589a99
Clean up references/core/ai-integration.md
donald-pinckney Feb 13, 2026
22d90c5
Clean up references/core/common-gotchas.md
donald-pinckney Feb 13, 2026
a32152b
Clean up references/core/common-gotchas.md
donald-pinckney Feb 13, 2026
9ce8441
Clean up references/core/determinism.md
donald-pinckney Feb 13, 2026
519b2ea
Clean up references/core/determinism.md
donald-pinckney Feb 13, 2026
49c449a
Update error-reference.md
donald-pinckney Feb 17, 2026
d2a4af3
Update interactive-workflows.md
donald-pinckney Feb 17, 2026
e62865a
Clean up patterns.md
donald-pinckney Feb 17, 2026
324b532
Cut shell scripts
donald-pinckney Feb 17, 2026
5d3f79f
Edit troubleshooting.md
donald-pinckney Feb 17, 2026
19a9589
remove interceptors for now
donald-pinckney Feb 18, 2026
761b220
remove dynamic workflows
donald-pinckney Feb 18, 2026
4d032f4
clarify on heartbeating of async activity completions, and prompt it …
donald-pinckney Feb 18, 2026
8d77164
Improve references/python/advanced-features.md
donald-pinckney Feb 18, 2026
ceb40a0
Use explicit namespace in connect
donald-pinckney Feb 18, 2026
c61bc64
remove duplicated content from determinism.md, clean up
donald-pinckney Feb 18, 2026
236eab2
Improve references/python/data-handling.md
donald-pinckney Feb 18, 2026
43b1ed7
Prefer start_to_close_timeout
donald-pinckney Feb 18, 2026
cc593e3
don't explicitely provide defaults for retry policies
donald-pinckney Feb 18, 2026
24f0e3e
error-handling.md cleanup
donald-pinckney Feb 18, 2026
18cb1e8
move idempotency patterns to patterns.md
donald-pinckney Feb 18, 2026
03e8706
remove multi-param activities
donald-pinckney Feb 18, 2026
3f7dc9d
small edits
donald-pinckney Feb 18, 2026
9163fa2
Unify sandbox stuff into one file
donald-pinckney Feb 18, 2026
4c288cf
local activities aren't experimental
donald-pinckney Feb 18, 2026
b8b47ca
Clean up references/python/sync-vs-async.md
donald-pinckney Feb 18, 2026
9bc285f
Cleanup observability.md, remove duplicated search attributes
donald-pinckney Feb 19, 2026
f455d39
Cut otel for now
donald-pinckney Feb 19, 2026
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
Prev Previous commit
Next Next commit
Improve references/python/data-handling.md
  • Loading branch information
donald-pinckney committed Feb 18, 2026
commit 236eab2d1a12592d338af137e444e7482a6a2596
77 changes: 36 additions & 41 deletions references/python/data-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ The default converter handles:

Use Pydantic models for validated, typed data.

In your workflow definition, just use input and result types that subclass `pydantic.BaseModel`:

```python
from pydantic import BaseModel
from temporalio.contrib.pydantic import pydantic_data_converter

class OrderInput(BaseModel):
order_id: str
Expand All @@ -41,7 +42,12 @@ class OrderWorkflow:
status="completed",
tracking_number="TRK123",
)
```

And when you configure the client, pass the `pydantic_data_converter`:

```python
from temporalio.contrib.pydantic import pydantic_data_converter
# Configure client with Pydantic support
client = await Client.connect(
"localhost:7233",
Expand All @@ -50,31 +56,13 @@ client = await Client.connect(
)
```

## Custom Data Converter
## Custom Data Conversion

Create custom converters for special serialization needs.
Usually the easiest way to do this is via implementing an EncodingPayloadConverter and CompositePayloadConverter. See:
- https://raw.githubusercontent.com/temporalio/samples-python/refs/heads/main/custom_converter/shared.py
- https://raw.githubusercontent.com/temporalio/samples-python/refs/heads/main/custom_converter/starter.py

```python
from temporalio.converter import (
DataConverter,
PayloadConverter,
DefaultPayloadConverter,
)

class CustomPayloadConverter(PayloadConverter):
# Implement encoding_payload_converters and decoding_payload_converters
pass

custom_converter = DataConverter(
payload_converter_class=CustomPayloadConverter,
)

client = await Client.connect(
"localhost:7233",
namespace="default",
data_converter=custom_converter,
)
```
for an extended example.

## Payload Encryption

Expand All @@ -94,7 +82,8 @@ class EncryptionCodec(PayloadCodec):
return [
Payload(
metadata={"encoding": b"binary/encrypted"},
data=self._fernet.encrypt(p.SerializeToString()),
# Since encryption uses C extensions that give up the GIL, we can avoid blocking the async event loop here.
data=await asyncio.to_thread(self._fernet.encrypt, p.SerializeToString()),
)
for p in payloads
]
Expand All @@ -103,7 +92,7 @@ class EncryptionCodec(PayloadCodec):
result = []
for p in payloads:
if p.metadata.get("encoding") == b"binary/encrypted":
decrypted = self._fernet.decrypt(p.data)
decrypted = await asyncio.to_thread(self._fernet.decrypt, p.data)
decoded = Payload()
decoded.ParseFromString(decrypted)
result.append(decoded)
Expand All @@ -126,32 +115,37 @@ client = await Client.connect(
Custom searchable fields for workflow visibility.

```python
from temporalio.common import SearchAttributes, SearchAttributeKey
from temporalio.common import (
SearchAttributeKey,
SearchAttributePair,
TypedSearchAttributes,
)
from datetime import datetime
from datetime import timezone

# Define typed keys
ORDER_ID = SearchAttributeKey.for_keyword("OrderId")
ORDER_STATUS = SearchAttributeKey.for_keyword("OrderStatus")
ORDER_TOTAL = SearchAttributeKey.for_float("OrderTotal")
CREATED_AT = SearchAttributeKey.for_datetime("CreatedAt")

# Set at workflow start
await client.execute_workflow(
# At workflow start
handle = await client.start_workflow(
OrderWorkflow.run,
order,
id=f"order-{order.id}",
task_queue="orders",
search_attributes=SearchAttributes.from_pairs([
(ORDER_ID, order.id),
(ORDER_STATUS, "pending"),
(ORDER_TOTAL, order.total),
(CREATED_AT, datetime.now(timezone.utc)),
search_attributes=TypedSearchAttributes([
SearchAttributePair(ORDER_ID, order.id),
SearchAttributePair(ORDER_STATUS, "pending"),
SearchAttributePair(ORDER_TOTAL, order.total),
SearchAttributePair(CREATED_AT, datetime.now(timezone.utc)),
]),
)

# Upsert from within workflow
workflow.upsert_search_attributes([
(ORDER_STATUS, "completed"),
])
# Inside workflow: upsert
workflow.upsert_search_attributes(TypedSearchAttributes([
SearchAttributePair(ORDER_STATUS, "completed"),
]))
```

## Workflow Memo
Expand All @@ -170,14 +164,15 @@ await client.execute_workflow(
"notes": "Priority customer",
},
)
```

```python
# Read memo from workflow
@workflow.defn
class OrderWorkflow:
@workflow.run
async def run(self, order: Order) -> str:
memo = workflow.memo()
notes = memo.get("notes", "")
notes: str = workflow.memo_value("notes", type_hint=str)
...
```

Expand Down