python-navitia-client 1.1.0__py3-none-any.whl

navitia_client/entities/__init__.py

@@ -0,0 +1,23 @@
+# ruff: noqa: F401
+
+from .base_entity import BaseEntity
+from .coord import Coord
+from .administrative_region import AdministrativeRegion
+from .stand import StandStatus, Stands
+from .poi import POIType, POI
+from .trip import Trip
+from .stop_area import StopArea, StopPoint
+from .network import Network
+from .address import Address
+from .physical_mode import PhysicalModeId, CommercialMode, PhysicalMode
+from .place import Place, PlaceEmbeddedType
+from .pt_object import PtObject, PtObjectEmbeddedType
+from .line_and_route import Line, Route
+from .disruption import DisruptionStatus, Disruption
+from .context import Context
+from .pt_datetime import PTDatetime
+from .note import Note
+from .stop_datetime import StopDateTime
+from .equipment import EquipmentAvailability, EquipmentDetails, StopAreaEquipments
+from .equipment_reports import EquipmentReports
+from .display_information import DisplayInformation

navitia_client/entities/access_point.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+
+from .base_entity import BaseEntity
+from .coord import Coord
+
+
+@dataclass
+class AccessPoint(BaseEntity):
+    coord: Coord
+    access_point_code: str

navitia_client/entities/address.py

@@ -0,0 +1,28 @@
+from dataclasses import dataclass
+from typing import Any, Sequence
+
+from .base_entity import BaseEntity
+from .coord import Coord
+from .administrative_region import AdministrativeRegion
+
+
+@dataclass
+class Address(BaseEntity):
+    label: str
+    coord: Coord
+    house_number: int
+    administrative_regions: Sequence[AdministrativeRegion]
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "Address":
+        return Address(
+            id=payload["id"],
+            name=payload["name"],
+            label=payload["label"],
+            coord=Coord.from_payload(payload["coord"]),
+            house_number=payload["house_number"],
+            administrative_regions=[
+                AdministrativeRegion.from_payload(data)
+                for data in payload["administrative_regions)"]
+            ],
+        )

navitia_client/entities/administrative_region.py

@@ -0,0 +1,59 @@
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Optional
+from .base_entity import BaseEntity
+from .coord import Coord
+
+
+@dataclass
+class Region(BaseEntity):
+    dataset_created_at: Optional[datetime]
+    end_production_date: Optional[datetime]
+    last_load_at: Optional[datetime]
+    shape: Optional[str]
+    start_production_date: Optional[datetime]
+    status: Optional[str]
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "Region":
+        return cls(
+            id=payload["id"],
+            name=payload["name"],
+            dataset_created_at=datetime.fromisoformat(payload["dataset_created_at"])
+            if "dataset_created_at" in payload
+            else None,
+            end_production_date=datetime.strptime(
+                payload["end_production_date"], "%Y%m%d"
+            )
+            if "end_production_date" in payload
+            else None,
+            last_load_at=datetime.fromisoformat(payload["last_load_at"])
+            if "last_load_at" in payload
+            else None,
+            shape=payload["shape"],
+            start_production_date=datetime.strptime(
+                payload["start_production_date"], "%Y%m%d"
+            )
+            if "end_production_date" in payload
+            else None,
+            status=payload["status"],
+        )
+
+
+@dataclass
+class AdministrativeRegion(BaseEntity):
+    label: str
+    coord: Coord
+    level: int
+    zip_code: str
+
+    @staticmethod
+    def from_payload(payload: dict[str, Any]) -> "AdministrativeRegion":
+        return AdministrativeRegion(
+            id=payload["id"],
+            name=payload["name"],
+            label=payload["label"],
+            coord=Coord.from_payload(payload["coord"]),
+            level=payload["level"],
+            zip_code=payload["zip_code"],
+        )

navitia_client/entities/arrival.py

@@ -0,0 +1,21 @@
+from dataclasses import dataclass
+from typing import Any
+
+from navitia_client.entities.line_and_route import Route
+from navitia_client.entities.stop_area import StopPoint
+from navitia_client.entities.stop_datetime import StopDateTime
+
+
+@dataclass
+class Arrival:
+    route: Route
+    stop_date_time: StopDateTime
+    stop_point: StopPoint
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "Arrival":
+        return cls(
+            route=Route.from_payload(payload["route"]),
+            stop_point=StopPoint.from_payload(payload["stop_point"]),
+            stop_date_time=StopDateTime.from_payload(payload["stop_date_time"]),
+        )

navitia_client/entities/base_entity.py

@@ -0,0 +1,7 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class BaseEntity:
+    id: str
+    name: str

navitia_client/entities/company.py

