Skip to content

doc(taskbroker_client): better docstring for apply_async_with_future #743

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

Merged
lvthanh03 merged 2 commits into from
Jul 6, 2026
Merged

doc(taskbroker_client): better docstring for apply_async_with_future #743

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f529558
doc(taskbroker_client): better docstring for apply_async_with_future
lvthanh03 Jul 6, 2026
948b189
clarify that produce still happens
lvthanh03 Jul 6, 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
9 changes: 7 additions & 2 deletions clients/python/src/taskbroker_client/task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,13 @@ def apply_async_with_future(
**options: Any,
) -> ProducerFuture | None:
"""
Schedule a task and return the producer future for callers that need to
wait on delivery alongside other Kafka produces.
Schedule a task and return the producer future.

This does not wait for delivery. Callers that need delivery confirmation
must wait on the returned future themselves. Callers that do not need the
future should use apply_async(). Ignoring the returned future does not
cancel or prevent the produce; the task activation has already been
handed to the producer.
"""
activation, args, kwargs = self._create_activation_for_async_dispatch(
args=args, kwargs=kwargs, headers=headers, expires=expires, countdown=countdown
Expand Down
Loading