Current File : //lib/python3.9/site-packages/ansible/module_utils/common/__pycache__/validation.cpython-39.pyc
a
�)g�J � @ sJ d dl mZmZmZ eZd dlZd dlZd dlm Z d dl
m Z d dl m
Z
d dlmZ d dlmZ d dlmZ d d lmZ d d
lmZmZmZmZ d d � Zd6dd�Z d7dd�Z d8dd�Z d9dd�Z d:dd�Z d;dd�Z!d<dd�Z"d=d d �Z#d>d d!�Z$d"d#� Z%d$d%� Z&d&d'� Z'd(d)� Z(d*d+� Z)d,d-� Z*d.d/� Z+d0d1� Z,d2d3� Z-d4d5� Z.dS )?� )�absolute_import�division�print_functionN)� literal_eval)� to_native)�json)� is_iterable)�jsonify)�human_to_bytes)�boolean)� binary_type�
integer_types� string_types� text_typec C s t | �s| g} tt| ��|��S )a Count the number of occurrences of a key in a given dictionary
:arg terms: String or iterable of values to check
:arg parameters: Dictionary of parameters
:returns: An integer that is the number of occurrences of the terms values
in the provided dictionary.
)r �len�set� intersection)�terms�
parameters� r �J/usr/lib/python3.9/site-packages/ansible/module_utils/common/validation.py� count_terms s
r Fc
C s� t | t�s|r| d fS | S t�d| �r6|r2| d fS | S t�d| �rR|rN| d fS | S z t| �}|rj|d fW S |W S W n@ ty� } z(|r�| |fW Y d }~S | W Y d }~S d }~0 0 d S )Nz \w\.\w+\(z
import \w+)�
isinstancer �re�searchr � Exception)�value�locals�include_exceptions�result�er r r � safe_eval* s*
r! c C s| g }| du r|S | D ] }t ||�}|dkr|�|� q|rxdd� |D �}dd�|� }|rld�|d�|��}tt|���|S ) a� Check mutually exclusive terms against argument parameters
Accepts a single list or list of lists that are groups of terms that should be
mutually exclusive with one another
:arg terms: List of mutually exclusive parameters
:arg parameters: Dictionary of parameters
:kwarg options_context: List of strings of parent key names if ``terms`` are
in a sub spec.
:returns: Empty list or raises :class:`TypeError` if the check fails.
N� c S s g | ]}d � |��qS )�|)�join)�.0�checkr r r �
<listcomp>^ � z,check_mutually_exclusive.<locals>.<listcomp>z%parameters are mutually exclusive: %s�, �{0} found in {1}� -> �r �appendr$ �format� TypeErrorr )r r �options_context�resultsr& �countZ full_list�msgr r r �check_mutually_exclusiveF s
r4 c C sx g }| du r|S | D ] }t ||�}|dkr|�|� q|rt|D ]4}dd�|� }|rfd�|d�|��}tt|���q>|S )a� Check each list of terms to ensure at least one exists in the given module
parameters
Accepts a list of lists or tuples
:arg terms: List of lists of terms to check. For each list of terms, at
least one is required.
:arg parameters: Dictionary of parameters
:kwarg options_context: List of strings of parent key names if ``terms`` are
in a sub spec.
:returns: Empty list or raises :class:`TypeError` if the check fails.
Nr z$one of the following is required: %sr) r* r+ r, )r r r0 r1 �termr2 r3 r r r �check_required_one_ofg s
r6 c s� g }| du r|S | D ]B}� fdd�|D �}dd� |D �}t |�dkrd|v r|�|� q|r�|D ]4}dd�|� }|r�d�|d �|��}tt|���q`|S )
a Check each list of terms to ensure every parameter in each list exists
in the given parameters.
Accepts a list of lists or tuples.
:arg terms: List of lists of terms to check. Each list should include
parameters that are all required when at least one is specified
in the parameters.
:arg parameters: Dictionary of parameters
:kwarg options_context: List of strings of parent key names if ``terms`` are
in a sub spec.
:returns: Empty list or raises :class:`TypeError` if the check fails.
Nc s g | ]}t |� ��qS r )r )r% �field�r r r r' � r( z+check_required_together.<locals>.<listcomp>c S s g | ]}|d kr|�qS )r r )r% �cr r r r' � r( r z$parameters are required together: %sr) r* r+ )r r- r$ r. r/ r )r r r0 r1 r5 ZcountsZnon_zeror3 r r8 r �check_required_together� s r: c C s� i }| du r|S | � � D ]b\}}||vs|| du r6qg ||< t|t�rN|g}|D ]&}||vsj|| du rR|| �|� qRq|r�|� � D ]H\}}t|�dkr�d|d�|�f }|r�d�|d�|��}tt|���q�|S )a� For each key in requirements, check the corresponding list to see if they
exist in parameters.
Accepts a single string or list of values for each key.
:arg requirements: Dictionary of requirements
:arg parameters: Dictionary of parameters
:kwarg options_context: List of strings of parent key names if ``requirements`` are
in a sub spec.
:returns: Empty dictionary or raises :class:`TypeError` if the
Nr z)missing parameter(s) required by '%s': %sr) r* r+ ) �itemsr r r- r r$ r. r/ r ) � requirementsr r0 r �keyr �required�missingr3 r r r �check_required_by� s(
r@ c C s� g }| du r|S | � � D ]*\}}|�dd�}|r||vr|�|� q|r|dd�t|�� }|rpd�|d�|��}tt|���|S )a Check all parameters in argument_spec and return a list of parameters
that are required but not present in parameters.
Raises :class:`TypeError` if the check fails
:arg argument_spec: Argument spec dictionary containing all parameters
and their specification
:arg parameters: Dictionary of parameters
:kwarg options_context: List of strings of parent key names if ``argument_spec`` are
in a sub spec.
:returns: Empty list or raises :class:`TypeError` if the check fails.
Nr> F� missing required arguments: %sr) r* r+ )r; �getr- r$ �sortedr. r/ r )Z
argument_specr r0 r? �k�vr> r3 r r r �check_required_arguments� s rF c
C sJ g }| du r|S | D ]�}i }g |d< d}d}t |�dkrF|\}} } }n
|\}} } |rft | �}d|d< nd|d< ||v r�|| | kr�| D ]$}
t|
|�} | dkr�|d �|
� q�t |d �rt |d �|kr||d < | |d
< | |d < |�|� q|�rF|D ]N}d |d |d
|d d
�|d �f } |�r8d�| d�|��} tt| ���q�|S )aT Check parameters that are conditionally required
Raises :class:`TypeError` if the check fails
:arg requirements: List of lists specifying a parameter, value, parameters
required when the given parameter is the specified value, and optionally
a boolean indicating any or all parameters are required.
:Example:
.. code-block:: python
required_if=[
['state', 'present', ('path',), True],
['someint', 99, ('bool_param', 'string_param')],
]
:arg parameters: Dictionary of parameters
:returns: Empty list or raises :class:`TypeError` if the check fails.
The results attribute of the exception contains a list of dictionaries.
Each dictionary is the result of evaluating each item in requirements.
Each return dictionary contains the following keys:
:key missing: List of parameters that are required but missing
:key requires: 'any' or 'all'
:key parameter: Parameter name that has the requirement
:key value: Original value of the parameter
:key requirements: Original required parameters
:Example:
.. code-block:: python
[
{
'parameter': 'someint',
'value': 99
'requirements': ('bool_param', 'string_param'),
'missing': ['string_param'],
'requires': 'all',
}
]
:kwarg options_context: List of strings of parent key names if ``requirements`` are
in a sub spec.
Nr? r F� �anyZrequires�allZ parameterr r< z0%s is %s but %s of the following are missing: %sr) r* r+ )r r r- r$ r. r/ r )
r< r r0 r1 Zreqr? Zmax_missing_countZ is_one_ofr= �valr& r2 r3 r r r �check_required_if� sD 0
�rK c C sP g }|du r|S |D ]}| � |�s|�|� q|rLdd�|� }tt|���|S )a� This is for checking for required params when we can not check via
argspec because we need more information than is simply given in the argspec.
Raises :class:`TypeError` if any required parameters are missing
:arg parameters: Dictionary of parameters
:arg required_parameters: List of parameters to look for in the given parameters.
:returns: Empty list or raises :class:`TypeError` if the check fails.
NrA r) )rB r- r$ r/ r )r Zrequired_parametersZmissing_params�paramr3 r r r �check_missing_parametersR s
rM T� c C s8 t | t�r| S |r t| dd�S d�| �}tt|���dS )as Verify that the value is a string or convert to a string.
Since unexpected changes can sometimes happen when converting to a string,
``allow_conversion`` controls whether or not the value will be converted or a
TypeError will be raised if the value is not a string and would be converted
:arg value: Value to validate or convert to a string
:arg allow_conversion: Whether to convert the string and return it or raise
a TypeError
:returns: Original value if it is a string, the value converted to a string
if allow_conversion=True, or raises a TypeError if allow_conversion=False.
Zsurrogate_or_strict)�errorsz5'{0!r}' is not a string and conversion is not allowedN)r r r r. r/ )r Zallow_conversionrL �prefixr3 r r r �check_type_stro s
rQ c C sT t | t�r| S t | t�r"| �d�S t | t�s6t | t�r@t| �gS tdt| � ��dS )a� Verify that the value is a list or convert to a list
A comma separated string will be split into a list. Raises a :class:`TypeError`
if unable to convert to a list.
:arg value: Value to validate or convert to a list
:returns: Original value if it is already a list, single item list if a
float, int, or string without commas, or a multi-item list if a
comma-delimited string.
�,z %s cannot be converted to a listN) r �listr �split�int�float�strr/ �type�r r r r �check_type_list� s
rZ c C s^ t | t�r| S t | t��rJ| �d�rnz t�| �W S tyj t| t� dd�\}}|durbtd��| Y S 0 n�d| v �rBg }g }d}d}| � � D ]�}|r�|�
|� d}q�|dkr�d}q�|s�|d v r�|}q�|r�||kr�d}q�|�s
|d
v �r
d � |�}|�r|�
|� g }q�|�
|� q�d � |�}|�r0|�
|� td d
� |D ��S td��tdt | � ��dS )a Verify that value is a dict or convert it to a dict and return it.
Raises :class:`TypeError` if unable to convert to a dict
:arg value: Dict or string to convert to a dict. Accepts ``k1=v2, k2=v2``.
:returns: value converted to a dictionary
�{T)r Nz'unable to evaluate string as dictionary�=F�\)�'�")rR � rN c s s | ]}|� d d�V qdS )r\ r" N)rT )r% �xr r r � <genexpr>� r( z"check_type_dict.<locals>.<genexpr>z7dictionary requested, could not parse JSON or key=valuez %s cannot be converted to a dict)
r �dictr �
startswithr �loadsr r! r/ �stripr- r$ rX ) r r �exc�fieldsZ field_bufferZin_quoteZ in_escaper9 r7 r r r �check_type_dict� sL
ri c C sB t | t�r| S t | t�s&t | ttf�r.t| �S tdt| � ��dS )aX Verify that the value is a bool or convert it to a bool and return it.
Raises :class:`TypeError` if unable to convert to a bool
:arg value: String, int, or float to convert to bool. Valid booleans include:
'1', 'on', 1, '0', 0, 'n', 'f', 'false', 'true', 'y', 't', 'yes', 'no', 'off'
:returns: Boolean True or False
z %s cannot be converted to a boolN)r �boolr rU rV r r/ rX rY r r r �check_type_bool� s
rk c C sJ t | t�r| S t | t�r6z
t| �W S ty4 Y n0 tdt| � ��dS )z�Verify that the value is an integer and return it or convert the value
to an integer and return it
Raises :class:`TypeError` if unable to convert to an int
:arg value: String or int to convert of verify
:return: int of given value
z %s cannot be converted to an intN)r r
r rU �
ValueErrorr/ rX rY r r r �check_type_int� s
rm c C sP t | t�r| S t | tttf�r<z
t| �W S ty: Y n0 tdt| � ��dS )z�Verify that value is a float or convert it to a float and return it
Raises :class:`TypeError` if unable to convert to a float
:arg value: float, int, str, or bytes to verify or convert and return.
:returns: float of given value.
z!%s cannot be converted to a floatN)r rV r r rU rl r/ rX rY r r r �check_type_float� s
rn c C s t | �} tj�tj�| ��S )zgVerify the provided value is a string or convert it to a string,
then return the expanded path
)rQ �os�path�
expanduser�
expandvarsrY r r r �check_type_path s rs c C s | S )zReturns the raw valuer rY r r r �check_type_raw s rt c C s2 z
t | �W S ty, tdt| � ��Y n0 dS )zpConvert a human-readable string value to bytes
Raises :class:`TypeError` if unable to covert the value
z&%s cannot be converted to a Byte valueN�r
rl r/ rX rY r r r �check_type_bytes s
rv c C s6 zt | dd�W S ty0 tdt| � ��Y n0 dS )z�Convert a human-readable string bits value to bits in integer.
Example: ``check_type_bits('1Mb')`` returns integer 1048576.
Raises :class:`TypeError` if unable to covert the value.
T)Zisbitsz%%s cannot be converted to a Bit valueNru rY r r r �check_type_bits* s rw c C sB t | ttf�r| �� S t | tttf�r.t| �S tdt | � ��dS )z�Return a jsonified string. Sometimes the controller turns a json string
into a dict/list so transform it back into json here
Raises :class:`TypeError` if unable to covert the value
z'%s cannot be converted to a json stringN)
r r r rf rS �tuplerc r r/ rX rY r r r �check_type_jsonarg7 s
ry )NF)N)N)N)N)N)N)N)TNrN )/Z
__future__r r r rX Z
__metaclass__ro r �astr Zansible.module_utils._textr Z(ansible.module_utils.common._json_compatr Z'ansible.module_utils.common.collectionsr Z+ansible.module_utils.common.text.convertersr Z+ansible.module_utils.common.text.formattersr
Z)ansible.module_utils.parsing.convert_boolr Zansible.module_utils.sixr r
r r r r! r4 r6 r: r@ rF rK rM rQ rZ ri rk rm rn rs rt rv rw ry r r r r �<module> s>
!
"
$
(
!
\
6
Mini Shell