@@ -0,0 +1,16 @@
+from dataclasses import dataclass
+from typing import Any
+
+from .base_entity import BaseEntity
+
+
+@dataclass
+class Company(BaseEntity):
+    pass
+
+    @classmethod
+    def from_payload(cls, payload: Any) -> "Company":
+        return cls(
+            id=payload.get("id"),
+            name=payload.get("name"),
+        )

navitia_client/entities/context.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any
+
+
+@dataclass
+class Context:
+    timezone: str
+    current_datetime: datetime
+    car_direct_path: dict[str, Any]

navitia_client/entities/contributor.py

@@ -0,0 +1,19 @@
+from dataclasses import dataclass
+from typing import Any, Optional
+
+from navitia_client.entities.base_entity import BaseEntity
+
+
+@dataclass
+class Contributor(BaseEntity):
+    license: str
+    website: Optional[str]
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "Contributor":
+        return cls(
+            id=payload["id"],
+            name=payload["name"],
+            license=payload["license"],
+            website=payload["website"],
+        )

navitia_client/entities/coord.py

@@ -0,0 +1,15 @@
+from dataclasses import dataclass
+from typing import Any
+
+
+@dataclass
+class Coord:
+    lon: float
+    lat: float
+
+    @classmethod
+    def from_payload(cls, payload: Any) -> "Coord":
+        return cls(
+            lon=payload.get("lon"),
+            lat=payload.get("lat"),
+        )

navitia_client/entities/dataset.py

@@ -0,0 +1,32 @@
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Optional
+
+from navitia_client.entities.contributor import Contributor
+
+
+@dataclass
+class Dataset:
+    contributor: Contributor
+    description: Optional[str]
+    end_validation_date: datetime
+    id: str
+    realtime_level: str
+    start_validation_date: datetime
+    system: Optional[str]
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "Dataset":
+        return cls(
+            contributor=Contributor.from_payload(payload["contributor"]),
+            description=payload["description"],
+            end_validation_date=datetime.strptime(
+                payload["end_validation_date"], "%Y%m%dT%H%M%S"
+            ),
+            id=payload["id"],
+            realtime_level=payload["realtime_level"],
+            start_validation_date=datetime.strptime(
+                payload["start_validation_date"], "%Y%m%dT%H%M%S"
+            ),
+            system=payload["system"],
+        )

navitia_client/entities/departure.py

@@ -0,0 +1,21 @@
+from dataclasses import dataclass
+from typing import Any
+
+from navitia_client.entities.line_and_route import Route
+from navitia_client.entities.stop_area import StopPoint
+from navitia_client.entities.stop_datetime import StopDateTime
+
+
+@dataclass
+class Departure:
+    route: Route
+    stop_date_time: StopDateTime
+    stop_point: StopPoint
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "Departure":
+        return cls(
+            route=Route.from_payload(payload["route"]),
+            stop_point=StopPoint.from_payload(payload["stop_point"]),
+            stop_date_time=StopDateTime.from_payload(payload["stop_date_time"]),
+        )

navitia_client/entities/direction.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass
+from typing import Any
+from navitia_client.entities.base_entity import BaseEntity
+from navitia_client.entities.stop_area import StopArea
+
+
+@dataclass
+class Direction(BaseEntity):
+    embedded_type: str
+    quality: int
+    stop_area: StopArea
+
+    @classmethod
+    def from_payload(
+        cls,
+        payload: dict[str, Any],
+    ) -> "Direction":
+        return cls(
+            id=payload["id"],
+            name=payload["name"],
+            embedded_type=payload["embedded_type"],
+            quality=payload["quality"],
+            stop_area=StopArea.from_payload(payload["stop_area"]),
+        )

navitia_client/entities/display_information.py

@@ -0,0 +1,43 @@
+from dataclasses import dataclass
+from typing import Any, Optional, Sequence
+
+from .equipment import Equipment
+
+
+@dataclass
+class DisplayInformation:
+    network: str
+    physical_mode: Optional[str]
+    commercial_mode: Optional[str]
+    code: str
+    color: str
+    text_color: str
+    direction: str
+    headsign: Optional[str]
+    label: Optional[str]
+    name: str
+    trip_short_name: Optional[str]
+    equipments: Optional[Sequence[Equipment]]
+    description: Optional[str]
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "DisplayInformation":
+        return cls(
+            network=payload["network"],
+            physical_mode=payload.get("physical_mode"),
+            commercial_mode=payload.get("commercial_mode"),
+            code=payload["code"],
+            color=payload["color"],
+            text_color=payload["text_color"],
+            direction=payload["direction"],
+            headsign=payload.get("headsign"),
+            label=payload.get("label"),
+            name=payload["name"],
+            trip_short_name=payload.get("trip_short_name"),
+            equipments=[
+                Equipment(equipment_data) for equipment_data in payload["equipments"]
+            ]
+            if payload.get("equipments")
+            else None,
+            description=payload.get("description"),
+        )

