Skip to content

feat: add async support #118

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
Open
tharropoulos wants to merge 32 commits into
base: master
Choose a base branch
from
Open

feat: add async support #118

tharropoulos wants to merge 32 commits into from

Conversation

@tharropoulos
Copy link
Contributor

@tharropoulos tharropoulos commented Dec 8, 2025 •
edited
Loading

Change Summary

This PR migrates the Typesense Python client from requests to httpx and adds async support across all client components. The library now supports both synchronous and asynchronous operations.

Core Changes

  • Migrate HTTP client from requests to httpx for sync operations
  • Add AsyncApiCall class for async HTTP operations
  • Refactor RequestHandler to support both sync (httpx.Client) and async (httpx.AsyncClient) clients
  • Update test dependencies: replace requests-mock with respx for mocking httpx requests
  • Add pytest-asyncio for async test support

Async Client

  • Add AsyncClient class as the main entry point for async operations
  • Add async versions of all resource classes

Type System Improvements

  • Make TDoc TypeVar covariant in Collection and Collections classes for better type flexibility
  • Remove redundant from __future__ import annotations imports

Testing

  • Add async test fixtures for all async components
  • Add async integration tests mirroring existing sync tests
  • Remove redundant mocked tests in favor of integration tests

Dependencies

  • Add httpx as core dependency
  • Add respx and pytest-asyncio for testing
  • Update various dependency versions

Notes

  • All async classes follow the same API patterns as their sync counterparts
  • The async client supports async context management via async with

PR Checklist

@tharropoulos
fix(document): fix types for document deletion
ab4c4fd
@tharropoulos
chore: bump mypy
175af19
@tharropoulos
chore: add httpx
aae9d75
@tharropoulos
chore(tests): remove redudant mocked tests
df27a32
@tharropoulos
test(curation_set): add missing integration tests
d3d4dbe
@tharropoulos
test(synonym_set): add missing integration tests
c577545
@tharropoulos
refactor: migrate request handler from requests to httpx with async s…
2f70a2b 
…upport

replace requests library with httpx to enable both synchronous and
asynchronous http operations. refactor make_request to support sync
and async clients with separate implementation methods.

