python-openpublictransport 0.3.1__tar.gz → 0.3.3__tar.gz

{python_openpublictransport-0.3.1 → python_openpublictransport-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-openpublictransport
-Version: 0.3.1
+Version: 0.3.3
 Summary: Python library for public transport APIs (EFA, OTP2, TRIAS, FPTF, HAFAS, GTFS-RT)
 License: MIT
 Requires-Python: >=3.11

{python_openpublictransport-0.3.1 → python_openpublictransport-0.3.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-openpublictransport"
-version = "0.3.1"
+version = "0.3.3"
 description = "Python library for public transport APIs (EFA, OTP2, TRIAS, FPTF, HAFAS, GTFS-RT)"
 readme = "README.md"
 license = { text = "MIT" }

{python_openpublictransport-0.3.1 → python_openpublictransport-0.3.3}/src/openpublictransport/models.py

@@ -36,6 +36,10 @@ class UnifiedDeparture:
     description: Optional[str] = None
     agency: Optional[str] = None
     notices: Optional[list[str]] = None
+    # The subset of ``notices`` that reports an actual disruption, as opposed
+    # to routine information such as bicycle rules or on-board facilities.
+    # None means the provider does not tell them apart: every notice counts.
+    disruptions: Optional[list[str]] = None
     planned_platform: Optional[str] = None
     platform_changed: bool = False
     # Human-readable form of `platform` when the provider offers one
@@ -63,6 +67,9 @@ class UnifiedDeparture:
             result["agency"] = self.agency
         if self.notices:
             result["notices"] = self.notices
+            # Always present next to the notices, even when empty, so consumers
+            # can tell "no disruption" apart from an older payload without it.
+            result["disruptions"] = self.notices if self.disruptions is None else self.disruptions
         if self.platform_name and self.platform_name != self.platform:
             result["platform_name"] = self.platform_name
         if self.platform_changed:

{python_openpublictransport-0.3.1 → python_openpublictransport-0.3.3}/src/openpublictransport/parsers.py

@@ -34,6 +34,13 @@ def rail_line_label(number: str, name: str) -> str:
     return number
 
 
+# EFA hint types that carry routine timetable or vehicle information ("bicycles
+# limited", "wheelchair accessible", "on-board restaurant") rather than a
+# disruption. Infos (lineInfo, stopBlocking, …) and real-time hints such as
+# RTIncidentCall ("delay of a preceding train") are disruptions.
+EFA_ROUTINE_HINT_TYPES = frozenset({"Timetable", "VehicleType"})
+
+
 # Human-readable platform labels APIs prefix onto the bare track identifier:
 # "Gleis 3", "Bstg. 12", "Steig B", "Platform 4", "Pl. 2", "Track 1".
 _PLATFORM_LABEL_RE = re.compile(
@@ -140,16 +147,20 @@ def parse_departure_generic(
         is_realtime = get_realtime_fn(stop, estimated_time_str, planned_time_str)
 
         notices = []
+        disruptions = []
         for info in stop.get("infos", []):
             if isinstance(info, dict):
                 text = info.get("subtitle") or info.get("title") or info.get("content", "")
                 if text and isinstance(text, str):
                     notices.append(text.strip())
+                    disruptions.append(text.strip())
         for hint in stop.get("hints", []):
             if isinstance(hint, dict):
                 text = hint.get("content") or hint.get("text", "")
                 if text and isinstance(text, str):
                     notices.append(text.strip())
+                    if hint.get("type") not in EFA_ROUTINE_HINT_TYPES:
+                        disruptions.append(text.strip())
 
         planned_fn = get_planned_platform_fn or _default_planned_platform_fn
         planned_platform = planned_fn(stop)
@@ -174,6 +185,7 @@ def parse_departure_generic(
             description=description if description else None,
             agency=agency if agency else None,
             notices=notices if notices else None,
+            disruptions=disruptions if notices else None,
             planned_platform=str(planned_platform).strip() if planned_platform and platform_changed else None,
             platform_changed=platform_changed,
             platform_name=str(platform_name).strip() or None,

{python_openpublictransport-0.3.1 → python_openpublictransport-0.3.3}/src/openpublictransport/providers/hafas_mgate_base.py

@@ -327,11 +327,15 @@ class HafasMgateBaseProvider(BaseProvider):
         destination_id: str,
         departure_time: Optional[datetime] = None,
         results: int = 4,
+        arrival_time: Optional[datetime] = None,
     ) -> List[Dict[str, Any]]:
         """Plan journeys between two stops with the mgate ``TripSearch`` service.
 
         ``departure_time`` is converted to the network's time zone; without it
-        the search starts now. Returns one dict per connection::
+        the search starts now. ``arrival_time`` switches to an "arrive by"
+        search instead (like hafas-client's ``arrival`` option, ``outFrwd``
+        false): the connections that arrive by then. It wins over
+        ``departure_time``. Returns one dict per connection::
 
             {"duration_minutes": int, "transfers": int, "legs": [leg, ...]}
 
@@ -342,7 +346,7 @@ class HafasMgateBaseProvider(BaseProvider):
         (the unprefixed ones are real-time when the network reports it).
         """
         tz = ZoneInfo(self.timezone)
-        when = (departure_time or datetime.now(tz)).astimezone(tz)
+        when = (arrival_time or departure_time or datetime.now(tz)).astimezone(tz)
         svc = {
             "meth": "TripSearch",
             "req": {
@@ -350,7 +354,7 @@ class HafasMgateBaseProvider(BaseProvider):
                 "arrLocL": [self._location(destination_id)],
                 "outDate": when.strftime("%Y%m%d"),
                 "outTime": when.strftime("%H%M%S"),
-                "outFrwd": True,
+                "outFrwd": arrival_time is None,
                 "numF": results,
                 "getPasslist": False,
                 "getPolyline": False,

{python_openpublictransport-0.3.1 → python_openpublictransport-0.3.3}/src/python_openpublictransport.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-openpublictransport
-Version: 0.3.1
+Version: 0.3.3
 Summary: Python library for public transport APIs (EFA, OTP2, TRIAS, FPTF, HAFAS, GTFS-RT)
 License: MIT
 Requires-Python: >=3.11

{python_openpublictransport-0.3.1 → python_openpublictransport-0.3.3}/src/python_openpublictransport.egg-info/SOURCES.txt

@@ -81,6 +81,7 @@ src/python_openpublictransport.egg-info/requires.txt
 src/python_openpublictransport.egg-info/top_level.txt
 tests/test_cta.py
 tests/test_digitransit.py
+tests/test_disruptions.py
 tests/test_efa_mimetype.py
 tests/test_efa_platform.py
 tests/test_entur.py

python_openpublictransport-0.3.3/tests/test_disruptions.py

@@ -0,0 +1,101 @@
+"""Tests for telling disruptions apart from routine notices.
+
+EFA mixes routine timetable and vehicle information ("bicycles limited",
+"wheelchair accessible vehicle", "on-board restaurant") with real disruptions
+in the same ``hints`` list, so everything ended up in a red warning banner.
+See https://github.com/NerdySoftPaw/openpublictransport-card/issues/15.
+"""
+
+from datetime import datetime
+from zoneinfo import ZoneInfo
+
+from openpublictransport.models import UnifiedDeparture
+from openpublictransport.providers.gvh import GVHProvider
+
+TZ = ZoneInfo("Europe/Berlin")
+NOW = datetime(2026, 10, 16, 20, 0, tzinfo=TZ)
+
+
+def _stop_event(hints=None, infos=None) -> dict:
+    """A GVH departure from Hannover Hbf as the live API returns it."""
+    event = {
+        "location": {"id": "de:03241:31", "name": "Hauptbahnhof", "properties": {"platform": "8"}},
+        "departureTimePlanned": "2026-10-16T18:10:00Z",
+        "departureTimeEstimated": "2026-10-16T18:12:00Z",
+        "transportation": {
+            "name": "ICE 550 InterCityExpress",
+            "number": "550",
+            "destination": {"name": "Köln Hbf"},
+            "product": {"class": 0, "name": "ICE"},
+        },
+    }
+    if hints is not None:
+        event["hints"] = hints
+    if infos is not None:
+        event["infos"] = infos
+    return event
+
+
+def test_routine_hints_are_notices_but_not_disruptions():
+    """Timetable and VehicleType hints stay notices without becoming disruptions."""
+    event = _stop_event(hints=[
+        {"content": "behindertengerechtes Fahrzeug", "providerCode": "13", "type": "VehicleType"},
+        {"content": "Bordrestaurant", "providerCode": "BR", "type": "Timetable"},
+    ])
+    dep = GVHProvider(None).parse_departure(event, TZ, NOW)
+
+    assert dep.notices == ["behindertengerechtes Fahrzeug", "Bordrestaurant"]
+    assert dep.disruptions == []
+    result = dep.to_dict()
+    assert result["notices"] == ["behindertengerechtes Fahrzeug", "Bordrestaurant"]
+    assert result["disruptions"] == []
+
+
+def test_realtime_hints_and_infos_are_disruptions():
+    """Real-time incident hints and infos are disruptions; routine hints are not."""
+    event = _stop_event(
+        hints=[
+            {"content": "Bordrestaurant", "providerCode": "BR", "type": "Timetable"},
+            {"content": "Technische Störung am Zug", "providerCode": "x", "type": "RTIncidentCall"},
+        ],
+        infos=[{"type": "lineInfo", "priority": "normal", "title": "Bauarbeiten S1, S2, S5"}],
+    )
+    dep = GVHProvider(None).parse_departure(event, TZ, NOW)
+
+    assert dep.notices == ["Bauarbeiten S1, S2, S5", "Bordrestaurant", "Technische Störung am Zug"]
+    assert dep.disruptions == ["Bauarbeiten S1, S2, S5", "Technische Störung am Zug"]
+
+
+def test_hint_without_type_is_a_disruption():
+    """An unknown or missing hint type is kept as a disruption, never hidden."""
+    dep = GVHProvider(None).parse_departure(_stop_event(hints=[{"content": "Ersatzverkehr"}]), TZ, NOW)
+
+    assert dep.disruptions == ["Ersatzverkehr"]
+
+
+def test_no_notices_no_keys():
+    """Without notices, neither key appears in the attributes."""
+    dep = GVHProvider(None).parse_departure(_stop_event(), TZ, NOW)
+
+    assert dep.notices is None and dep.disruptions is None
+    assert "notices" not in dep.to_dict()
+    assert "disruptions" not in dep.to_dict()
+
+
+def test_unclassified_notices_all_count_as_disruptions():
+    """Providers that do not classify their notices report all of them as disruptions."""
+    dep = UnifiedDeparture(
+        line="U1",
+        destination="Somewhere",
+        departure_time="20:10",
+        planned_time="20:10",
+        delay=0,
+        platform=None,
+        transportation_type="subway",
+        is_realtime=True,
+        minutes_until_departure=10,
+        departure_time_obj=NOW,
+        notices=["Cancelled"],
+    )
+
+    assert dep.to_dict()["disruptions"] == ["Cancelled"]

{python_openpublictransport-0.3.1 → python_openpublictransport-0.3.3}/tests/test_german_regional_providers.py

@@ -202,3 +202,22 @@ async def test_search_trips_with_extid_and_empty_result():
 def test_german_category_labels(cat_out, cat_out_l, expected):
     prod = {"prodCtx": {"catOut": cat_out, "catOutL": cat_out_l}}
     assert VMTProvider(session=None)._transport_type(prod) == expected
+
+
+async def test_search_trips_arrive_by():
+    provider = NAHSHProvider(session=None)
+    provider._request = AsyncMock(return_value={"svcResL": [{"res": {}}]})
+
+    await provider.search_trips("A=1@L=1@", "A=1@L=2@", arrival_time=datetime(2026, 10, 17, 6, 0, tzinfo=ZoneInfo("UTC")))
+
+    req = json.loads(provider._request.call_args.kwargs["data"])["svcReqL"][0]["req"]
+    assert req["outFrwd"] is False
+    # 06:00 UTC is 08:00 in Berlin
+    assert (req["outDate"], req["outTime"]) == ("20261017", "080000")
+
+
+async def test_search_trips_departure_stays_forward():
+    provider = NAHSHProvider(session=None)
+    provider._request = AsyncMock(return_value={"svcResL": [{"res": {}}]})
+    await provider.search_trips("A=1@L=1@", "A=1@L=2@")
+    assert json.loads(provider._request.call_args.kwargs["data"])["svcReqL"][0]["req"]["outFrwd"] is True