Commit14f1f34

Gurov Ilya

authored and

committed

feat(api_core): add retry param into PollingFuture() and it's inheritors (#9923)

* feat(api_core): add retry param into PollingFuture() and it's inheritorsTowards #6197

1 parent18375fb commit14f1f34Copy full SHA for 14f1f34

File tree

+35

-6

lines changed

+35

-6

lines changed

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -66,9 +66,12 @@ def __init__(self, retry=DEFAULT_RETRY):`
`66`	`66`	`self._done_callbacks= []`
`67`	`67`
`68`	`68`	`@abc.abstractmethod`
`69`		`-defdone(self):`
	`69`	`+defdone(self,retry=DEFAULT_RETRY):`
`70`	`70`	`"""Checks to see if the operation is complete.`
`71`	`71`
	`72`	`+ Args:`
	`73`	`+ retry (google.api_core.retry.Retry): (Optional) How to retry the RPC.`
	`74`	`+`
`72`	`75`	`Returns:`
`73`	`76`	`bool: True if the operation is complete, False otherwise.`
`74`	`77`	`"""`

Lines changed: 12 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -145,21 +145,28 @@ def _set_result_from_operation(self):`
`145`	`145`	`)`
`146`	`146`	`self.set_exception(exception)`
`147`	`147`
`148`		`-def_refresh_and_update(self):`
`149`		`-"""Refresh the operation and update the result if needed."""`
	`148`	`+def_refresh_and_update(self,retry=polling.DEFAULT_RETRY):`
	`149`	`+"""Refresh the operation and update the result if needed.`
	`150`	`+`
	`151`	`+ Args:`
	`152`	`+ retry (google.api_core.retry.Retry): (Optional) How to retry the RPC.`
	`153`	`+ """`
`150`	`154`	`# If the currently cached operation is done, no need to make another`
`151`	`155`	`# RPC as it will not change once done.`
`152`	`156`	`ifnotself._operation.done:`
`153`		`-self._operation=self._refresh()`
	`157`	`+self._operation=self._refresh(retry=retry)`
`154`	`158`	`self._set_result_from_operation()`
`155`	`159`
`156`		`-defdone(self):`
	`160`	`+defdone(self,retry=polling.DEFAULT_RETRY):`
`157`	`161`	`"""Checks to see if the operation is complete.`
`158`	`162`
	`163`	`+ Args:`
	`164`	`+ retry (google.api_core.retry.Retry): (Optional) How to retry the RPC.`
	`165`	`+`
`159`	`166`	`Returns:`
`160`	`167`	`bool: True if the operation is complete, False otherwise.`
`161`	`168`	`"""`
`162`		`-self._refresh_and_update()`
	`169`	`+self._refresh_and_update(retry)`
`163`	`170`	`returnself._operation.done`
`164`	`171`
`165`	`172`	`defcancel(self):`

Lines changed: 19 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,10 @@`
`15`	`15`
`16`	`16`	`importmock`
`17`	`17`
	`18`	`+fromgoogle.api_coreimportexceptions`
`18`	`19`	`fromgoogle.api_coreimportoperation`
`19`	`20`	`fromgoogle.api_coreimportoperations_v1`
	`21`	`+fromgoogle.api_coreimportretry`
`20`	`22`	`fromgoogle.longrunningimportoperations_pb2`
`21`	`23`	`fromgoogle.protobufimportstruct_pb2`
`22`	`24`	`fromgoogle.rpcimportcode_pb2`
`@@ -113,6 +115,23 @@ def test_result():`
`113`	`115`	`assertfuture.done()`
`114`	`116`
`115`	`117`
	`118`	`+deftest_done_w_retry():`
	`119`	`+RETRY_PREDICATE=retry.if_exception_type(exceptions.TooManyRequests)`
	`120`	`+test_retry=retry.Retry(predicate=RETRY_PREDICATE)`
	`121`	`+`
	`122`	`+expected_result=struct_pb2.Struct()`
	`123`	`+responses= [`
	`124`	`+make_operation_proto(),`
	`125`	`+# Second operation response includes the result.`
	`126`	`+make_operation_proto(done=True,response=expected_result),`
	`127`	`+ ]`
	`128`	`+future,_,_=make_operation_future(responses)`
	`129`	`+future._refresh=mock.Mock()`
	`130`	`+`
	`131`	`+future.done(retry=test_retry)`
	`132`	`+future._refresh.assert_called_once_with(retry=test_retry)`
	`133`	`+`
	`134`	`+`
`116`	`135`	`deftest_exception():`
`117`	`136`	`expected_exception=status_pb2.Status(message="meep")`
`118`	`137`	`responses= [`

Comments

(0)