a Oc`@s<dZddlZddlZddlZddlZddlmZddlm Z m Z m Z ddl m Z GdddZGdd d eZGd d d eZGd d d eZGdddeZGdddeZGdddeZGdddeZGdddZGdddeZGdddeZGdddeZGdddeZd'd!d"Zd#d$Zd(d%d&ZdS))zS Fundamental schema attributes These can be imported directly from `confu.schema` N)isclass)ApplyDefaultErrorValidationErrorValidationWarning)config_parser_dictc@s^eZdZdZdddZeddZeddZed d Zed d Z ed dZ ddZ dS) AttributezZ Base confu schema attribute. All other schema attributes should extend this cKs||_d|vr|d|_|d|_|d|_|d|_|dg|_|dd|_|dd |_|d d |_ d |_ d S) a Initialize attribute **Keyword Arguments** - name (`str`): describes the attribute name, if not specified explicitly will be set through the schema that instantiates the attribute. - default (`mixed`): the default value of this attribute. Once a default value is set, schema validation will no longer raise a validation error if the attribute is missing from the configuration. - choices (`list`): if specified on values in this list may be set for this attribute - help (`str`): help description - cli (`bool=True|function`): enable CLI support for this attribute - deprecated (`str`): version id of when this attribute will be deprecated - added (`str`): version id of when this attribute was added to the schema - removed (`str`): version id of when this attribute will be removed default deprecatedaddedremovedchoiceshelprcliTcli_show_defaultN) namegetdefault_handlerr r r choices_handlerr cli_toggler containerselfrkwargsrH/var/www/html/gsl.tools/lib/python3.9/site-packages/confu/schema/core.py__init__s    zAttribute.__init__cCs t|dS)Nr)hasattrrrrr has_defaultTszAttribute.has_defaultcCs|jo|jduSN)rr rrrrdefault_is_noneXszAttribute.default_is_nonecCs t|dd}t|r||S|S)z= Return the default value for this attribute rNgetattrcallable)rr rrrr \s zAttribute.defaultcCs"t|dd}t|r||S|S)z Return a list of possible value choices for this attribute Will return an empty list if the attribute is **NOT** limited by choices rN)r#r$r)rrrrrr fs  zAttribute.choicescCs t|dd}t|r||S|S)z Returns whether or not the attribute is available in as a cli argument when confu is used to generated argparse or click arguments rTr")rZtogglerrrrus z Attribute.clicKs<|js|jst|||d|jr8||jvr8t|||d|S)a Validate a value for this attribute Will raise a `ValidationError` or `ValidationWarning` exception on validation failure **Arguments** - value (`mixed`): the value to validate - path (`list`): current path in the config schema, this is mostly used to identify where an error occured when validating against config data, you can pass an empty list to it when calling this manually z-attribute at top level defined without a namezinvalid choice)rrrrr rvaluepathrrrrvalidates  zAttribute.validateN)r) __name__ __module__ __qualname____doc__rpropertyrr!r r rr(rrrrrs ;     rcs:eZdZdZd fdd ZeddZfddZZS) Strz Attribute that requires a string value Keyword Attributes: - blank : if True allow "" as a value rc s:tjfd|i||dd|_|js6|jr6d|_dS)NrblankFT)superrrr/default_is_blankr __class__rrrs z Str.__init__cCs |jdkS)Nr)r rrrrr1szStr.default_is_blankc sPt|ts|jst|||d|dkr:|js:t|||dtj||fi|S)Nzstring expectedrzcannot be blank) isinstancestrr!rr/r0r(r%r2rrr(s z Str.validate)r) r)r*r+r,rr-r1r( __classcell__rrr2rr.s  r.cs.eZdZdZdfdd ZfddZZS)Filez Attribute that requires a file to exist at path **Keyword Attributes** - require_exist ('bool=True'): if `True` file needs to exist rc s(tjfd|i||dd|_dS)Nr require_existT)r0rrr8rr2rrrsz File.__init__c stj||fi|}|dur(|jr(|S|dkr:|jr:|Stj|}tj|}tj|}tj |sr|j o~tj | }|st |||d|S)Nrzfile does not exist) r0r(r!r/osr' expandvars expanduserabspathexistsr8isdirrrr&r'rZvalidr2rrr(s   z File.validate)r)r)r*r+r,rr(r6rrr2rr7sr7cs6eZdZdZd fdd ZddZfddZZS) Directoryad Attribute that requires an existing directory path **Keyword Arguments** - require_exist ('bool=True'): if `True` directory needs to exist - create (`octal`): if set, instead of raising a ValidationError on a non-existing directory, attempt to create directory first using the value passed as mode (chmod) e.g., create=0o777 rc s4tjfd|i||d|_|dd|_dS)Nrcreater8T)r0rrrAr8rr2rrrs zDirectory.__init__c CsPzt||jWn8tyJ}z t|||d|WYd}~n d}~00dS)Nz4tried to create directory but failed with error: {})r9makedirsrA Exceptionrformat)rr&Z config_patherrrrrmakedirszDirectory.makedirc stj||fi|}|dur(|jr(|Stj|}|dkr@|Stj|}tj|}|jdurztj |sz| |||j rtj |otj |}nd}|st |||d||S)NrTz"valid path to directory expected: )r0r(r!r9r'r:r;r<rAr=rFr8r>rr?r2rrr(s$    zDirectory.validate)r)r)r*r+r,rrFr(r6rrr2rr@s  r@csNeZdZdZgdZgdZd fdd ZfddZd d Zd d Z Z S)Boolz1 Attribute that requires a boolean value )trueyes1)falseno0rc s tjfd|i|d|_dS)NrF)r0rrrr2rrr-sz Bool.__init__c sZt|tr@||jvrd}n"||jvr2d}nt|||dtjt||fi|S)NTFzboolean expected) r4r5lower true_values false_valuesrr0r(boolr%r2rrr(1s z Bool.validatecCs|d=d||dS)Ntypez {}/--no-{}-)rDstriprparamrrrrfinalize_click;szBool.finalize_clickcCsX|d=|ds|jddn8|jdd|drDd|d|d<d|d }|S) NrRr store_true)action store_falserz DISABLE {}z--no-{}rS)updaterrDrTrUrrrfinalize_argparse?s  zBool.finalize_argparse)r) r)r*r+r,rOrPrr(rWr\r6rrr2rrG%s rGcs eZdZdZfddZZS)Intz2 Attribute that requires an integer value c sZ|dur|jr|Sz t|}Wn$ttfyBt|||dYn0tj||fi|S)Nzinteger expected)r!int TypeError ValueErrorrr0r(r%r2rrr(Qs z Int.validater)r*r+r,r(r6rrr2rr]Ksr]cs eZdZdZfddZZS)Floatz/ Attribute that requires a float value c sZ|dur|jr|Sz t|}Wn$ttfyBt|||dYn0tj||fi|S)Nzfloat expected)r!floatr_r`rr0r(r%r2rrr(as zFloat.validaterarrr2rrb[srbcs>eZdZdZd fdd ZefddZfddZZS) Listz. Attribute that requires a list value Nc s`t|tstdd|vr"g|d<t|r2d|d<t|trB||_tj|fi|||_dS)a Initialize List attribute **Keyword Arguments** - name (`str`): describes the attribute name, if not specified explicitly will be set through the schema that instantiates the attribute. - item (`Attribute`): allows you to specify an arbitrary attribute to use for all values in the list. - default (`mixed`): the default value of this attribute. Once a default value is set, schema validation will no longer raise a validation error if the attribute is missing from the configuration. - help (`str`): help description - cli (`bool=True`): enable CLI support for this attribute - deprecated (`str`): version id of when this attribute will be deprecated - added (`str`): version id of when this attribute was added to the schema - removed (`str`): version id of when this attribute will be removed z"item needs to be a confu attributer FrN)r4rr_rrr0ritem)rrrerr2rrrus  z List.__init__cst|jtrdStjS)NF)r4reSchemar0rrr2rrrs zList.clic s"t|tr|d}t|ts,t|||d|dt}|dt}g}d}|D]}zTt|jtr| |jj |||g||dn| |j |||g|d7}WqTty} z| | WYd} ~ qTd} ~ 0t y} z| | WYd} ~ qTd} ~ 00qTtj ||fi|S)N,z list expectederrorswarningsrrhri)r4r5splitlistrrValidationErrorProcessorrerfappendr(errorrwarningr0) rr&r'rrhriZ validatedidxrerprqr2rrr(s.     "z List.validate)NN) r)r*r+r,rr-rr(r6rrr2rrdks &rdc@s eZdZdZddZddZdS)rnz| This the default validation error processor, it will raise an exception when a warning or error is encountered cCs|dSr rrrprrrrpszValidationErrorProcessor.errorcCs|dSr rrrqrrrrqsz ValidationErrorProcessor.warningN)r)r*r+r,rprqrrrrrnsrnc@s@eZdZdZddZddZddZdd Zd d Zd d Z dS)CollectValidationExceptionsz{ This validation error processor will store all errors and warnings it encounters and NOT raise any exceptions cCs g|_dSr  exceptionsrrrrrsz$CollectValidationExceptions.__init__ccs|jEdHdSr rvrrrr__iter__sz$CollectValidationExceptions.__iter__cCs t|jSr )lenrwrrrr__len__sz#CollectValidationExceptions.__len__cCs |j|Sr rv)rkeyrrr __getitem__sz'CollectValidationExceptions.__getitem__cCs|j|dSr rwrorsrrrrpsz!CollectValidationExceptions.errorcCs|j|dSr r}rtrrrrqsz#CollectValidationExceptions.warningN) r)r*r+r,rrxrzr|rprqrrrrrusrucs<eZdZdZfddZddZd ddZd d d ZZS) rfa Describes a confu schema. Instantiate confu attributes as properties of the schema. As the schema itself is a confu attribute, you may nest schemas within schemas **Example** ``` class MySchema(Schema): str_attr = Str() ``` csi|_t|D].}t||}t|tr||j|<|js||_qd|vrNi|d<d|d<|d|_|jrx|jrxtdn|jr||j_ t j |i|dS)a Initialize schema **Keyword Arguments** - item (`Attribute`): allows you to specify an arbitrary attribute to use for all values in the schema. This is only allowed if your schema does **NOT** explicitly set any attributes in it's definition - name (`str`): describes the attribute name, if not specified explicitly will be set through the schema that instantiates the attribute. - default (`mixed`): the default value of this attribute. Once a default value is set, schema validation will no longer raise a validation error if the attribute is missing from the configuration. - help (`str`): help description - cli (`bool=True`): enable CLI support for this attribute - deprecated (`str`): version id of when this attribute will be deprecated - added (`str`): version id of when this attribute was added to the schema - removed (`str`): version id of when this attribute will be removed r Frrez^You cannot specify an `item` attribute on a Schema instance that has attributes defined withinN) _attrdirr#r4rrrrer`rr0r)rargsrrattrr2rrrs$      zSchema.__init__ccst|jEdHdSr )rmr~itemsrrrr attributes(szSchema.attributesNcCs^|sg}|D]H\}}t|trH||||g|j|||gdq||||gqdS)N)r')rr4rfwalk)rcallbackr'r attributerrrr,s z Schema.walkc Cs|dur g}|durt}|dur(t}t|tjjrHt|drH|j}nt|tjr\t |}t|t s~| t |d||dSt |D]\}}zP|j||j}|durt|||d|dn|j|||g||d||<Wqt y}z| |WYd}~qd}~0ty@} z|| WYd} ~ qd} ~ 00q|D]6\} }| |vrL|jsL| t ||| gddqL|S) a Validate config data against this schema **Attributes** - config (`dict`): config to validate **Keyword Attributes** - path (`list`): current path in the config data, this can be ignored on the initial call and will be set automatically on any subsequent calls (nested schemas) - errors (`ValidationErrorProcessor`) - warnigns (`ValidationErrorProcessor`) Ndatazdictionary expectedzunknown attribute ''rjmissing)rnr4 collectionsabcMutableMappingrr configparser ConfigParserrdictrprrmrr~rrerr(rqrr) rconfigr'rhrir{r&rrprqrrrrr(6sD  "zSchema.validate)N)NNN) r)r*r+r,rrrr(r6rrr2rrfs  0 rfcs"eZdZdZdfdd ZZS)Dictzc Wrapper for schema with arbitrary keys For this the `item` property needs to be set. Ncstj|||d|dS)N)rre)r0r)rrrerrr2rrr{sz Dict.__init__)NN)r)r*r+r,rr6rrr2rrtsrc@s"eZdZdZddZdddZdS) ProxySchemaz An object that can be used in place of a schema in order to dynamically obtain a schema instance from somewhere else during validate cCs tdS)z* return a schema instance N)NotImplementedError)rrrrrschemaszProxySchema.schemaNcCs||j||||dS)zE call validate on the schema returned by self.schema )r'rhri)rr()rrr'rhrirrrr(s zProxySchema.validate)NNN)r)r*r+r,rr(rrrrrsrFc Kst}|r*|j|fd|i|dg|fSt}|j|f||d|t|}t|}|dk} |rt|r|D]} |d| jqp|D]} |d| jq| s||d|d| ||fSd S) a Helper function that allows schema validation to either collect or raise errors **Arguments** - schema (`Schema`): schema instance - config (`dict|munge.Config`) **Keyword Arguments** - raise_errors (`bool=False`): if `True` will raise a ValidationError exception if it encounters validation errors If `False` it will instead collect errors and warnings and return a tuple: ``` success(bool), errors(CollectValidationExceptions), warnings(CollectValidationException) ``` - log (`callable`): function to use to log errors, will be passed a str message - any additional kwargs will be passed on to `Schema.validate` riTrjrz[Config Error] z[Config Warning] z errors, z warnings in configN)rur(ryr$pretty) rr raise_errorslogrrirhZ num_errorsZ num_warningssuccessrprqrrrr(s"  r(cCsv|}d}|D]}|}||}q t|tr|rTt|jtrT|D]}t|j|ddq>|r~t|jtr~|D]}t||jgqhn|dur|jr|j||<nt|trVt|t r| |}|rt|jtrt|jjtrt | D]\}}t||j|gq|durt |jpi||<|jdur6t|||t|jtrrt|j||n|durr|jrr|j||<dS)z Apply attribute default to config dict at the specified path **Arguments** - config (`dict`): the config dictonary - attribute (`Attribute`): attribute instance - path (`list(str)`): full path of the attribute in the schema NTdebug)rr4rdrerfapply_defaults apply_defaultrr rrrmrcopydeepcopy)rrr'_configprevsectionrekrrrrsB            rcst|tr|}t|jtrJtD]\}}t|j||dq,dSt|jtrtD]\}}t |j|gqbdSfdd}| |dS)z Take a config object and apply a schema's default values to keys that are missing. **Arguments** - schema (`Schema`): schema instance - config (`dict`): the config dictonary rNc sHzt||Wn2tyB}zt||d|WYd}~n d}~00dSr )rrCr)rr'excrrrr,sz apply_defaults..callback) r4rrrerfrmrrrdrr)rrrrvrrrrrs     r)FN)F)r,collections.abcrrrr9inspectrZconfu.exceptionsrrrZ confu.utilrrr.r7r@rGr]rbrdrnrurfrrr(rrrrrrs2   (C&U   1I