docs: Add guide on validating Actor input with Pydantic#941
Open
vdusek wants to merge 3 commits into
Open
Conversation
vdusek
added
adhoc
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #941 +/- ##
==========================================
+ Coverage 86.87% 86.94% +0.06%
==========================================
Files 48 48
Lines 2942 2942
==========================================
+ Hits 2556 2558 +2
+ Misses 386 384 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
vdusek
changed the title
Mantisus
approved these changes
Jun 7, 2026
Collaborator
Mantisus
left a comment
Mantisus
left a comment
There was a problem hiding this comment.
LGTM. Just a few suggestions
| """Typed and validated representation of the Actor input.""" | ||
|
|
||
| # Accept both snake_case and the input schema's camelCase; ignore extras. | ||
| model_config = ConfigDict(populate_by_name=True, extra='ignore') |
Collaborator
There was a problem hiding this comment.
Since all Actor input fields are camelCase, we can use the alias_generator.
from pydantic.alias_generators import to_camel
model_config = ConfigDict(populate_by_name=True, extra='ignore', alias_generator=to_camel)
search_terms: list[str] = Field(min_length=1)| {ModelValidatorExample} | ||
| </CodeBlock> | ||
|
|
||
| **Secret input fields.** The platform decrypts [secret input fields](https://docs.apify.com/platform/actors/development/secret-input) for you before <ApiLink to="class/Actor#get_input">`Actor.get_input`</ApiLink> returns, so you receive plaintext. Wrap such fields in Pydantic's `SecretStr` to keep them from leaking into logs or `model_dump()` output. |
Collaborator
There was a problem hiding this comment.
Maybe we can add an example using SecretStr?
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
3 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.
Adds a guide on validating Actor input with Pydantic, so Actor code works with a typed, guaranteed-valid object instead of reaching into a raw input dictionary. Follows the structure of the existing guides.
docs/03_guides/11_pydantic.mdx— the guide: why raw-dict access is fragile, defining an input model (aliases bridgingcamelCase↔snake_case, defaults, constraints, a custom validator,extra='ignore'), validating withmodel_validateand failing fast onValidationError, the relationship to the platform input schema, and a few extra features (HttpUrl/EmailStr,model_validator,SecretStr).code/11_pydantic.py— the runnable example Actor (Run on Apify), plus the11_http_url.py,11_model_validator.py, and11_raw_input.pysnippets.Verified locally for valid input (passes validation, writes
OUTPUT, exit 0) and invalid input (per-field summary keyed by input-schema alias, run ends FAILED). Lint + type-check pass.