feat: support for async bidi streaming apis #836

chandra-siri · 2025-08-14T06:43:22Z

feat: support for async bidi streaming apis

Further details can be found here

Fixes #834

python versions <= 3.10 dont support `async with asyncio.timeout`

provide support for the same.

google/api_core/bidi_async.py

google/api_core/bidi.py

google/api_core/bidi_async.py

google/api_core/bidi_base.py

google/api_core/bidi_async.py

…into feat/834-bidi-async-support

these files will be removed once googleapis/python-api-core#836 gets submitted

* Add async bidiRpc files in python-storage these files will be removed once googleapis/python-api-core#836 gets submitted * fix import path for bidi_base

tests/asyncio/test_bidi_async.py

google/api_core/bidi_async.py

vchudnov-g

Looks good. I have some small comments, and a bunch of nits. I'll TAL at the test next week.

google/api_core/bidi_async.py

vchudnov-g · 2025-09-25T20:14:46Z

google/api_core/bidi_async.py

+    otherwise open-ended set of requests to send through a request-streaming
+    (or bidirectional) RPC.
+
+    The reason this is necessary is because it lets the user have control on


Consider keeping (and clarifying?) the "The reason this is necessary..." paragraph from _RequestQueueGenerator, especially since the next pargraph below also talks about technical details. Or we could put both technical details in comments rather than in the docstring.

WDYT?

sure, I've moved this paragraph and next two to class level comments, PTAL and resolve the comments if it looks good.

vchudnov-g · 2025-09-25T20:16:20Z

google/api_core/bidi_async.py

+
+        request_generator.call = call
+
+        if hasattr(call, "_wrapped"):  # pragma: NO COVER


Was the TODO in the original file addressed?

not sure, is there any issue number ? or internal bugId ?

It doesn't have an issue. You could create one, but at least copy the text: # TODO: api_core should expose the future interface for wrapped callables as well.

No issue number (you could create one), but let's at least include the text: # TODO: api_core should expose the future interface for wrapped callables as well.

google/api_core/bidi.py

google/api_core/bidi_async.py

tests/asyncio/test_bidi_async.py

vchudnov-g · 2025-09-25T21:00:00Z

Adding @daniel-sanche for visibility.

@ohmayr , do you have any remaining concerns with the code?

…into feat/834-bidi-async-support

chandra-siri · 2025-10-01T13:50:04Z

Looks good. I have some small comments, and a bunch of nits. I'll TAL at the test next week.

@vchudnov-g Addressed your comments. PTAL

vchudnov-g

Looks good. We're almost there. Just some minor comments, and I want to ping @daniel-sanche again in case he has any comments.

vchudnov-g · 2025-10-03T23:01:03Z

google/api_core/bidi.py

 _BIDIRECTIONAL_CONSUMER_NAME = "Thread-ConsumeBidirectionalStream"


+#   The reason this is necessary is because gRPC takes an iterator as the


nit: Consider moving this comment block inside the method (after the docstring)

vchudnov-g · 2025-10-03T23:07:58Z

google/api_core/bidi_async.py

+
+        request_generator.call = call
+
+        if hasattr(call, "_wrapped"):  # pragma: NO COVER


It doesn't have an issue. You could create one, but at least copy the text: # TODO: api_core should expose the future interface for wrapped callables as well.

vchudnov-g · 2025-10-03T23:15:41Z

google/api_core/bidi_async.py

+
+        request_generator.call = call
+
+        if hasattr(call, "_wrapped"):  # pragma: NO COVER


No issue number (you could create one), but let's at least include the text: # TODO: api_core should expose the future interface for wrapped callables as well.

google/api_core/bidi_base.py

vchudnov-g · 2025-10-03T23:36:22Z

tests/asyncio/test_bidi_async.py

+
+        assert await anext(aiter(generator)) == mock.sentinel.A
+
+    async def test_yield_initial_callable_and_exit(self):


What's the difference between this test function and the previous test_yield_initial_and_exit? The bodies look the same. What am I missing?

vchudnov-g · 2025-10-03T23:38:44Z

tests/asyncio/test_bidi_async.py

