Implement async context manager protocol for AIO clients#2180
Open
Leo Singer (lpsinger) wants to merge 1 commit intoconfluentinc:masterfrom
Open
Implement async context manager protocol for AIO clients#2180Leo Singer (lpsinger) wants to merge 1 commit intoconfluentinc:masterfrom
Leo Singer (lpsinger) wants to merge 1 commit intoconfluentinc:masterfrom
Conversation
Leo Singer (lpsinger)
requested review from
a team and
Matthew Seal (MSeal)
as code owners
|
🎉 All Contributor License Agreements have been signed. Ready to merge. |
When AIOProducer or AIOConsumer is used as the target of a `with:` statement, automatically close the connection at the end of the context.
Leo Singer (lpsinger)
force-pushed
the
async-context-manager
branch
from
698ad20 to
c6e00e6
Compare
Comment on lines
+84
to
+93
| async def test_async_context_manager(self, mock_producer, mock_common, basic_config): | ||
| with AIOProducer(basic_config) as producer: | ||
| assert producer._is_closed is False | ||
| assert producer._is_closed is True | ||
|
|
||
| with AIOProducer(basic_config) as producer2: | ||
| assert producer2._is_closed is False | ||
| await producer2.close() | ||
| await producer2.close() | ||
| assert producer2._is_closed is True |
Member
There was a problem hiding this comment.
-
We need to use
async with AIOProducer ...since we defined aenter and aexit magic methods. -
Can we also add the same test for AIOConsumer?
Comment on lines
+19
to
+23
| try: | ||
| from typing import Self | ||
| except ImportError: | ||
| # FIXME: remove once we depend on Python >= 3.11 | ||
| from typing_extensions import Self |
There was a problem hiding this comment.
Can we add a version check instead? For example: if sys.version_info >= (3, 11):
Comment on lines
+20
to
+25
| try: | ||
| from typing import Self | ||
| except ImportError: | ||
| # FIXME: remove once we depend on Python >= 3.11 | ||
| from typing_extensions import Self | ||
|
|
There was a problem hiding this comment.
Member
Ojasva Jain (ojasvajain)
left a comment
Ojasva Jain (ojasvajain)
left a comment
There was a problem hiding this comment.
Couple of comments. Please pull the latest changes and update the CHANGELOG.md. Thanks for the contribution!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When AIOProducer or AIOConsumer is used as the target of a
with:statement, automatically close the connection at the end of the context.What
Checklist
References
JIRA:
Test & Review
Open questions / Follow-ups