Skip to content

Commit c312262

Browse files
committed
renamed streaming retry function
1 parent 1ccadb1 commit c312262

File tree

6 files changed

+20
-21
lines changed

6 files changed

+20
-21
lines changed

google/api_core/retry.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def check_if_exists():
6666

6767
from google.api_core import datetime_helpers
6868
from google.api_core import exceptions
69-
from google.api_core.retry_streaming import retry_target_generator
69+
from google.api_core.retry_streaming import retry_target_stream
7070
from google.auth import exceptions as auth_exceptions
7171

7272
_LOGGER = logging.getLogger(__name__)
@@ -313,7 +313,7 @@ class Retry(object):
313313
will be retried. Defaults to False.
314314
To avoid duplicate values, retryable streams should typically be
315315
wrapped in additional filter logic before use. For more details, see
316-
``google.api_core.retry_streaming.retry_target_generator``.
316+
``google.api_core.retry_streaming.retry_target_stream``.
317317
deadline (float): DEPRECATED: use `timeout` instead. For backward
318318
compatibility, if specified it will override the ``timeout`` parameter.
319319
"""
@@ -361,7 +361,7 @@ def retry_wrapped_func(*args, **kwargs):
361361
sleep_generator = exponential_sleep_generator(
362362
self._initial, self._maximum, multiplier=self._multiplier
363363
)
364-
retry_func = retry_target_generator if self._is_stream else retry_target
364+
retry_func = retry_target_stream if self._is_stream else retry_target
365365
return retry_func(
366366
target,
367367
self._predicate,

google/api_core/retry_async.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ async def check_if_exists():
6161
from google.api_core.retry import exponential_sleep_generator
6262
from google.api_core.retry import if_exception_type # noqa: F401
6363
from google.api_core.retry import if_transient_error
64-
from google.api_core.retry_streaming_async import retry_target_generator
64+
from google.api_core.retry_streaming_async import retry_target_stream
6565

6666

6767
_LOGGER = logging.getLogger(__name__)
@@ -184,7 +184,7 @@ class AsyncRetry:
184184
function call itself will be retried. Defaults to False.
185185
To avoid duplicate values, retryable streams should typically be
186186
wrapped in additional filter logic before use. For more details, see
187-
``google.api_core.retry_streaming_async.retry_target_generator``.
187+
``google.api_core.retry_streaming_async.retry_target_stream``.
188188
deadline (float): DEPRECATED use ``timeout`` instead. If set it will
189189
override ``timeout`` parameter.
190190
"""
@@ -247,7 +247,7 @@ def retry_wrapped_stream(*args, **kwargs):
247247
sleep_generator = exponential_sleep_generator(
248248
self._initial, self._maximum, multiplier=self._multiplier
249249
)
250-
return retry_target_generator(
250+
return retry_target_stream(
251251
target,
252252
self._predicate,
253253
sleep_generator,

google/api_core/retry_streaming.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
List,
2121
Tuple,
2222
Iterable,
23-
Iterator,
2423
Generator,
2524
TypeVar,
2625
Any,
@@ -67,7 +66,7 @@ def _build_timeout_error(
6766
return exc_list[-1], None
6867

6968

70-
def retry_target_generator(
69+
def retry_target_stream(
7170
target: Callable[[], Union[Iterable[T], Generator[T, Any, None]]],
7271
predicate: Callable[[Exception], bool],
7372
sleep_generator: Iterable[float],

google/api_core/retry_streaming_async.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
T = TypeVar("T")
4343

4444

45-
async def retry_target_generator(
45+
async def retry_target_stream(
4646
target: Union[
4747
Callable[[], AsyncIterable[T]],
4848
Callable[[], Awaitable[AsyncIterable[T]]],

tests/asyncio/test_retry_async.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ async def test_retry_target_bad_sleep_generator():
136136

137137
@pytest.mark.asyncio
138138
async def test_retry_streaming_target_bad_sleep_generator():
139-
from google.api_core.retry_streaming_async import retry_target_generator
139+
from google.api_core.retry_streaming_async import retry_target_stream
140140

141141
async def target_fn():
142142
async def inner_gen():
@@ -146,7 +146,7 @@ async def inner_gen():
146146
return inner_gen()
147147

148148
with pytest.raises(ValueError, match="Sleep generator"):
149-
gen = retry_target_generator(target_fn, lambda x: True, [], None)
149+
gen = retry_target_stream(target_fn, lambda x: True, [], None)
150150
await gen.__anext__()
151151

152152

@@ -828,7 +828,7 @@ async def test_exc_factory_non_retryable_error(self):
828828
generator should give the option to override exception creation logic
829829
test when non-retryable error is thrown
830830
"""
831-
from google.api_core.retry_streaming_async import retry_target_generator
831+
from google.api_core.retry_streaming_async import retry_target_stream
832832

833833
timeout = 6
834834
sent_errors = [ValueError("test"), ValueError("test2"), BufferError("test3")]
@@ -842,7 +842,7 @@ def factory(*args, **kwargs):
842842
assert kwargs["timeout_val"] == timeout
843843
return expected_final_err, expected_source_err
844844

845-
generator = retry_target_generator(
845+
generator = retry_target_stream(
846846
self._generator_mock,
847847
retry_async.if_exception_type(ValueError),
848848
[0] * 3,
@@ -867,7 +867,7 @@ async def test_exc_factory_timeout(self):
867867
test when timeout is exceeded
868868
"""
869869
import time
870-
from google.api_core.retry_streaming_async import retry_target_generator
870+
from google.api_core.retry_streaming_async import retry_target_stream
871871

872872
timeout = 2
873873
time_now = time.monotonic()
@@ -889,7 +889,7 @@ def factory(*args, **kwargs):
889889
assert kwargs["timeout_val"] == timeout
890890
return expected_final_err, expected_source_err
891891

892-
generator = retry_target_generator(
892+
generator = retry_target_stream(
893893
self._generator_mock,
894894
retry_async.if_exception_type(ValueError),
895895
[0] * 3,

tests/unit/test_retry.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ def test_retry_target_bad_sleep_generator():
164164

165165

166166
def test_retry_streaming_target_bad_sleep_generator():
167-
from google.api_core.retry_streaming import retry_target_generator
167+
from google.api_core.retry_streaming import retry_target_stream
168168

169169
def target_fn():
170170
def inner_gen():
@@ -176,7 +176,7 @@ def inner_gen():
176176
with pytest.raises(
177177
ValueError, match="Sleep generator stopped yielding sleep values"
178178
):
179-
gen = retry_target_generator(target_fn, lambda x: True, [], None)
179+
gen = retry_target_stream(target_fn, lambda x: True, [], None)
180180
next(gen)
181181

182182

@@ -826,7 +826,7 @@ def test_exc_factory_non_retryable_error(self):
826826
generator should give the option to override exception creation logic
827827
test when non-retryable error is thrown
828828
"""
829-
from google.api_core.retry_streaming import retry_target_generator
829+
from google.api_core.retry_streaming import retry_target_stream
830830

831831
timeout = 6
832832
sent_errors = [ValueError("test"), ValueError("test2"), BufferError("test3")]
@@ -840,7 +840,7 @@ def factory(*args, **kwargs):
840840
assert kwargs["timeout_val"] == timeout
841841
return expected_final_err, expected_source_err
842842

843-
generator = retry_target_generator(
843+
generator = retry_target_stream(
844844
self._generator_mock,
845845
retry.if_exception_type(ValueError),
846846
[0] * 3,
@@ -864,7 +864,7 @@ def test_exc_factory_timeout(self):
864864
test when timeout is exceeded
865865
"""
866866
import time
867-
from google.api_core.retry_streaming import retry_target_generator
867+
from google.api_core.retry_streaming import retry_target_stream
868868

869869
timeout = 2
870870
time_now = time.monotonic()
@@ -886,7 +886,7 @@ def factory(*args, **kwargs):
886886
assert kwargs["timeout_val"] == timeout
887887
return expected_final_err, expected_source_err
888888

889-
generator = retry_target_generator(
889+
generator = retry_target_stream(
890890
self._generator_mock,
891891
retry.if_exception_type(ValueError),
892892
[0] * 3,

0 commit comments

Comments
 (0)