a oep @sdZdZdZddlZddlZddlmZejdkr8eZne ZddZ e Z e d ejejBZe d ejejBZd Zd eZzeWneyd dZYn0ddZddZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdd d eZ Gd!d"d"eZ!Gd#d$d$eZ"Gd%d&d&eZ#Gd'd(d(e$Z%dWd*d+Z&dXd,d-Z'dYd.d/Z(d0d0d0d0d0d)d)d)d)d)d1 Z)d2d3Z*d4d5Z+dZd6d7Z,d[d8d9Z-d\d:d;Z.d]dd?Z0d_d@dAZ1d`dBdCZ2dadDdEZ3dbdFdGZ4e'e(e+e.e*dHZ5dIdJZ6dKdLZ7dMdNZ8dOdPZ9dQdRZ:e;dSkrddlZddldSZ?e?j@AZBeBCdTe%ier$a (?: ([a-zA-Z_][a-zA-Z0-9_]*)\s*=\s*list\( ( (?: \s* (?: (?:".*?")| # double quotes (?:'.*?')| # single quotes (?:[^'",\s\)][^,\)]*?) # unquoted ) \s*,\s* )* (?: (?:".*?")| # double quotes (?:'.*?')| # single quotes (?:[^'",\s\)][^,\)]*?) # unquoted )? # last one ) \) ) z ( (?:".*?")| # double quotes (?:'.*?')| # single quotes (?:[^'",\s=][^,=]*?) # unquoted ) (?: (?:\s*,\s*)|(?:\s*$) # comma ) a (?: ( (?: [a-zA-Z_][a-zA-Z0-9_]*\s*=\s*list\( (?: \s* (?: (?:".*?")| # double quotes (?:'.*?')| # single quotes (?:[^'",\s\)][^,\)]*?) # unquoted ) \s*,\s* )* (?: (?:".*?")| # double quotes (?:'.*?')| # single quotes (?:[^'",\s\)][^,\)]*?) # unquoted )? # last one \) )| (?: (?:".*?")| # double quotes (?:'.*?')| # single quotes (?:[^'",\s=][^,=]*?)| # unquoted (?: # keyword argument [a-zA-Z_][a-zA-Z0-9_]*\s*=\s* (?: (?:".*?")| # double quotes (?:'.*?')| # single quotes (?:[^'",\s=][^,=]*?) # unquoted ) ) ) ) (?: (?:\s*,\s*)|(?:\s*$) # comma ) ) z^%s*cCs|rdSdSdS)z$Simple boolean equivalent function. rNr!)valr!r!r#bool sr(cCsRddl}ddl}z|d||dWS|jyLtd|Yn0dS)a Convert decimal dotted quad string to long integer >>> int(dottedQuadToNum('1 ')) 1 >>> int(dottedQuadToNum(' 1.2')) 16777218 >>> int(dottedQuadToNum(' 1.2.3 ')) 16908291 >>> int(dottedQuadToNum('1.2.3.4')) 16909060 >>> dottedQuadToNum('255.255.255.255') 4294967295 >>> dottedQuadToNum('255.255.255.256') Traceback (most recent call last): ValueError: Not a good dotted-quad IP: 255.255.255.256 rN!LzNot a good dotted-quad IP: %s)socketstructunpackZ inet_atonstriperror ValueError)Zipr*r+r!r!r#rs rc Csvddl}ddl}|tdks$|dkr0td|z||dt|WS|j|jtfyptd|Yn0dS)a! Convert int or long int to dotted quad string >>> numToDottedQuad(long(-1)) Traceback (most recent call last): ValueError: Not a good numeric IP: -1 >>> numToDottedQuad(long(1)) '0.0.0.1' >>> numToDottedQuad(long(16777218)) '1.0.0.2' >>> numToDottedQuad(long(16908291)) '1.2.0.3' >>> numToDottedQuad(long(16909060)) '1.2.3.4' >>> numToDottedQuad(long(4294967295)) '255.255.255.255' >>> numToDottedQuad(long(4294967296)) Traceback (most recent call last): ValueError: Not a good numeric IP: 4294967296 >>> numToDottedQuad(-1) Traceback (most recent call last): ValueError: Not a good numeric IP: -1 >>> numToDottedQuad(1) '0.0.0.1' >>> numToDottedQuad(16777218) '1.0.0.2' >>> numToDottedQuad(16908291) '1.2.0.3' >>> numToDottedQuad(16909060) '1.2.3.4' >>> numToDottedQuad(4294967295) '255.255.255.255' >>> numToDottedQuad(4294967296) Traceback (most recent call last): ValueError: Not a good numeric IP: 4294967296 rNlzNot a good numeric IP: %sr))r*r+longr/Z inet_ntoapackr. OverflowError)Znumr*r+r!r!r#r/s( rc@seZdZdZdS)ra This error indicates that the check failed. It can be the base class for more specific errors. Any check function that fails ought to raise this error. (or a subclass) >>> raise ValidateError Traceback (most recent call last): ValidateError N__name__ __module__ __qualname____doc__r!r!r!r#rcsrc@seZdZdZdS)r z1No value was supplied to a check that needed one.Nr3r!r!r!r#r qsr c@seZdZdZddZdS)rz'An unknown check function was requestedcCst|d|fdS)z >>> raise VdtUnknownCheckError('yoda') Traceback (most recent call last): VdtUnknownCheckError: the check "yoda" is unknown. zthe check "%s" is unknown.Nr__init__selfvaluer!r!r#r9xszVdtUnknownCheckError.__init__Nr4r5r6r7r9r!r!r!r#rusrc@seZdZdZddZdS)rz!An incorrect parameter was passedcCst|d||fdS)z >>> raise VdtParamError('yoda', 'jedi') Traceback (most recent call last): VdtParamError: passed an incorrect value "jedi" for parameter "yoda". z2passed an incorrect value "%s" for parameter "%s".N) SyntaxErrorr9)r;namer<r!r!r#r9szVdtParamError.__init__Nr=r!r!r!r#rsrc@seZdZdZddZdS)rz(The value supplied was of the wrong typecCst|d|fdS)z >>> raise VdtTypeError('jedi') Traceback (most recent call last): VdtTypeError: the value "jedi" is of the wrong type. z$the value "%s" is of the wrong type.Nr8r:r!r!r#r9szVdtTypeError.__init__Nr=r!r!r!r#rsrc@seZdZdZddZdS)rzIThe value supplied was of the correct type, but was not an allowed value.cCst|d|fdS)z >>> raise VdtValueError('jedi') Traceback (most recent call last): VdtValueError: the value "jedi" is unacceptable. zthe value "%s" is unacceptable.Nr8r:r!r!r#r9szVdtValueError.__init__Nr=r!r!r!r#rsrc@seZdZdZddZdS)r z>The value supplied was of the correct type, but was too small.cCst|d|fdS)z >>> raise VdtValueTooSmallError('0') Traceback (most recent call last): VdtValueTooSmallError: the value "0" is too small. zthe value "%s" is too small.Nr8r:r!r!r#r9szVdtValueTooSmallError.__init__Nr=r!r!r!r#r sr c@seZdZdZddZdS)r z>> raise VdtValueTooBigError('1') Traceback (most recent call last): VdtValueTooBigError: the value "1" is too big. zthe value "%s" is too big.Nr8r:r!r!r#r9szVdtValueTooBigError.__init__Nr=r!r!r!r#r sr c@seZdZdZddZdS)r z>The value supplied was of the correct type, but was too short.cCst|d|fdS)z >>> raise VdtValueTooShortError('jed') Traceback (most recent call last): VdtValueTooShortError: the value "jed" is too short. zthe value "%s" is too short.Nr8r:r!r!r#r9szVdtValueTooShortError.__init__Nr=r!r!r!r#r sr c@seZdZdZddZdS)r z=The value supplied was of the correct type, but was too long.cCst|d|fdS)z >>> raise VdtValueTooLongError('jedie') Traceback (most recent call last): VdtValueTooLongError: the value "jedie" is too long. zthe value "%s" is too long.Nr8r:r!r!r#r9szVdtValueTooLongError.__init__Nr=r!r!r!r#r sr c@seZdZdZedejZedejZe Z e Z ee ej ejBZ eeej ejBZdddZddd Zd d Zd d ZddZddZddZddZddZddZdS)ra3 Validator is an object that allows you to register a set of 'checks'. These checks take input and test that it conforms to the check. This can also involve converting the value from a string into the correct datatype. The ``check`` method takes an input string which configures which check is to be used and applies that check to a supplied value. An example input string would be: 'int_range(param1, param2)' You would then provide something like: >>> def int_range_check(value, min, max): ... # turn min and max from strings to integers ... min = int(min) ... max = int(max) ... # check that value is of the correct type. ... # possible valid inputs are integers or strings ... # that represent integers ... if not isinstance(value, (int, long, string_type)): ... raise VdtTypeError(value) ... elif isinstance(value, string_type): ... # if we are given a string ... # attempt to convert to an integer ... try: ... value = int(value) ... except ValueError: ... raise VdtValueError(value) ... # check the value is between our constraints ... if not min <= value: ... raise VdtValueTooSmallError(value) ... if not value <= max: ... raise VdtValueTooBigError(value) ... return value >>> fdict = {'int_range': int_range_check} >>> vtr1 = Validator(fdict) >>> vtr1.check('int_range(20, 40)', '30') 30 >>> vtr1.check('int_range(20, 40)', '60') Traceback (most recent call last): VdtValueTooBigError: the value "60" is too big. New functions can be added with : :: >>> vtr2 = Validator() >>> vtr2.functions['int_range'] = int_range_check Or by passing in a dictionary of functions when Validator is instantiated. Your functions *can* use keyword arguments, but the first argument should always be 'value'. If the function doesn't take additional arguments, the parentheses are optional in the check. It can be written with either of : :: keyword = function_name keyword = function_name() The first program to utilise Validator() was Michael Foord's ConfigObj, an alternative to ConfigParser which supports lists and can validate a config file using a config schema. For more details on using Validator with ConfigObj see: https://configobj.readthedocs.org/en/latest/configobj.html z (.+?)\((.*)\)z%^([a-zA-Z_][a-zA-Z0-9_]*)\s*=\s*(.*)$NcCsR|jttttttttt t t t t |jttd|_|durB|j|t|_i|_dS)z( >>> vtri = Validator() )integerfloatbooleanip_addrstringlisttupleZint_listZ float_listZ bool_listZ ip_addr_listZ string_list mixed_listpassoption force_listN)_passrrrrrrrrrrrrrrrK functionsupdaterZbaseErrorClass_cache)r;rMr!r!r#r92s, zValidator.__init__FcCsJ||\}}}}|r.|dur$t||}|dur:dS|||||S)a Usage: check(check, value) Arguments: check: string representing check to apply (including arguments) value: object to be checked Returns value, converted to correct type if necessary If the check fails, raises a ``ValidateError`` subclass. >>> vtor.check('yoda', '') Traceback (most recent call last): VdtUnknownCheckError: the check "yoda" is unknown. >>> vtor.check('yoda()', '') Traceback (most recent call last): VdtUnknownCheckError: the check "yoda" is unknown. >>> vtor.check('string(default="")', '', missing=True) '' N)_parse_with_cachingr _handle_none _check_value)r;checkr<missingfun_namefun_args fun_kwargsdefaultr!r!r#rSPs zValidator.checkcCs"|dkr dS|dvr||}|S)NNonez'None'z"None")_unquoter:r!r!r#rQss  zValidator._handle_nonecCs||jvr.|j|\}}}}t|}t|}nF||\}}}}tddt|D}|t|t||f|j|<||||fS)NcSsg|]\}}t||fqSr!)str).0keyr<r!r!r# r%z1Validator._parse_with_caching..)rOrFdict _parse_checkitems)r;rSrUrVrWrXr!r!r#rP|s  zValidator._parse_with_cachingcCsDz|j|}Wnty(t|Yn0||g|Ri|SdSr )rMKeyErrorr)r;r<rUrVrWfunr!r!r#rRs  zValidator._check_valuecCs|j|}|r|d}|d}|j|}|durDtd|g}i}|j|D]}|}|j|} | r| | \} } | || <qX|j |} | r| d} | dvr| | } | || d<qX| | |qXn |didfS| dd} |||| fS)Nr&zBad syntax in check "%s".rZr!rX)_func_rematchgroup _matchfinderr _paramfinderfindallr- _list_arg _list_handle_key_argr[appendpop)r;rSZ fun_matchrU arg_stringZ arg_matchrVrWarg listmatchr^r'ZkeymatchrXr!r!r#ras6           zValidator._parse_checkcCs8t|dkr4|ddvr4|d|dkr4|dd}|S)zUnquote a value if necessary.rer)'"r&)len)r;r'r!r!r#r[s( zValidator._unquotecCsBg}|d}|d}|j|D]}|||q$||fS)z7Take apart a ``keyword=list('val, 'val')`` type string.r&re)rh _list_membersrkror[)r;rsoutr?argsrrr!r!r#rms   zValidator._list_handlecCs|S)z Dummy check that always passes >>> vtor.check('', 0) 0 >>> vtor.check('', '0') '0' r!r:r!r!r#rLs zValidator._passcCsL||\}}}}|dur&td|||}|dur<|S|||||S)z Given a check, return the default value for the check (converted to the right type). If the check doesn't specify a default value then a ``KeyError`` will be raised. Nz Check "%s" has no default value.)rPrcrQrR)r;rSrUrVrWrXr<r!r!r#get_default_values  zValidator.get_default_value)N)F)r4r5r6r7recompileDOTALLrfrnrlrx _paramstringVERBOSErj _matchstringrir9rSrQrPrRrar[rmrLr{r!r!r!r#rs"H  #  (  rFc Cs|rtp t}g}t||D]|\}}|dur6||qt|ttttfrz|||Wqty}zt||WYd}~qd}~00qt||q|S)a Return numbers from inputs or raise VdtParamError. Lets ``None`` pass through. Pass in keyword argument ``to_float=True`` to use float for the conversion rather than int. >>> _is_num_param(('', ''), (0, 1.0)) [0, 1] >>> _is_num_param(('', ''), (0, 1.0), to_float=True) [0.0, 1.0] >>> _is_num_param(('a'), ('a')) Traceback (most recent call last): VdtParamError: passed an incorrect value "a" for parameter "a". N) rBintzipro isinstancer0 string_typer/r)namesvaluesto_floatrdZ out_paramsr?r'er!r!r# _is_num_params  " rcCstd||f\}}t|tttfs*t|t|tr\z t|}WntyZt|Yn0|durt||krtt||dur||krt||S)aH A check that tests that a given value is an integer (int, or long) and optionally, between bounds. A negative value is accepted, while a float will fail. If the value is a string, then the conversion is done - if possible. Otherwise a VdtError is raised. >>> vtor.check('integer', '-1') -1 >>> vtor.check('integer', '0') 0 >>> vtor.check('integer', 9) 9 >>> vtor.check('integer', 'a') Traceback (most recent call last): VdtTypeError: the value "a" is of the wrong type. >>> vtor.check('integer', '2.2') Traceback (most recent call last): VdtTypeError: the value "2.2" is of the wrong type. >>> vtor.check('integer(10)', '20') 20 >>> vtor.check('integer(max=20)', '15') 15 >>> vtor.check('integer(10)', '9') Traceback (most recent call last): VdtValueTooSmallError: the value "9" is too small. >>> vtor.check('integer(10)', 9) Traceback (most recent call last): VdtValueTooSmallError: the value "9" is too small. >>> vtor.check('integer(max=20)', '35') Traceback (most recent call last): VdtValueTooBigError: the value "35" is too big. >>> vtor.check('integer(max=20)', 35) Traceback (most recent call last): VdtValueTooBigError: the value "35" is too big. >>> vtor.check('integer(0, 9)', False) 0 minmaxN) rrrr0rrr/r r r<rrZmin_valZmax_valr!r!r#rs(   rcCstd||fdd\}}t|ttttfs0t|t|tsbz t|}Wnty`t|Yn0|durz||krzt||dur||krt ||S)a< A check that tests that a given value is a float (an integer will be accepted), and optionally - that it is between bounds. If the value is a string, then the conversion is done - if possible. Otherwise a VdtError is raised. This can accept negative values. >>> vtor.check('float', '2') 2.0 From now on we multiply the value to avoid comparing decimals >>> vtor.check('float', '-6.8') * 10 -68.0 >>> vtor.check('float', '12.2') * 10 122.0 >>> vtor.check('float', 8.4) * 10 84.0 >>> vtor.check('float', 'a') Traceback (most recent call last): VdtTypeError: the value "a" is of the wrong type. >>> vtor.check('float(10.1)', '10.2') * 10 102.0 >>> vtor.check('float(max=20.2)', '15.1') * 10 151.0 >>> vtor.check('float(10.0)', '9.0') Traceback (most recent call last): VdtValueTooSmallError: the value "9.0" is too small. >>> vtor.check('float(max=20.0)', '35.0') Traceback (most recent call last): VdtValueTooBigError: the value "35.0" is too big. rT)rN) rrrr0rBrrr/r r rr!r!r#rFs#    rT) TZon1trueZyesFZoff0ZfalsenocCsXt|tr4zt|WSty2t|Yn0|dkr@dS|dkrLdSt|dS)a Check if the value represents a boolean. >>> vtor.check('boolean', 0) 0 >>> vtor.check('boolean', False) 0 >>> vtor.check('boolean', '0') 0 >>> vtor.check('boolean', 'off') 0 >>> vtor.check('boolean', 'false') 0 >>> vtor.check('boolean', 'no') 0 >>> vtor.check('boolean', 'nO') 0 >>> vtor.check('boolean', 'NO') 0 >>> vtor.check('boolean', 1) 1 >>> vtor.check('boolean', True) 1 >>> vtor.check('boolean', '1') 1 >>> vtor.check('boolean', 'on') 1 >>> vtor.check('boolean', 'true') 1 >>> vtor.check('boolean', 'yes') 1 >>> vtor.check('boolean', 'Yes') 1 >>> vtor.check('boolean', 'YES') 1 >>> vtor.check('boolean', '') Traceback (most recent call last): VdtTypeError: the value "" is of the wrong type. >>> vtor.check('boolean', 'up') Traceback (most recent call last): VdtTypeError: the value "up" is of the wrong type. FTN)rr bool_dictlowerrcrr<r!r!r#rs,  rcCsFt|tst||}z t|Wnty@t|Yn0|S)as Check that the supplied value is an Internet Protocol address, v.4, represented by a dotted-quad string, i.e. '1.2.3.4'. >>> vtor.check('ip_addr', '1 ') '1' >>> vtor.check('ip_addr', ' 1.2') '1.2' >>> vtor.check('ip_addr', ' 1.2.3 ') '1.2.3' >>> vtor.check('ip_addr', '1.2.3.4') '1.2.3.4' >>> vtor.check('ip_addr', '0.0.0.0') '0.0.0.0' >>> vtor.check('ip_addr', '255.255.255.255') '255.255.255.255' >>> vtor.check('ip_addr', '255.255.255.256') Traceback (most recent call last): VdtValueError: the value "255.255.255.256" is unacceptable. >>> vtor.check('ip_addr', '1.2.3.4.5') Traceback (most recent call last): VdtValueError: the value "1.2.3.4.5" is unacceptable. >>> vtor.check('ip_addr', 0) Traceback (most recent call last): VdtTypeError: the value "0" is of the wrong type. )rrrr-rr/rrr!r!r#rs   rcCstd||f\}}t|tr$t|z t|}WntyJt|Yn0|durd||krdt||dur|||kr|t|t|S)a Check that the value is a list of values. You can optionally specify the minimum and maximum number of members. It does no check on list members. >>> vtor.check('list', ()) [] >>> vtor.check('list', []) [] >>> vtor.check('list', (1, 2)) [1, 2] >>> vtor.check('list', [1, 2]) [1, 2] >>> vtor.check('list(3)', (1, 2)) Traceback (most recent call last): VdtValueTooShortError: the value "(1, 2)" is too short. >>> vtor.check('list(max=5)', (1, 2, 3, 4, 5, 6)) Traceback (most recent call last): VdtValueTooLongError: the value "(1, 2, 3, 4, 5, 6)" is too long. >>> vtor.check('list(min=3, max=5)', (1, 2, 3, 4)) [1, 2, 3, 4] >>> vtor.check('list', 0) Traceback (most recent call last): VdtTypeError: the value "0" is of the wrong type. >>> vtor.check('list', '12') Traceback (most recent call last): VdtTypeError: the value "12" is of the wrong type. rN) rrrrrw TypeErrorr r rFr<rrZmin_lenZmax_lenZ num_membersr!r!r#rs   rcCstt|||S)a Check that the value is a tuple of values. You can optionally specify the minimum and maximum number of members. It does no check on members. >>> vtor.check('tuple', ()) () >>> vtor.check('tuple', []) () >>> vtor.check('tuple', (1, 2)) (1, 2) >>> vtor.check('tuple', [1, 2]) (1, 2) >>> vtor.check('tuple(3)', (1, 2)) Traceback (most recent call last): VdtValueTooShortError: the value "(1, 2)" is too short. >>> vtor.check('tuple(max=5)', (1, 2, 3, 4, 5, 6)) Traceback (most recent call last): VdtValueTooLongError: the value "(1, 2, 3, 4, 5, 6)" is too long. >>> vtor.check('tuple(min=3, max=5)', (1, 2, 3, 4)) (1, 2, 3, 4) >>> vtor.check('tuple', 0) Traceback (most recent call last): VdtTypeError: the value "0" is of the wrong type. >>> vtor.check('tuple', '12') Traceback (most recent call last): VdtTypeError: the value "12" is of the wrong type. )rGrr<rrr!r!r#rsrcCst|tst|td||f\}}z t|}WntyJt|Yn0|durd||krdt||dur|||kr|t||S)a Check that the supplied value is a string. You can optionally specify the minimum and maximum number of members. >>> vtor.check('string', '0') '0' >>> vtor.check('string', 0) Traceback (most recent call last): VdtTypeError: the value "0" is of the wrong type. >>> vtor.check('string(2)', '12') '12' >>> vtor.check('string(2)', '1') Traceback (most recent call last): VdtValueTooShortError: the value "1" is too short. >>> vtor.check('string(min=2, max=3)', '123') '123' >>> vtor.check('string(min=2, max=3)', '1234') Traceback (most recent call last): VdtValueTooLongError: the value "1234" is too long. rN)rrrrrwrr r rr!r!r#r0s   rcCsddt|||DS)a Check that the value is a list of integers. You can optionally specify the minimum and maximum number of members. Each list member is checked that it is an integer. >>> vtor.check('int_list', ()) [] >>> vtor.check('int_list', []) [] >>> vtor.check('int_list', (1, 2)) [1, 2] >>> vtor.check('int_list', [1, 2]) [1, 2] >>> vtor.check('int_list', [1, 'a']) Traceback (most recent call last): VdtTypeError: the value "a" is of the wrong type. cSsg|] }t|qSr!)rr]Zmemr!r!r#r_hr%zis_int_list..rrr!r!r#rTsrcCsddt|||DS)al Check that the value is a list of booleans. You can optionally specify the minimum and maximum number of members. Each list member is checked that it is a boolean. >>> vtor.check('bool_list', ()) [] >>> vtor.check('bool_list', []) [] >>> check_res = vtor.check('bool_list', (True, False)) >>> check_res == [True, False] 1 >>> check_res = vtor.check('bool_list', [True, False]) >>> check_res == [True, False] 1 >>> vtor.check('bool_list', [True, 'a']) Traceback (most recent call last): VdtTypeError: the value "a" is of the wrong type. cSsg|] }t|qSr!)rrr!r!r#r_r%z is_bool_list..rrr!r!r#rksrcCsddt|||DS)a Check that the value is a list of floats. You can optionally specify the minimum and maximum number of members. Each list member is checked that it is a float. >>> vtor.check('float_list', ()) [] >>> vtor.check('float_list', []) [] >>> vtor.check('float_list', (1, 2.0)) [1.0, 2.0] >>> vtor.check('float_list', [1, 2.0]) [1.0, 2.0] >>> vtor.check('float_list', [1, 'a']) Traceback (most recent call last): VdtTypeError: the value "a" is of the wrong type. cSsg|] }t|qSr!)rrr!r!r#r_r%z!is_float_list..rrr!r!r#rsrcCs(t|trt|ddt|||DS)an Check that the value is a list of strings. You can optionally specify the minimum and maximum number of members. Each list member is checked that it is a string. >>> vtor.check('string_list', ()) [] >>> vtor.check('string_list', []) [] >>> vtor.check('string_list', ('a', 'b')) ['a', 'b'] >>> vtor.check('string_list', ['a', 1]) Traceback (most recent call last): VdtTypeError: the value "1" is of the wrong type. >>> vtor.check('string_list', 'hello') Traceback (most recent call last): VdtTypeError: the value "hello" is of the wrong type. cSsg|] }t|qSr!)rrr!r!r#r_r%z"is_string_list..)rrrrrr!r!r#rs rcCsddt|||DS)a Check that the value is a list of IP addresses. You can optionally specify the minimum and maximum number of members. Each list member is checked that it is an IP address. >>> vtor.check('ip_addr_list', ()) [] >>> vtor.check('ip_addr_list', []) [] >>> vtor.check('ip_addr_list', ('1.2.3.4', '5.6.7.8')) ['1.2.3.4', '5.6.7.8'] >>> vtor.check('ip_addr_list', ['a']) Traceback (most recent call last): VdtValueError: the value "a" is unacceptable. cSsg|] }t|qSr!)rrr!r!r#r_r%z#is_ip_addr_list..rrr!r!r#rsrcCs t|ttfs|g}t|||S)a Check that a value is a list, coercing strings into a list with one member. Useful where users forget the trailing comma that turns a single value into a list. You can optionally specify the minimum and maximum number of members. A minumum of greater than one will fail if the user only supplies a string. >>> vtor.check('force_list', ()) [] >>> vtor.check('force_list', []) [] >>> vtor.check('force_list', 'hello') ['hello'] )rrFrGrrr!r!r#rKsrK)rArBrDrErCc Gsz t|}Wnty&t|Yn0|t|kr>t|n|t|krRt|zddt||DWSty}ztd|WYd}~n d}~00dS)a Check that the value is a list. Allow specifying the type of each member. Work on lists of specific lengths. You specify each member as a positional argument specifying type Each type should be one of the following strings : 'integer', 'float', 'ip_addr', 'string', 'boolean' So you can specify a list of two strings, followed by two integers as : mixed_list('string', 'string', 'integer', 'integer') The length of the list must match the number of positional arguments you supply. >>> mix_str = "mixed_list('integer', 'float', 'ip_addr', 'string', 'boolean')" >>> check_res = vtor.check(mix_str, (1, 2.0, '1.2.3.4', 'a', True)) >>> check_res == [1, 2.0, '1.2.3.4', 'a', True] 1 >>> check_res = vtor.check(mix_str, ('1', '2.0', '1.2.3.4', 'a', 'True')) >>> check_res == [1, 2.0, '1.2.3.4', 'a', True] 1 >>> vtor.check(mix_str, ('b', 2.0, '1.2.3.4', 'a', True)) Traceback (most recent call last): VdtTypeError: the value "b" is of the wrong type. >>> vtor.check(mix_str, (1, 2.0, '1.2.3.4', 'a')) Traceback (most recent call last): VdtValueTooShortError: the value "(1, 2.0, '1.2.3.4', 'a')" is too short. >>> vtor.check(mix_str, (1, 2.0, '1.2.3.4', 'a', 1, 'b')) Traceback (most recent call last): VdtValueTooLongError: the value "(1, 2.0, '1.2.3.4', 'a', 1, 'b')" is too long. >>> vtor.check(mix_str, 0) Traceback (most recent call last): VdtTypeError: the value "0" is of the wrong type. >>> vtor.check('mixed_list("yoda")', ('a')) Traceback (most recent call last): VdtParamError: passed an incorrect value "KeyError('yoda',)" for parameter "'mixed_list'" cSsg|]\}}t||qSr!)fun_dict)r]rrr'r!r!r#r_r%z!is_mixed_list..rHN)rwrrr r rrcr)r<rzlengthrr!r!r#rs+     rcGs&t|tst|||vr"t||S)a This check matches the value to any of a set of options. >>> vtor.check('option("yoda", "jedi")', 'yoda') 'yoda' >>> vtor.check('option("yoda", "jedi")', 'jed') Traceback (most recent call last): VdtValueError: the value "jed" is unacceptable. >>> vtor.check('option("yoda", "jedi")', 0) Traceback (most recent call last): VdtTypeError: the value "0" is of the wrong type. )rrrr)r<optionsr!r!r#r#s rcOs |||fS)ag A function that exists for test purposes. >>> checks = [ ... '3, 6, min=1, max=3, test=list(a, b, c)', ... '3', ... '3, 6', ... '3,', ... 'min=1, test="a b c"', ... 'min=5, test="a, b, c"', ... 'min=1, max=3, test="a, b, c"', ... 'min=-100, test=-99', ... 'min=1, max=3', ... '3, 6, test="36"', ... '3, 6, test="a, b, c"', ... '3, max=3, test=list("a", "b", "c")', ... '''3, max=3, test=list("'a'", 'b', "x=(c)")''', ... "test='x=fish(3)'", ... ] >>> v = Validator({'test': _test}) >>> for entry in checks: ... pprint(v.check(('test(%s)' % entry), 3)) (3, ('3', '6'), {'max': '3', 'min': '1', 'test': ['a', 'b', 'c']}) (3, ('3',), {}) (3, ('3', '6'), {}) (3, ('3',), {}) (3, (), {'min': '1', 'test': 'a b c'}) (3, (), {'min': '5', 'test': 'a, b, c'}) (3, (), {'max': '3', 'min': '1', 'test': 'a, b, c'}) (3, (), {'min': '-100', 'test': '-99'}) (3, (), {'max': '3', 'min': '1'}) (3, ('3', '6'), {'test': '36'}) (3, ('3', '6'), {'test': 'a, b, c'}) (3, ('3',), {'max': '3', 'test': ['a', 'b', 'c']}) (3, ('3',), {'max': '3', 'test': ["'a'", 'b', 'x=(c)']}) (3, (), {'test': 'x=fish(3)'}) >>> v = Validator() >>> v.check('integer(default=6)', '3') 3 >>> v.check('integer(default=6)', None, True) 6 >>> v.get_default_value('integer(default=6)') 6 >>> v.get_default_value('float(default=6)') 6.0 >>> v.get_default_value('pass(default=None)') >>> v.get_default_value("string(default='None')") 'None' >>> v.get_default_value('pass') Traceback (most recent call last): KeyError: 'Check "pass" has no default value.' >>> v.get_default_value('pass(default=list(1, 2, 3, 4))') ['1', '2', '3', '4'] >>> v = Validator() >>> v.check("pass(default=None)", None, True) >>> v.check("pass(default='None')", None, True) 'None' >>> v.check('pass(default="None")', None, True) 'None' >>> v.check('pass(default=list(1, 2, 3, 4))', None, True) ['1', '2', '3', '4'] Bug test for unicode arguments >>> v = Validator() >>> v.check(unicode('string(min=4)'), unicode('test')) == unicode('test') True >>> v = Validator() >>> v.get_default_value(unicode('string(min=4, default="1234")')) == unicode('1234') True >>> v.check(unicode('string(min=4, default="1234")'), unicode('test')) == unicode('test') True >>> v = Validator() >>> default = v.get_default_value('string(default=None)') >>> default == None 1 r!)r<rzZkeywargsr!r!r#_test7sQrcCsdS)z >>> >>> v = Validator() >>> v.get_default_value('string(default="#ff00dd")') '#ff00dd' >>> v.get_default_value('integer(default=3) # comment') 3 Nr!r!r!r!r#_test2srcCsdS)a >>> vtor.check('string(default="")', '', missing=True) '' >>> vtor.check('string(default="\n")', '', missing=True) '\n' >>> print(vtor.check('string(default="\n")', '', missing=True)) >>> vtor.check('string()', '\n') '\n' >>> vtor.check('string(default="\n\n\n")', '', missing=True) '\n\n\n' >>> vtor.check('string()', 'random \n text goes here\n\n') 'random \n text goes here\n\n' >>> vtor.check('string(default=" \nrandom text\ngoes \n here\n\n ")', ... '', missing=True) ' \nrandom text\ngoes \n here\n\n ' >>> vtor.check("string(default='\n\n\n')", '', missing=True) '\n\n\n' >>> vtor.check("option('\n','a','b',default='\n')", '', missing=True) '\n' >>> vtor.check("string_list()", ['foo', '\n', 'bar']) ['foo', '\n', 'bar'] >>> vtor.check("string_list(default=list('\n'))", '', missing=True) ['\n'] Nr!r!r!r!r#_test3sr__main__Zvtor)globsZ optionflagsz{} failures out of {} tests)F)NN)NN)NN)NN)NN)NN)NN)NN)NN)NN)NN)Jr7r__all__r|sysr version_infoZ basestringrr\Zunicoderr0r}rr~rlrxrrr( NameErrorrr Exceptionrr rr>rrrr r r r objectrrrrrrrrrrrrrrrrKrrrrrrr4Zdoctestmodulesgetm__dict__copyrrNZtestmodZIGNORE_EXCEPTION_DETAILELLIPSISZfailuresZtestsformatr!r!r!r#sp      ) 4        % 8 5  <% - " $       9T