refactor!: Adapt to apify-client v3#719
Draft
vdusek wants to merge 3 commits into
Draft
Conversation
github-actions
Bot
added
t-tooling
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #719 +/- ##
==========================================
- Coverage 87.00% 86.66% -0.35%
==========================================
Files 48 48
Lines 2956 2918 -38
==========================================
- Hits 2572 2529 -43
- Misses 384 389 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
from
a45f20c to
4270cb9
Compare
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
from
c26dd9f to
7d6dbb1
Compare
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
3 times, most recently
from
3e14e50 to
12a29ae
Compare
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
from
ba4d354 to
e094d6a
Compare
This was referenced Feb 5, 2026
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
from
4528205 to
9c44f3b
Compare
vdusek
added a commit
to apify/apify-client-python
that referenced
this pull request
Feb 23, 2026
### Summary This is a major refactoring that introduces fully typed Pydantic models throughout the client library. The models are generated from the OpenAPI specifications. All API responses now return typed objects instead of raw dictionaries. This follows up on apify/apify-docs#2182. ### Issues - Closes: #21 - Closes: #481 ### Packages - Add direct dependency on `Pydantic`. - Removes the dependency on `apify-shared`. - Add dev dependency [datamodel-code-generator](https://koxudaxi.github.io/datamodel-code-generator/) for model generation. ### Key changes - Uses [datamodel-code-generator](https://koxudaxi.github.io/datamodel-code-generator/) tool configured via `pyproject.toml` to generate Pydantic models based on the [OpenAPI specs](https://docs.apify.com/api/openapi.json). - Refactors the whole codebase to adopt the new generated models. - All resource clients now return typed Pydantic models (`Actor`, `Task`, `Run`, etc.). - Adds response wrappers for validating and extracting API response data. - Updates list methods to return typed pagination models. - Documentation examples now use typed attribute access. - Updates the SDK to use the new typed client. - See the corresponding PR in `apify/apify-sdk-python` for details - apify/apify-sdk-python#719. - It will be merged later. ### Architecture - Get rid of 3/4/5 levels of inheritance. - Get rid of inline imports because of circular dependencies. - I had to utilize `ClientRegistry` to be able to achieve that (because of resource clients-siblings imports). ### Breaking changes - Client methods now return Pydantic models instead of dicts. - Access patterns change from dict-style (`result['key']`) to attribute-style (`result.key`). ### Test plan - Updated test concurrency to 16 workers. - A lot of new tests were implemented - coverage ~95%. - Unit tests - do not call production API, only for testing utils or other functionality using mocks. - Integration tests - call production API. - Thanks to the new tests, I was able to do a lot of fixes in the OpenAPI specs. ### Next steps - Explore the generation of resource clients using [openapi-python-client](https://github.com/openapi-generators/openapi-python-client). - Fully automate model updates based on changes in [apify-api/openapi](https://github.com/apify/apify-docs/tree/master/apify-api/openapi). - This will be released as part of the Apify client v3.0.
vdusek
changed the title
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
2 times, most recently
from
8057e7c to
05a8aba
Compare
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
from
a5fb9c8 to
fc2dde8
Compare
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
from
fc2dde8 to
e3439b4
Compare
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
2 times, most recently
from
7ac5f59 to
2019646
Compare
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
3 times, most recently
from
4a98a06 to
cb9ed09
Compare
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
from
cb9ed09 to
24a6fa8
Compare
vdusek
changed the title
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
from
1a1043e to
a23a8b5
Compare
vdusek
force-pushed
the
adapt-to-apify-client-v3
branch
from
102881c to
dd58d25
Compare
…lasses The SDK kept full standalone pydantic copies of apify-client's four Actor pricing-info models (plus ActorChargeEvent / PricingPerEvent) and a _from_client_pricing_info converter. The copies existed only because the platform's APIFY_ACTOR_PRICING_INFO env var omits fields apify-client v3 marks required (apifyMarginPercentage, createdAt, startedAt, per-event eventDescription, per-variant trialMinutes / pricePerUnitUsd / unitName). Replace the copies with thin subclasses of the apify-client models that relax only those omitted fields to optional. Since each subclass is-a apify-client model, the charging manager can isinstance-check against the client base, so Run.pricing_info from the API flows through unchanged and the converter is removed. Configuration.actor_pricing_info keeps its exact discriminated-union shape, so there is no public API change. Also fixes a latent bug: event_price_usd is now correctly optional (inherited), so tier-priced pay-per-event Actors no longer fail env-var validation; such events are skipped in the flat-price charging path.
Restructure the apify-client section of the v4 upgrading guide to mirror the client's "Upgrading to v3" guide, and document the changes that reach SDK users through it: - Split into "Built on apify-client v3", "Typed responses", and "Literal string aliases instead of StrEnum classes"; fix the typed-responses method list (start / abort / call / call_task; metamorph returns None). - Add "Actor pricing info models" - the pricing models are now thin apify-client subclasses; shape unchanged, fuller field set, event_price_usd optional. - Add "Using the client from Actor.new_client" - 404 raising NotFoundError on ambiguous endpoints, keyword-only arguments, and async iterate_* returning AsyncIterator.
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.
Description
apify-python-clientv3, which introduces fully typed API clients generated from OpenAPI specifications.Issues
RemainingTimeliteral toinherit#697PricingModel#853Testing
apify-python-clientv3.