refactor: derive Pydantic model field aliases with to_camel

Author: vdusek

src/apify/_charging.py

@@ -5,9 +5,10 @@
 from dataclasses import dataclass
 from datetime import UTC, datetime
 from decimal import Decimal
-from typing import TYPE_CHECKING, Annotated, Literal, Protocol, TypedDict
+from typing import TYPE_CHECKING, Literal, Protocol, TypedDict
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict
+from pydantic.alias_generators import to_camel
 
 import apify_client._models as _client_models
 from apify_client._models import ActorChargeEvent as ClientActorChargeEvent
@@ -52,22 +53,26 @@
 class _RelaxedPricingMetadata(BaseModel):
     """Mixin relaxing the `CommonActorPricingInfo` metadata fields the platform env var omits."""
 
-    model_config = ConfigDict(populate_by_name=True, extra='allow')
+    model_config = ConfigDict(populate_by_name=True, extra='allow', alias_generator=to_camel)
 
-    apify_margin_percentage: Annotated[float | None, Field(alias='apifyMarginPercentage')] = None
-    created_at: Annotated[datetime | None, Field(alias='createdAt')] = None
-    started_at: Annotated[datetime | None, Field(alias='startedAt')] = None
+    apify_margin_percentage: float | None = None
+    created_at: datetime | None = None
+    started_at: datetime | None = None
 
 
 @docs_group('Charging')
 class ActorChargeEvent(ClientActorChargeEvent):
+    model_config = ConfigDict(alias_generator=to_camel)
+
     # `event_description` is required in apify-client but omitted from the env var.
-    event_description: Annotated[str | None, Field(alias='eventDescription')] = None
+    event_description: str | None = None
 
 
 @docs_group('Charging')
 class PricingPerEvent(ClientPricingPerEvent):
-    actor_charge_events: Annotated[dict[str, ActorChargeEvent] | None, Field(alias='actorChargeEvents')] = None
+    model_config = ConfigDict(alias_generator=to_camel)
+
+    actor_charge_events: dict[str, ActorChargeEvent] | None = None
 
 
 @docs_group('Charging')
@@ -77,20 +82,20 @@ class FreeActorPricingInfo(_RelaxedPricingMetadata, ClientFree):
 
 @docs_group('Charging')
 class FlatPricePerMonthActorPricingInfo(_RelaxedPricingMetadata, ClientFlatPricePerMonth):
-    trial_minutes: Annotated[int | None, Field(alias='trialMinutes')] = None
-    price_per_unit_usd: Annotated[float | None, Field(alias='pricePerUnitUsd')] = None
+    trial_minutes: int | None = None
+    price_per_unit_usd: float | None = None
 
 
 @docs_group('Charging')
 class PricePerDatasetItemActorPricingInfo(_RelaxedPricingMetadata, ClientPricePerDatasetItem):
-    unit_name: Annotated[str | None, Field(alias='unitName')] = None
+    unit_name: str | None = None
     # `price_per_unit_usd` is already optional in apify-client - inherited.
 
 
 @docs_group('Charging')
 class PayPerEventActorPricingInfo(_RelaxedPricingMetadata, ClientPayPerEvent):
     # Re-typed to the relaxed element so an omitted `eventDescription` validates; the field stays required.
-    pricing_per_event: Annotated[PricingPerEvent, Field(alias='pricingPerEvent')]
+    pricing_per_event: PricingPerEvent
 
 
 ActorPricingInfoModel = ClientFree | ClientFlatPricePerMonth | ClientPricePerDatasetItem | ClientPayPerEvent

src/apify/events/_types.py

