i3UdZddlZddlZddlZddlZddlZgdZejeZ da de d< ddZ dd Z ejGd d Zed ZejGd deZGddZdeej*zfdZdedeeej0ffdZdeeej0fdeeej0fdeeefdeeeeffdZdeedeedeeej0fdeeej0fdeeefdeeeeff dZd deeej0fdeeej0fdeedzfdZy)!aBConfiguration class :py:class:`Config` with deep-update, schema validation and deprecated names. The :py:class:`Config` class implements a configuration that is based on structured dictionaries. The configuration schema is defined in a dictionary structure and the configuration data is given in a dictionary structure. N)ConfigUNSET SchemaIssueset_global_cfgget_global_cfgz Config | NoneCFGrc|ayN)r)cfgs */root/searxng/searx/botdetection/config.pyrrs Creturnc0t tdtS)Nz-Botdetection's config is not yet initialized.)r ValueErrorr r rrs {HII Jr c,eZdZdZdefdZdZdZeZy)FALSEzClass of ``False`` singletonmsgc||_yr r)selfrs r __init__zFALSE.__init__*s r cy)NFrrs r __bool__zFALSE.__bool__-sr c|jSr rrs r __str__z FALSE.__str__0s xxr N) __name__ __module__ __qualname____doc__strrrr__repr__rr r rr%s"&CHr rzcLeZdZdZdej ddeffd ZdZxZ S)rz>Exception to store and/or raise a message from a schema issue.level)warninvalidrc2||_t| |yr )r%superr)rr%r __class__s r rzSchemaIssue.__init__=s  r c@d|jd|jdS)Nz [cfg schema z] r)r%argsrs r rzSchemaIssue.__str__As!djj\DIIaL>::r ) rrr r!typingLiteralr"rr __classcell__)r*s@r rr9s(Hfnn->?c;r rc eZdZUdZeZeed<edejdejde e e fddfdZ de e e jfde e e ffd Zd e de jfd Zd e e e jffd Zde e e jffdZde fdZedfde de jdede jfdZde de jfdZde de e e jffdZefde de jfdZefde de jfdZy)rz!Base class used for configurationr schema_filecfg_file deprecatedrctjd||t||}|jstj d||Stjd|t|}|j |\}}|D] }tj t|"|std|d|j||S)Nzload schema file: %s) cfg_schemar3zmissing config file: %szload config file: %sz schema of z is invalid!) logdebug toml_loadexistswarningvalidateerrorr" TypeErrorupdate) clsr1r2r3r upd_cfgis_valid issue_listrs r from_tomlzConfig.from_tomlJs (+6Y{3 K KK18 <J ((3H%"||G4* C IIc#h  j ,?@ @ 7 r r5cT||_||_tj||_y)aConstructor 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`. N)r5r3copydeepcopyr )rr5r3s r rzConfig.__init__bs"2<*4*.-- *Cr keyc$|j|Sr )get)rrGs r __getitem__zConfig.__getitem__osxx}r r cDt|j||jS)znValidation of dictionary ``cfg`` on :py:obj:`Config.SCHEMA`. Validation is done by :py:obj:`validate`.)r;r5r3)rr s r r;zConfig.validatersdoo>>r r@c0t|j|y)z)Update this configuration by ``upd_cfg``.N)dict_deepupdater )rr@s r r>z Config.updatexs '*r namec.t||jS)z?Returns default value of field ``name`` in ``self.cfg_schema``.)valuer5)rrNs r defaultzConfig.default}sT4??++r TrQreplacec|j|}|j|jddt}|tur|tur t ||}|rt |t r||z}|S)zReturns 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. .)_get_parent_dictrIsplitrKeyError isinstancer")rrNrQrRparentvals r rIz Config.getsi&&t,jjC,e4 %<%tn$C z#s+*C r r[cT|j|}|||jdd<y)zSet the value to which ``name`` points in the configuration. If there is no such ``name`` in the config, a :py:obj:`KeyError` is raised. rTrUN)rVrW)rrNr[rZs r setz Config.sets+ &&t,&)tzz#r"#r cdj|jddd}|rt||j}n |j}|tust |t s t||S)NrTrU)joinrWrPr rrYdictrX)rrN parent_namerZs r rVzConfig._get_parent_dicts[hhtzz#s34 ,1+txx,HFXXF eOZ%=;' ' r c|j||}|tur|tur t||Stjt |S)z;Get a :py:class:`pathlib.Path` object from a config string.)rIrrXpathlibPathr")rrNrQr[s r pathz Config.pathsEhhtW% %<%tn$N||CH%%r c|j||}|tur|tur t||St|j dd\}}t |ii|gd}t ||S)zVGet python object referred by full qualiffied name (FQN) in the config string.rTr)rIrrXr"rsplit __import__getattr)rrNrQfqn modulenamems r pyobjz Config.pyobjslhhtW% %<%tn$N X__S!4T z2rD61 5q$r N)rrr r!robject__annotations__ classmethodrcrdr`r"rCr-AnyrrJr;r>rQboolrIr]rVrernrr r rrEsv+E6GLLGLLVZ[^`c[cVdiq. D4VZZ#8 Dd3PS8n Dsvzz?Dfjj1? +d3 ?3+ ,C,49$fjj4SYS]S]$**&***ST#vzz/-B5:&&vzz&6;  #    r file_namec. t|d5}tj|cdddS#1swYyxYw#tj$rH}t |j ddj dd}t jd||d}~wwxYw)Nrb   z%s: %s)opentomllibloadTOMLDecodeErrorr"rRr6r<)rtfexcrs r r8r8s~ )T " #a<<? # # #  " "#htR(00s; (Is+ s* 9- 9699B ABBrN data_dictc|}|jdD]3}t|tr|j|t}|tus2|S|S)aReturns the value to which ``name`` points in the ``dat_dict``. .. code: python >>> data_dict = { "foo": {"bar": 1 }, "bar": {"foo": 2 }, "foobar": [1, 2, 3], } >>> value('foobar', data_dict) [1, 2, 3] >>> value('foo.bar', data_dict) 1 >>> value('foo.bar.xxx', data_dict) rT)rWrYr`rIr)rNrret_valparts r rPrPsQ&G 3 gt $kk$.G e   N  Nr schema_dictr3cg}d}g}t|ts tddt|tstdddj|dt |||||\}}||fS)aDeep validation of dictionary in ``data_dict`` against dictionary in ``schema_dict``. Argument deprecated is a dictionary that maps deprecated configuration names to a messages:: deprecated = { "foo.bar" : "config 'foo.bar' is deprecated, use 'bar.foo'", "..." : "..." } The function returns a python tuple ``(is_valid, issue_list)``: ``is_valid``: A bool value indicating ``data_dict`` is valid or not. ``issue_list``: A list of messages (:py:obj:`SchemaIssue`) from the validation:: [schema warn] data_dict: deprecated 'fontlib.foo': [schema invalid] data_dict: key unknown 'fontlib.foo' [schema invalid] data_dict: type mismatch 'fontlib.foo': expected ..., is ... If ``schema_dict`` or ``data_dict`` is not a dictionary type a :py:obj:`SchemaIssue` is raised. Tr'zschema_dict is not a dict typezdata_dict issuerTz is not a dict type)rYr`rr_ _validate)rrr3namesrArBs r r;r;sx8EH$&J k4 ()%EFF i &)sxx6GGZ%[\\$UJ YPZ[Hj Z r rrBcnd}|jD]\}}|j|dj|}|j|} | r!|jt dd|d| t ||} | t ur$| s|jt dd|dd}nxt| t|k7r9|jt dd |d t| d t|d}n(t|trt|||||\} } |xr| }|j||fS) NTrTr&z data_dict 'z': deprecated - r'z': key unknown in schema_dictFzdata_dict: type mismatch 'z ': expected z, is: ) itemsappendr_rIrrPrtyperYr`rpop) rrBrrr3rArG data_valuerNdeprecated_msg schema_value_valid_s r rrsGH%??,Z Sxx#-    k&KvEUVdUe2fg hT;/ 5 !!!+i;tfLi9j"kl  , 4 #3 3   1$7G\HZG[[abfgqbrast  H  D )!%[*jYIFA*FH ;> Z r base_dictupd_dictct|ts tdt|ts td|g}|jD]\}}t|trc||vrFt||tstddj |dt |||||gzat j|||<zt|trc||vrFt||tstddj |d||j|t j|||<t|trn||vrUt||tstddj |d||j|j V|j ||<kt j |||<y) aDeep-update of dictionary in ``base_dict`` by dictionary in ``upd_dict``. For each ``upd_key`` & ``upd_val`` pair in ``upd_dict``: 0. If types of ``base_dict[upd_key]`` and ``upd_val`` do not match raise a :py:obj:`TypeError`. 1. If ``base_dict[upd_key]`` is a dict: recursively deep-update it by ``upd_val``. 2. If ``base_dict[upd_key]`` not exist: set ``base_dict[upd_key]`` from a (deep-) copy of ``upd_val``. 3. If ``upd_val`` is a list, extend list in ``base_dict[upd_key]`` by the list in ``upd_val``. 4. If ``upd_val`` is a set, update set in ``base_dict[upd_key]`` by set in ``upd_val``. z-argument 'base_dict' is not a dictionary typez,argument 'upd_dict' is not a dictionary typeNztype mismatch rTz!: is not a dict type in base_dictz!: is not a list type in base_dictz : is not a set type in base_dict) rYr`r=rr_rMrErFlistextendr]r>)rrrupd_keyupd_vals r rMrM=s( i &GHH h %FGG }$NN,44 gt $)#!)G"4d;#nSXXe_4EEf$ghhg&&*]]7%; '"  &)#")G"4d;#nSXXe_4EEf$ghh'"))'2 &*]]7%; '"  %)#!)G"4c:#nSXXe_4EEe$fgg'"))',,.9 &-\\^ '" "&7!3Ig i44r )r r)rrr ) r!r-rEloggingrcr|__all__ getLoggerrr6rrprrfinalrrrrrr"rdr8r`rrrPtuplersrr;rrMrr r rs  Pg!_(      i;*;;v v rw||+S&**_ 58& c6::o&& 37VZZ3H& VZ[^`c[cVd&  4k" "#& R* 9* [!* c6::o&* CO$ * S#X *  4k" "# * ZP4tCO4P4S&**_@UP4^bcf^gjn^nP4r