Inheritance diagram for searx.enginelib.traits.EngineTraits:

Collaboration diagram for searx.enginelib.traits.EngineTraits:

Public Member Functions
	get_language (self, str searxng_locale, default=None)

	get_region (self, str searxng_locale, default=None)

bool	is_locale_supported (self, str searxng_locale)

	copy (self)

Union[ 'EngineTraits', None]	fetch_traits (cls, Engine engine)

	set_traits (self, Engine engine)

Public Attributes
str	data_type = 'traits_v1':

Static Public Attributes
Dict	regions = dataclasses.field(default_factory=dict)

Dict	languages = dataclasses.field(default_factory=dict)

Optional	all_locale = None

Literal	data_type = 'traits_v1'

Dict	custom = dataclasses.field(default_factory=dict)

Protected Member Functions
	_set_traits_v1 (self, Engine engine)

Detailed Description

The class is intended to be instantiated for each engine.

Definition at line 37 of file traits.py.

Member Function Documentation

◆ _set_traits_v1()

searx.enginelib.traits.EngineTraits._set_traits_v1	(		self,
		Engine	engine )

protected

Definition at line 162 of file traits.py.

    def _set_traits_v1(self, engine: Engine):
        # For an engine, when there is `language: ...` in the YAML settings the engine
        # does support only this one language (region)::
        #
        #   - name: google italian
        #     engine: google
        #     language: it
        #     region: it-IT                                      # type: ignore
 
        traits = self.copy()
 
        _msg = "settings.yml - engine: '%s' / %s: '%s' not supported"
 
        languages = traits.languages
        if hasattr(engine, 'language'):
            if engine.language not in languages:
                raise ValueError(_msg % (engine.name, 'language', engine.language))
            traits.languages = {engine.language: languages[engine.language]}
 
        regions = traits.regions
        if hasattr(engine, 'region'):
            if engine.region not in regions:
                raise ValueError(_msg % (engine.name, 'region', engine.region))
            traits.regions = {engine.region: regions[engine.region]}
 
        engine.language_support = bool(traits.languages or traits.regions)
 
        # set the copied & modified traits in engine's namespace
        engine.traits = traits
 
 

References searx.enginelib.traits.EngineTraits.copy().

Referenced by searx.enginelib.traits.EngineTraits.set_traits().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copy()

searx.enginelib.traits.EngineTraits.copy ( self )

Create a copy of the dataclass object.

Definition at line 132 of file traits.py.

    def copy(self):
        """Create a copy of the dataclass object."""
        return EngineTraits(**dataclasses.asdict(self))
 

Referenced by searx.enginelib.traits.EngineTraits._set_traits_v1().

Here is the caller graph for this function:

◆ fetch_traits()

