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

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

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

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

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

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

@@ -328,6 +328,8 @@ class HafasMgateBaseProvider(BaseProvider):
         departure_time: Optional[datetime] = None,
         results: int = 4,
         arrival_time: Optional[datetime] = None,
+        via_id: Optional[str] = None,
+        via_dwell_minutes: Optional[int] = None,
     ) -> List[Dict[str, Any]]:
         """Plan journeys between two stops with the mgate ``TripSearch`` service.
 
@@ -335,7 +337,12 @@ class HafasMgateBaseProvider(BaseProvider):
         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::
+        ``departure_time``.
+
+        ``via_id`` routes every connection through that stop (mgate
+        ``viaLocL``); ``via_dwell_minutes`` asks for at least that long a stay
+        there (the entry's ``min``). Without a via the dwell time is ignored.
+        Returns one dict per connection::
 
             {"duration_minutes": int, "transfers": int, "legs": [leg, ...]}
 
@@ -360,6 +367,11 @@ class HafasMgateBaseProvider(BaseProvider):
                 "getPolyline": False,
             },
         }
+        if via_id:
+            via: Dict[str, Any] = {"loc": self._location(via_id)}
+            if via_dwell_minutes and via_dwell_minutes > 0:
+                via["min"] = int(via_dwell_minutes)
+            svc["req"]["viaLocL"] = [via]
         res = await self._mgate_request(svc)
         if not res:
             return []

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

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

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

@@ -221,3 +221,24 @@ async def test_search_trips_departure_stays_forward():
     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
+
+
+async def test_search_trips_via_with_dwell_time():
+    """A via stop goes into viaLocL; a dwell time becomes its minimum stay."""
+    provider = NAHSHProvider(session=None)
+    provider._request = AsyncMock(return_value={"svcResL": [{"res": {}}]})
+
+    await provider.search_trips("A=1@L=1@", "A=1@L=2@", via_id="A=1@L=3@", via_dwell_minutes=30)
+    req = json.loads(provider._request.call_args.kwargs["data"])["svcReqL"][0]["req"]
+    assert req["viaLocL"] == [{"loc": {"lid": "A=1@L=3@"}, "min": 30}]
+
+    await provider.search_trips("A=1@L=1@", "A=1@L=2@", via_id="8000323")
+    req = json.loads(provider._request.call_args.kwargs["data"])["svcReqL"][0]["req"]
+    assert req["viaLocL"] == [{"loc": {"type": "S", "extId": "8000323"}}]
+
+
+async def test_search_trips_without_via_sends_no_via():
+    provider = NAHSHProvider(session=None)
+    provider._request = AsyncMock(return_value={"svcResL": [{"res": {}}]})
+    await provider.search_trips("A=1@L=1@", "A=1@L=2@", via_dwell_minutes=15)
+    assert "viaLocL" not in json.loads(provider._request.call_args.kwargs["data"])["svcReqL"][0]["req"]