+            assert await anext(aiter(generator))
+            assert (
+                exc_info.value.args[0]
+                == "Inactive call, replacing item on queue and exiting request generator."


semi-nit: It would be more robust if you could compare a single unique identifier in the exception (failing that, a shorter substring), because we could conceivably want to change the string in the future.

vchudnov-g · 2025-10-03T23:44:13Z

tests/asyncio/test_bidi_async.py

+        generator.call = call
+
+        with pytest.raises(asyncio.TimeoutError):
+            await asyncio.wait_for(anext(aiter(generator)), timeout=1)


How are we handling the timeouts in the test? I'd like to minimize the amount of real-time we spend testing. To that end:

could the timeout here be even shorter, like a hundredth of a second?

in other test functions that don't have a timeout, is anything delaying the async test data from being streamed back? Where is that set? Could we minimize any such delays as well?

If I'm understanding this correctly, the timeout will happen here simply because there is nothing in the queue, right? But comparing to the previous test case, would this create raise a StopAsyncIteration exception? Is that then caught by asyncio.wait_for? In that case, does the value of the timeout matter here? Adding some comments here might help readers.

vchudnov-g · 2025-10-03T23:55:18Z

tests/asyncio/test_bidi_async.py

+    @pytest.mark.asyncio
+    @pytest.mark.skipif(
+        sys.version_info < (3, 8),  # type: ignore[operator]
+        reason="Python 3.8 below doesnt provide support for assert_awaited_once",


Suggested change

reason="Python 3.8 below doesnt provide support for assert_awaited_once",

reason="Versions of Python below 3.8 don't provide support for assert_awaited_once",

feat: support for async bidi streaming apis

d751f63

product-auto-label bot added the size: l Pull request size is large. label Aug 14, 2025

chandra-siri added 11 commits August 14, 2025 06:57

fix linting

fdcd903

Add bidiBase, refactor bidiRpc and add AsyncBidi

5835178

remove changes from noxfile

df8fba5

use queue.get() instead of queue.get_nowait()

19cf273

use asyncio.wait_for instead of asyncio.timeout

5b6d287

python versions <= 3.10 dont support `async with asyncio.timeout`

aiter() and anext() are not defined in python<=3.9

2599f96

provide support for the same.

remove support for python 3.7 and below

9c1a621

fix mypy errors

cc19089

fix typo, version -> version_info

a86a9b1

AsyncMock not present in python3.7

5464dc5

update doc strings

e96a409

chandra-siri marked this pull request as ready for review August 30, 2025 17:13

chandra-siri requested review from a team as code owners August 30, 2025 17:13

blunderbuss-gcf bot assigned vchudnov-g Aug 30, 2025

chandra-siri added 3 commits September 1, 2025 11:39

use pytest.approx to round of floating point errors.

52686b8

add tolerance

d01421b

add test_open_error_call_error unit test

98eae06

ohmayr reviewed Sep 4, 2025

View reviewed changes

chandra-siri added 3 commits September 8, 2025 18:17

Merge branch 'main' of https://github.com/googleapis/python-api-core …

af2121c

…into feat/834-bidi-async-support

minor changes based on PR comments

5a7550f

formatting fixes

c486c49

chandra-siri requested a review from ohmayr September 8, 2025 19:25

remove changes from test_method.py

14342b1

chandra-siri added a commit to chandra-siri/python-storage that referenced this pull request Sep 17, 2025

Add async bidiRpc files in python-storage

32168a6

these files will be removed once googleapis/python-api-core#836 gets submitted

chandra-siri mentioned this pull request Sep 17, 2025

feat: Add async bidiRpc files in python-storage googleapis/python-storage#1545

Merged

fix typos in doc string and error msg

6fabb1f

minor fixes in comments & doc strings

2df8cc4

ohmayr reviewed Sep 24, 2025

View reviewed changes

tests/asyncio/test_bidi_async.py Outdated Show resolved Hide resolved

google/api_core/bidi_async.py Outdated Show resolved Hide resolved

vchudnov-g reviewed Sep 25, 2025

View reviewed changes

chandra-siri added 2 commits October 1, 2025 13:45

address review comments. mostly fix doc-strings

b963922

Merge branch 'main' of https://github.com/googleapis/python-api-core …

470aeb4

…into feat/834-bidi-async-support

remove unused variable to fix lint

7475d99

chandra-siri requested review from vchudnov-g and ohmayr October 1, 2025 13:54

vchudnov-g reviewed Oct 4, 2025

View reviewed changes


		request_generator.call = call

		if hasattr(call, "_wrapped"): # pragma: NO COVER

		_BIDIRECTIONAL_CONSUMER_NAME = "Thread-ConsumeBidirectionalStream"


		# The reason this is necessary is because gRPC takes an iterator as the


		assert await anext(aiter(generator)) == mock.sentinel.A

		async def test_yield_initial_callable_and_exit(self):

	reason="Python 3.8 below doesnt provide support for assert_awaited_once",
	reason="Versions of Python below 3.8 don't provide support for assert_awaited_once",

feat: support for async bidi streaming apis #836

Are you sure you want to change the base?

feat: support for async bidi streaming apis #836

Conversation

chandra-siri commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vchudnov-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chandra-siri Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vchudnov-g commented Sep 25, 2025

Uh oh!

chandra-siri commented Oct 1, 2025

Uh oh!

vchudnov-g left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chandra-siri commented Aug 14, 2025 •

edited

Loading

chandra-siri Oct 1, 2025 •

edited

Loading