Functions
None	request (str query, "OnlineParams" params)
EngineResults	response ("SXNG_Response" resp)
datetime\|None	_parse_date (str date)

Variables
dict	about
bool	paging = True
list	categories = ["general", "books"]
str	base_url = "https://openlibrary.org"
str	search_api = "https://openlibrary.org/search.json"
int	results_per_page = 10

Detailed Description

`Open Library`_ is an open, editable library catalog, building towards a web
page for every book ever published.

.. _Open Library: https://openlibrary.org

Configuration
=============

The service sometimes takes a very long time to respond, the ``timeout`` may
need to be adjusted.

.. code:: yaml

  - name: openlibrary
    engine: openlibrary
    shortcut: ol
    timeout: 10


Implementations
===============

Function Documentation

◆ _parse_date()

datetime | None searx.engines.openlibrary._parse_date ( str date )

protected

Definition at line 103 of file openlibrary.py.

def _parse_date(date: str) -> datetime | None:
    if not date:
        return None
    try:
        return parser.parse(date)
    except parser.ParserError:
        return None

Referenced by response().

Here is the caller graph for this function:

◆ request()

None searx.engines.openlibrary.request	(	str	query,
		"OnlineParams"	params )

Definition at line 58 of file openlibrary.py.

def request(query: str, params: "OnlineParams") -> None:
    args = {
        "q": query,
        "page": params["pageno"],
        "limit": results_per_page,
        "fields": "*",
    }
    params["url"] = f"{search_api}?{urlencode(args)}"
    logger.debug("REST API: %s", params["url"])
 
 

◆ response()

EngineResults searx.engines.openlibrary.response ( "SXNG_Response" resp )

Definition at line 69 of file openlibrary.py.

def response(resp: "SXNG_Response") -> EngineResults:
    res = EngineResults()
    json_data = resp.json()
 
    for item in json_data.get("docs", []):
        cover = ""
        if "lending_identifier_s" in item:
            cover = f"https://archive.org/services/img/{item['lending_identifier_s']}"
 
        published = item.get("publish_date")
        if published:
            published_dates = [date for date in map(_parse_date, published) if date]
            if published_dates:
                published = min(published_dates)
 
        if not published:
            published = _parse_date(str(item.get("first_publish_year")))
 
        content = " / ".join(item.get("first_sentence", []))
        res.add(
            res.types.Paper(
                url=f"{base_url}/{item['key']}",
                title=item["title"],
                content=content,
                isbn=item.get("isbn", [])[:5],
                authors=item.get("author_name", []),
                thumbnail=cover,
                publishedDate=published,
                tags=item.get("subject", [])[:10] + item.get("place", [])[:10],
            )
        )
    return res
 
 

References _parse_date().

Here is the call graph for this function:

Variable Documentation

◆ about

dict searx.engines.openlibrary.about

Initial value:

=  {
    "website": "https://openlibrary.org",
    "wikidata_id": "Q1201876",
    "require_api_key": False,
    "use_official_api": False,
    "official_api_documentation": "https://openlibrary.org/developers/api",
}

Definition at line 38 of file openlibrary.py.

◆ base_url

str searx.engines.openlibrary.base_url = "https://openlibrary.org"

Definition at line 49 of file openlibrary.py.

◆ categories

list searx.engines.openlibrary.categories = ["general", "books"]

Definition at line 47 of file openlibrary.py.

◆ paging

bool searx.engines.openlibrary.paging = True

Definition at line 46 of file openlibrary.py.

◆ results_per_page

int searx.engines.openlibrary.results_per_page = 10

Definition at line 55 of file openlibrary.py.

◆ search_api

str searx.engines.openlibrary.search_api = "https://openlibrary.org/search.json"

Definition at line 50 of file openlibrary.py.

Functions

Variables