feat: Accept Pydantic models as alternatives to dicts in resource client methods#663
Open
feat: Accept Pydantic models as alternatives to dicts in resource client methods#663
Conversation
vdusek
added
adhoc
vdusek
changed the title
danpoletaev
force-pushed
the
feat/union-dict-model-types
branch
from
ac60efe to
a1715c9
Compare
B4nan
force-pushed
the
feat/union-dict-model-types
branch
from
a1715c9 to
ac60efe
Compare
github-actions
bot
added
the
tested
vdusek
force-pushed
the
feat/union-dict-model-types
branch
from
322306d to
e68c909
Compare
vdusek
force-pushed
the
feat/union-dict-model-types
branch
from
e68c909 to
0d584bc
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #663 +/- ##
==========================================
+ Coverage 94.83% 94.93% +0.09%
==========================================
Files 45 45
Lines 4340 4401 +61
==========================================
+ Hits 4116 4178 +62
+ Misses 224 223 -1
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
changed the title
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
1 participant
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.
Changes summary
dict | PydanticModelunion types in resource client methods that previously only accepted dict, enabling type-safe usage alongside plain dict input.encode_webhook_list_to_base64utility with a structuredWebhookRepresentationListmodel that handles validation and base64 encoding.RequestInputandRequestDeleteInputmodels in_types.pyfor RQ operations, matching the actual API schema requirements.Motivation
Improve typing on the input side of resource client methods. We don't want to accept only Pydantic models, which would require users to import additional classes. Instead, methods now accept both dict and the corresponding Pydantic model. This way, users don't have to import anything extra, but can optionally use the model types for type-safe usage and to discover the expected dict shape.
Next steps
Once we fully update the OpenAPI spec (apify/apify-docs#2286), we can remove the manually created models in
_types.pyand replace them with the generated ones.Test plan