a
S @ s d Z dZdZddlZddlZddlmZ ejdk r8eZne Zdd Z
e Z e
d ejejB Ze
d
ejejB Zd Zd e Zze W n ey d
d ZY n0 dd Zdd ZG dd deZG dd deZG dd deZG dd de Z G dd d eZ G d d d eZ G d d d e Z G d!d" d"e Z!G d#d$ d$e Z"G d%d& d&e Z#G d'd( d(e$Z%dVd*d+Z&dWd,d-Z'dXd.d/Z(d0d0d0d0d0d)d)d)d)d)d1
Z)d2d3 Z*d4d5 Z+dYd6d7Z,dZd8d9Z-d[d:d;Z.d\dd?Z0d^d@dAZ1d_dBdCZ2d`dDdEZ3dadFdGZ4e'e(e+e.e*dHZ5dIdJ Z6dKdL Z7dMdN Z8dOdP Z9dQdR Z:e;dSkrddlZddldSZ?e?j@A ZBeBCdTe% i e r$ 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*c C s | rdS dS dS )z$Simple boolean equivalent function. r Nr! )valr! r! r# bool
s r( c C sR ddl }ddl}z |d|| d W S |jyL td| Y n0 dS )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
r N!Lz Not a good dotted-quad IP: %s)socketstructunpackZ inet_atonstriperror
ValueError)Zipr* r+ r! r! r# r s r c
C sv ddl }ddl}| tdks$| dk r0td| z||dt| W S |j|jtfyp td| Y n0 dS )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
r Nl zNot a good numeric IP: %sr) )r* r+ longr/ Z inet_ntoapackr.
OverflowError)Znumr* r+ r! r! r# r 0 s ( r c @ s e Zd ZdZdS )r a
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# r d s r c @ s e Zd ZdZdS )r
z1No value was supplied to a check that needed one.Nr3 r! r! r! r# r
r s r
c @ s e Zd ZdZdd ZdS )r z'An unknown check function was requestedc C s t | d|f dS )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# r9 y s z VdtUnknownCheckError.__init__Nr4 r5 r6 r7 r9 r! r! r! r# r v s r c @ s e Zd ZdZdd ZdS )r z!An incorrect parameter was passedc C s t | d||f dS )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# r9 s zVdtParamError.__init__Nr= r! r! r! r# r s r c @ s e Zd ZdZdd ZdS )r z(The value supplied was of the wrong typec C s t | d|f dS )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.Nr8 r: r! r! r# r9 s zVdtTypeError.__init__Nr= r! r! r! r# r s r c @ s e Zd ZdZdd ZdS )r zIThe value supplied was of the correct type, but was not an allowed value.c C s t | d|f dS )z
>>> raise VdtValueError('jedi')
Traceback (most recent call last):
VdtValueError: the value "jedi" is unacceptable.
z the value "%s" is unacceptable.Nr8 r: r! r! r# r9 s zVdtValueError.__init__Nr= r! r! r! r# r s r c @ s e Zd ZdZdd ZdS )r z>The value supplied was of the correct type, but was too small.c C s t | d|f dS )z
>>> raise VdtValueTooSmallError('0')
Traceback (most recent call last):
VdtValueTooSmallError: the value "0" is too small.
z the value "%s" is too small.Nr8 r: r! r! r# r9 s z VdtValueTooSmallError.__init__Nr= r! r! r! r# r s r c @ s e Zd ZdZdd ZdS )r
z>> raise VdtValueTooBigError('1')
Traceback (most recent call last):
VdtValueTooBigError: the value "1" is too big.
zthe value "%s" is too big.Nr8 r: r! r! r# r9 s z VdtValueTooBigError.__init__Nr= r! r! r! r# r
s r
c @ s e Zd ZdZdd ZdS )r z>The value supplied was of the correct type, but was too short.c C s t | d|f dS )z
>>> raise VdtValueTooShortError('jed')
Traceback (most recent call last):
VdtValueTooShortError: the value "jed" is too short.
z the value "%s" is too short.Nr8 r: r! r! r# r9 s z VdtValueTooShortError.__init__Nr= r! r! r! r# r s r c @ s e Zd ZdZdd ZdS )r z=The value supplied was of the correct type, but was too long.c C s t | d|f dS )z
>>> raise VdtValueTooLongError('jedie')
Traceback (most recent call last):
VdtValueTooLongError: the value "jedie" is too long.
zthe value "%s" is too long.Nr8 r: r! r! r# r9 s z VdtValueTooLongError.__init__Nr= r! r! r! r# r s r c @ s e Zd ZdZedejZedejZe Z e
Z
ee ej ejB Z
eeej ejB ZdddZddd Zd
d Zd d
Zdd Zdd Zdd Zdd Zdd Zdd ZdS ) r a3
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*(.*)$Nc C sR | j ttttttttt t
t t t
| j ttd| _|durB| j| t| _i | _dS )z(
>>> vtri = Validator()
) integerfloatbooleanip_addrstringlisttupleZint_listZ
float_listZ bool_listZ ip_addr_listZ string_list
mixed_listpassoption
force_listN)_passr r r r r r r r r r r r r r rK functionsupdater ZbaseErrorClass_cache)r; rM r! r! r# r9 3 s, zValidator.__init__Fc C sJ | |\}}}}|r.|du r$t | |}|du r: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# rS Q s
zValidator.checkc C s" |dkr d S |dv r | |}|S )NNonez'None'z"None")_unquoter: r! r! r# rQ t s
zValidator._handle_nonec C s || j v r.| j | \}}}}t|}t|}nF| |\}}}}tdd t| D }|t|t||f| j |< ||||fS )Nc S s g | ]\}}t ||fqS r! )str).0keyr< r! r! r#
r% z1Validator._parse_with_caching..)rO rF dict _parse_checkitems)r; rS rU rV rW rX r! r! r# rP } s
z Validator._parse_with_cachingc C sD z| j | }W n ty( t|Y n0 ||g|R i |S d S r )rM KeyErrorr )r; r< rU rV rW funr! r! r# rR s
zValidator._check_valuec C s | j |}|r|d}|d}| j|}|d u rDtd| g }i }| j|D ]}| }| j|} | r| | \}
} | ||
< qX| j
|} | r| d} | dvr| | } | || d< qX| | | qXn |di d fS |
dd }
||||
fS )Nr& zBad syntax in check "%s".rZ r! rX )_func_rematchgroup _matchfinderr _paramfinderfindallr- _list_arg _list_handle_key_argr[ appendpop)r; rS Z fun_matchrU
arg_stringZ arg_matchrV rW arg listmatchr^ r' ZkeymatchrX r! r! r# ra s6
zValidator._parse_checkc C s8 t |dkr4|d dv r4|d |d kr4|dd }|S )z Unquote a value if necessary.re r )'"r& )len)r; r' r! r! r# r[ s ( zValidator._unquotec C sB g }| d}| d}| j|D ]}|| | q$||fS )z7Take apart a ``keyword=list('val, 'val')`` type string.r& re )rh
_list_membersrk ro r[ )r; rs outr? argsrr r! r! r# rm s
zValidator._list_handlec C s |S )z
Dummy check that always passes
>>> vtor.check('', 0)
0
>>> vtor.check('', '0')
'0'
r! r: r! r! r# rL s zValidator._passc C sL | |\}}}}|du r&td| | |}|du r<|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.)rP rc rQ rR )r; rS rU rV rW rX r< r! r! r# get_default_value s
zValidator.get_default_value)N)F)r4 r5 r6 r7 recompileDOTALLrf rn rl rx _paramstringVERBOSErj _matchstringri r9 rS rQ rP rR ra r[ rm rL r{ r! r! r! r# r s" H
# (
r Fc C s |rt p
t}g }t| |D ]|\}}|du r6|| qt|ttt tfrz||| W q ty } zt||W Y d}~qd}~0 0 qt||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) rB intzipro
isinstancer0 string_typer/ r )namesvaluesto_floatrd Z
out_paramsr? r' er! r! r#
_is_num_param s " r c C s t d||f\}}t| tttfs*t| t| tr\z t| } W n tyZ t| Y n0 |durt| |k rtt| |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) r r r r0 r r r/ r r
r< r r Zmin_valZmax_valr! r! r# r s (
r c C s t d||fdd\}}t| ttttfs0t| t| tsbz t| } W n ty` t| Y n0 |durz| |k rzt| |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.
r T)r N)
r r r r0 rB r r r/ r r
r r! r! r# r G s #
r T)
TZon1trueZyesFZoff0Zfalsenoc C sX t | tr4zt| W S ty2 t| Y n0 | dkr@dS | dkrLdS t| 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)r r bool_dictlowerrc r r< r! r! r# r s ,
r c C sF t | tst| | } z t| W n ty@ t| Y n0 | 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.
)r r r r- r r/ r r r! r! r# r s
r c C s t d||f\}}t| tr$t| z t| }W n tyJ t| Y n0 |durd||k rdt| |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.
r N) r r r r rw TypeErrorr r rF r< r r Zmin_lenZmax_lenZ num_membersr! r! r# r s
r c C s t t| ||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.
)rG r r< r r r! r! r# r s r c C s t | tst| td||f\}}z t| }W n tyJ t| Y n0 |durd||k rdt| |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.
r N)r r r r rw r r r r r! r! r# r 1 s
r c C s dd t | ||D S )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.
c S s g | ] }t |qS r! )r r] Zmemr! r! r# r_ i r% z is_int_list..r r r! r! r# r U s r c C s dd t | ||D S )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.
c S s g | ] }t |qS r! )r r r! r! r# r_ r% z is_bool_list..r r r! r! r# r l s r c C s dd t | ||D S )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.
c S s g | ] }t |qS r! )r r r! r! r# r_ r% z!is_float_list..r r r! r! r# r s r c C s( t | trt| dd t| ||D S )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.
c S s g | ] }t |qS r! )r r r! r! r# r_ r% z"is_string_list..)r r r r r r! r! r# r s
r c C s dd t | ||D S )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.
c S s g | ] }t |qS r! )r r r! r! r# r_ r% z#is_ip_addr_list..r r r! r! r# r s r c C s 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']
)r rF rG r r r! r! r# rK s rK )rA rB rD rE rC c
G s z t | }W n ty& t| Y n0 |t |k r>t| n|t |krRt| zdd t|| D W S ty } ztd|W Y d}~n
d}~0 0 dS )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'"
c S s g | ]\}}t | |qS r! )fun_dict)r] rr r' r! r! r# r_ r% z!is_mixed_list..rH N)rw r r r r r rc r )r< rz lengthr r! r! r# r s +
r c G s& 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.
)r r r r )r< optionsr! r! r# r $ s
r c O s
| ||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< rz Zkeywargsr! r! r# _test8 s Qr c C s dS )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# _test2 s r c C s dS )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# _test3 s r __main__Zvtor)globsZ optionflags)F)NN)NN)NN)NN)NN)NN)NN)NN)NN)NN)NN)Ir7 r __all__r| sysr version_infoZ
basestringr r\ Zunicoder r0 r} r r~ rl rx r r r( NameErrorr r Exceptionr r
r r> r r r r r
r r objectr r r r r r r r r r r r r r r rK r r r r r r r4 Zdoctestmodulesgetm__dict__copyr rN ZtestmodZIGNORE_EXCEPTION_DETAILELLIPSISZfailuresZtestsr! r! r! r# s p!
) 4
%
8
5
<%
-
"
$
9T