Functions
	request (query, params)

	response (resp)

Variables
logging	logger .Logger

dict	about

list	categories = ['general']

bool	paging = True

int	number_of_results = 5

str	search_type = 'nearmatch'

bool	srenablerewrites = True

str	srsort = 'relevance'

str	srprop = 'sectiontitle\|snippet\|timestamp\|categorysnippet'

str	base_url = 'https://{language}.wikipedia.org/'

str	api_path = 'w/api.php'

str	timestamp_format = '%Y-%m-%dT%H:%M:%SZ'

Detailed Description

The MediaWiki engine is a *generic* engine to **query** Wikimedia wikis by
the `MediaWiki Action API`_.  For a `query action`_ all Wikimedia wikis have
endpoints that follow this pattern::

    https://{base_url}/w/api.php?action=query&list=search&format=json

.. note::

   In its actual state, this engine is implemented to parse JSON result
   (`format=json`_) from a search query (`list=search`_).  If you need other
   ``action`` and ``list`` types ask SearXNG developers to extend the
   implementation according to your needs.

.. _MediaWiki Action API: https://www.mediawiki.org/wiki/API:Main_page
.. _query action: https://www.mediawiki.org/w/api.php?action=help&modules=query
.. _`list=search`: https://www.mediawiki.org/w/api.php?action=help&modules=query%2Bsearch
.. _`format=json`: https://www.mediawiki.org/w/api.php?action=help&modules=json

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

Request:

- :py:obj:`base_url`
- :py:obj:`search_type`
- :py:obj:`srenablerewrites`
- :py:obj:`srsort`
- :py:obj:`srprop`

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

Function Documentation

◆ request()

searx.engines.mediawiki.request	(		query,
			params )

Definition at line 113 of file mediawiki.py.

def request(query, params):
 
    # write search-language back to params, required in response
 
    if params['language'] == 'all':
        params['language'] = 'en'
    else:
        params['language'] = params['language'].split('-')[0]
 
    api_url = f"{base_url.rstrip('/')}/{api_path}?".format(language=params['language'])
    offset = (params['pageno'] - 1) * number_of_results
 
    args = {
        'action': 'query',
        'list': 'search',
        'format': 'json',
        'srsearch': query,
        'sroffset': offset,
        'srlimit': number_of_results,
        'srwhat': search_type,
        'srprop': srprop,
        'srsort': srsort,
    }
    if srenablerewrites:
        args['srenablerewrites'] = '1'
 
    params['url'] = api_url + urlencode(args)
    return params
 
 
# get response from search-request

References searx.format.

◆ response()

searx.engines.mediawiki.response ( resp )

Definition at line 144 of file mediawiki.py.

def response(resp):
 
    results = []
    search_results = resp.json()
 
    # return empty array if there are no results
    if not search_results.get('query', {}).get('search'):
        return []
 
    for result in search_results['query']['search']:
 
        if result.get('snippet', '').startswith('#REDIRECT'):
            continue
 
        title = result['title']
        sectiontitle = result.get('sectiontitle')
        content = html_to_text(result.get('snippet', ''))
        metadata = html_to_text(result.get('categorysnippet', ''))
        timestamp = result.get('timestamp')
 
        url = (
            base_url.format(language=resp.search_params['language']) + 'wiki/' + quote(title.replace(' ', '_').encode())
        )
        if sectiontitle:
            # in case of sectiontitle create a link to the section in the wiki page
            url += '#' + quote(sectiontitle.replace(' ', '_').encode())
            title += ' / ' + sectiontitle
 
        item = {'url': url, 'title': title, 'content': content, 'metadata': metadata}
 
        if timestamp:
            item['publishedDate'] = datetime.strptime(timestamp, timestamp_format)
 
        results.append(item)
 
    # return results
    return results

Variable Documentation

◆ about

dict searx.engines.mediawiki.about

Initial value:

=  {
    "website": None,
    "wikidata_id": None,
    "official_api_documentation": 'https://www.mediawiki.org/w/api.php?action=help&modules=query',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 52 of file mediawiki.py.

◆ api_path

str searx.engines.mediawiki.api_path = 'w/api.php'

Definition at line 103 of file mediawiki.py.

◆ base_url

str searx.engines.mediawiki.base_url = 'https://{language}.wikipedia.org/'

Definition at line 96 of file mediawiki.py.

◆ categories

list searx.engines.mediawiki.categories = ['general']

Definition at line 62 of file mediawiki.py.

◆ logger

logging searx.engines.mediawiki.logger .Logger

Definition at line 47 of file mediawiki.py.

◆ number_of_results

int searx.engines.mediawiki.number_of_results = 5

Definition at line 64 of file mediawiki.py.

◆ paging

bool searx.engines.mediawiki.paging = True

Definition at line 63 of file mediawiki.py.

◆ search_type

str searx.engines.mediawiki.search_type = 'nearmatch'

Definition at line 66 of file mediawiki.py.

◆ srenablerewrites

bool searx.engines.mediawiki.srenablerewrites = True

Definition at line 73 of file mediawiki.py.

◆ srprop

str searx.engines.mediawiki.srprop = 'sectiontitle|snippet|timestamp|categorysnippet'

Definition at line 90 of file mediawiki.py.

◆ srsort

str searx.engines.mediawiki.srsort = 'relevance'

Definition at line 81 of file mediawiki.py.

◆ timestamp_format

str searx.engines.mediawiki.timestamp_format = '%Y-%m-%dT%H:%M:%SZ'

Definition at line 109 of file mediawiki.py.

Functions

Variables