themeparks 2.0.0__tar.gz → 2.0.1__tar.gz

{themeparks-2.0.0 → themeparks-2.0.1}/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [2.0.1] - 2026-09-01
+### Fixed
+- `PriceData.amount` is now nullable. The API returns `null` when a paid queue
+  exists but the provider does not publish a price, and `0` only when the queue
+  is genuinely free. Both previously arrived as `0`, so an unknown price was
+  indistinguishable from a free one.
+
+  Before this, a single null amount on one attraction made pydantic reject the
+  **entire** live response for that park, not just the one field.
+
+  Code testing `if price.amount:` or `if not price.amount:` now conflates
+  "free" with "price unknown" — the exact confusion this change exists to
+  remove. Switch to an explicit check:
+
+  ```python
+  if price.amount is None:
+      label = "price not published"
+  else:
+      label = f"{price.currency} {price.amount / 100:.2f}"
+  ```
+
+  `price.formatted` is optional and may be absent when the amount is unknown,
+  so do not rely on it alone to detect the case.
+
 ## [2.0.0] - 2026-04-15
 First stable v2 release. Identical surface to `2.0.0a1` after a brief alpha
 soak; no code changes since `2.0.0a1`. Bumped `Development Status` classifier

{themeparks-2.0.0 → themeparks-2.0.1}/MIGRATION.md

@@ -170,7 +170,7 @@ The async surface mirrors the sync surface method-for-method.
 
 ## New in v2 (not in v1)
 
-- `tp.entity(id).walk()` — breadth-first iterator over every descendant.
+- `tp.entity(id).walk()` — iterator over every descendant in a single API call (the `/children` endpoint already returns the full subtree).
 - `tp.entity(id).schedule.range(start, end)` — stitches monthly schedule
   responses into a single sorted, filtered list.
 - `tp.destinations.find(query)` — case-insensitive lookup by slug or name.

