Functions
	init (_)
str	_base_url ()
	request (query, params)
	response (resp)

Variables
dict	about
list	categories = ['general']
bool	paging = True
int	number_of_results = 10
str	http_digest_auth_user = ""
str	http_digest_auth_pass = ""
str	search_mode = 'global'
str	search_type = 'text'
list	base_url = 'https://yacy.searchlab.eu'

Detailed Description

YaCy_ is a free distributed search engine, built on the principles of
peer-to-peer (P2P) networks.

API: Dev:APIyacysearch_

Releases:

- https://github.com/yacy/yacy_search_server/tags
- https://download.yacy.net/

.. _Yacy: https://yacy.net/
.. _Dev:APIyacysearch: https://wiki.yacy.net/index.php/Dev:APIyacysearch

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

The engine has the following (additional) settings:

- :py:obj:`http_digest_auth_user`
- :py:obj:`http_digest_auth_pass`
- :py:obj:`search_mode`
- :py:obj:`search_type`

The :py:obj:`base_url` has to be set in the engine named `yacy` and is used by
all yacy engines.

.. code:: yaml

  - name: yacy
    engine: yacy
    categories: general
    search_type: text
    shortcut: ya
    base_url:
      - https://yacy.searchlab.eu
      - https://search.lomig.me
      - https://yacy.ecosys.eu
      - https://search.webproject.link

  - name: yacy images
    engine: yacy
    categories: images
    search_type: image
    shortcut: yai
    disabled: true


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

Function Documentation

◆ _base_url()

str searx.engines.yacy._base_url ( )

protected

Definition at line 114 of file yacy.py.

def _base_url() -> str:
    from searx.engines import engines  # pylint: disable=import-outside-toplevel
 
    url = engines['yacy'].base_url  # type: ignore
    if isinstance(url, list):
        url = random.choice(url)
    if url.endswith("/"):
        url = url[:-1]
    return url
 
 

◆ init()

searx.engines.yacy.init ( _ )

Definition at line 104 of file yacy.py.

def init(_):
    valid_types = [
        'text',
        'image',
        # 'app', 'audio', 'video',
    ]
    if search_type not in valid_types:
        raise ValueError('search_type "%s" is  not one of %s' % (search_type, valid_types))
 
 

◆ request()

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

Definition at line 125 of file yacy.py.

def request(query, params):
 
    offset = (params['pageno'] - 1) * number_of_results
    args = {
        'query': query,
        'startRecord': offset,
        'maximumRecords': number_of_results,
        'contentdom': search_type,
        'resource': search_mode,
    }
 
    # add language tag if specified
    if params['language'] != 'all':
        args['lr'] = 'lang_' + params['language'].split('-')[0]
 
    params["url"] = f"{_base_url()}/yacysearch.json?{urlencode(args)}"
 
    if http_digest_auth_user and http_digest_auth_pass:
        params['auth'] = DigestAuth(http_digest_auth_user, http_digest_auth_pass)
 
    return params
 
 

◆ response()

searx.engines.yacy.response ( resp )

Definition at line 148 of file yacy.py.

def response(resp):
    results = []
 
    raw_search_results = loads(resp.text)
 
    # return empty array if there are no results
    if not raw_search_results:
        return []
 
    search_results = raw_search_results.get('channels', [])
 
    if len(search_results) == 0:
        return []
 
    for result in search_results[0].get('items', []):
        # parse image results
        if search_type == 'image':
            result_url = ''
            if 'url' in result:
                result_url = result['url']
            elif 'link' in result:
                result_url = result['link']
            else:
                continue
 
            # append result
            results.append(
                {
                    'url': result_url,
                    'title': result['title'],
                    'content': '',
                    'img_src': result['image'],
                    'template': 'images.html',
                }
            )
 
        # parse general results
        else:
            publishedDate = None
            if 'pubDate' in result:
                publishedDate = parser.parse(result['pubDate'])
 
            # append result
            results.append(
                {
                    'url': result['link'] or '',
                    'title': result['title'],
                    'content': html_to_text(result['description']),
                    'publishedDate': publishedDate,
                }
            )
 
        # TODO parse video, audio and file results
 
    return results

Variable Documentation

◆ about

dict searx.engines.yacy.about

Initial value:

=  {
    "website": 'https://yacy.net/',
    "wikidata_id": 'Q1759675',
    "official_api_documentation": 'https://wiki.yacy.net/index.php/Dev:API',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 65 of file yacy.py.

◆ base_url

list searx.engines.yacy.base_url = 'https://yacy.searchlab.eu'

Definition at line 98 of file yacy.py.

◆ categories

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

Definition at line 75 of file yacy.py.

◆ http_digest_auth_pass

str searx.engines.yacy.http_digest_auth_pass = ""

Definition at line 80 of file yacy.py.

◆ http_digest_auth_user

str searx.engines.yacy.http_digest_auth_user = ""

Definition at line 78 of file yacy.py.

◆ number_of_results

int searx.engines.yacy.number_of_results = 10

Definition at line 77 of file yacy.py.

◆ paging

bool searx.engines.yacy.paging = True

Definition at line 76 of file yacy.py.

◆ search_mode

str searx.engines.yacy.search_mode = 'global'

Definition at line 83 of file yacy.py.

◆ search_type

str searx.engines.yacy.search_type = 'text'

Definition at line 93 of file yacy.py.

Functions

Variables