Union['EngineTraits', None] searx.enginelib.traits.EngineTraits.fetch_traits	(		cls,
		Engine	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 in searx.enginelib.traits.EngineTraitsMap.

Definition at line 137 of file traits.py.

    def fetch_traits(cls, engine: Engine) -> Union['EngineTraits', None]:
        """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.
        """
 
        fetch_traits = getattr(engine, 'fetch_traits', None)
        engine_traits = None
 
        if fetch_traits:
            engine_traits = cls()
            fetch_traits(engine_traits)
        return engine_traits
 

◆ get_language()

searx.enginelib.traits.EngineTraits.get_language	(		self,
		str	searxng_locale,
			default = None )

Return engine's language string that *best fits* to SearXNG's locale.

:param searxng_locale: SearXNG's internal representation of locale
  selected by the user.

:param default: engine's default language

The *best fits* rules are implemented in
:py:obj:`searx.locales.get_engine_locale`.  Except for the special value ``all``
which is determined from :py:obj:`EngineTraits.all_locale`.

Definition at line 87 of file traits.py.

    def get_language(self, searxng_locale: str, default=None):
        """Return engine's language string that *best fits* to SearXNG's locale.
 
        :param searxng_locale: SearXNG's internal representation of locale
          selected by the user.
 
        :param default: engine's default language
 
        The *best fits* rules are implemented in
        :py:obj:`searx.locales.get_engine_locale`.  Except for the special value ``all``
        which is determined from :py:obj:`EngineTraits.all_locale`.
        """
        if searxng_locale == 'all' and self.all_locale is not None:
            return self.all_locale
        return locales.get_engine_locale(searxng_locale, self.languages, default=default)
 

References searx.enginelib.traits.EngineTraits.all_locale, searx.enginelib.traits.EngineTraits.languages, searx.query.RawTextQuery.languages, searx.search.checker.impl.ResultContainerTests.languages, and searx.search.checker.impl.TestResults.languages.

Referenced by searx.enginelib.traits.EngineTraits.is_locale_supported().

Here is the caller graph for this function:

◆ get_region()

searx.enginelib.traits.EngineTraits.get_region	(		self,
		str	searxng_locale,
			default = None )

Return engine's region string that best fits to SearXNG's locale.

:param searxng_locale: SearXNG's internal representation of locale
  selected by the user.

:param default: engine's default region

The *best fits* rules are implemented in
:py:obj:`searx.locales.get_engine_locale`.  Except for the special value ``all``
which is determined from :py:obj:`EngineTraits.all_locale`.

Definition at line 103 of file traits.py.

    def get_region(self, searxng_locale: str, default=None):
        """Return engine's region string that best fits to SearXNG's locale.
 
        :param searxng_locale: SearXNG's internal representation of locale
          selected by the user.
 
        :param default: engine's default region
 
        The *best fits* rules are implemented in
        :py:obj:`searx.locales.get_engine_locale`.  Except for the special value ``all``
        which is determined from :py:obj:`EngineTraits.all_locale`.
        """
        if searxng_locale == 'all' and self.all_locale is not None:
            return self.all_locale
        return locales.get_engine_locale(searxng_locale, self.regions, default=default)
 

References searx.enginelib.traits.EngineTraits.all_locale, and searx.enginelib.traits.EngineTraits.regions.

Referenced by searx.enginelib.traits.EngineTraits.is_locale_supported().

Here is the caller graph for this function:

◆ is_locale_supported()

bool searx.enginelib.traits.EngineTraits.is_locale_supported	(		self,
		str	searxng_locale )

A *locale* (SearXNG's internal representation) is considered to be
supported by the engine if the *region* or the *language* is supported
by the engine.

For verification the functions :py:func:`EngineTraits.get_region` and
:py:func:`EngineTraits.get_language` are used.

Definition at line 119 of file traits.py.

    def is_locale_supported(self, searxng_locale: str) -> bool:
        """A *locale* (SearXNG's internal representation) is considered to be
        supported by the engine if the *region* or the *language* is supported
        by the engine.
 
        For verification the functions :py:func:`EngineTraits.get_region` and
        :py:func:`EngineTraits.get_language` are used.
        """
        if self.data_type == 'traits_v1':
            return bool(self.get_region(searxng_locale) or self.get_language(searxng_locale))
 
        raise TypeError('engine traits of type %s is unknown' % self.data_type)
 

References searx.enginelib.traits.EngineTraits.data_type, searx.enginelib.traits.EngineTraits.get_language(), and searx.enginelib.traits.EngineTraits.get_region().

Here is the call graph for this function:

◆ set_traits()

searx.enginelib.traits.EngineTraits.set_traits	(		self,
		Engine	engine )

Set traits from self object in a :py:obj:`.Engine` namespace.

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

Reimplemented in searx.enginelib.traits.EngineTraitsMap.

Definition at line 151 of file traits.py.

    def set_traits(self, engine: Engine):
        """Set traits from self object in a :py:obj:`.Engine` namespace.
 
        :param engine: engine instance build by :py:func:`searx.engines.load_engine`
        """
 
        if self.data_type == 'traits_v1':
            self._set_traits_v1(engine)
        else:
            raise TypeError('engine traits of type %s is unknown' % self.data_type)
 

References searx.enginelib.traits.EngineTraits._set_traits_v1(), and searx.enginelib.traits.EngineTraits.data_type.

Here is the call graph for this function:

Member Data Documentation

◆ all_locale

Optional searx.enginelib.traits.EngineTraits.all_locale = None

static

Definition at line 74 of file traits.py.

Referenced by searx.enginelib.traits.EngineTraits.get_language(), and searx.enginelib.traits.EngineTraits.get_region().

◆ custom

Dict searx.enginelib.traits.EngineTraits.custom = dataclasses.field(default_factory=dict)

static

Definition at line 83 of file traits.py.

◆ data_type [1/2]

searx.enginelib.traits.EngineTraits.data_type = 'traits_v1'

static

Definition at line 79 of file traits.py.

Referenced by searx.enginelib.traits.EngineTraits.is_locale_supported(), and searx.enginelib.traits.EngineTraits.set_traits().

◆ data_type [2/2]

str searx.enginelib.traits.EngineTraits.data_type = 'traits_v1':

Definition at line 130 of file traits.py.

Referenced by searx.enginelib.traits.EngineTraits.is_locale_supported(), and searx.enginelib.traits.EngineTraits.set_traits().

◆ languages

searx.enginelib.traits.EngineTraits.languages = dataclasses.field(default_factory=dict)

static

Definition at line 57 of file traits.py.

Referenced by searx.search.checker.impl.ResultContainerTests._add_language(), searx.search.checker.impl.TestResults.add_language(), and searx.enginelib.traits.EngineTraits.get_language().

◆ regions

searx.enginelib.traits.EngineTraits.regions = dataclasses.field(default_factory=dict)

static

Definition at line 40 of file traits.py.

Referenced by searx.enginelib.traits.EngineTraits.get_region().

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

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

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ _set_traits_v1()

◆ copy()

◆ fetch_traits()

◆ get_language()

◆ get_region()

◆ is_locale_supported()

◆ set_traits()

Member Data Documentation

◆ all_locale

◆ custom

◆ data_type [1/2]

◆ data_type [2/2]

◆ languages

◆ regions