searx.engines.piped Namespace Reference

Functions
str	_backend_url ()
str	_frontend_url ()
	request (query, params)
	response (resp)

Variables
dict	about
list	categories = []
bool	paging = True
list	backend_url = None
str	frontend_url = None
str	piped_filter = 'all'

Detailed Description

An alternative privacy-friendly YouTube frontend which is efficient by
design.  `Piped’s architecture`_ consists of 3 components:

- :py:obj:`backend <backend_url>`
- :py:obj:`frontend <frontend_url>`
- proxy

.. _Piped’s architecture: https://docs.piped.video/docs/architecture/

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

The :py:obj:`backend_url` and :py:obj:`frontend_url` has to be set in the engine
named `piped` and are used by all ``piped`` engines (unless an individual values
for ``backend_url`` and ``frontend_url`` are configured for the engine).


.. code:: yaml

  - name: piped
    engine: piped
    piped_filter: videos
    ...
    frontend_url: https://..
    backend_url:
      - https://..
      - https://..

  - name: piped.music
    engine: piped
    network: piped
    shortcut: ppdm
    piped_filter: music_songs
    ...

Known Quirks
============

The implementation to support :py:obj:`paging <searx.enginelib.Engine.paging>`
is based on the *nextpage* method of Piped's REST API / the :py:obj:`frontend
API <frontend_url>`.  This feature is *next page driven* and plays well with the
:ref:`infinite_scroll <settings ui>` setting in SearXNG but it does not really
fit into SearXNG's UI to select a page by number.

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

Function Documentation

_backend_url()

str searx.engines.piped._backend_url ( )

protected

Definition at line 96 of file piped.py.

def _backend_url() -> str:
    from searx.engines import engines  # pylint: disable=import-outside-toplevel
 
    url: list[str] | str = backend_url or engines["piped"].backend_url  # type: ignore
    if isinstance(url, list):
        url = random.choice(url)
    return url
 
 

Referenced by request().

Here is the caller graph for this function:

_frontend_url()

str searx.engines.piped._frontend_url ( )

protected

Definition at line 105 of file piped.py.

def _frontend_url() -> str:
    from searx.engines import engines  # pylint: disable=import-outside-toplevel
 
    return frontend_url or engines["piped"].frontend_url  # type: ignore
 
 

Referenced by response().

Here is the caller graph for this function:

request()

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

Definition at line 111 of file piped.py.

def request(query, params):
 
    args = {
        'q': query,
        'filter': piped_filter,
    }
 
    path = "/search"
    if params['pageno'] > 1:
        # don't use nextpage when user selected to jump back to page 1
        nextpage = params['engine_data'].get('nextpage')
        if nextpage:
            path = "/nextpage/search"
            args['nextpage'] = nextpage
 
    params["url"] = _backend_url() + f"{path}?" + urlencode(args)
    return params
 
 

References _backend_url().

Here is the call graph for this function:

response()

searx.engines.piped.response

(

resp

)

Definition at line 130 of file piped.py.

def response(resp):
    results = []
 
    json = resp.json()
 
    for result in json["items"]:
        # note: piped returns -1 for all upload times when filtering for music
        uploaded = result.get("uploaded", -1)
 
        item = {
            # the api url differs from the frontend, hence use piped.video as default
            "url": _frontend_url() + result.get("url", ""),
            "title": result.get("title", ""),
            "publishedDate": parser.parse(time.ctime(uploaded / 1000)) if uploaded != -1 else None,
            "iframe_src": _frontend_url() + '/embed' + result.get("url", ""),
            "views": humanize_number(result["views"]),
        }
        length = result.get("duration")
        if length:
            item["length"] = datetime.timedelta(seconds=length)
 
        if piped_filter == 'videos':
            item["template"] = "videos.html"
            # if the value of shortDescription set, but is None, return empty string
            item["content"] = result.get("shortDescription", "") or ""
            item["thumbnail"] = result.get("thumbnail", "")
 
        elif piped_filter == 'music_songs':
            item["template"] = "default.html"
            item["thumbnail"] = result.get("thumbnail", "")
            item["content"] = result.get("uploaderName", "") or ""
 
        results.append(item)
 
    results.append(
        {
            "engine_data": json["nextpage"],
            "key": "nextpage",
        }
    )
    return results

References _frontend_url().

Here is the call graph for this function:

Variable Documentation

about

dict searx.engines.piped.about

Initial value:

=  {
    "website": 'https://github.com/TeamPiped/Piped/',
    "wikidata_id": 'Q107565255',
    "official_api_documentation": 'https://docs.piped.video/docs/api-documentation/',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 61 of file piped.py.

backend_url

list searx.engines.piped.backend_url = None

Definition at line 75 of file piped.py.

categories

list searx.engines.piped.categories = []

Definition at line 71 of file piped.py.

frontend_url

str searx.engines.piped.frontend_url = None

Definition at line 86 of file piped.py.

paging

bool searx.engines.piped.paging = True

Definition at line 72 of file piped.py.

piped_filter

str searx.engines.piped.piped_filter = 'all'

Definition at line 92 of file piped.py.