navitia_client/entities/disruption.py

@@ -0,0 +1,233 @@
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+from typing import Any, Optional, Sequence
+
+from .pt_object import PtObject
+from .line_and_route import Route
+from .stop_area import StopPoint
+
+
+class DisruptionStatus(Enum):
+    PAST = "past"
+    ACTIVE = "active"
+    FUTURE = "future"
+
+
+class Effect(Enum):
+    NO_SERVICE = "NO_SERVICE"
+    REDUCED_SERVICE = "REDUCED_SERVICE"
+    SIGNIFICANT_DELAYS = "SIGNIFICANT_DELAYS"
+    DETOUR = "DETOUR"
+    ADDITIONAL_SERVICE = "ADDITIONAL_SERVICE"
+    MODIFIED_SERVICE = "MODIFIED_SERVICE"
+    OTHER_EFFECT = "OTHER_EFFECT"
+    UNKNOWN_EFFECT = "UNKNOWN_EFFECT"
+    STOP_MOVED = "STOP_MOVED"
+    NO_EFFECT = "NO_EFFECT"
+    ACCESSIBILITY_ISSUE = "ACCESSIBILITY_ISSUE"
+
+
+@dataclass
+class Severity:
+    color: str
+    priority: int | None
+    name: str
+    effect: Effect
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "Severity":
+        return cls(
+            color=payload["color"],
+            priority=payload["priority"],
+            name=payload["name"],
+            effect=Effect(payload["effect"]),
+        )
+
+
+@dataclass
+class DisruptionPeriod:
+    begin: datetime
+    end: datetime
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "DisruptionPeriod":
+        return cls(
+            begin=datetime.strptime(payload["begin"], "%Y%m%dT%H%M%S"),
+            end=datetime.strptime(payload["end"], "%Y%m%dT%H%M%S"),
+        )
+
+
+@dataclass
+class Channel:
+    id: str
+    content_type: str
+    name: str
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "Channel":
+        return cls(
+            id=payload["id"], content_type=payload["content_type"], name=payload["name"]
+        )
+
+
+@dataclass
+class DisruptionMessage:
+    text: str
+    channel: Channel
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "DisruptionMessage":
+        return cls(
+            text=payload["text"], channel=Channel.from_payload(payload["channel"])
+        )
+
+
+@dataclass
+class ImpactedSection:
+    section_from: PtObject
+    section_to: PtObject
+    routes: Sequence[Route]
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "ImpactedSection":
+        routes = [Route.from_payload(route_data) for route_data in payload["routes"]]
+
+        return cls(
+            section_from=PtObject.from_payload(payload["section_from"]),
+            section_to=PtObject.from_payload(payload["section_to"]),
+            routes=routes,
+        )
+
+
+class StopTimeEffect(Enum):
+    ADDED = "added"
+    DELETED = "deleted"
+    DELAYED = "delayed"
+    UNCHANGED = "unchanged"
+
+
+@dataclass
+class ImpactedStop:
+    stop_point: StopPoint
+    amended_departure_time: str
+    amended_arrival_time: str
+    base_departure_time: Optional[str]
+    base_arrival_time: Optional[str]
+    cause: str
+    stop_time_effect: StopTimeEffect  # written as deprecated in the doc
+    arrival_status: StopTimeEffect
+    departure_status: StopTimeEffect
+    is_detour: bool
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "ImpactedStop":
+        return cls(
+            amended_arrival_time=payload["amended_arrival_time"],
+            amended_departure_time=payload["amended_departure_time"],
+            arrival_status=StopTimeEffect(payload["arrival_status"]),
+            base_arrival_time=payload["base_arrival_time"]
+            if "base_arrival_time" in payload
+            else None,
+            base_departure_time=payload["base_departure_time"]
+            if "base_departure_time" in payload
+            else None,
+            cause=payload["cause"],
+            departure_status=StopTimeEffect(payload["departure_status"]),
+            is_detour=bool(payload["is_detour"]),
+            stop_point=StopPoint.from_payload(payload["stop_point"]),
+            stop_time_effect=StopTimeEffect(payload["stop_time_effect"]),
+        )
+
+
+@dataclass
+class ImpactedObject:
+    pt_object: Optional[PtObject]
+    impacted_section: Optional[ImpactedSection]
+    impacted_stops: Optional[Sequence[ImpactedStop]]
+
+    @classmethod
+    def from_payload(
+        cls,
+        payload: dict[str, Any],
+    ) -> "ImpactedObject":
+        impacted_stops = (
+            [
+                ImpactedStop.from_payload(impacted_stop_data)
+                for impacted_stop_data in payload["impacted_stops"]
+            ]
+            if "impacted_stops" in payload
+            else None
+        )
+        return cls(
+            pt_object=PtObject.from_payload(payload["pt_object"])
+            if "pt_object" in payload
+            else None,
+            impacted_section=ImpactedSection.from_payload(payload["impacted_section"])
+            if "impacted_section" in payload
+            else None,
+            impacted_stops=impacted_stops,
+        )
+
+
+@dataclass
+class Disruption:
+    id: str
+    status: Optional[DisruptionStatus]
+    disruption_id: Optional[str]
+    impact_id: Optional[str]
+    severity: Optional[Severity]
+    application_periods: Optional[Sequence[DisruptionPeriod]]
+    messages: Optional[Sequence[DisruptionMessage]]
+    updated_at: Optional[datetime]
+    impacted_objects: Optional[Sequence[ImpactedObject]]
+    cause: Optional[str]
+    category: Optional[str]
+    contributor: Optional[str]
+
+    @classmethod
+    def from_payload(
+        cls,
+        payload: dict[str, Any],
+    ) -> "Disruption":
+        print(payload)
+        application_periods = (
+            [
+                DisruptionPeriod.from_payload(application_period)
+                for application_period in payload["application_periods"]
+            ]
+            if "application_periods" in payload
+            else None
+        )
+        messages = (
+            [DisruptionMessage.from_payload(message) for message in payload["messages"]]
+            if "messages" in payload
+            else None
+        )
+        impacted_objects = (
+            [
+                ImpactedObject.from_payload(object)
+                for object in payload["impacted_objects"]
+            ]
+            if "impacted_objects" in payload
+            else None
+        )
+
+        return cls(
+            id=payload["id"],
+            status=DisruptionStatus(payload["status"]) if "status" in payload else None,
+            disruption_id=payload.get("disruption_id"),
+            impact_id=payload.get("impact_id"),
+            severity=Severity.from_payload(payload["severity"])
+            if "severity" in payload
+            else None,
+            application_periods=application_periods,
+            messages=messages,
+            updated_at=datetime.strptime(payload["updated_at"], "%Y%m%dT%H%M%S")
+            if "updated_at" in payload
+            else None,
+            impacted_objects=impacted_objects,
+            cause=payload.get("cause"),
+            category=payload.get("category"),
+            contributor=payload.get("contributor"),
+        )

