�
`�cp� � �@ � d Z dZdZddlZddlZddlmZ ej dk reZne Zd� Z
e Z ej
dej ej z � � Z ej
d ej ej z � � Zd
Zd ez Z e n# e$ r d � ZY nw xY wd
� Zd� Z G d� de� � Z G d� de� � Z G d� de� � Z G d� de � � Z G d� de� � Z G d� de� � Z G d� d e � � Z G d � d e � � Z! G d � d e � � Z" G d!� d"e � � Z# G d#� d$e$� � Z%d@d&�Z&dAd'�Z'dAd(�Z(d)d)d)d)d)d%d%d%d%d%d*�
Z)d+� Z*d,� Z+dAd-�Z,dAd.�Z-dAd/�Z.dAd0�Z/dAd1�Z0dAd2�Z1dAd3�Z2dAd4�Z3dAd5�Z4e'e(e+e.e*d6�Z5d7� Z6d8� Z7d9� Z8d:� Z9d;� Z:e;d<k r�ddlZddl<Z<ej= �> d<� � Z?e?j@ �A � � ZBeB�C d= e%� � i� � e<jD e?eBe<jE e<jF z �>� � \ ZGZHeGr J d?�I eGeH� � � � �dS dS )Ba
The Validator object is used to check that supplied values
conform to a specification.
The value can be supplied as a string - e.g. from a config file.
In this case the check will also *convert* the value to
the required type. This allows you to add validation
as a transparent layer to access data stored as strings.
The validation checks that the data is correct *and*
converts it to the expected type.
Some standard checks are provided for basic data types.
Additional checks are easy to write. They can be
provided when the ``Validator`` is instantiated or
added afterwards.
The standard functions work with the following basic data types :
* integers
* floats
* booleans
* strings
* ip_addr
plus lists of these datatypes
Adding additional checks is done through coding simple functions.
The full set of standard checks are :
* 'integer': matches integer values (including negative)
Takes optional 'min' and 'max' arguments : ::
integer()
integer(3, 9) # any value from 3 to 9
integer(min=0) # any positive value
integer(max=9)
* 'float': matches float values
Has the same parameters as the integer check.
* 'boolean': matches boolean values - ``True`` or ``False``
Acceptable string values for True are :
true, on, yes, 1
Acceptable string values for False are :
false, off, no, 0
Any other value raises an error.
* 'ip_addr': matches an Internet Protocol address, v.4, represented
by a dotted-quad string, i.e. '1.2.3.4'.
* 'string': matches any string.
Takes optional keyword args 'min' and 'max'
to specify min and max lengths of the string.
* 'list': matches any list.
Takes optional keyword args 'min', and 'max' to specify min and
max sizes of the list. (Always returns a list.)
* 'tuple': matches any tuple.
Takes optional keyword args 'min', and 'max' to specify min and
max sizes of the tuple. (Always returns a tuple.)
* 'int_list': Matches a list of integers.
Takes the same arguments as list.
* 'float_list': Matches a list of floats.
Takes the same arguments as list.
* 'bool_list': Matches a list of boolean values.
Takes the same arguments as list.
* 'ip_addr_list': Matches a list of IP addresses.
Takes the same arguments as list.
* 'string_list': Matches a list of strings.
Takes the same arguments as list.
* 'mixed_list': Matches a list with different types in
specific positions. List size must match
the number of arguments.
Each position can be one of :
'integer', 'float', 'ip_addr', 'string', 'boolean'
So to specify a list with two strings followed
by two integers, you write the check as : ::
mixed_list('string', 'string', 'integer', 'integer')
* 'pass': This check matches everything ! It never fails
and the value is unchanged.
It is also the default if no check is specified.
* 'option': This check matches any from a list of options.
You specify this check with : ::
option('option 1', 'option 2', 'option 3')
You can supply a default value (returned if no value is supplied)
using the default keyword argument.
You specify a list argument for default using a list constructor syntax in
the check : ::
checkname(arg1, arg2, default=list('val 1', 'val 2', 'val 3'))
A badly formatted set of arguments will raise a ``VdtParamError``.
z1.0.1) � __version__�dottedQuadToNum�numToDottedQuad�
ValidateError�VdtUnknownCheckError�
VdtParamError� VdtTypeError�
VdtValueError�VdtValueTooSmallError�VdtValueTooBigError�VdtValueTooShortError�VdtValueTooLongError�VdtMissingValue� Validator�
is_integer�is_float�
is_boolean�is_list�is_tuple�
is_ip_addr� is_string� is_int_list� is_bool_list�
is_float_list�is_string_list�is_ip_addr_list�
is_mixed_list� is_option� N)�pprint)� c � � | S �N� )�xs �4/usr/lib/python3/dist-packages/configobj/validate.py�<lambda>r& � s � �� � 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 � � | rdS dS )z$Simple boolean equivalent function. � r r# )�vals r% �boolr+ s � � � ��1��1r' c �� � ddl }ddl} |� d|� | � � � � � � � d S # |j $ r t
d| z � � �w xY w)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)�socket�struct�unpack� inet_aton�strip�error�
ValueError)�ipr. r/ s r% r r s� � �( ��������?��}�}�T� � � �R�X�X�Z�Z� (� (�*� *�*+�-� -�� �<� ?� ?� ?��8�2�=�>�>�>�?���s �A A � A(c �0 � ddl }ddl}| t d� � k s| dk rt d| z � � � |� |� dt | � � � � � � S # |j |j t f$ r t d| z � � �w xY w)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/ �longr4 � inet_ntoa�packr3 �
OverflowError)�numr. r/ s r% r r / s� � �P �������� �T�*�
�
� � ��q����4�s�:�;�;�;�<�� � � �K�K��d�3�i�i� (� (�*� *� *�� �L�&�,�
� 6� <� <� <��4�s�:�;�;�;�<���s �5A+ �+*Bc � � 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 c s � � � � � �
�
�
�
r' r c � � e Zd ZdZdS )r z1No value was supplied to a check that needed one.Nr= r# r' r% r r q s � � � � � �;�;�;�;r' r c � � e Zd ZdZd� ZdS )r z'An unknown check function was requestedc �D � t � | d|�d�� � dS )z�
>>> raise VdtUnknownCheckError('yoda')
Traceback (most recent call last):
VdtUnknownCheckError: the check "yoda" is unknown.
z the check "z
" is unknown.N�r �__init__��self�values r% rF z VdtUnknownCheckError.__init__x �) � � � � �t�t�U�U�U�%L�M�M�M�M�Mr' N�r> r? r@ rA rF r# r' r% r r u s. � � � � � �1�1�N� N� N� N� Nr' r c � � e Zd ZdZd� ZdS )r z!An incorrect parameter was passedc �J � t � | d|�d|�d�� � dS )z�
>>> raise VdtParamError('yoda', 'jedi')
Traceback (most recent call last):
VdtParamError: passed an incorrect value "jedi" for parameter "yoda".
zpassed an incorrect value "z" for parameter "z".N)� SyntaxErrorrF )rH �namerI s r% rF zVdtParamError.__init__� s5 � � � � �T�T�[`�[`�[`�bf�bf�bf�#g�h�h�h�h�hr' NrK r# r' r% r r � s. � � � � � �+�+�i� i� i� i� ir' r c � � e Zd ZdZd� ZdS )r z(The value supplied was of the wrong typec �D � t � | d|�d�� � dS )z�
>>> raise VdtTypeError('jedi')
Traceback (most recent call last):
VdtTypeError: the value "jedi" is of the wrong type.
� the value "z" is of the wrong type.NrE rG s r% rF zVdtTypeError.__init__� s) � � � � �t�t�u�u�u�%V�W�W�W�W�Wr' NrK r# r' r% r r � s. � � � � � �2�2�X� X� X� X� Xr' r c � � e Zd ZdZd� ZdS )r zIThe value supplied was of the correct type, but was not an allowed value.c �D � t � | d|�d�� � dS )z�
>>> raise VdtValueError('jedi')
Traceback (most recent call last):
VdtValueError: the value "jedi" is unacceptable.
rR z" is unacceptable.NrE rG s r% rF zVdtValueError.__init__� s) � � � � �t�t�%�%�%�%Q�R�R�R�R�Rr' NrK r# r' r% r r � s. � � � � � �S�S�S� S� S� S� Sr' r c � � e Zd ZdZd� ZdS )r
z>The value supplied was of the correct type, but was too small.c �D � t � | d|�d�� � dS )z�
>>> raise VdtValueTooSmallError('0')
Traceback (most recent call last):
VdtValueTooSmallError: the value "0" is too small.
rR z" is too small.NrE rG s r% rF z VdtValueTooSmallError.__init__� s) � � � � �t�t�u�u�u�%N�O�O�O�O�Or' NrK r# r' r% r
r
� s. � � � � � �H�H�P� P� P� P� Pr' r
c � � e Zd ZdZd� ZdS )r z<The value supplied was of the correct type, but was too big.c �D � t � | d|�d�� � dS )z�
>>> raise VdtValueTooBigError('1')
Traceback (most recent call last):
VdtValueTooBigError: the value "1" is too big.
rR z
" is too big.NrE rG s r% rF z VdtValueTooBigError.__init__� rJ r' NrK r# r' r% r r � s. � � � � � �F�F�N� N� N� N� Nr' r c � � e Zd ZdZd� ZdS )r z>The value supplied was of the correct type, but was too short.c �D � t � | d|�d�� � dS )z�
>>> raise VdtValueTooShortError('jed')
Traceback (most recent call last):
VdtValueTooShortError: the value "jed" is too short.
rR z" is too short.NrE rG s r% rF z VdtValueTooShortError.__init__� s5 � � � � � �D�.3�e�e� 5� 7� 7� 7� 7� 7r' NrK r# r' r% r r � s) � � � � � �H�H�7� 7� 7� 7� 7r' r c � � e Zd ZdZd� ZdS )r
z=The value supplied was of the correct type, but was too long.c �D � t � | d|�d�� � dS )z�
>>> raise VdtValueTooLongError('jedie')
Traceback (most recent call last):
VdtValueTooLongError: the value "jedie" is too long.
rR z" is too long.NrE rG s r% rF z VdtValueTooLongError.__init__� s) � � � � �t�t�e�e�e�%M�N�N�N�N�Nr' NrK r# r' r% r
r
� s. � � � � � �G�G�O� O� O� O� Or' r
c �* � e Zd ZdZ ej dej � � Z ej dej � � Ze Z e
Z
ej e ej ej z � � Z
ej eej ej z � � Zdd�Zdd�Zd� Zd � Zd
� Zd � Zd � Zd
� Zd� Zd� 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 � � i d| j �dt �dt �dt �dt �dt
�dt �dt �d t �d
t �d t �d t �d
t �dt �d| j �dt �dt �| _ |�| j � |� � t$ | _ i | _ dS )z(
>>> vtri = Validator()
� �integer�float�boolean�ip_addr�string�list�tuple�int_list�
float_list� bool_list� ip_addr_list� string_list�
mixed_list�pass�option�
force_listN)�_passr r r r r r r r r r r r r r ro � functions�updater �baseErrorClass�_cache)rH rq s r% rF zValidator.__init__2 s � �
� ��
�
� �z�
�
�X�
�
�z�
�
�z�
�
�i�
�
�G�
�
�X�
�
� �
�
�-�
�
� �
�
�O�
�
�>�
�
�-�
�
�D�J�
�
�i�!
�"
�*�#
���& � � �N� !� !�)� ,� ,� ,� +����� � � r' Fc � � | � |� � \ }}}}|r%|�t � � �| � |� � }|�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)rH �checkrI �missing�fun_name�fun_args�
fun_kwargs�defaults r% ry zValidator.checkP sp � �* 37�2J�2J�5�2Q�2Q�/��(�J�� � /���%�'�'�'��%�%�g�.�.�E� �=��4�� � ���(�J�G�G�Gr' c �H � |dk rd S |dv r| � |� � }|S )N�None�z'None'z"None")�_unquoterG s r% rw zValidator._handle_nones s2 � � �F�?�?��4�
�*�
*�
*��M�M�%�(�(�E�� r' c �v � || j v r1| j | \ }}}}t |� � }t |� � }nz| � |� � \ }}}}t d� t |� � � � � D � � � � }|t |� � t |� � |f| j |< ||||fS )Nc �6 � g | ]\ }}t |� � |f��S r# )�str)�.0�keyrI s r% �
<listcomp>z1Validator._parse_with_caching.<locals>.<listcomp>� s' � � ^� ^� ^�\�c�5��C���%� 0� ^� ^� ^r' )rt re �dict� _parse_check�items)rH ry r{ r| r} r~ s r% rv z Validator._parse_with_caching| s� � � �D�K� � �6:�k�%�6H� 3�H�h�
�G� �H�~�~�H� �j�)�)�J�J�6:�6G�6G��6N�6N� 3�H�h�
�G� � ^� ^�T�*�JZ�JZ�J\�J\�E]�E]� ^� ^� ^�_�_�J�!)�4��>�>�4�
�;K�;K�W�!T�D�K�� ���:�w�6�6r' c �p � | j | } ||g|�R i |��S # t $ r t |� � �w xY wr" )rq �KeyErrorr )rH rI r{ r| r} �funs r% rx zValidator._check_value� s` � � 7��.��*�C� �3�u�6�x�6�6�6�:�6�6� 6�� � 1� 1� 1�&�x�0�0� 0� 1���s �
�5c �& � | j � |� � }|�rS|� d� � }|� d� � }| j � |� � }|�t d|z � � �g }i }| j � |� � D ]�}|� � � }| j � |� � } | r | � | � � \ }
} | ||
< �P| j
� |� � } | rG| � d� � } | dvr| � | � � } | || � d� � < ��|� | � |� � � � ��n|di d fS |�
dd � � }
||||
fS )Nr) � zBad syntax in check "%s".r� r# r~ )�_func_re�match�group� _matchfinderr � _paramfinder�findallr2 � _list_arg� _list_handle�_key_argr� �append�pop)rH ry � fun_matchr{ �
arg_string� arg_matchr| r} �arg� listmatchr� r* �keymatchr~ s r% r� zValidator._parse_check� s� � ��M�'�'��.�.� � � '� ���q�)�)�H�"� � ��+�+�J� �)�/�/�
�;�;�I�� �#�$?�%�$G�H�H�H��H��J��(�0�0��<�<�
4�
4���i�i�k�k�� �N� 0� 0�� 5� 5� � � � #� 0� 0�� ;� ;�H�C��&)�J�s�O� � �=�.�.�s�3�3��� �"�.�.��+�+�C� �"6�6�6� "�m�m�C� 0� 0��47�J�x�~�~�a� 0� 0�1� �����
�
�c� 2� 2�3�3�3�3�#
4�( �"�b�$�&� &� �.�.��D�1�1����:�w�6�6r' c �x � t |� � dk r&|d dv r |d |d k r
|dd� }|S )z Unquote a value if necessary.r� r )�'�"���r) )�len)rH r* s r% r� zValidator._unquote� sC � � ��H�H��M�M��A��*� 4� 4�3�q�6�S��W�;L�;L��a��d�)�C��
r' c �� � g }|� d� � }|� d� � }| j � |� � D ]*}|� | � |� � � � �+||fS )z7Take apart a ``keyword=list('val, 'val')`` type string.r) r� )r� �
_list_membersr� r� r� )rH r� �outrO �argsr� s r% r� zValidator._list_handle� st � ������q�!�!�����q�!�!���%�-�-�d�3�3� +� +�C� �J�J�t�}�}�S�)�)� *� *� *� *��S�y�r' c � � |S )z�
Dummy check that always passes
>>> vtor.check('', 0)
0
>>> vtor.check('', '0')
'0'
r# rG s r% rp zValidator._pass� s � � � r' c � � | � |� � \ }}}}|�t d|z � � �| � |� � }|�|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.)rv r� rw rx )rH ry r{ r| r} r~ rI s r% �get_default_valuezValidator.get_default_value� sp � � 37�2J�2J�5�2Q�2Q�/��(�J�� �?��=��E�F�F� F��!�!�'�*�*�� �=��L�� � ���(�J�G�G�Gr' r" �F)r> r? r@ rA �re�compile�DOTALLr� r� r� r� � _paramstring�VERBOSEr� � _matchstringr� rF ry rw rv rx r� r� r� rp r� r# r' r% r r � sD � � � � � �E� E�P �r�z�*�B�I�6�6�H� �r�z�B�R�Y�O�O�H� �I� "�M� �2�:�l�B�J���,B�C�C�L� �2�:�l�B�J���,B�C�C�L�� � � �< H� H� H� H�F� � � 7� 7� 7� 7� 7� 7�%7� %7� %7�P� � �� � � � � �H� H� H� H� Hr' r Fc �x � |rt pt }g }t | |� � D ]�\ }}|�|� |� � � t |t t
t t f� � rB |� ||� � � � �e# t $ r}t ||� � �d}~ww xY wt ||� � �|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) ra �int�zipr� �
isinstancer7 � string_typer4 r )�names�values�to_floatr� �
out_paramsrO r* �es r% �
_is_num_paramr� � s� � � �
�u�
#��C��J��5�&�)�)� +� +� ��s� �;� � � �c� "� "� "� "�
��c�4�� � <�
=�
=� +�
/��!�!�#�#�c�(�(�+�+�+�+�� �
/�
/�
/�#�D�#�.�.�.�����
/���� ��c�*�*� *� �s �) B�
B'�B"�"B'c �t � t d||f� � \ }}t | t t t f� � st | � � �t | t � � r. t | � � } n # t $ r t | � � �w xY w|�| |k rt | � � �|�| |k rt | � � �| 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
��min�max) r� r� r� r7 r� r r4 r
r �rI r� r� �min_val�max_vals r% r r s� � �P '�~��S�z�B�B��W�g� �e�c�4�� 5� 6� 6� "��5�!�!�!��%��%�%� &� &���J�J�E�E��� &� &� &� �u�%�%� %� &������%�'�/�/�#�E�*�*�*���%�'�/�/�!�%�(�(�(� �Ls � A- �-Bc � � t d||fd�� � \ }}t | t t t t
f� � st
| � � �t | t � � s. t | � � } n # t $ r t
| � � �w xY w|�| |k rt | � � �|�| |k rt | � � �| 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� )
r� r� r� r7 ra r� r r4 r
r r� s r% r r F s� � �F '���c�
�T�3� 3� 3��W�g� �e�c�4�� � <� =� =� "��5�!�!�!� �e�U� #� #� &� &��%�L�L�E�E��� &� &� &� �u�%�%� %� &������%�'�/�/�#�E�*�*�*���%�'�/�/�!�%�(�(�(� �Ls �%A5 �5BT)
T�on�1�true�yesF�off�0�false�noc �� � t | t � � r= t | � � � S # t $ r t | � � �w xY w| dk rdS | dk rdS t | � � �)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.
FT)r� r� � bool_dict�lowerr� r �rI s r% r r � s� � �X �%��%�%� &� &� �U�[�[�]�]�+� +��� &� &� &� �u�%�%� %� &����
��~�~��u� �$� � ��t��5�!�!�!s � 6 �Ac �� � t | t � � st | � � �| � � � } t | � � n # t
$ r t
| � � �w xY w| 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 r2 r r4 r r� s r% r r � su � �6 �e�[� )� )� "��5�!�!�!� �K�K�M�M�E�#��� � � � �� � #� #� #��E�"�"�"�#���� �Ls �A
�
A$c �J � t d||f� � \ }}t | t � � rt | � � � t | � � }n # t
$ r t | � � �w xY w|�||k rt
| � � �|�||k rt | � � �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� ) r� r� r� r r� � TypeErrorr r
re �rI r� r� �min_len�max_len� num_memberss r% r r � s� � �> '�~��S�z�B�B��W�g��%��%�%� "��5�!�!�!�"��%�j�j� � �� � "� "� "��5�!�!�!�"������{�W� 4� 4�#�E�*�*�*���{�W� 4� 4�"�5�)�)�)� ��;�;�� �A � A%c �> � 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.
)rf r �rI r� r� s r% r r s � �> ����S�)�)� *� *�*r' c �0 � t | t � � st | � � �t d||f� � \ }} t | � � }n # t
$ r t | � � �w xY w|�||k rt
| � � �|�||k rt | � � �| 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� )r� r� r r� r� r� r r
r� s r% r r 0 s� � �, �e�[� )� )� "��5�!�!�!�&�~��S�z�B�B��W�g�"��%�j�j� � �� � "� "� "��5�!�!�!�"������{�W� 4� 4�#�E�*�*�*���{�W� 4� 4�"�5�)�)�)� �Lr� c �8 � d� 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 �, � g | ]}t |� � ��S r# )r �r� �mems r% r� z is_int_list.<locals>.<listcomp>h � � � @� @� @��J�s�O�O� @� @� @r' �r r� s r% r r T s% � �( A� @�w�u�c�3�'?�'?� @� @� @�@r' c �8 � d� 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 �, � g | ]}t |� � ��S r# )r r� s r% r� z is_bool_list.<locals>.<listcomp>� r� r' r� r� s r% r r k s% � �, A� @�w�u�c�3�'?�'?� @� @� @�@r' c �8 � d� 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 �, � g | ]}t |� � ��S r# )r r� s r% r� z!is_float_list.<locals>.<listcomp>� s � � >� >� >�c�H�S�M�M� >� >� >r' r� r� s r% r r � s$ � �( ?� >�W�U�C��%=�%=� >� >� >�>r' c � � t | t � � rt | � � �d� 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 �, � g | ]}t |� � ��S r# )r r� s r% r� z"is_string_list.<locals>.<listcomp>� s � � ?� ?� ?�s�I�c�N�N� ?� ?� ?r' )r� r� r r r� s r% r r � sD � �* �%��%�%� "��5�!�!�!� ?� ?�g�e�S�#�&>�&>� ?� ?� ?�?r' c �8 � d� 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 �, � g | ]}t |� � ��S r# )r r� s r% r� z#is_ip_addr_list.<locals>.<listcomp>� r� r' r� r� s r% r r � s% � �$ A� @�w�u�c�3�'?�'?� @� @� @�@r' c �b � t | t t f� � s| 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� re rf r r� s r% ro ro � s3 � �" �e�d�E�]� +� +� ���� �5�#�s� #� #�#r' )r` ra rc rd rb c �` � t | � � }n # t $ r t | � � �w xY w|t |� � k rt | � � �|t |� � k rt | � � � d� t || � � D � � S # t $ r}t d|� � �d}~ww xY w)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 �> � g | ]\ }}t | |� � ��S r# )�fun_dict)r� r� r* s r% r� z!is_mixed_list.<locals>.<listcomp> s( � �D�D�D�x�s�C���
�c�"�"�D�D�Dr' rl N)r� r� r r r
r� r� r )rI r� �lengthr� s r% r r � s� � �V"��U������ � "� "� "��5�!�!�!�"����
��D� � ���#�E�*�*�*� �#�d�)�)� � �"�5�)�)�)�-�D�D�3�t�U�3C�3C�D�D�D�D�� � -� -� -��L�!�,�,�,�����-���s � �,�4B �
B-�B(�(B-c �t � t | t � � st | � � �| |vrt | � � �| 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 )rI �optionss r% r r # sB � � �e�[� )� )� "��5�!�!�!� �G� � ��E�"�"�"� �Lr' c � � | ||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# )rI r� �keywargss r% �_testr� 7 s � �b
�4�� "�"r' c � � 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% �_test2r� � � � � � r' c � � dS )a�
>>> vtor.check('string(default="")', '', missing=True)
''
>>> vtor.check('string(default="\n")', '', missing=True)
'\n'
>>> print(vtor.check('string(default="\n")', '', missing=True))
<BLANKLINE>
<BLANKLINE>
>>> 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% �_test3r� � r� r' �__main__�vtor)�globs� optionflagsz{} failures out of {} testsr� )NN)JrA r �__all__r� �sysr � version_info�
basestringr� r� �unicoder� r7 r� r� r� r� r� r� r� r+ � NameErrorr r � Exceptionr r r rN r r r r
r r r
�objectr r� r r r� r r r r r r r r r r ro r� r r r� r� r� r> �doctest�modules�get�m�__dict__�copyr� rr �testmod�IGNORE_EXCEPTION_DETAIL�ELLIPSIS�failures�tests�formatr# r' r% �<module>r s� ��"n� n�` � � ��@
� � � �
�
�
�
� � � � � � �
��d��� �K�K��K�
�k�G� �D� �B�J� �* �Z�"�)��+
�
� �. ��
� � �Z�"�)�� � �
�'� �R � �$� ���D�D��� � � �� � � � ����� � � �<1<� 1<� 1<�h � � � � �I� � � � <� <� <� <� <�m� <� <� <� N� N� N� N� N�=� N� N� N� i� i� i� i� i�K� i� i� i� X� X� X� X� X�=� X� X� X� S� S� S� S� S�M� S� S� S� P� P� P� P� P�M� P� P� P� N� N� N� N� N�-� N� N� N� 7� 7� 7� 7� 7�M� 7� 7� 7� O� O� O� O� O�=� O� O� O�OH� OH� OH� OH� OH�� OH� OH� OH�d � � � �J5� 5� 5� 5�p1� 1� 1� 1�j �d��t�D� ��U�U�%�
�
� � 9"� 9"� 9"�x"� "� "�J*� *� *� *�Z +� +� +� +�D!� !� !� !�HA� A� A� A�.A� A� A� A�2?� ?� ?� ?�.@� @� @� @�4A� A� A� A�*$� $� $� $�0 �
���� � ��6-� 6-� 6-�r� � �(Q#� Q#� Q#�h� � �� � �: �z����J�J�J��N�N�N� � ���
�#�#�A�
�J�O�O� � �E� �L�L�� � � � �� � � � &�g�o� ���3�g�6F�F�H� H� H�O�H�e� �N�N�6�=�=�h��N�N�N�N�N� �� O�Ns �.A1 �1A<�;A< |