Skip to content

refactor: Use Pydantic models instead of custom dict representations #650

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

Draft
vdusek wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

refactor: Use Pydantic models instead of custom dict representations #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4829e3a
refactor: Use Pydantic request models and simplify base client internals
vdusek Feb 24, 2026
1b03bbc
fix: Restore timeout parameter on _update() method
vdusek Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/apify_client/_consts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
DEFAULT_MIN_DELAY_BETWEEN_RETRIES = timedelta(milliseconds=500)
"""Default minimum delay between retries."""


DEFAULT_WAIT_FOR_FINISH = timedelta(seconds=999999)
"""Default maximum wait time for job completion (effectively infinite)."""

Expand Down
90 changes: 56 additions & 34 deletions src/apify_client/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: https://docs.apify.com/api/openapi.json
# timestamp: 2026-02-24T08:34:43+00:00
# filename: openapi.json
# timestamp: 2026-02-24T14:39:16+00:00

from __future__ import annotations

Expand Down Expand Up @@ -258,14 +258,45 @@ class FreeActorPricingInfo(CommonActorPricingInfo):
pricing_model: Annotated[Literal['FREE'], Field(alias='pricingModel')]


class ActorPermissionLevel(StrEnum):
"""Determines permissions that the Actor requires to run. For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions)."""

LIMITED_PERMISSIONS = 'LIMITED_PERMISSIONS'
FULL_PERMISSIONS = 'FULL_PERMISSIONS'


class DefaultRunOptions(BaseModel):
model_config = ConfigDict(
extra='allow',
)
build: Annotated[str, Field(examples=['latest'])]
build: Annotated[str | None, Field(examples=['latest'])] = None
timeout_secs: Annotated[int | None, Field(alias='timeoutSecs', examples=[3600])] = None
memory_mbytes: Annotated[int, Field(alias='memoryMbytes', examples=[2048])]
memory_mbytes: Annotated[int | None, Field(alias='memoryMbytes', examples=[2048])] = None
restart_on_error: Annotated[bool | None, Field(alias='restartOnError', examples=[False])] = None
max_items: Annotated[int | None, Field(alias='maxItems')] = None
force_permission_level: Annotated[ActorPermissionLevel | None, Field(alias='forcePermissionLevel')] = None


class ActorStandby(BaseModel):
model_config = ConfigDict(
extra='allow',
)
is_enabled: Annotated[bool | None, Field(alias='isEnabled')] = None
desired_requests_per_actor_run: Annotated[int | None, Field(alias='desiredRequestsPerActorRun')] = None
max_requests_per_actor_run: Annotated[int | None, Field(alias='maxRequestsPerActorRun')] = None
idle_timeout_secs: Annotated[int | None, Field(alias='idleTimeoutSecs')] = None
build: str | None = None
memory_mbytes: Annotated[int | None, Field(alias='memoryMbytes')] = None
disable_standby_fields_override: Annotated[bool | None, Field(alias='disableStandbyFieldsOverride')] = None
should_pass_actor_input: Annotated[bool | None, Field(alias='shouldPassActorInput')] = None


class ExampleRunInput(BaseModel):
model_config = ConfigDict(
extra='allow',
)
body: Annotated[str | None, Field(examples=['{ "helloWorld": 123 }'])] = None
content_type: Annotated[str | None, Field(alias='contentType', examples=['application/json; charset=utf-8'])] = None


class CreateActorRequest(BaseModel):
Expand All @@ -292,21 +323,9 @@ class CreateActorRequest(BaseModel):
] = None
categories: list[str] | None = None
default_run_options: Annotated[DefaultRunOptions | None, Field(alias='defaultRunOptions')] = None


class ActorPermissionLevel(StrEnum):
"""Determines permissions that the Actor requires to run. For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions)."""

LIMITED_PERMISSIONS = 'LIMITED_PERMISSIONS'
FULL_PERMISSIONS = 'FULL_PERMISSIONS'


class ExampleRunInput(BaseModel):
model_config = ConfigDict(
extra='allow',
)
body: Annotated[str, Field(examples=['{ "helloWorld": 123 }'])]
content_type: Annotated[str, Field(alias='contentType', examples=['application/json; charset=utf-8'])]
actor_standby: Annotated[ActorStandby | None, Field(alias='actorStandby')] = None
example_run_input: Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')] = None
is_deprecated: Annotated[bool | None, Field(alias='isDeprecated')] = None


class TaggedBuildInfo(BaseModel):
Expand Down Expand Up @@ -367,6 +386,7 @@ class Actor(BaseModel):
"""
A brief, LLM-generated readme summary
"""
actor_standby: Annotated[ActorStandby | None, Field(alias='actorStandby')] = None


