Skip to content

Commit

Permalink
chore: move retry async check to wrap time (#649)
Browse files Browse the repository at this point in the history
* chore: move retry async check to wrap time

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* added no cover mark

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
  • Loading branch information
3 people committed Jun 4, 2024
1 parent 1203fb9 commit ac098a7
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
7 changes: 3 additions & 4 deletions google/api_core/retry/retry_unary.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,7 @@ def retry_target(

for sleep in sleep_generator:
try:
result = target()
if inspect.isawaitable(result):
warnings.warn(_ASYNC_RETRY_WARNING)
return result
return target()

# pylint: disable=broad-except
# This function explicitly must deal with broad exceptions.
Expand Down Expand Up @@ -280,6 +277,8 @@ def __call__(
Callable: A callable that will invoke ``func`` with retry
behavior.
"""
if inspect.iscoroutinefunction(func):
warnings.warn(_ASYNC_RETRY_WARNING)
if self._on_error is not None:
on_error = self._on_error

Expand Down
16 changes: 11 additions & 5 deletions tests/unit/retry/test_retry_unary.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,20 @@ def test_retry_target_non_retryable_error(utcnow, sleep):
)
@pytest.mark.asyncio
async def test_retry_target_warning_for_retry(utcnow, sleep):
predicate = retry.if_exception_type(ValueError)
target = mock.AsyncMock(spec=["__call__"])
"""
retry.Retry should raise warning when wrapping an async function.
"""

async def target():
pass # pragma: NO COVER

retry_obj = retry.Retry()

with pytest.warns(Warning) as exc_info:
# Note: predicate is just a filler and doesn't affect the test
retry.retry_target(target, predicate, range(10), None)
# raise warning when wrapping an async function
retry_obj(target)

assert len(exc_info) == 2
assert len(exc_info) == 1
assert str(exc_info[0].message) == retry.retry_unary._ASYNC_RETRY_WARNING
sleep.assert_not_called()

Expand Down

0 comments on commit ac098a7

Please sign in to comment.