summaryrefslogtreecommitdiff
path: root/searx/wikidata.py
blob: defb2a0bb0d597512ab5070b1db39061e7799f43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# SPDX-License-Identifier: AGPL-3.0-or-later
"""Shared methods for accessing Wikidata."""

import typing as t
from urllib.parse import urlencode

from searx.network import get, post
from searx.utils import gen_useragent


# SPARQL
SPARQL_ENDPOINT_URL = "https://query.wikidata.org/sparql"
SPARQL_EXPLAIN_URL = "https://query.wikidata.org/bigdata/namespace/wdq/sparql?explain"


def send_wikidata_query(query: str, method: str = "GET", **kwargs: dict[str, t.Any]) -> dict[str, t.Any]:
    if method == "GET":
        # query will be cached by wikidata
        http_response = get(
            SPARQL_ENDPOINT_URL + "?" + urlencode({"query": query}), headers=get_wikidata_headers(), **kwargs
        )
    else:
        # query won't be cached by wikidata
        http_response = post(SPARQL_ENDPOINT_URL, data={"query": query}, headers=get_wikidata_headers(), **kwargs)

    http_response.raise_for_status()
    return http_response.json()


def get_wikidata_headers() -> dict[str, str]:
    # user agent: https://www.mediawiki.org/wiki/Wikidata_Query_Service/User_Manual#Query_limits
    return {
        "Accept": "application/sparql-results+json",
        "User-Agent": gen_useragent(),
    }