@@ -3,7 +3,8 @@
 from datetime import datetime
 from typing import Annotated, Any, Literal
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
+from pydantic.alias_generators import to_camel
 
 from crawlee.events._types import (
     Event,
@@ -27,14 +28,16 @@
 
 @docs_group('Event data')
 class SystemInfoEventData(BaseModel):
-    mem_avg_bytes: Annotated[float, Field(alias='memAvgBytes')]
-    mem_current_bytes: Annotated[float, Field(alias='memCurrentBytes')]
-    mem_max_bytes: Annotated[float, Field(alias='memMaxBytes')]
-    cpu_avg_usage: Annotated[float, Field(alias='cpuAvgUsage')]
-    cpu_max_usage: Annotated[float, Field(alias='cpuMaxUsage')]
-    cpu_current_usage: Annotated[float, Field(alias='cpuCurrentUsage')]
-    is_cpu_overloaded: Annotated[bool, Field(alias='isCpuOverloaded')]
-    created_at: Annotated[datetime, Field(alias='createdAt')]
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
+    mem_avg_bytes: float
+    mem_current_bytes: float
+    mem_max_bytes: float
+    cpu_avg_usage: float
+    cpu_max_usage: float
+    cpu_current_usage: float
+    is_cpu_overloaded: bool
+    created_at: datetime
 
     def to_crawlee_format(self, dedicated_cpus: float) -> EventSystemInfoData:
         return EventSystemInfoData.model_validate(
@@ -54,36 +57,48 @@ def to_crawlee_format(self, dedicated_cpus: float) -> EventSystemInfoData:
 
 @docs_group('Events')
 class PersistStateEvent(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
     name: Literal[Event.PERSIST_STATE]
     data: Annotated[EventPersistStateData, Field(default_factory=lambda: EventPersistStateData(is_migrating=False))]
 
 
 @docs_group('Events')
 class SystemInfoEvent(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
     name: Literal[Event.SYSTEM_INFO]
     data: SystemInfoEventData
 
 
 @docs_group('Events')
 class MigratingEvent(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
     name: Literal[Event.MIGRATING]
     data: Annotated[EventMigratingData, Field(default_factory=EventMigratingData)]
 
 
 @docs_group('Events')
 class AbortingEvent(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
     name: Literal[Event.ABORTING]
     data: Annotated[EventAbortingData, Field(default_factory=EventAbortingData)]
 
 
 @docs_group('Events')
 class ExitEvent(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
     name: Literal[Event.EXIT]
     data: Annotated[EventExitData, Field(default_factory=EventExitData)]
 
 
 @docs_group('Events')
 class EventWithoutData(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
     name: Literal[
         Event.SESSION_RETIRED,
         Event.BROWSER_LAUNCHED,
@@ -97,12 +112,16 @@ class EventWithoutData(BaseModel):
 
 @docs_group('Events')
 class DeprecatedEvent(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
     name: Literal['cpuInfo']
     data: Annotated[dict[str, Any], Field(default_factory=dict)]
 
 
 @docs_group('Events')
 class UnknownEvent(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
     name: str
     data: Annotated[dict[str, Any], Field(default_factory=dict)]
 

src/apify/request_loaders/_apify_request_list.py

@@ -5,7 +5,8 @@
 from itertools import chain
 from typing import Annotated, Any
 
-from pydantic import BaseModel, Field, TypeAdapter
+from pydantic import BaseModel, ConfigDict, Field, TypeAdapter
+from pydantic.alias_generators import to_camel
 
 from crawlee._types import HttpMethod
 from crawlee.http_clients import HttpClient, ImpitHttpClient
@@ -20,14 +21,16 @@
 
 
 class _RequestDetails(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
     method: HttpMethod = 'GET'
     payload: str = ''
     headers: Annotated[dict[str, str], Field(default_factory=dict)]
-    user_data: Annotated[dict[str, str], Field(default_factory=dict, alias='userData')]
+    user_data: Annotated[dict[str, str], Field(default_factory=dict)]
 
 
 class _RequestsFromUrlInput(_RequestDetails):
-    requests_from_url: str = Field(alias='requestsFromUrl')
+    requests_from_url: str
 
 
 class _SimpleUrlInput(_RequestDetails):

src/apify/storage_clients/_apify/_models.py

@@ -3,7 +3,8 @@
 from datetime import datetime, timedelta
 from typing import TYPE_CHECKING, Annotated
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field
+from pydantic.alias_generators import to_camel
 
 from apify_client._models import RequestQueueStats
 from crawlee.storage_clients.models import KeyValueStoreMetadata, RequestQueueMetadata
@@ -22,7 +23,9 @@ class ApifyKeyValueStoreMetadata(KeyValueStoreMetadata):
     Includes additional Apify-specific fields.
     """
 
-    url_signing_secret_key: Annotated[str | None, Field(alias='urlSigningSecretKey', default=None)]
+    model_config = ConfigDict(alias_generator=to_camel)
+
+    url_signing_secret_key: str | None = None
     """The secret key used for signing URLs for secure access to key-value store records."""
 
 
@@ -34,24 +37,30 @@ class RequestQueueHead(BaseModel):
     including metadata about the queue's state and lock information for the requests.
     """
 
-    model_config = ConfigDict(populate_by_name=True, extra='allow')
+    model_config = ConfigDict(populate_by_name=True, extra='allow', alias_generator=to_camel)
 
-    limit: Annotated[int | None, Field(alias='limit', default=None)]
+    limit: int | None = None
     """The maximum number of requests that were requested from the queue."""
 
-    had_multiple_clients: Annotated[bool, Field(alias='hadMultipleClients', default=False)]
+    had_multiple_clients: bool = False
     """Indicates whether the queue has been accessed by multiple clients (consumers)."""
 
-    queue_modified_at: Annotated[datetime, Field(alias='queueModifiedAt')]
+    queue_modified_at: datetime
     """The timestamp when the queue was last modified."""
 
-    lock_time: Annotated[timedelta | None, Field(alias='lockSecs', default=None)]
+    # Accept both `lockSecs` (the lock duration in seconds, the key the API actually sends) and the camelCase
+    # `lockTime` that `to_camel` derives from the field name. Serialization keeps emitting `lockSecs` for backward
+    # compatibility. The field is named `lock_time` because Pydantic parses the value into a `timedelta`.
+    lock_time: Annotated[
+        timedelta | None,
+        Field(validation_alias=AliasChoices('lockSecs', 'lockTime'), serialization_alias='lockSecs'),
+    ] = None
     """The duration for which the returned requests are locked and cannot be processed by other clients."""
 
-    queue_has_locked_requests: Annotated[bool | None, Field(alias='queueHasLockedRequests', default=False)]
+    queue_has_locked_requests: bool | None = False
     """Indicates whether the queue contains any locked requests."""
 
-    items: Annotated[list[Request], Field(alias='items', default_factory=list[Request])]
+    items: Annotated[list[Request], Field(default_factory=list[Request])]
     """The list of request objects retrieved from the beginning of the queue."""
 
     @classmethod
@@ -77,6 +86,8 @@ class CachedRequest(BaseModel):
     Only internal structure.
     """
 
+    model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
+
     id: str
     """Id of the request."""
 
@@ -91,5 +102,7 @@ class CachedRequest(BaseModel):
 
 
 class ApifyRequestQueueMetadata(RequestQueueMetadata):
-    stats: Annotated[RequestQueueStats, Field(alias='stats', default_factory=RequestQueueStats)]
+    model_config = ConfigDict(alias_generator=to_camel)
+
+    stats: Annotated[RequestQueueStats, Field(default_factory=RequestQueueStats)]
     """Additional statistics about the request queue."""