Commit11b5e02

committed

fix: add warning to retry target to avoid incorrect use

1 parent405272c commit11b5e02Copy full SHA for 11b5e02

File tree

+26

-3

lines changed

+26

-3

lines changed

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`
`27`	`27`	`fromgoogle.api_coreimportexceptionsascore_exceptions`
`28`	`28`	`fromgoogle.api_coreimportgapic_v1,page_iterator_async`
`29`		`-fromgoogle.api_coreimportretryasretries`
	`29`	`+fromgoogle.api_coreimportretry_asyncasretries`
`30`	`30`	`fromgoogle.api_coreimporttimeoutastimeouts`
`31`	`31`	`fromgoogle.longrunningimportoperations_pb2`
`32`	`32`	`fromgrpcimportCompression`
`@@ -48,7 +48,7 @@ def __init__(self, channel, client_config=None):`
`48`	`48`	`# Create the gRPC client stub with gRPC AsyncIO channel.`
`49`	`49`	`self.operations_stub=operations_pb2.OperationsStub(channel)`
`50`	`50`
`51`		`-default_retry=retries.Retry(`
	`51`	`+default_retry=retries.AsyncRetry(`
`52`	`52`	`initial=0.1,# seconds`
`53`	`53`	`maximum=60.0,# seconds`
`54`	`54`	`multiplier=1.3,`

Lines changed: 5 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ def check_if_exists():`
`62`	`62`	`importrandom`
`63`	`63`	`importsys`
`64`	`64`	`importtime`
	`65`	`+importinspect`
`65`	`66`	`fromtypingimportAny,Callable,TypeVar,TYPE_CHECKING`
`66`	`67`
`67`	`68`	`importrequests.exceptions`
`@@ -201,7 +202,10 @@ def retry_target(`
`201`	`202`
`202`	`203`	`forsleepinsleep_generator:`
`203`	`204`	`try:`
`204`		`-returntarget()`
	`205`	`+result=target()`
	`206`	`+ifinspect.isawaitable(result):`
	`207`	`+raiseexceptions.GoogleAPICallError("Warning: Using the synchronous google.api_core.retry.Retry with asynchronous calls may lead to unexpected results. Please use google.api_core.retry_async.AsyncRetry instead.")`
	`208`	`+returnresult`
`205`	`209`
`206`	`210`	`# pylint: disable=broad-except`
`207`	`211`	`# This function explicitly must deal with broad exceptions.`

Lines changed: 19 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`
`21`	`21`	`fromgoogle.api_coreimportexceptions`
`22`	`22`	`fromgoogle.api_coreimportretry_async`
	`23`	`+fromgoogle.api_coreimportretry`
`23`	`24`
`24`	`25`
`25`	`26`	`@mock.patch("asyncio.sleep",autospec=True)`
`@@ -95,6 +96,24 @@ async def test_retry_target_non_retryable_error(utcnow, sleep):`
`95`	`96`	`assertexc_info.value==exception`
`96`	`97`	`sleep.assert_not_called()`
`97`	`98`
	`99`	`+@mock.patch("asyncio.sleep",autospec=True)`
	`100`	`+@mock.patch(`
	`101`	`+"google.api_core.datetime_helpers.utcnow",`
	`102`	`+return_value=datetime.datetime.min,`
	`103`	`+autospec=True,`
	`104`	`+)`
	`105`	`+@pytest.mark.asyncio`
	`106`	`+asyncdeftest_retry_target_warning_for_retry(utcnow,sleep):`
	`107`	`+predicate=retry_async.if_exception_type(ValueError)`
	`108`	`+target=mock.AsyncMock(spec=["__call__"])`
	`109`	`+`
	`110`	`+withpytest.raises(exceptions.GoogleAPICallError)asexc_info:`
	`111`	`+retry.retry_target(target,predicate,range(10),None)`
	`112`	`+`
	`113`	`+assertexc_info.match("Warning: Using the synchronous google.api_core.retry.Retry with asynchronous calls may lead to unexpected results. Please use google.api_core.retry_async.AsyncRetry instead.")`
	`114`	`+assertexc_info.type==exceptions.GoogleAPICallError`
	`115`	`+sleep.assert_not_called()`
	`116`	`+`
`98`	`117`
`99`	`118`	`@mock.patch("asyncio.sleep",autospec=True)`
`100`	`119`	`@mock.patch("google.api_core.datetime_helpers.utcnow",autospec=True)`

Comments

(0)