- replace requests with httpx for http client operations
- add support for both httpx.client and httpx.asyncclient
- split make_request into _make_sync_request and _make_async_request
- update type hints with bounds for tparams and tbody
- change data parameter to content for httpx compatibility
- update error handling to use httpx.decodingerror
- update documentation to reflect async support
@tharropoulos
chore: update test dependencies for httpx migration
fb8780d 
- replace requests-mock with respx for httpx test mocking
- add pytest-asyncio configuration with auto mode
- remove types-requests dependency
- update charset-normalizer, requests, and urllib3 versions
@tharropoulos
refactor: migrate api_call from requests to httpx and add async support
9c2e2ae 
- replace requests with httpx in api_call class
- add async_api_call class with httpx.asyncclient support
- migrate tests from requests_mock to respx
@tharropoulos
feat(alias): add async support for alias operations
c230421 
- add asyncalias class for async individual alias operations
- add asyncaliases class for async alias collection operations
- add async tests for alias and aliases functionality
- add async fixtures for testing async alias operations
- remove future annotations imports from test files
@tharropoulos
feat(analytics): add async support for analytics operations
dd2abf2 
- add async tests for analytics functionality
- remove future annotations imports from test files
@tharropoulos tharropoulos marked this pull request as draft December 8, 2025 19:16
@tharropoulos
feat(analyticsV1): add async support for analytics v1 operations
82de166 
- add async tests for analytics v1 functionality
- add async fixtures for testing async analytics v1 operations
- remove future annotations imports from test files
@tharropoulos
refactor(collection): make TDoc typevar covariant in collection classes
e681907
@tharropoulos
feat(collection): add async support for collection operations
fb20e89 
- add AsyncCollection class for async individual collection operations
- add AsyncCollections class for async collection collection operations
- add async tests for collection and collections functionality
- add async fixtures for testing async collection operations
- remove future annotations imports from test files
@tharropoulos
feat(convo): add async support for conversation model operations
421608a 
- add AsyncConversationModel class for async individual model operations
- add AsyncConversationsModels class for async models collection operations
- add async tests for conversation model and models functionality
- add async fixtures for testing async conversation model operations
@tharropoulos
feat(curation): add async support for curation set operations
e81edec 
- add AsyncCurationSet class for async individual curation set operations
- add AsyncCurationSets class for async curation sets collection operations
- add async tests for curation set and sets functionality
- add async fixtures for testing async curation set operations
- remove future annotations imports from test files
@tharropoulos
feat(debug): add async support for debug operations
1b704d0 
- add AsyncDebug class for async debug information retrieval
- add async tests for debug functionality
- add async fixtures for testing async debug operations
- remove future annotations imports from test files
@tharropoulos
feat(documents): add async support for document operations
9a62bc2 
- add AsyncDocument class for async individual document operations
- add AsyncDocuments class for async documents collection operations
- add async tests for document and documents functionality
- add async fixtures for testing async document operations
@tharropoulos
feat(api-keys): add async support for key operations
f5e27fd 
- add AsyncKey class for async individual key operations
- add AsyncKeys class for async keys collection operations
- add async tests for key and keys functionality
- add async fixtures for testing async key operations
@tharropoulos
feat(metrics): add async support for metrics operations
c311ab5 
- add AsyncMetrics class for async metrics retrieval
- add async tests for metrics functionality
- add async fixtures for testing async metrics operations
@tharropoulos
feat(multi-search): add async support for multi-search operations
9956fd9 
- add AsyncMultiSearch class for async multi-search operations
- add async tests for multi-search functionality
- add async fixtures for testing async multi-search operations
@tharropoulos
feat(nl-search): add async support for nl search model operations
6a6e4d3 
- add AsyncNLSearchModel class for async individual model operations
- add AsyncNLSearchModels class for async mod
@tharropoulos
feat(ops): add async support for operations
cff9373 
- add AsyncOperations class for async operations functionality
- add async tests for operations functionality
- add async fixtures for testing async operations
@tharropoulos
feat(overrides): add async support for override operations
fc0f205 
- add AsyncOverride class for async individual override operations
- add AsyncOverrides class for async overrides collection operations
- add async tests for override and overrides functionality
- add async fixtures for testing async override operations
@tharropoulos
feat(synonyms): add async support for synonym operations
0487a9a 
- add AsyncSynonym class for async individual synonym operations
- add AsyncSynonyms class for async synonyms collection operations
- add async tests for synonym and synonyms functionality
- add async fixtures for testing async synonym operations
- remove future annotations imports from test files
@tharropoulos
feat(synonym-set): add async support for synonym set operations
723b6dc 
- add AsyncSynonymSet class for async individual synonym set operations
- add AsyncSynonymSets class for async synonym sets collection operations
- add async tests for synonym set and sets functionality
- add async fixtures for testing async synonym set operations
- remove future annotations imports from test files
@tharropoulos
lint: remove annotations imports
79845b6
@tharropoulos
chore: bump deps
c603234
@tharropoulos
feat(stemming): add async support for stemming operations
63c426f 
- add AsyncStemming class for async stemming dictionary operations
- add AsyncStemmingDictionaries class for async dictionaries collection operations
- add AsyncStemmingDictionary class for async individual dictionary operations
- add async tests for stemming functionality
- add async fixtures for testing async stemming operations
@tharropoulos
feat(stopwords): add async support for stopwords operations
57ce53e 
- add AsyncStopwords class for async stopwords collection operations
- add AsyncStopwordsSet class for async individual stopwords set operations
- add async tests for stopwords and stopwords set functionality
- add async fixtures for testing async stopwords operations
@tharropoulos
feat(client): expose async client class
95a4da5
@tharropoulos tharropoulos marked this pull request as ready for review December 9, 2025 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tharropoulos