searx.enginelib Namespace Reference

Namespaces
namespace	__main__
namespace	traits

Classes
class	Engine
class	EngineCache

Functions
	state ()
	maintenance (bool force=True)

Variables
list	__all__ = ["EngineCache", "Engine", "ENGINES_CACHE"]
ExpireCacheSQLite	ENGINES_CACHE
	app = typer.Typer()

Detailed Description

Implementations of the framework for the SearXNG engines.

- :py:obj:`searx.enginelib.EngineCache`
- :py:obj:`searx.enginelib.Engine`
- :py:obj:`searx.enginelib.traits`

There is a command line for developer purposes and for deeper analysis.  Here is
an example in which the command line is called in the development environment::

  $ ./manage pyenv.cmd bash --norc --noprofile
  (py3) python -m searx.enginelib --help

.. hint::

   The long term goal is to modularize all implementations of the engine
   framework here in this Python package.  ToDo:

   - move implementations of the :ref:`searx.engines loader` to a new module in
     the :py:obj:`searx.enginelib` namespace.

-----

Function Documentation

maintenance()

searx.enginelib.maintenance

(

bool

force = True

)

Carry out maintenance on cache of the engines.

Definition at line 73 of file __init__.py.

def maintenance(force: bool = True):
    """Carry out maintenance on cache of the engines."""
    ENGINES_CACHE.maintenance(force=force)
 
 

state()

searx.enginelib.state

(

)

Show state for the caches of the engines.

Definition at line 58 of file __init__.py.

def state():
    """Show state for the caches of the engines."""
 
    title = "cache tables and key/values"
    print(title)
    print("=" * len(title))
    print(ENGINES_CACHE.state().report())
    print()
    title = f"properties of {ENGINES_CACHE.cfg.name}"
    print(title)
    print("=" * len(title))
    print(str(ENGINES_CACHE.properties))
 
 
@app.command()

Variable Documentation

__all__

list searx.enginelib.__all__ = ["EngineCache", "Engine", "ENGINES_CACHE"]

private

Definition at line 26 of file __init__.py.

app

searx.enginelib.app = typer.Typer()

Definition at line 54 of file __init__.py.

ENGINES_CACHE

ExpireCacheSQLite searx.enginelib.ENGINES_CACHE

Initial value:

=  ExpireCacheSQLite.build_cache(
    ExpireCacheCfg(
        name="ENGINES_CACHE",
        MAXHOLD_TIME=60 * 60 * 24 * 7,  # 7 days
        MAINTENANCE_PERIOD=60 * 60,  # 2h
    )
)

Definition at line 43 of file __init__.py.