navitia_client/entities/equipment.py

@@ -0,0 +1,42 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Optional
+
+from .base_entity import BaseEntity
+from .stop_area import StopArea
+
+
+class Equipment(Enum):
+    WHEELCHAIR_ACCESSIBILITY = "has_wheelchair_accessibility"
+    BIKE_ACCEPTED = "has_bike_accepted"
+    AIR_CONDITIONED = "has_air_conditioned"
+    VISUAL_ANNOUNCEMENT = "has_visual_announcement"
+    AUDIBLE_ANNOUNCEMENT = "has_audible_announcement"
+    APPROPRIATE_ESCORT = "has_appropriate_escort"
+    APPROPRIATE_SIGNAGE = "has_appropriate_signage"
+    SCHOOL_VEHICLE = "has_school_vehicle"
+    WHEELCHAR_BOARDING = "has_wheelchair_boarding"
+    SHELTERED = "has_sheltered"
+    ELEVATOR = "has_elevator"
+    ESCALATOR = "has_escalator"
+    BIKE_DEPOT = "has_bike_depot"
+
+
+@dataclass
+class EquipmentAvailability:
+    status: str
+    cause: Optional[str]
+    effect: Optional[str]
+    periods: Optional[dict[str, str]]
+
+
+@dataclass
+class EquipmentDetails(BaseEntity):
+    current_availability: EquipmentAvailability
+    embedded_type: str
+
+
+@dataclass
+class StopAreaEquipments:
+    equiment_details: EquipmentDetails
+    stop_area: StopArea

navitia_client/entities/equipment_reports.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+
+from .line_and_route import Line
+from .equipment import StopAreaEquipments
+
+
+@dataclass
+class EquipmentReports:
+    line: Line
+    stop_area_equipments: StopAreaEquipments

navitia_client/entities/isochrones.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any
+
+from navitia_client.entities.place import Place
+
+
+@dataclass
+class Isochrone:
+    from_: Place
+    geojson: Any
+    max_date_time: datetime
+    max_duration: int
+    min_date_time: datetime
+    min_duration: int
+    requested_date_time: datetime
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> "Isochrone":
+        return cls(
+            from_=Place.from_payload(payload["from"]),
+            geojson=payload["geojson"],
+            max_date_time=datetime.strptime(payload["max_date_time"], "%Y%m%dT%H%M%S"),
+            max_duration=payload["max_duration"],
+            min_date_time=datetime.strptime(payload["min_date_time"], "%Y%m%dT%H%M%S"),
+            min_duration=payload["min_duration"],
+            requested_date_time=datetime.strptime(
+                payload["requested_date_time"], "%Y%m%dT%H%M%S"
+            ),
+        )