Skip to content

parse_discovery

parse_discovery

parse_discovery(doc: dict, language: str | None = None) -> tuple[dict[str, str], str]

Parse a gbfs.json auto-discovery document → ({feed_name: url}, version).

Handles GBFS 2.x (data keyed by language) and 3.x (data.feeds directly).

See Also

resolve : Resolve the discovery URL first. GBFSFeed : The feed object it underpins.

Source code in src/gbfs_toolkit/io/fetch.py
def parse_discovery(doc: dict, language: str | None = None) -> tuple[dict[str, str], str]:
    """Parse a ``gbfs.json`` auto-discovery document → ({feed_name: url}, version).

    Handles GBFS 2.x (``data`` keyed by language) and 3.x (``data.feeds`` directly).

    See Also
    --------
    [`resolve`][gbfs_toolkit.resolve] : Resolve the discovery URL first.
    [`GBFSFeed`][gbfs_toolkit.GBFSFeed] : The feed object it underpins.
    """
    version = str(doc.get("version", "2.x"))
    data = doc.get("data", {})
    if isinstance(data, dict) and "feeds" in data:  # GBFS 3.x
        feeds = data["feeds"]
    elif isinstance(data, dict) and data:  # GBFS 1.x / 2.x, keyed by language
        key = language if (language and language in data) else next(iter(data))
        feeds = data.get(key, {}).get("feeds", [])
    else:
        feeds = []
    mapping = {f.get("name"): f.get("url") for f in feeds if f.get("name") and f.get("url")}
    return mapping, version