.oO SearXNG Developer Documentation Oo.
Loading...
Searching...
No Matches
searx.extended_types Namespace Reference

Classes

class  SXNG_Request
 
class  SXNG_Response
 

Variables

list __all__ = ["SXNG_Request", "sxng_request", "SXNG_Response"]
 
 sxng_request = typing.cast(SXNG_Request, flask.request)
 

Detailed Description

This module implements the type extensions applied by SearXNG.

- :py:obj:`flask.request` is replaced by :py:obj:`sxng_request`
- :py:obj:`flask.Request` is replaced by :py:obj:`SXNG_Request`
- :py:obj:`httpx.response` is replaced by :py:obj:`SXNG_Response`

----

.. py:attribute:: sxng_request
   :type: SXNG_Request

   A replacement for :py:obj:`flask.request` with type cast :py:obj:`SXNG_Request`.

.. autoclass:: SXNG_Request
   :members:

.. autoclass:: SXNG_Response
   :members:

Variable Documentation

◆ __all__

list searx.extended_types.__all__ = ["SXNG_Request", "sxng_request", "SXNG_Response"]
private

Definition at line 25 of file extended_types.py.

◆ sxng_request

searx.extended_types.sxng_request = typing.cast(SXNG_Request, flask.request)

Definition at line 67 of file extended_types.py.