searx.botdetection.config.Config Class Reference

Public Member Functions
Config	from_toml (cls, pathlib.Path schema_file, pathlib.Path cfg_file, dict deprecated)
	__init__ (self, typing.Dict cfg_schema, typing.Dict[str, str] deprecated)
Any	__getitem__ (self, str key)
	validate (self, dict cfg)
	update (self, dict upd_cfg)
	default (self, str name)
Any	get (self, str name, Any default=UNSET, bool replace=True)
	set (self, str name, val)
	path (self, str name, default=UNSET)
	pyobj (self, name, default=UNSET)

Public Attributes
	cfg_schema
	deprecated
	cfg

Static Public Attributes
	UNSET = UNSET

Protected Member Functions
	_get_parent_dict (self, name)

Detailed Description

Base class used for configuration

Definition at line 64 of file config.py.

Constructor & Destructor Documentation

__init__()

searx.botdetection.config.Config.__init__	(		self,
		typing.Dict	cfg_schema,
		typing.Dict[str, str]	deprecated )

Construtor of class Config.

:param cfg_schema: Schema of the configuration
:param deprecated: dictionary that maps deprecated configuration names to a messages

These values are needed for validation, see :py:obj:`validate`.

Definition at line 93 of file config.py.

    def __init__(self, cfg_schema: typing.Dict, deprecated: typing.Dict[str, str]):
        """Construtor of class Config.
 
        :param cfg_schema: Schema of the configuration
        :param deprecated: dictionary that maps deprecated configuration names to a messages
 
        These values are needed for validation, see :py:obj:`validate`.
 
        """
        self.cfg_schema = cfg_schema
        self.deprecated = deprecated
        self.cfg = copy.deepcopy(cfg_schema)
 

Member Function Documentation

__getitem__()

Any searx.botdetection.config.Config.__getitem__	(		self,
		str	key )

Definition at line 106 of file config.py.

    def __getitem__(self, key: str) -> Any:
        return self.get(key)
 

References searx.metrics.models.HistogramStorage.get(), searx.metrics.models.CounterStorage.get(), searx.botdetection.config.Config.get(), and searx.network.Request.get().

Here is the call graph for this function:

_get_parent_dict()

searx.botdetection.config.Config._get_parent_dict ( self, name )

protected

Definition at line 151 of file config.py.

    def _get_parent_dict(self, name):
        parent_name = '.'.join(name.split('.')[:-1])
        if parent_name:
            parent = value(parent_name, self.cfg)
        else:
            parent = self.cfg
        if (parent is UNSET) or (not isinstance(parent, dict)):
            raise KeyError(parent_name)
        return parent
 

References searx.botdetection.config.Config.cfg, and searx.botdetection.config.value().

Referenced by searx.botdetection.config.Config.get(), and searx.botdetection.config.Config.set().

Here is the call graph for this function:

Here is the caller graph for this function:

default()

searx.botdetection.config.Config.default	(		self,
		str	name )

Returns default value of field ``name`` in ``self.cfg_schema``.

Definition at line 120 of file config.py.

    def default(self, name: str):
        """Returns default value of field ``name`` in ``self.cfg_schema``."""
        return value(name, self.cfg_schema)
 

References searx.botdetection.config.Config.cfg_schema, and searx.botdetection.config.value().

Referenced by searx.settings_defaults.SettingsValue.__call__(), and searx.settings_defaults.SettingsDirectoryValue.__call__().

Here is the call graph for this function:

Here is the caller graph for this function:

from_toml()

Config searx.botdetection.config.Config.from_toml	(		cls,
		pathlib.Path	schema_file,
		pathlib.Path	cfg_file,
		dict	deprecated )

Definition at line 70 of file config.py.

    def from_toml(cls, schema_file: pathlib.Path, cfg_file: pathlib.Path, deprecated: dict) -> Config:
 
        # init schema
 
        log.debug("load schema file: %s", schema_file)
        cfg = cls(cfg_schema=toml_load(schema_file), deprecated=deprecated)
        if not cfg_file.exists():
            log.warning("missing config file: %s", cfg_file)
            return cfg
 
        # load configuration
 
        log.debug("load config file: %s", cfg_file)
        upd_cfg = toml_load(cfg_file)
 
        is_valid, issue_list = cfg.validate(upd_cfg)
        for msg in issue_list:
            log.error(str(msg))
        if not is_valid:
            raise TypeError(f"schema of {cfg_file} is invalid!")
        cfg.update(upd_cfg)
        return cfg
 

References searx.botdetection.config.toml_load().

Here is the call graph for this function:

get()

Any searx.botdetection.config.Config.get	(		self,
		str	name,
		Any	default = UNSET,
		bool	replace = True )

Returns the value to which ``name`` points in the configuration.

If there is no such ``name`` in the config and the ``default`` is
:py:obj:`UNSET`, a :py:obj:`KeyError` is raised.

