searx.favicons.cache.FaviconCacheMEM Class Reference

Inheritance diagram for searx.favicons.cache.FaviconCacheMEM:

Collaboration diagram for searx.favicons.cache.FaviconCacheMEM:

Public Member Functions
	__init__ (self, FaviconCacheConfig cfg)
None|tuple[bytes|None, str|None]	__call__ (self, str resolver, str authority)
bool	set (self, str resolver, str authority, str|None mime, bytes|None data)
	state (self)
	maintenance (self, bool force=False)
Public Member Functions inherited from searx.favicons.cache.FaviconCache
	__init__ (self, FaviconCacheConfig cfg)
None|tuple[None|bytes, None|str]	__call__ (self, str resolver, str authority)

Public Attributes
	cfg = cfg

Protected Attributes
dict	_data = {}
dict	_sha_mime = {}

Detailed Description

Favicon cache in process' memory.  Its just a POC that stores the
favicons in the memory of the process.

.. attention::

   Don't use it in production, it will blow up your memory!!

Definition at line 447 of file cache.py.

Constructor & Destructor Documentation

__init__()

searx.favicons.cache.FaviconCacheMEM.__init__	(		self,
		FaviconCacheConfig	cfg )

Definition at line 457 of file cache.py.

    def __init__(self, cfg: FaviconCacheConfig):
 
        self.cfg = cfg
        self._data: dict[str, t.Any] = {}
        self._sha_mime: dict[str, tuple[str, str | None]] = {}
 

Member Function Documentation

__call__()

None | tuple[bytes | None, str | None] searx.favicons.cache.FaviconCacheMEM.__call__	(		self,
		str	resolver,
		str	authority )

Definition at line 463 of file cache.py.

    def __call__(self, resolver: str, authority: str) -> None | tuple[bytes | None, str | None]:
 
        sha, mime = self._sha_mime.get(f"{resolver}:{authority}", (None, None))
        if sha is None:
            return None
        data = self._data.get(sha)
        if data == FALLBACK_ICON:
            data = None
        return data, mime
 

References _data, and _sha_mime.

maintenance()

searx.favicons.cache.FaviconCacheMEM.maintenance	(		self,
		bool	force = False )

Performs maintenance on the cache

Reimplemented from searx.favicons.cache.FaviconCache.

Definition at line 495 of file cache.py.

    def maintenance(self, force: bool = False):
        pass

set()

bool searx.favicons.cache.FaviconCacheMEM.set	(		self,
		str	resolver,
		str	authority,
		str | None	mime,
		bytes | None	data )

Set data and mime-type in the cache.  If data is None, the
:py:obj:`FALLBACK_ICON` is registered. in the cache.

Reimplemented from searx.favicons.cache.FaviconCache.

Definition at line 473 of file cache.py.

    def set(self, resolver: str, authority: str, mime: str | None, data: bytes | None) -> bool:
 
        if data is None:
            data = FALLBACK_ICON
            mime = None
 
        elif mime is None:
            logger.error(
                "favicon resolver %s tries to cache mime-type None for authority %s",
                resolver,
                authority,
            )
            return False
 
        digest = hashlib.sha256(data).hexdigest()
        self._data[digest] = data
        self._sha_mime[f"{resolver}:{authority}"] = (digest, mime)
        return True
 

References _data, and _sha_mime.

state()

searx.favicons.cache.FaviconCacheMEM.state

(

self

)

Returns a :py:obj:`FaviconCacheStats` (key/values) with information
on the state of the cache.

Reimplemented from searx.favicons.cache.FaviconCache.

Definition at line 492 of file cache.py.

    def state(self):
        return FaviconCacheStats(favicons=len(self._data.keys()))
 

References _data.

Member Data Documentation

_data

dict searx.favicons.cache.FaviconCacheMEM._data = {}

protected

Definition at line 460 of file cache.py.

Referenced by __call__(), set(), and state().

_sha_mime

dict searx.favicons.cache.FaviconCacheMEM._sha_mime = {}

protected

Definition at line 461 of file cache.py.

Referenced by __call__(), and set().

cfg

searx.favicons.cache.FaviconCacheMEM.cfg = cfg

Definition at line 459 of file cache.py.

Referenced by searx.cache.ExpireCache.secret_hash().

---

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

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