Why are synchronous activities recommended?

Open
#1,468 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Read README.md, starting with the say_hello_activity example and the “Types of Activities” section. Compare the recommendation for synchronous activities with the performance guidance and executor requirement, then clarify the documentation so the intended default and exceptions are unambiguous.

Written by the indexing model from the issue text.

Description

from README.md:

The say_hello_activity is synchronous which is the recommended activity type (see "Types of Activities" below), but it can be async

However a few lines below, asynchronous activities are described as much more performant. Also, handling any sync tasks requires the Worker to be created with an explicit executor parameter.

It seems like async activities are expected and sync ones should be exceptional.

Dominant language
Python
Stars
1.2k
Forks
241
Avg merge
3d 2h
Merged PRs (30d)
49

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from temporalio/sdk-python

All issues in temporalio/sdk-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.