{themeparks-2.0.0 → themeparks-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: themeparks
-Version: 2.0.0
+Version: 2.0.1
 Summary: Official SDK for the ThemeParks.wiki API
 Project-URL: Homepage, https://api.themeparks.wiki
 Project-URL: Source, https://github.com/ThemeParks/ThemeParks_Python
@@ -30,7 +30,7 @@ Requires-Dist: mypy>=1.10; extra == 'dev'
 Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
 Requires-Dist: pytest-recording>=0.13; extra == 'dev'
 Requires-Dist: pytest>=8; extra == 'dev'
-Requires-Dist: ruff>=0.4; extra == 'dev'
+Requires-Dist: ruff<0.17,>=0.4; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
 Requires-Dist: mkdocs>=1.5; extra == 'docs'

{themeparks-2.0.0 → themeparks-2.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "themeparks"
-version = "2.0.0"
+version = "2.0.1"
 description = "Official SDK for the ThemeParks.wiki API"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -40,7 +40,9 @@ dev = [
   "pytest>=8",
   "pytest-asyncio>=0.23",
   "pytest-recording>=0.13",
-  "ruff>=0.4",
+  # Upper-bounded: an unpinned minor bump is what started reformatting
+  # Markdown code blocks and turned CI red on unrelated PRs.
+  "ruff>=0.4,<0.17",
   "mypy>=1.10",
   "datamodel-code-generator[http]>=0.25",
 ]
@@ -63,6 +65,11 @@ asyncio_mode = "auto"
 [tool.ruff]
 line-length = 100
 target-version = "py39"
+# Markdown is documentation, not source. Ruff 0.16 began formatting Python
+# blocks inside it, which rewrites hand-written examples in README.md,
+# MIGRATION.md and docs/ — CI has been failing `ruff format --check .` on
+# those four files regardless of what any PR changes. Prose stays ours.
+extend-exclude = ["*.md"]
 
 [tool.ruff.lint]
 select = ["E", "F", "W", "I", "N", "UP", "B", "A", "SIM", "PL"]
@@ -72,7 +79,9 @@ select = ["E", "F", "W", "I", "N", "UP", "B", "A", "SIM", "PL"]
 "themeparks/_errors.py" = ["A001", "UP045"]
 "themeparks/_transport.py" = ["A004"]
 "themeparks/__init__.py" = ["A004"]
-"themeparks/_generated/*.py" = ["N815", "F401"]
+# E501: field descriptions come from the upstream spec, so line length is not
+# this repo's to choose. The PriceData.amount description is already over.
+"themeparks/_generated/*.py" = ["N815", "F401", "E501"]
 
 [tool.mypy]
 python_version = "3.9"

{themeparks-2.0.0 → themeparks-2.0.1}/themeparks/_client.py

@@ -118,6 +118,9 @@ class ThemeParks:
     def __exit__(self, exc_type: Any, exc: Any, tb: Any) -> None:
         self.close()
 
+    def __repr__(self) -> str:
+        return f"ThemeParks(base_url={str(self._client.base_url).rstrip('/')!r})"
+
 
 class AsyncThemeParks:
     """Asynchronous mirror of :class:`ThemeParks`.
@@ -171,3 +174,6 @@ class AsyncThemeParks:
 
     async def __aexit__(self, exc_type: Any, exc: Any, tb: Any) -> None:
         await self.close()
+
+    def __repr__(self) -> str:
+        return f"AsyncThemeParks(base_url={str(self._client.base_url).rstrip('/')!r})"

themeparks-2.0.1/themeparks/_generated/models.py

@@ -0,0 +1,516 @@
+# generated by datamodel-codegen:
+#   filename:  https://api.themeparks.wiki/docs/v1.yaml
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class BoardingGroupState(Enum):
+    """
+    State of boarding group availability
+    """
+
+    AVAILABLE = "AVAILABLE"
+    PAUSED = "PAUSED"
+    CLOSED = "CLOSED"
+
+
+class DiningAvailability(BaseModel):
+    partySize: float | None = None
+    """
+    Available party size
+    """
+    waitTime: float | None = None
+    """
+    Current wait time in minutes
+    """
+
+
+class EntityLocation(BaseModel):
+    latitude: float | None = None
+    """
+    Latitude coordinate of the entity location
+    """
+    longitude: float | None = None
+    """
+    Longitude coordinate of the entity location
+    """
+
+
+class ScheduleEntry(BaseModel):
+    """
+    Represents a single schedule entry
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    date: str
+    """
+    The date of the schedule entry
+    """
+    type: str
+    """
+    Type of schedule entry e.g. OPERATING, EXTRA_HOURS, etc.
+    """
+    description: str | None = None
+    """
+    Optional description of the schedule entry
+    """
+    openingTime: str
+    """
+    Opening time for this schedule entry
+    """
+    closingTime: str
+    """
+    Closing time for this schedule entry
+    """
+
+
+class EntityType1(Enum):
+    """
+    Type of entity
+    """
+
+    DESTINATION = "DESTINATION"
+    PARK = "PARK"
+    ATTRACTION = "ATTRACTION"
+    RESTAURANT = "RESTAURANT"
+    HOTEL = "HOTEL"
+    SHOW = "SHOW"
+
+
+class EntityType(Enum):
+    """
+    Type of entity in the theme park system
+    """
+
+    DESTINATION = "DESTINATION"
+    PARK = "PARK"
+    ATTRACTION = "ATTRACTION"
+    RESTAURANT = "RESTAURANT"
+    HOTEL = "HOTEL"
+    SHOW = "SHOW"
+
+
+class StandbyQueue(BaseModel):
+    waitTime: float | None = None
+    """
+    Current standby wait time in minutes
+    """
+
+
+class SingleRiderQueue(BaseModel):
+    waitTime: float | None = None
+    """
+    Current single rider wait time in minutes
+    """
+
+
+class BoardingGroupQueue(BaseModel):
+    allocationStatus: BoardingGroupState | None = None
+    currentGroupStart: float | None = None
+    """
+    Current boarding group start number
+    """
+    currentGroupEnd: float | None = None
+    """
+    Current boarding group end number
+    """
+    nextAllocationTime: AwareDatetime | None = None
+    """
+    Next boarding group allocation time
+    """
+    estimatedWait: float | None = None
+    """
+    Estimated wait time in minutes
+    """
+
+
+class PaidStandbyQueue(BaseModel):
+    waitTime: float | None = None
+    """
+    Current paid standby wait time in minutes
+    """
+
+
+class LiveShowTime(BaseModel):
+    type: str
+    """
+    Type of show time entry
+    """
+    startTime: AwareDatetime | None = None
+    """
+    Start time of the show
+    """
+    endTime: AwareDatetime | None = None
+    """
+    End time of the show
+    """
+
+
+class LiveStatusType(Enum):
+    """
+    Current operating status of an entity
+    """
+
+    OPERATING = "OPERATING"
+    DOWN = "DOWN"
+    CLOSED = "CLOSED"
+    REFURBISHMENT = "REFURBISHMENT"
+
+
+class Park(BaseModel):
+    id: str
+    """
+    Unique identifier of the park
+    """
+    name: str
+    """
+    Name of the park
+    """
+
+
+class EntityType2(Enum):
+    """
+    Type of entity
+    """
+
+    DESTINATION = "DESTINATION"
+    PARK = "PARK"
+    ATTRACTION = "ATTRACTION"
+    RESTAURANT = "RESTAURANT"
+    HOTEL = "HOTEL"
+    SHOW = "SHOW"
+
+
+class PriceData(BaseModel):
+    amount: float | None = None
+    """
+    Numerical price amount, in the currency's lowest denomination (e.g. cents). null when the item costs money but the provider does not publish an amount; 0 means genuinely free
+    """
+    currency: str
+    """
+    Currency code
+    """
+    formatted: str | None = None
+    """
+    Formatted price string
+    """
+
+
+class Type(Enum):
+    """
+    Type of schedule entry
+    """
+
+    OPERATING = "OPERATING"
+    TICKETED_EVENT = "TICKETED_EVENT"
+    PRIVATE_EVENT = "PRIVATE_EVENT"
+    EXTRA_HOURS = "EXTRA_HOURS"
+    INFO = "INFO"
+
+
+class ReturnTimeState(Enum):
+    """
+    State of return time availability
+    """
+
+    AVAILABLE = "AVAILABLE"
+    TEMP_FULL = "TEMP_FULL"
+    FINISHED = "FINISHED"
+
+
+class Price(BaseModel):
+    amount: float
+    """
+    Price amount
+    """
+    currency: str
+    """
+    Currency code
+    """
+    formatted: str | None = None
+    """
+    Formatted price string
+    """
+
+
+class SchedulePriceType(Enum):
+    """
+    Type of schedule price
+    """
+
+    ADMISSION = "ADMISSION"
+    PACKAGE = "PACKAGE"
+    ATTRACTION = "ATTRACTION"
+
+
+class TagData(BaseModel):
+    tag: str
+    """
+    Tag identifier
+    """
+    tagName: str
+    """
+    Human readable tag name
+    """
+    id: str | None = None
+    """
+    Unique identifier
+    """
+    value: Any | None = None
+    """
+    Tag value - can be string, number or object
+    """
+
+
+class DestinationEntry(BaseModel):
+    id: str
+    """
+    Unique identifier of the destination
+    """
+    name: str
+    """
+    Name of the destination
+    """
+    slug: str | None = None
+    """
+    URL-friendly slug for the destination
+    """
+    externalId: str | None = None
+    """
+    External entity ID from the source data provider
+    """
+    parks: list[Park]
+    """
+    Array of parks within this destination
+    """
+
+
+class DestinationsResponse(BaseModel):
+    destinations: list[DestinationEntry]
+    """
+    Array of all destinations
+    """
+
+
+class EntityChild(BaseModel):
+    id: str
+    """
+    Unique entity identifier
+    """
+    name: str
+    """
+    Entity name
+    """
+    entityType: EntityType
+    externalId: str | None = None
+    """
+    External identifier
+    """
+    parentId: str | None = None
+    """
+    Parent entity identifier
+    """
+    location: EntityLocation | None = None
+
+
+class EntityChildrenResponse(BaseModel):
+    id: str | None = None
+    """
+    Parent entity identifier
+    """
+    name: str | None = None
+    """
+    Parent entity name
+    """
+    entityType: EntityType | None = None
+    timezone: str | None = None
+    """
+    Entity timezone
+    """
+    children: list[EntityChild] | None = None
+
+
+class EntityData(BaseModel):
+    id: str
+    """
+    Unique entity identifier
+    """
+    name: str
+    """
+    Entity name
+    """
+    entityType: EntityType
+    parentId: str | None = None
+    """
+    Parent entity identifier
+    """
+    destinationId: str | None = None
+    """
+    DestinationEntry identifier
+    """
+    timezone: str
+    """
+    Entity timezone
+    """
+    location: EntityLocation | None = None
+    tags: list[TagData] | None = None
+
+
+class ReturnTimeQueue(BaseModel):
+    state: ReturnTimeState | None = None
+    returnStart: AwareDatetime | None = None
+    """
+    Start time of return window
+    """
+    returnEnd: AwareDatetime | None = None
+    """
+    End time of return window
+    """
+
+
+class PaidReturnTimeQueue(BaseModel):
+    state: ReturnTimeState | None = None
+    returnStart: AwareDatetime | None = None
+    returnEnd: AwareDatetime | None = None
+    price: PriceData | None = None
+
+
+class LiveQueue(BaseModel):
+    STANDBY: StandbyQueue | None = None
+    SINGLE_RIDER: SingleRiderQueue | None = None
+    RETURN_TIME: ReturnTimeQueue | None = None
+    PAID_RETURN_TIME: PaidReturnTimeQueue | None = None
+    BOARDING_GROUP: BoardingGroupQueue | None = None
+    PAID_STANDBY: PaidStandbyQueue | None = None
+
+
+class SchedulePriceObject(BaseModel):
+    type: SchedulePriceType | None = None
+    """
+    Type of price object
+    """
+    id: str | None = None
+    """
+    Unique identifier
+    """
+    name: str | None = None
+    """
+    Name of the price object
+    """
+    price: Price | None = None
+    available: bool | None = None
+    """
+    Whether this price option is available
+    """
+
+
+class EntityLiveData(BaseModel):
+    id: str
+    """
+    Entity identifier
+    """
+    name: str
+    """
+    Entity name
+    """
+    entityType: EntityType
+    status: LiveStatusType | None = None
+    lastUpdated: AwareDatetime
+    """
+    Last update timestamp
+    """
+    queue: LiveQueue | None = None
+    showtimes: list[LiveShowTime] | None = None
+    operatingHours: list[LiveShowTime] | None = None
+    diningAvailability: list[DiningAvailability] | None = None
+
+
+class EntityLiveDataResponse(BaseModel):
+    id: str | None = None
+    """
+    Entity identifier
+    """
+    name: str | None = None
+    """
+    Entity name
+    """
+    entityType: EntityType | None = None
+    timezone: str | None = None
+    """
+    Entity timezone
+    """
+    liveData: list[EntityLiveData] | None = None
+
+
+class PricedScheduleEntry(BaseModel):
+    date: str
+    """
+    Schedule date
+    """
+    openingTime: AwareDatetime
+    """
+    Opening time
+    """
+    closingTime: AwareDatetime
+    """
+    Closing time
+    """
+    type: Type
+    """
+    Type of schedule entry
+    """
+    purchases: list[SchedulePriceObject] | None = None
+    """
+    Available purchases for this schedule entry
+    """
+
+
+class ParkSchedule(BaseModel):
+    id: str | None = None
+    """
+    Entity identifier
+    """
+    name: str | None = None
+    """
+    Entity name
+    """
+    entityType: EntityType2 | None = None
+    """
+    Type of entity
+    """
+    timezone: str | None = None
+    """
+    Entity timezone
+    """
+    schedule: list[PricedScheduleEntry] | None = None
+
+
+class EntityScheduleResponse(BaseModel):
+    id: str | None = None
+    """
+    Entity identifier
+    """
+    name: str | None = None
+    """
+    Entity name
+    """
+    entityType: EntityType1 | None = None
+    """
+    Type of entity
+    """
+    timezone: str | None = None
+    """
+    Entity timezone
+    """
+    schedule: list[ScheduleEntry] | None = None
+    parks: list[ParkSchedule] | None = None
+    """
+    Only included for destinations, lists all parks within the destination
+    """

themeparks-2.0.0/themeparks/_generated/models.py

@@ -1,221 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  https://api.themeparks.wiki/docs/v1.yaml
-
-from __future__ import annotations
-
-from enum import Enum
-from typing import Annotated, Any
-
-from pydantic import AwareDatetime, BaseModel, Field
-
-
-class EntityType(Enum):
-    DESTINATION = "DESTINATION"
-    PARK = "PARK"
-    ATTRACTION = "ATTRACTION"
-    RESTAURANT = "RESTAURANT"
-    HOTEL = "HOTEL"
-    SHOW = "SHOW"
-
-
-class LiveStatusType(Enum):
-    OPERATING = "OPERATING"
-    DOWN = "DOWN"
-    CLOSED = "CLOSED"
-    REFURBISHMENT = "REFURBISHMENT"
-
-
-class ReturnTimeState(Enum):
-    AVAILABLE = "AVAILABLE"
-    TEMP_FULL = "TEMP_FULL"
-    FINISHED = "FINISHED"
-
-
-class BoardingGroupState(Enum):
-    AVAILABLE = "AVAILABLE"
-    PAUSED = "PAUSED"
-    CLOSED = "CLOSED"
-
-
-class PriceData(BaseModel):
-    amount: float
-    currency: str
-    formatted: str | None = None
-
-
-class StandbyQueue(BaseModel):
-    waitTime: float | None = None
-
-
-class SingleRiderQueue(BaseModel):
-    waitTime: float | None = None
-
-
-class ReturnTimeQueue(BaseModel):
-    state: ReturnTimeState | None = None
-    returnStart: AwareDatetime | None = None
-    returnEnd: AwareDatetime | None = None
-
-
-class PaidReturnTimeQueue(BaseModel):
-    state: ReturnTimeState | None = None
-    returnStart: AwareDatetime | None = None
-    returnEnd: AwareDatetime | None = None
-    price: PriceData | None = None
-
-
-class BoardingGroupQueue(BaseModel):
-    allocationStatus: BoardingGroupState | None = None
-    currentGroupStart: float | None = None
-    currentGroupEnd: float | None = None
-    nextAllocationTime: AwareDatetime | None = None
-    estimatedWait: float | None = None
-
-
-class PaidStandbyQueue(BaseModel):
-    waitTime: float | None = None
-
-
-class LiveQueue(BaseModel):
-    STANDBY: StandbyQueue | None = None
-    SINGLE_RIDER: SingleRiderQueue | None = None
-    RETURN_TIME: ReturnTimeQueue | None = None
-    PAID_RETURN_TIME: PaidReturnTimeQueue | None = None
-    BOARDING_GROUP: BoardingGroupQueue | None = None
-    PAID_STANDBY: PaidStandbyQueue | None = None
-
-
-class LiveShowTime(BaseModel):
-    type: str
-    startTime: AwareDatetime | None = None
-    endTime: AwareDatetime | None = None
-
-
-class DiningAvailability(BaseModel):
-    partySize: float | None = None
-    waitTime: float | None = None
-
-
-class TagData(BaseModel):
-    tag: str
-    tagName: str
-    id: str | None = None
-    value: str | float | dict[str, Any] | None = None
-
-
-class Location(BaseModel):
-    latitude: float | None = None
-    longitude: float | None = None
-
-
-class EntityData(BaseModel):
-    id: str
-    name: str
-    entityType: EntityType
-    parentId: str | None = None
-    destinationId: str | None = None
-    timezone: str
-    location: Location | None = None
-    tags: list[TagData] | None = None
-
-
-class EntityChild(BaseModel):
-    id: str
-    name: str
-    entityType: EntityType
-    externalId: str | None = None
-    parentId: str | None = None
-    location: Location | None = None
-
-
-class EntityChildrenResponse(BaseModel):
-    id: str | None = None
-    name: str | None = None
-    entityType: EntityType | None = None
-    timezone: str | None = None
-    children: list[EntityChild] | None = None
-
-
-class EntityLiveData(BaseModel):
-    id: str
-    name: str
-    entityType: EntityType
-    status: LiveStatusType | None = None
-    lastUpdated: AwareDatetime
-    queue: LiveQueue | None = None
-    showtimes: list[LiveShowTime] | None = None
-    operatingHours: list[LiveShowTime] | None = None
-    diningAvailability: list[DiningAvailability] | None = None
-
-
-class EntityLiveDataResponse(BaseModel):
-    id: str | None = None
-    name: str | None = None
-    entityType: EntityType | None = None
-    timezone: str | None = None
-    liveData: list[EntityLiveData] | None = None
-
-
-class Type(Enum):
-    ADMISSION = "ADMISSION"
-    PACKAGE = "PACKAGE"
-    ATTRACTION = "ATTRACTION"
-
-
-class SchedulePriceObject(BaseModel):
-    type: Type | None = None
-    id: str | None = None
-    name: str | None = None
-    price: PriceData | None = None
-    available: bool | None = None
-
-
-class Type1(Enum):
-    OPERATING = "OPERATING"
-    TICKETED_EVENT = "TICKETED_EVENT"
-    PRIVATE_EVENT = "PRIVATE_EVENT"
-    EXTRA_HOURS = "EXTRA_HOURS"
-    INFO = "INFO"
-
-
-class ScheduleEntry(BaseModel):
-    date: str
-    openingTime: AwareDatetime
-    closingTime: AwareDatetime
-    type: Type1
-    purchases: list[SchedulePriceObject] | None = None
-
-
-class EntityScheduleResponse(BaseModel):
-    id: str | None = None
-    name: str | None = None
-    entityType: EntityType | None = None
-    timezone: str | None = None
-    schedule: list[ScheduleEntry] | None = None
-    parks: list[EntityScheduleResponse] | None = None
-    """
-    Only included for destinations, this will list all parks within the destination
-    """
-
-
-class DestinationParkEntry(BaseModel):
-    id: str | None = None
-    name: str | None = None
-
-
-class DestinationEntry(BaseModel):
-    id: str | None = None
-    name: str | None = None
-    slug: str | None = None
-    externalId: str | None = None
-    """
-    External entity ID from the source data provider
-    """
-    parks: list[DestinationParkEntry] | None = None
-
-
-class DestinationsResponse(BaseModel):
-    destinations: list[DestinationEntry] | None = None
-
-
-EntityScheduleResponse.model_rebuild()