Inheritance diagram for searx.cache.ExpireCache:

Collaboration diagram for searx.cache.ExpireCache:

Public Member Functions
bool	set (self, str key, typing.Any value, int\|None expire, str\|None ctx=None)
typing.Any	get (self, str key, typing.Any default=None, str\|None ctx=None)
bool	maintenance (self, bool force=False, bool truncate=False)
ExpireCacheStats	state (self)
bytes	serialize (self, typing.Any value)
typing.Any	deserialize (self, bytes value)
str	secret_hash (self, str\|bytes name)

Static Public Member Functions
"ExpireCacheSQLite"	build_cache (ExpireCacheCfg cfg)
str	normalize_name (str name)

Static Public Attributes
str	hash_token = "hash_token"

Detailed Description

Abstract base class for the implementation of a key/value cache
with expire date.

Definition at line 120 of file cache.py.

Member Function Documentation

◆ build_cache()

"ExpireCacheSQLite" searx.cache.ExpireCache.build_cache ( ExpireCacheCfg cfg )

static

Factory to build a caching instance.

.. note::

   Currently, only the SQLite adapter is available, but other database
   types could be implemented in the future, e.g. a Valkey (Redis)
   adapter.

Definition at line 171 of file cache.py.

    def build_cache(cfg: ExpireCacheCfg) -> "ExpireCacheSQLite":
        """Factory to build a caching instance.
 
        .. note::
 
           Currently, only the SQLite adapter is available, but other database
           types could be implemented in the future, e.g. a Valkey (Redis)
           adapter.
        """
        return ExpireCacheSQLite(cfg)
 

◆ deserialize()

typing.Any searx.cache.ExpireCache.deserialize	(		self,
		bytes	value )

Definition at line 194 of file cache.py.

    def deserialize(self, value: bytes) -> typing.Any:
        obj = pickle.loads(value)
        return obj
 

Referenced by searx.cache.ExpireCacheSQLite.get(), searx.cache.ExpireCacheSQLite.pairs(), and searx.cache.ExpireCacheSQLite.state().

Here is the caller graph for this function:

◆ get()

typing.Any searx.cache.ExpireCache.get	(		self,
		str	key,
		typing.Any	default = None,
		str \| None	ctx = None )

Return *value* of *key*.  If key is unset, ``None`` is returned.

Reimplemented in searx.cache.ExpireCacheSQLite.

Definition at line 149 of file cache.py.

    def get(self, key: str, default: typing.Any = None, ctx: str | None = None) -> typing.Any:
        """Return *value* of *key*.  If key is unset, ``None`` is returned."""
 

Referenced by searx.result_types._base.LegacyResult.__init__(), searx.result_types._base.LegacyResult.defaults_from(), and searx.answerers._core.AnswerStorage.register().

Here is the caller graph for this function:

◆ maintenance()

bool searx.cache.ExpireCache.maintenance	(		self,
		bool	force = False,
		bool	truncate = False )

Performs maintenance on the cache.

``force``:
  Maintenance should be carried out even if the maintenance interval has
  not yet been reached.

``truncate``:
  Truncate the entire cache, which is necessary, for example, if the
  password has changed.

Reimplemented in searx.cache.ExpireCacheSQLite.

Definition at line 153 of file cache.py.

    def maintenance(self, force: bool = False, truncate: bool = False) -> bool:
        """Performs maintenance on the cache.
 
        ``force``:
          Maintenance should be carried out even if the maintenance interval has
          not yet been reached.
 
        ``truncate``:
          Truncate the entire cache, which is necessary, for example, if the
          password has changed.
        """
 

Referenced by searx.cache.ExpireCacheSQLite.get(), searx.cache.ExpireCacheSQLite.init(), searx.cache.ExpireCacheSQLite.pairs(), searx.cache.ExpireCacheSQLite.set(), and searx.favicons.cache.FaviconCacheSQLite.set().

Here is the caller graph for this function:

◆ normalize_name()

str searx.cache.ExpireCache.normalize_name ( str name )

static

Returns a normalized name that can be used as a file name or as a SQL
table name (is used, for example, to normalize the context name).

Definition at line 183 of file cache.py.

    def normalize_name(name: str) -> str:
        """Returns a normalized name that can be used as a file name or as a SQL
        table name (is used, for example, to normalize the context name)."""
 
        _valid = "-_." + string.ascii_letters + string.digits
        return "".join([c for c in name if c in _valid])
 

