python-openpublictransport 0.1.10__tar.gz → 0.1.12__tar.gz

{python_openpublictransport-0.1.10 → python_openpublictransport-0.1.12}/PKG-INFO

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

{python_openpublictransport-0.1.10 → python_openpublictransport-0.1.12}/pyproject.toml

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

{python_openpublictransport-0.1.10 → python_openpublictransport-0.1.12}/src/openpublictransport/providers/national_rail.py

@@ -4,6 +4,7 @@ Stop search uses the Overpass API (OSM) to find UK railway stations with
 ref:crs tags, returning the 3-letter CRS code used by OpenLDBWS.
 """
 
+import asyncio
 import json
 import logging
 import re
@@ -22,8 +23,16 @@ from .base import BaseProvider
 
 _LOGGER = logging.getLogger(__name__)
 
-_ENDPOINT = "https://lite.realtime.nationalrail.co.uk/OpenLDBWS/ldb11.asmx"
-_SOAP_ACTION = "http://thalesgroup.com/RTTI/2017-10-01/ldb/GetDepartureBoard"
+# Use the same LDBWS version triple as the reference OpenLDBWS clients:
+#   endpoint  = ldb12.asmx  (WSDL ver=2021-11-01)
+#   body ns   = 2021-11-01/ldb/
+#   SOAPAction= 2012-01-13/ldb/GetDepartureBoard
+# The SOAPAction is version-pinned to 2012-01-13 (it does NOT track the body's
+# ldb version); sending a mismatched SOAPAction makes the ASMX service reject the
+# request with an HTTP 500 SOAP fault ("did not recognize the value of the
+# SOAPAction header").
+_ENDPOINT = "https://lite.realtime.nationalrail.co.uk/OpenLDBWS/ldb12.asmx"
+_SOAP_ACTION = "http://thalesgroup.com/RTTI/2012-01-13/ldb/GetDepartureBoard"
 _OVERPASS_URL = "https://overpass-api.de/api/interpreter"
 
 # UK bounding box (lat_min, lon_min, lat_max, lon_max)
@@ -31,7 +40,7 @@ _UK_BBOX = "49,-11,62,2"
 
 _SOAP_TEMPLATE = """<?xml version="1.0" encoding="UTF-8"?>
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
-               xmlns:ldb="http://thalesgroup.com/RTTI/2017-10-01/ldb/"
+               xmlns:ldb="http://thalesgroup.com/RTTI/2021-11-01/ldb/"
                xmlns:tok="http://thalesgroup.com/RTTI/2013-11-28/Token/types">
   <soap:Header>
     <tok:AccessToken>
@@ -81,6 +90,16 @@ def _static_result(station: Dict[str, Any]) -> Dict[str, Any]:
     }
 
 
+def _soap_fault_string(body: str) -> str:
+    """Best-effort extraction of a SOAP fault reason from an error response."""
+    if not body:
+        return ""
+    m = re.search(r"<(?:\w+:)?(?:faultstring|Text|Reason)[^>]*>(.*?)</", body, re.DOTALL | re.IGNORECASE)
+    if m:
+        return m.group(1).strip()[:200]
+    return body.strip()[:200]
+
+
 def _strip_namespaces(xml_string: str) -> str:
     """Remove XML namespace prefixes and declarations for simpler parsing.
 
@@ -167,7 +186,21 @@ class NationalRailProvider(BaseProvider):
                         f"{self.provider_name}: authentication failed (HTTP {resp.status}) — check API key"
                     )
                 if resp.status != 200:
-                    _LOGGER.warning("%s: HTTP %s for CRS %s", self.provider_name, resp.status, crs)
+                    # Surface the SOAP fault reason (HTTP 500) instead of hiding it,
+                    # so genuine request/token faults are diagnosable.
+                    body = ""
+                    try:
+                        body = await resp.text()
+                    except Exception:  # pragma: no cover - defensive
+                        pass
+                    fault = _soap_fault_string(body)
+                    _LOGGER.warning(
+                        "%s: HTTP %s for CRS %s%s",
+                        self.provider_name,
+                        resp.status,
+                        crs,
+                        f" — {fault}" if fault else "",
+                    )
                     return None
                 text = await resp.text()
         except Exception as exc:
@@ -320,8 +353,11 @@ class NationalRailProvider(BaseProvider):
         """Find UK railway stations with their CRS codes.
 
         The live Overpass API (OpenStreetMap) is the source of truth. Only if it
-        is unreachable, rate-limited, or returns nothing do we fall back to a
-        bundled offline snapshot — see :func:`_load_static_stations`.
+        is unreachable or rate-limited (a *failure*, not a successful empty
+        result) do we fall back to a bundled offline snapshot — see
+        :func:`_load_static_stations`. When Overpass succeeds and legitimately
+        finds nothing, we return that empty result rather than serving
+        potentially out-of-date snapshot data.
 
         A search term that looks like a 3-letter CRS code (e.g. "WIN", "RDG")
         is matched directly against the CRS code; anything else is matched
@@ -332,14 +368,15 @@ class NationalRailProvider(BaseProvider):
             return []
 
         results = await self._search_overpass(term)
-        if results:
+        if results is not None:
+            # Overpass answered authoritatively (possibly with zero matches).
             return results
 
