Skip to content
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

Add custom sleep parameter to async_bulk and async_streaming_bulk #2717

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

Add custom sleep parameter to async_bulk and async_streaming_bulk #2717

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8232d7e
add custom sleep parameter to async_bulk and async_streaming_bulk
girolamo-giordano Dec 5, 2024
c8659e7
Merge branch 'elastic:main' into main
girolamo-giordano Dec 30, 2024
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 elasticsearch/_async/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
Any,
AsyncIterable,
AsyncIterator,
Awaitable,
Callable,
Collection,
Dict,
Expand Down Expand Up @@ -167,6 +168,7 @@ async def async_streaming_bulk(
expand_action_callback: Callable[
[_TYPE_BULK_ACTION], _TYPE_BULK_ACTION_HEADER_AND_BODY
] = expand_action,
sleep: Callable[[float],Awaitable[None]] = asyncio.sleep,
raise_on_exception: bool = True,
max_retries: int = 0,
initial_backoff: float = 2,
Expand Down Expand Up @@ -202,6 +204,7 @@ async def async_streaming_bulk(
:arg expand_action_callback: callback executed on each action passed in,
should return a tuple containing the action line and the data line
(`None` if data line should be omitted).
:arg sleep: custom callable defined for custom action on cancelling
:arg retry_on_status: HTTP status code that will trigger a retry.
(if `None` is specified only status 429 will retry).
:arg max_retries: maximum number of times a document will be retried when
Expand Down Expand Up @@ -246,7 +249,7 @@ async def map_actions() -> AsyncIterable[_TYPE_BULK_ACTION_HEADER_AND_BODY]:
]
] = []
if attempt:
await asyncio.sleep(
await sleep(
min(max_backoff, initial_backoff * 2 ** (attempt - 1))
)

Expand Down Expand Up @@ -304,6 +307,7 @@ async def async_bulk(
client: AsyncElasticsearch,
actions: Union[Iterable[_TYPE_BULK_ACTION], AsyncIterable[_TYPE_BULK_ACTION]],
stats_only: bool = False,
sleep: Callable[[float],Awaitable[None]] = asyncio.sleep,
ignore_status: Union[int, Collection[int]] = (),
*args: Any,
**kwargs: Any,
Expand All @@ -329,6 +333,7 @@ async def async_bulk(
:arg actions: iterator containing the actions
:arg stats_only: if `True` only report number of successful/failed
operations instead of just number of successful and a list of error responses
:arg sleep: custom callable defined for custom action on cancelling
:arg ignore_status: list of HTTP status code that you want to ignore

Any additional keyword arguments will be passed to
Expand All @@ -344,7 +349,7 @@ async def async_bulk(
# make streaming_bulk yield successful results so we can count them
kwargs["yield_ok"] = True
async for ok, item in async_streaming_bulk(
client, actions, ignore_status=ignore_status, *args, **kwargs # type: ignore[misc]
client, actions, sleep=sleep, ignore_status=ignore_status, *args, **kwargs # type: ignore[misc]
):
# go through request-response pairs and detect failures
if not ok:
Expand Down