Add async support with AsyncAnticaptchaClient#131
Merged
Conversation
Add a new async_client module providing AsyncAnticaptchaClient and AsyncJob classes that mirror the sync API but use httpx.AsyncClient and asyncio.sleep for non-blocking operation in async frameworks (FastAPI, aiohttp, etc.). This is a non-breaking change: the sync API is untouched, httpx remains an optional dependency (pip install python-anticaptcha[async]), and the new classes are lazily imported in __init__.py to avoid requiring httpx at package import time. https://claude.ai/code/session_01Pimg4VAco2v4srPeZj44Zm
- Extract _BaseClientMixin and _BaseJobMixin into _common.py to share init logic, payload builders, solution getters, and repr between sync and async clients - Refactor AnticaptchaClient and AsyncAnticaptchaClient to inherit from shared mixins, reducing maintenance burden - Add "Async Usage" section to README.md and docs/usage.rst - Add async_client automodule to docs/api.rst - Add CHANGELOG.rst entries for async support - Add async example scripts (async_recaptcha_request.py, async_balance.py) - Add "Framework :: AsyncIO" and "Topic :: Internet :: WWW/HTTP" classifiers - Add "asyncio", "async", "httpx" keywords for PyPI discoverability https://claude.ai/code/session_01Pimg4VAco2v4srPeZj44Zm
- Rename base.py → sync_client.py for symmetry with async_client.py; add backward-compat base.py re-export shim - Rename all sync example files with sync_ prefix to match async_ examples - Rename test_base.py → test_sync_client.py - Promote "Async Usage" to same heading level as sync in README and docs - Add "Sync client" heading in docs/usage.rst for symmetry - Rename "Base" → "Sync Client" in docs/api.rst - Update __init__.py to import from sync_client instead of base - All existing import paths preserved for backward compatibility https://claude.ai/code/session_01Pimg4VAco2v4srPeZj44Zm
- Adopt upstream improvements: backoff support in Job.join(), assert statements, Literal type hints, code quality fixes - Make async_client.py standalone (remove _common.py mixin dependency) to match upstream's standalone sync_client.py style - Remove _common.py — both clients are now self-contained - Update CHANGELOG to remove _common.py reference - Resolve merge conflicts in __init__.py, base.py, test_sync_client.py https://claude.ai/code/session_01Pimg4VAco2v4srPeZj44Zm
The module-level ImportError prevented Sphinx autodoc from importing async_client when httpx is not installed. Now the module imports successfully (setting httpx=None) and raises ImportError only when AsyncAnticaptchaClient is instantiated without httpx. https://claude.ai/code/session_01Pimg4VAco2v4srPeZj44Zm
- Fix ruff import sorting in __init__.py, test_sync_client.py, test_async_client.py - Fix ruff-format: async_client.py await parenthesization, string concatenation - Fix mypy: add return type to __getattr__, add type:ignore for optional httpx import - Add httpx to test dependencies so async tests work in CI - Remove redundant explicit imports from base.py shim (covered by *) https://claude.ai/code/session_01Pimg4VAco2v4srPeZj44Zm
The example files were renamed with sync_ prefix but test_examples.py still imported them by their old names. https://claude.ai/code/session_01Pimg4VAco2v4srPeZj44Zm
Required by funcaptcha and hcaptcha example tests. https://claude.ai/code/session_01Pimg4VAco2v4srPeZj44Zm
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.
Summary
This PR adds comprehensive async/await support to the python-anticaptcha library through a new
AsyncAnticaptchaClientclass, enabling seamless integration with async frameworks like FastAPI, aiohttp, and Starlette.Key Changes
AsyncAnticaptchaClientandAsyncJobclasses that mirror the sync API but usehttpx.AsyncClientfor HTTP requests andasynciofor async operations_BaseClientMixinand_BaseJobMixinto eliminate duplication between sync and async implementationsbase.pyto newsync_client.pyasync_client.pyfor async implementation_common.pyfor shared base classes and constantsbase.pyto re-export fromsync_client.pyfor backward compatibilityhttpxand is installed viapip install python-anticaptcha[async]examples/async_recaptcha_request.py)tests/test_async_client.py) with 290+ lines covering initialization, response handling, task creation, job polling, and context manager behaviorasync_balance.py,async_recaptcha_request.py) and renamed existing examples withsync_prefix for clarityImplementation Details
httpx.AsyncClientfor HTTP operations instead ofrequests.SessionAsyncJob.join()method usesasyncio.sleep()for non-blocking polling_get_client_ip()as an async methodasync withfor async,withfor sync)base.pyhttps://claude.ai/code/session_01Pimg4VAco2v4srPeZj44Zm