Method get_paginated

beetsplug/tidal/api.py:198–230

Perform a GET request to the Tidal API with pagination resolution.

(
        self,
        url: str,
        include: list[str] | str | None = None,
        params: dict[str, Any] | None = None,
        **kwargs,
    )

        return a

    def get_paginated(
        self,
        url: str,
        include: list[str] | str | None = None,
        params: dict[str, Any] | None = None,
        **kwargs,
    ) -> Document[list[Any]]:
        """
        Perform a GET request to the Tidal API with pagination resolution.
        """
        include = include or []
        params = params or {}

        doc: Document[list[Any]] = {
            "data": [],
            "included": [],
            "links": {"next": url},
        }

        while next_ := doc.get("links", {}).get("next"):
            page_doc = self.get_json(
                url=next_, params={**params, "include": include}, **kwargs
            )
            doc = self.merge_multiresource_pagination(doc, page_doc)

        # Dedupe include
        doc["included"] = list(
            {
                (item["type"], item["id"]): item
                for item in doc.get("included", [])
            }.values()
        )
        return doc