searx.enginelib.traits.EngineTraitsMap Class Reference

Inheritance diagram for searx.enginelib.traits.EngineTraitsMap:

Collaboration diagram for searx.enginelib.traits.EngineTraitsMap:

Public Member Functions
	save_data (self)
'EngineTraitsMap'	from_data (cls)
'EngineTraitsMap'	fetch_traits (cls, t.Callable[[str], None] log)
	set_traits (self, "Engine | types.ModuleType" engine)
Public Member Functions inherited from searx.enginelib.traits.EngineTraits
	get_language (self, str searxng_locale, t.Any default=None)
t.Any	get_region (self, str searxng_locale, t.Any default=None)
bool	is_locale_supported (self, str searxng_locale)
	copy (self)

Static Public Attributes
tuple	ENGINE_TRAITS_FILE = (data_dir / 'engine_traits.json').resolve()
Static Public Attributes inherited from searx.enginelib.traits.EngineTraits
dict	regions = dataclasses.field(default_factory=dict)
dict	languages = dataclasses.field(default_factory=dict)
str	all_locale = None
t	data_type = 'traits_v1'
dict	custom = dataclasses.field(default_factory=dict)

Additional Inherited Members
Protected Member Functions inherited from searx.enginelib.traits.EngineTraits
	_set_traits_v1 (self, "Engine | types.ModuleType" engine)

Detailed Description

A python dictionary to map :class:`EngineTraits` by engine name.

Definition at line 194 of file traits.py.

Member Function Documentation

fetch_traits()

'EngineTraitsMap' searx.enginelib.traits.EngineTraitsMap.fetch_traits	(		cls,
		t.Callable[[str], None]	engine )

Call a function ``fetch_traits(engine_traits)`` from engines namespace to fetch
and set properties from the origin engine in the object ``engine_traits``.  If
function does not exists, ``None`` is returned.

Reimplemented from searx.enginelib.traits.EngineTraits.

Definition at line 214 of file traits.py.

    def fetch_traits(cls, log: t.Callable[[str], None]) -> 'EngineTraitsMap':
        from searx import engines  # pylint: disable=cyclic-import, import-outside-toplevel
 
        names = list(engines.engines)
        names.sort()
        obj = cls()
 
        for engine_name in names:
            engine: Engine | types.ModuleType = engines.engines[engine_name]
            traits = None
 
            # pylint: disable=broad-exception-caught
            try:
                traits = EngineTraits.fetch_traits(engine)
            except Exception as exc:
                log("FATAL: while fetch_traits %s: %s" % (engine_name, exc))
                if os.environ.get('FORCE', '').lower() not in ['on', 'true', '1']:
                    raise
                v = ENGINE_TRAITS.get(engine_name)
                if v:
                    log("FORCE: re-use old values from fetch_traits - ENGINE_TRAITS[%s]" % engine_name)
                    traits = EngineTraits(**v)
 
            if traits is not None:
                log("%-20s: SearXNG languages --> %s " % (engine_name, len(traits.languages)))
                log("%-20s: SearXNG regions   --> %s" % (engine_name, len(traits.regions)))
                obj[engine_name] = traits
 
        return obj
 

from_data()

'EngineTraitsMap' searx.enginelib.traits.EngineTraitsMap.from_data

(

cls

)

Instantiate :class:`EngineTraitsMap` object from :py:obj:`ENGINE_TRAITS`

Definition at line 206 of file traits.py.

    def from_data(cls) -> 'EngineTraitsMap':
        """Instantiate :class:`EngineTraitsMap` object from :py:obj:`ENGINE_TRAITS`"""
        obj = cls()
        for k, v in ENGINE_TRAITS.items():
            obj[k] = EngineTraits(**v)
        return obj
 

save_data()

searx.enginelib.traits.EngineTraitsMap.save_data

(

self

)

Store EngineTraitsMap in in file :py:obj:`self.ENGINE_TRAITS_FILE`

Definition at line 200 of file traits.py.

    def save_data(self):
        """Store EngineTraitsMap in in file :py:obj:`self.ENGINE_TRAITS_FILE`"""
        with open(self.ENGINE_TRAITS_FILE, 'w', encoding='utf-8') as f:
            json.dump(self, f, indent=2, sort_keys=True, cls=EngineTraitsEncoder)
 

References ENGINE_TRAITS_FILE.

set_traits()

searx.enginelib.traits.EngineTraitsMap.set_traits	(		self,
		"Engine | types.ModuleType"	engine )

Set traits in a :py:obj:`Engine` namespace.

:param engine: engine instance build by :py:func:`searx.engines.load_engine`

Reimplemented from searx.enginelib.traits.EngineTraits.

Definition at line 244 of file traits.py.

    def set_traits(self, engine: "Engine | types.ModuleType"):
        """Set traits in a :py:obj:`Engine` namespace.
 
        :param engine: engine instance build by :py:func:`searx.engines.load_engine`
        """
 
        engine_traits = EngineTraits(data_type='traits_v1')
        if engine.name in self.keys():
            engine_traits = self[engine.name]
 
        elif engine.engine in self.keys():
            # The key of the dictionary traits_map is the *engine name*
            # configured in settings.xml.  When multiple engines are configured
            # in settings.yml to use the same origin engine (python module)
            # these additional engines can use the languages from the origin
            # engine.  For this use the configured ``engine: ...`` from
            # settings.yml
            engine_traits = self[engine.engine]
 
        engine_traits.set_traits(engine)

Member Data Documentation

ENGINE_TRAITS_FILE

searx.enginelib.traits.EngineTraitsMap.ENGINE_TRAITS_FILE = (data_dir / 'engine_traits.json').resolve()

static

Definition at line 197 of file traits.py.

Referenced by save_data().

---

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

• /home/andrew/Documents/code/public/searxng/searx/enginelib/traits.py