Referenced by searx.cache.ExpireCacheSQLite.get(), searx.cache.ExpireCacheSQLite.pairs(), and searx.cache.ExpireCacheSQLite.set().

Here is the caller graph for this function:

◆ secret_hash()

str searx.cache.ExpireCache.secret_hash	(		self,
		str \| bytes	name )

Creates a hash of the argument ``name``.  The hash value is formed
from the ``name`` combined with the :py:obj:`password
<ExpireCacheCfg.password>`.  Can be used, for example, to make the
``key`` stored in the DB unreadable for third parties.

Definition at line 198 of file cache.py.

    def secret_hash(self, name: str | bytes) -> str:
        """Creates a hash of the argument ``name``.  The hash value is formed
        from the ``name`` combined with the :py:obj:`password
        <ExpireCacheCfg.password>`.  Can be used, for example, to make the
        ``key`` stored in the DB unreadable for third parties."""
 
        if isinstance(name, str):
            name = bytes(name, encoding='utf-8')
        m = hmac.new(name + self.cfg.password, digestmod='sha256')
        return m.hexdigest()
 
 

References searx.botdetection.config.Config.cfg, searx.cache.ExpireCacheSQLite.cfg, searx.favicons.cache.FaviconCacheMEM.cfg, and searx.favicons.cache.FaviconCacheSQLite.cfg.

◆ serialize()

bytes searx.cache.ExpireCache.serialize	(		self,
		typing.Any	value )

Definition at line 190 of file cache.py.

    def serialize(self, value: typing.Any) -> bytes:
        dump: bytes = pickle.dumps(value)
        return dump
 

Referenced by searx.cache.ExpireCacheSQLite.set().

Here is the caller graph for this function:

◆ set()

bool searx.cache.ExpireCache.set	(		self,
		str	key,
		typing.Any	value,
		int \| None	expire,
		str \| None	ctx = None )

Set *key* to *value*.  To set a timeout on key use argument
``expire`` (in sec.).  If expire is unset the default is taken from
:py:obj:`ExpireCacheCfg.MAXHOLD_TIME`.  After the timeout has expired,
the key will automatically be deleted.

The ``ctx`` argument specifies the context of the ``key``.  A key is
only unique in its context.

The concrete implementations of this abstraction determine how the
context is mapped in the connected database.  In SQL databases, for
example, the context is a DB table or in a Key/Value DB it could be
a prefix for the key.

If the context is not specified (the default is ``None``) then a
default context should be used, e.g. a default table for SQL databases
or a default prefix in a Key/Value DB.

Reimplemented in searx.cache.ExpireCacheSQLite.

Definition at line 129 of file cache.py.

    def set(self, key: str, value: typing.Any, expire: int | None, ctx: str | None = None) -> bool:
        """Set *key* to *value*.  To set a timeout on key use argument
        ``expire`` (in sec.).  If expire is unset the default is taken from
        :py:obj:`ExpireCacheCfg.MAXHOLD_TIME`.  After the timeout has expired,
        the key will automatically be deleted.
 
        The ``ctx`` argument specifies the context of the ``key``.  A key is
        only unique in its context.
 
        The concrete implementations of this abstraction determine how the
        context is mapped in the connected database.  In SQL databases, for
        example, the context is a DB table or in a Key/Value DB it could be
        a prefix for the key.
 
        If the context is not specified (the default is ``None``) then a
        default context should be used, e.g. a default table for SQL databases
        or a default prefix in a Key/Value DB.
        """
 

◆ state()

ExpireCacheStats searx.cache.ExpireCache.state ( self )

Returns a :py:obj:`ExpireCacheStats`, which provides information
about the status of the cache.

Reimplemented in searx.cache.ExpireCacheSQLite.

Definition at line 166 of file cache.py.

    def state(self) -> ExpireCacheStats:
        """Returns a :py:obj:`ExpireCacheStats`, which provides information
        about the status of the cache."""
 

Member Data Documentation

◆ hash_token

str searx.cache.ExpireCache.hash_token = "hash_token"

static

Definition at line 126 of file cache.py.

Referenced by searx.cache.ExpireCacheSQLite.init().

The documentation for this class was generated from the following file:

/home/andrew/Documents/code/public/searxng/searx/cache.py

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ build_cache()

◆ deserialize()

◆ get()

◆ maintenance()

◆ normalize_name()

◆ secret_hash()

◆ serialize()

◆ set()

◆ state()

Member Data Documentation

◆ hash_token