Definition at line 124 of file config.py.

    def get(self, name: str, default: Any = UNSET, replace: bool = True) -> Any:
        """Returns the value to which ``name`` points in the configuration.
 
        If there is no such ``name`` in the config and the ``default`` is
        :py:obj:`UNSET`, a :py:obj:`KeyError` is raised.
        """
 
        parent = self._get_parent_dict(name)
        val = parent.get(name.split('.')[-1], UNSET)
        if val is UNSET:
            if default is UNSET:
                raise KeyError(name)
            val = default
 
        if replace and isinstance(val, str):
            val = val % self
        return val
 

References searx.botdetection.config.Config._get_parent_dict().

Referenced by searx.botdetection.config.Config.__getitem__(), searx.botdetection.config.Config.path(), and searx.botdetection.config.Config.pyobj().

Here is the call graph for this function:

Here is the caller graph for this function:

path()

searx.botdetection.config.Config.path	(		self,
		str	name,
			default = UNSET )

Get a :py:class:`pathlib.Path` object from a config string.

Definition at line 161 of file config.py.

    def path(self, name: str, default=UNSET):
        """Get a :py:class:`pathlib.Path` object from a config string."""
 
        val = self.get(name, default)
        if val is UNSET:
            if default is UNSET:
                raise KeyError(name)
            return default
        return pathlib.Path(str(val))
 

References searx.metrics.models.HistogramStorage.get(), searx.metrics.models.CounterStorage.get(), searx.botdetection.config.Config.get(), and searx.network.Request.get().

Here is the call graph for this function:

pyobj()

searx.botdetection.config.Config.pyobj	(		self,
			name,
			default = UNSET )

Get python object refered by full qualiffied name (FQN) in the config
string.

Definition at line 171 of file config.py.

    def pyobj(self, name, default=UNSET):
        """Get python object refered by full qualiffied name (FQN) in the config
        string."""
 
        fqn = self.get(name, default)
        if fqn is UNSET:
            if default is UNSET:
                raise KeyError(name)
            return default
        (modulename, name) = str(fqn).rsplit('.', 1)
        m = __import__(modulename, {}, {}, [name], 0)
        return getattr(m, name)
 
 

References searx.metrics.models.HistogramStorage.get(), searx.metrics.models.CounterStorage.get(), searx.botdetection.config.Config.get(), and searx.network.Request.get().

Here is the call graph for this function:

set()

searx.botdetection.config.Config.set	(		self,
		str	name,
			val )

Set the value to which ``name`` points in the configuration.

If there is no such ``name`` in the config, a :py:obj:`KeyError` is
raised.

Definition at line 142 of file config.py.

    def set(self, name: str, val):
        """Set the value to which ``name`` points in the configuration.
 
        If there is no such ``name`` in the config, a :py:obj:`KeyError` is
        raised.
        """
        parent = self._get_parent_dict(name)
        parent[name.split('.')[-1]] = val
 

References searx.botdetection.config.Config._get_parent_dict().

Here is the call graph for this function:

update()

searx.botdetection.config.Config.update	(		self,
		dict	upd_cfg )

Update this configuration by ``upd_cfg``.

Definition at line 115 of file config.py.

    def update(self, upd_cfg: dict):
        """Update this configuration by ``upd_cfg``."""
 
        dict_deepupdate(self.cfg, upd_cfg)
 

References searx.botdetection.config.Config.cfg, and searx.botdetection.config.dict_deepupdate().

Here is the call graph for this function:

validate()

searx.botdetection.config.Config.validate	(		self,
		dict	cfg )

Validation of dictionary ``cfg`` on :py:obj:`Config.SCHEMA`.
Validation is done by :py:obj:`validate`.

Definition at line 109 of file config.py.

    def validate(self, cfg: dict):
        """Validation of dictionary ``cfg`` on :py:obj:`Config.SCHEMA`.
        Validation is done by :py:obj:`validate`."""
 
        return validate(self.cfg_schema, cfg, self.deprecated)
 

References searx.botdetection.config.Config.cfg_schema, searx.botdetection.config.Config.deprecated, and searx.botdetection.config.Config.validate().

Referenced by searx.botdetection.config.Config.validate().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

cfg

searx.botdetection.config.Config.cfg

Definition at line 104 of file config.py.

Referenced by searx.botdetection.config.Config._get_parent_dict(), and searx.botdetection.config.Config.update().

cfg_schema

searx.botdetection.config.Config.cfg_schema

Definition at line 102 of file config.py.

Referenced by searx.botdetection.config.Config.default(), and searx.botdetection.config.Config.validate().

deprecated

searx.botdetection.config.Config.deprecated

Definition at line 103 of file config.py.

Referenced by searx.botdetection.config.Config.validate().

UNSET

searx.botdetection.config.Config.UNSET = UNSET

static

Definition at line 67 of file config.py.

---

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

• /home/andrew/Documents/code/public/searxng/searx/botdetection/config.py