-        # Overpass down / throttled / empty → use the offline snapshot.
-        fallback = self._search_static(term)
+        # Overpass failed (unreachable / throttled) → use the offline snapshot.
+        fallback = await self._search_static(term)
         if fallback:
             _LOGGER.info(
-                "%s: Overpass returned nothing for %r — served %d result(s) from the "
+                "%s: Overpass unavailable for %r — served %d result(s) from the "
                 "bundled station snapshot (may be out of date)",
                 self.provider_name,
                 term,
@@ -347,9 +384,14 @@ class NationalRailProvider(BaseProvider):
             )
         return fallback
 
-    def _search_static(self, term: str) -> List[Dict[str, Any]]:
-        """Match ``term`` against the bundled offline station snapshot."""
-        stations = _load_static_stations()
+    async def _search_static(self, term: str) -> List[Dict[str, Any]]:
+        """Match ``term`` against the bundled offline station snapshot.
+
+        The snapshot is read from disk on first use; that read is dispatched to
+        an executor so it never blocks the event loop (results are cached, so
+        subsequent calls do no I/O).
+        """
+        stations = await asyncio.get_running_loop().run_in_executor(None, _load_static_stations)
         if not stations:
             return []
 
@@ -369,8 +411,13 @@ class NationalRailProvider(BaseProvider):
                         break
         return results[:10]
 
-    async def _search_overpass(self, term: str) -> List[Dict[str, Any]]:
-        """Query the live Overpass API for UK stations matching ``term``."""
+    async def _search_overpass(self, term: str) -> Optional[List[Dict[str, Any]]]:
+        """Query the live Overpass API for UK stations matching ``term``.
+
+        Returns a (possibly empty) list on a successful query, or ``None`` if
+        the request failed (non-200 / exception) so the caller can decide
+        whether to fall back to the offline snapshot.
+        """
         if re.fullmatch(r"[A-Za-z]{3}", term):
             # Direct CRS code lookup (ref:crs is stored uppercase in OSM)
             query = f"""[out:json][timeout:15];
@@ -397,11 +444,11 @@ out 10;"""
             ) as resp:
                 if resp.status != 200:
                     _LOGGER.warning("%s: Overpass HTTP %s", self.provider_name, resp.status)
-                    return []
+                    return None
                 data = await resp.json(content_type=None)
         except Exception as exc:
             _LOGGER.warning("%s: stop search failed: %s", self.provider_name, exc)
-            return []
+            return None
 
         results = []
         for element in data.get("elements", []):

{python_openpublictransport-0.1.10 → python_openpublictransport-0.1.12}/src/python_openpublictransport.egg-info/PKG-INFO

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

{python_openpublictransport-0.1.10 → python_openpublictransport-0.1.12}/tests/test_national_rail_parse.py

@@ -55,6 +55,13 @@ SAMPLE = """<?xml version="1.0" encoding="utf-8"?>
 </soap:Envelope>"""
 
 
+def test_ldbws_request_uses_consistent_version_triple():
+    """SOAPAction must be the 2012-01-13 value; a mismatch yields HTTP 500."""
+    assert nr._ENDPOINT.endswith("ldb12.asmx")
+    assert nr._SOAP_ACTION == "http://thalesgroup.com/RTTI/2012-01-13/ldb/GetDepartureBoard"
+    assert 'xmlns:ldb="http://thalesgroup.com/RTTI/2021-11-01/ldb/"' in nr._SOAP_TEMPLATE
+
+
 def test_strip_namespaces_handles_digit_prefixes():
     """Digit-bearing prefixes must be stripped so the XML parses."""
     stripped = nr._strip_namespaces(SAMPLE)

{python_openpublictransport-0.1.10 → python_openpublictransport-0.1.12}/tests/test_national_rail_static.py

@@ -34,6 +34,8 @@ class _Session:
         self.calls += 1
         if self.mode == "down":
             return _Resp(429, None)
+        if self.mode == "empty":
+            return _Resp(200, {"elements": []})
         payload = {
             "elements": [
                 {"tags": {"railway": "station", "ref:crs": "WIN",
@@ -45,23 +47,23 @@ class _Session:
 
 def test_snapshot_loads_and_has_known_stations():
     stations = nr._load_static_stations()
-    assert len(stations) > 2000
+    assert stations  # loads and is non-empty
     by_crs = {s["crs"]: s for s in stations}
     assert by_crs["WIN"]["name"] == "Winchester"
     assert by_crs["RDG"]["name"] == "Reading"
 
 
-def test_static_search_by_crs_code():
+async def test_static_search_by_crs_code():
     provider = NationalRailProvider(_Session("down"))
-    results = provider._search_static("rdg")
+    results = await provider._search_static("rdg")
     assert results == [
         {"id": "RDG", "name": "Reading", "place": "Network Rail", "area_type": "stop"}
     ]
 
 
-def test_static_search_by_name():
+async def test_static_search_by_name():
     provider = NationalRailProvider(_Session("down"))
-    results = provider._search_static("winchester")
+    results = await provider._search_static("winchester")
     assert any(r["id"] == "WIN" and r["name"] == "Winchester" for r in results)
 
 
@@ -73,6 +75,15 @@ async def test_overpass_success_does_not_use_fallback():
     assert results[0]["name"] == "Winchester Overpass"
 
 
+async def test_overpass_empty_result_does_not_fall_back():
+    """A successful but empty Overpass result must NOT serve stale snapshot data."""
+    session = _Session("empty")
+    provider = NationalRailProvider(session)
+    results = await provider.search_stops("WIN")
+    assert session.calls == 1  # Overpass was queried
+    assert results == []  # authoritative "no match" — snapshot not consulted
+
+
 async def test_falls_back_to_snapshot_when_overpass_down():
     session = _Session("down")
     provider = NationalRailProvider(session)