class ActorResponse(BaseModel):
Expand Down Expand Up @@ -415,15 +435,15 @@ class UpdateActorRequest(BaseModel):
model_config = ConfigDict(
extra='allow',
)
name: Annotated[str, Field(examples=['MyActor'])]
name: Annotated[str | None, Field(examples=['MyActor'])] = None
description: Annotated[str | None, Field(examples=['My favourite actor!'])] = None
is_public: Annotated[bool, Field(alias='isPublic', examples=[False])]
is_public: Annotated[bool | None, Field(alias='isPublic', examples=[False])] = None
actor_permission_level: Annotated[ActorPermissionLevel | None, Field(alias='actorPermissionLevel')] = None
seo_title: Annotated[str | None, Field(alias='seoTitle', examples=['My actor'])] = None
seo_description: Annotated[str | None, Field(alias='seoDescription', examples=['My actor is the best'])] = None
title: Annotated[str | None, Field(examples=['My Actor'])] = None
restart_on_error: Annotated[bool | None, Field(alias='restartOnError', examples=[False])] = None
versions: list[CreateOrUpdateVersionRequest]
versions: list[CreateOrUpdateVersionRequest] | None = None
pricing_infos: Annotated[
list[
PayPerEventActorPricingInfo
Expand Down Expand Up @@ -481,6 +501,9 @@ class UpdateActorRequest(BaseModel):
```

"""
actor_standby: Annotated[ActorStandby | None, Field(alias='actorStandby')] = None
example_run_input: Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')] = None
is_deprecated: Annotated[bool | None, Field(alias='isDeprecated')] = None


class ListOfVersions(BaseModel):
Expand Down Expand Up @@ -566,9 +589,7 @@ class ExampleWebhookDispatch(BaseModel):
extra='allow',
)
status: WebhookDispatchStatus
finished_at: Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-13T08:36:13.202Z'])] = (
None
)
finished_at: Annotated[AwareDatetime, Field(alias='finishedAt', examples=['2019-12-13T08:36:13.202Z'])]


class WebhookStats(BaseModel):
Expand Down Expand Up @@ -1178,6 +1199,7 @@ class TaskOptions(BaseModel):
timeout_secs: Annotated[int | None, Field(alias='timeoutSecs', examples=[300])] = None
memory_mbytes: Annotated[int | None, Field(alias='memoryMbytes', examples=[128])] = None
restart_on_error: Annotated[bool | None, Field(alias='restartOnError', examples=[False])] = None
max_items: Annotated[int | None, Field(alias='maxItems')] = None


class TaskInput(BaseModel):
Expand All @@ -1199,6 +1221,8 @@ class CreateTaskRequest(BaseModel):
name: Annotated[str, Field(examples=['my-task'])]
options: TaskOptions | None = None
input: TaskInput | None = None
title: str | None = None
actor_standby: Annotated[ActorStandby | None, Field(alias='actorStandby')] = None


class Task(BaseModel):
Expand All @@ -1217,6 +1241,8 @@ class Task(BaseModel):
options: TaskOptions | None = None
input: TaskInput | None = None
standby_url: Annotated[AnyUrl | None, Field(alias='standbyUrl')] = None
title: str | None = None
actor_standby: Annotated[ActorStandby | None, Field(alias='actorStandby')] = None


class TaskResponse(BaseModel):
Expand All @@ -1232,17 +1258,11 @@ class UpdateTaskRequest(BaseModel):
model_config = ConfigDict(
extra='allow',
)
id: Annotated[str, Field(examples=['ZxLNxrRaZrSjuhT9y'])]
user_id: Annotated[str, Field(alias='userId', examples=['BPWZBd7Z9c746JAnF'])]
act_id: Annotated[str, Field(alias='actId', examples=['asADASadYvn4mBZmm'])]
name: Annotated[str, Field(examples=['my-task'])]
username: Annotated[str | None, Field(examples=['janedoe'])] = None
created_at: Annotated[AwareDatetime, Field(alias='createdAt', examples=['2018-10-26T07:23:14.855Z'])]
modified_at: Annotated[AwareDatetime, Field(alias='modifiedAt', examples=['2018-10-26T13:30:49.578Z'])]
removed_at: Annotated[AwareDatetime | None, Field(alias='removedAt')] = None
stats: TaskStats | None = None
name: Annotated[str | None, Field(examples=['my-task'])] = None
title: str | None = None
options: TaskOptions | None = None
input: TaskInput | None = None
actor_standby: Annotated[ActorStandby | None, Field(alias='actorStandby')] = None


class Webhook(BaseModel):
Expand Down Expand Up @@ -2504,6 +2524,7 @@ class ScheduleCreate(BaseModel):
cron_expression: Annotated[str | None, Field(alias='cronExpression', examples=['* * * * *'])] = None
timezone: Annotated[str | None, Field(examples=['UTC'])] = None
description: Annotated[str | None, Field(examples=['Schedule of actor ...'])] = None
title: str | None = None
actions: list[ScheduleCreateActions] | None = None


Expand Down Expand Up @@ -2534,6 +2555,7 @@ class Schedule(BaseModel):
modified_at: Annotated[AwareDatetime, Field(alias='modifiedAt', examples=['2019-12-20T06:33:11.202Z'])]
next_run_at: Annotated[AwareDatetime | None, Field(alias='nextRunAt', examples=['2019-04-12T07:34:10.202Z'])] = None
last_run_at: Annotated[AwareDatetime | None, Field(alias='lastRunAt', examples=['2019-04-12T07:33:10.202Z'])] = None
title: str | None = None
actions: list[ScheduleActions]


Expand Down
Loading
Loading