Method query

openlibrary/api.py:174–209

Query Open Library. Open Library always limits the result to 1000 items due to performance issues. Pass limit=False to fetch all matching results by making multiple requests to the server. Please note that an iterator is returned instead of list when limit=False is

(self, q=None, **kw)

        return self._call_write("new", query, comment, action)

    def query(self, q=None, **kw):
        """Query Open Library.

        Open Library always limits the result to 1000 items due to
        performance issues. Pass limit=False to fetch all matching
        results by making multiple requests to the server. Please note
        that an iterator is returned instead of list when limit=False is
        passed.::

            >>> ol.query({'type': '/type/type', 'limit': 2}) #doctest: +SKIP
            [{'key': '/type/property'}, {'key': '/type/type'}]

            >>> ol.query(type='/type/type', limit=2) #doctest: +SKIP
            [{'key': '/type/property'}, {'key': '/type/type'}]
        """
        q = dict(q or {})
        q.update(kw)
        q = marshal(q)

        def unlimited_query(q):
            q["limit"] = 1000
            q.setdefault("offset", 0)
            q.setdefault("sort", "key")

            while True:
                result = self.query(q)
                yield from result
                if len(result) < 1000:
                    break
                q["offset"] += len(result)

        if "limit" in q and q["limit"] is False:
            return unlimited_query(q)
        else:
            response = self._request("/query.json", params={"query": json.dumps(q)})
            return unmarshal(response.json())

    def search(self, query, limit=10, offset=0, fields: list[str] | None = None):
        return self._request(