Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduce WeaviateAsyncClient as async alternative to WeaviateClient #1007

Merged
merged 94 commits into from
Jul 9, 2024
Merged

Introduce WeaviateAsyncClient as async alternative to WeaviateClient #1007

merged 94 commits into from
Jul 9, 2024

Conversation

tsmith023
Copy link
Contributor

@tsmith023 tsmith023 commented Apr 12, 2024 •
edited
Loading

  • Changes base implementation to be purely async using httpx and grpc.aio
  • Uses base implementation in WeaviateAsyncClient directly
  • A class decorator pattern wraps the async implementation in the sync routes replicating the arguments and docstrings automagically @dirkkul
  • The API surface itself must be duplicated however through .pyi stub fails due to this runtime patching
  • Replace WeaviateClient internal calls with event-loop-wrapped blocking calls using the base async implementation
  • An event loop thread is spun up by the client at instantiation as a global singleton that is used in all calls
  • client.batch is only available on the WeaviateClient object, since it is a purely sync algorithm. It depends on the new higher-level event loop thread

@tsmith023
Introduce WeaviateAsyncClient as async alternative to WeaviateClient
7e5c38c 
- Changes base implementation to be purely async using `httpx` and `grpclib`(instead of google's grpc due to [issues](grpc/grpc#25364))
- Uses base implementation in `WeaviateAsyncClient` directly
- Subdivides the codebase into `**/asy/*.py` and `**/sy/*.py` directories within each namespace directory
- Replace `WeaviateClient` internal calls with event-loop-wrapped blocking calls using the base async implementation
- `WeaviateClient` spins up its own personal event loop thread that it schedules async calls to. Should this be a global singleton instead?
- `client.batch` is only available on the `WeaviateClient` object, since it is a purely sync algorithm. It depends on the new higher-level event loop thread
@weaviate-git-bot
Copy link

Great to see you again! Thanks for the contribution.

beep boop - the Weaviate bot 👋🤖

PS:
Are you already a member of the Weaviate Slack channel?

@dirkkul dirkkul mentioned this pull request Apr 17, 2024
Closed
@tsmith023 tsmith023 linked an issue Apr 18, 2024 that may be closed by this pull request
Add Async Client to be able to make asynchronous requests #88
Closed
@rolandgvc
Copy link

I'm following this as well. I'm looking forward to the async client :)

@tsmith023 tsmith023 self-assigned this May 15, 2024
@tsmith023 tsmith023 added the enhancement New feature or request label May 15, 2024
@tsmith023
Merge branch 'main' of https://github.com/weaviate/weaviate-python-cl…
01dbf10 
…ient into implement-async-client
@tsmith023
Fix <3.9 import
ae9682c
@tsmith023
Fix flake8 check with new dir structure
93676d3
@tsmith023
Attempt fix of type checking Future in py3.8
8d4d5f5
@tsmith023
Add None to url of call to _fetch_token
324495f
@tsmith023
Fix deps for grpclib
a641654
@tsmith023
Fix missing grpclib in setup.cfg
c640536
@tsmith023
Add missing params to backups
88486cb
@tsmith023
Use fetch_token instead of _fetch_token in auth methods
15eb8ef
@tsmith023
Check whether loop is closed before scheduling coroutines
7780822
@tsmith023
Add pytest-asyncio for async tests of new impl
cc58ed1
@tsmith023
Add print if warnings wrong in auth tests
3bf5ab8
@tsmith023
Fix test depending on old functionality
3eb47b6
@tsmith023
Fix bad import
709745f
@tsmith023
Reduce untested load on large test
b7f53d0
@tsmith023
Assign future as variable then return fut.result()
d06046c
@tsmith023
Eliminate unclosed connection warnings
dba3e8f
@tsmith023
Attempt fix of closing/deleting fixture resources
9cd6b3f
@tsmith023
Add debugging print for CI test error
7358a49
@tsmith023
Increase timeout for embedded listening and increase sleep interval time
cd624d3
@tsmith023
Fix periodic refresh by running it synchronously always
84b356a
@tsmith023
Add pytest-asyncio to test-package CI job
4d7b3ee
@tsmith023
Make event loop a global singleton to reduce number of threads
4dca9b2
@tsmith023
Add missing get_open_id_configuration method on clients
26abb49
@tsmith023
Merge branch 'main' of https://github.com/weaviate/weaviate-python-cl…
1fa75df 
…ient into implement-async-client
@tsmith023
Substitute grpclib for grpc.aio due to performance concerns
ce320ec
@tsmith023
Fix deps and protos for grpclib -> grpcio replacement
e98ff86
@tsmith023
Fix requirements file
ef39f27
@tsmith023
Merge branch 'main' of https://github.com/weaviate/weaviate-python-cl…
379a240 
…ient into implement-async-client
@tsmith023
Fix requirements file
7c019bc
@tsmith023
Fix invalid input error handling with syncify wrapping
dde747f
@tsmith023
Fix requirements file
224936d
@tsmith023
Update vers in CI
8a3e41a
@tsmith023
Remove asserts of delete_by_id due to new backend logic (endpoint is …
eabf814 
…idempotent now)
@tsmith023
Refactor batch tests to use config.get_shards over old client
485e62c
@tsmith023
Add explicit dep due to problem here: pypa/twine#977 (comment)
b242e94
@tsmith023
Merge branch 'main' of https://github.com/weaviate/weaviate-python-cl…
7bb2dae 
…ient into implement-async-client
@tsmith023 tsmith023 changed the base branch from main to dev/1.26 July 1, 2024 09:59
dirkkul
dirkkul approved these changes Jul 9, 2024
View reviewed changes
Copy link
Collaborator

@dirkkul dirkkul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we tested enough :)

@dirkkul dirkkul merged commit fc42165 into dev/1.26 Jul 9, 2024
149 of 150 checks passed
@dirkkul dirkkul deleted the implement-async-client branch July 9, 2024 09:53
@gokturkDev
Copy link

Hi when is this going to be in the release version

@LukasWestholt LukasWestholt mentioned this pull request Sep 19, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dirkkul dirkkul dirkkul approved these changes

Assignees

@tsmith023 tsmith023

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Async Client to be able to make asynchronous requests
6 participants
@tsmith023 @weaviate-git-bot @rolandgvc @codecov-commenter @gokturkDev @dirkkul