searx.favicons.cache Namespace Reference

Classes
class	FaviconCache
class	FaviconCacheConfig
class	FaviconCacheMEM
class	FaviconCacheNull
class	FaviconCacheSQLite
class	FaviconCacheStats

Functions
	state ()
	maintenance (bool force=True, bool debug=False)
	init ("FaviconCacheConfig" cfg)

Variables
str	CACHE : "FaviconCache"
str	FALLBACK_ICON = b"FALLBACK_ICON"
	logger = logger.getChild('favicons.cache')
	app = typer.Typer()

Detailed Description

Implementations for caching favicons.

:py:obj:`FaviconCacheConfig`:
  Configuration of the favicon cache

:py:obj:`FaviconCache`:
  Abstract base class for the implementation of a favicon cache.

:py:obj:`FaviconCacheSQLite`:
  Favicon cache that manages the favicon BLOBs in a SQLite DB.

:py:obj:`FaviconCacheNull`:
  Fallback solution if the configured cache cannot be used for system reasons.

----

Function Documentation

init()

searx.favicons.cache.init

(

"FaviconCacheConfig"

cfg

)

Initialization of a global ``CACHE``

Definition at line 72 of file cache.py.

def init(cfg: "FaviconCacheConfig"):
    """Initialization of a global ``CACHE``"""
 
    global CACHE  # pylint: disable=global-statement
    if cfg.db_type == "sqlite":
        if sqlite3.sqlite_version_info <= (3, 35):
            logger.critical(
                "Disable favicon caching completely: SQLite library (%s) is too old! (require >= 3.35)",
                sqlite3.sqlite_version,
            )
            CACHE = FaviconCacheNull(cfg)
        else:
            CACHE = FaviconCacheSQLite(cfg)
    elif cfg.db_type == "mem":
        logger.error("Favicons are cached in memory, don't use this in production!")
        CACHE = FaviconCacheMEM(cfg)
    else:
        raise NotImplementedError(f"favicons db_type '{cfg.db_type}' is unknown")
 
 
@t.final

maintenance()

searx.favicons.cache.maintenance	(	bool	force = True,
		bool	debug = False )

perform maintenance of the cache

Definition at line 52 of file cache.py.

def maintenance(force: bool = True, debug: bool = False):
    """perform maintenance of the cache"""
    root_log = logging.getLogger()
    if debug:
        root_log.setLevel(logging.DEBUG)
    else:
        root_log.handlers = []
        handler = logging.StreamHandler()
        handler.setFormatter(logging.Formatter("%(message)s"))
        logger.addHandler(handler)
        logger.setLevel(logging.DEBUG)
 
    state_t0 = CACHE.state()
    CACHE.maintenance(force=force)
    state_t1 = CACHE.state()
    state_delta = state_t0 - state_t1
    print("The cache has been reduced by:")
    print(state_delta.report("\n- {descr}: {val}").lstrip("\n"))
 
 

state()

searx.favicons.cache.state

(

)

show state of the cache

Definition at line 46 of file cache.py.

def state():
    """show state of the cache"""
    print(CACHE.state().report())
 
 
@app.command()

Variable Documentation

app

searx.favicons.cache.app = typer.Typer()

Definition at line 42 of file cache.py.

CACHE

str searx.favicons.cache.CACHE : "FaviconCache"

Definition at line 38 of file cache.py.

FALLBACK_ICON

str searx.favicons.cache.FALLBACK_ICON = b"FALLBACK_ICON"

Definition at line 39 of file cache.py.

logger

searx.favicons.cache.logger = logger.getChild('favicons.cache')

Definition at line 41 of file cache.py.