Google
Edit File: parameters.cpython-39.pyc
a �)g_� � @ s� d dl mZmZmZ eZd dlZd dlZd dlm Z d dl m Z d dl m Z d dlmZmZmZ d dlmZ d dlmZ d d lmZmZmZmZmZm Z m Z m Z m Z m Z m!Z!m"Z"m#Z#m$Z$ d d l%m&Z&m'Z' d d l(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/ d d l0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6 d d l7m8Z8m9Z9m:Z:m;Z;m<Z<m=Z=m>Z>m?Z?m@Z@mAZAmBZBmCZCmDZDmEZEmFZFmGZGmHZH ed�ZIe:de#d�e;de"d�e<de!d�e=de d�fZJddddddddg d�fd d d d d d!d"d#�ZKd$ZLeHeEeAe?eCeBeFeGeDeDe@e>d%� ZMd&d'� ZNdLd(d)�ZOdMd*d+�ZPdNd,d-�ZQdOd/d0�ZRd1d2� ZSd3d4� ZTd5d6� ZUdPd8d9�ZVd:d;� ZWdQd<d=�ZXdRd>d?�ZYdSd@dA�ZZdTdBdC�Z[dDdE� Z\dFdG� Z]e^� fdHdI�Z_dJdK� Z`dS )U� )�absolute_import�division�print_functionN)�deque)�chain)� is_iterable)�to_bytes� to_native�to_text)�lenient_lowercase)�warn)� AliasError�AnsibleFallbackNotFound� AnsibleValidationErrorMultiple�ArgumentTypeError�ArgumentValueError� ElementError�MutuallyExclusiveError� NoLogError�RequiredByError� RequiredError�RequiredIfError�RequiredOneOfError�RequiredTogetherError�SubParameterTypeError)�BOOLEANS_FALSE� BOOLEANS_TRUE)�KeysView�Set�Sequence�Mapping�MutableMapping� MutableSet�MutableSequence)� binary_type� integer_types� string_types� text_type�PY2�PY3)�check_mutually_exclusive�check_required_arguments�check_required_together�check_required_one_of�check_required_if�check_required_by�check_type_bits�check_type_bool�check_type_bytes�check_type_dict�check_type_float�check_type_int�check_type_jsonarg�check_type_list�check_type_path�check_type_raw�check_type_strZrequired_together)�func�attr�errZrequired_one_ofZ required_ifZ required_by)� check_modeF)Z_debugF)Z_diffF)Z_keep_remote_filesF)�_nameN)�no_logF)Z _remote_tmpNZ_selinux_special_fs)Zfuse�nfsZvboxsfZramfsZ9pZvfat)Z_shellz/bin/sh)Z _socket_pathN)Z_string_conversion_actionr )Z_syslog_facility�INFO)Z_tmpdirN)Z _verbosityr )Zansible_versionz0.0)r> �debug�diff�keep_remote_filesZ module_namer@ Z remote_tmpZselinux_special_fsZshell_executableZsocketZstring_conversion_actionZsyslog_facilityZtmpdir� verbosity�version)r> rC rD rE r@ ) �str�list�dict�bool�int�float�path�rawZjsonargZjson�bytes�bitsc C s@ t | �s | du rd} t�| �}n| }t| dtt| ���} || fS )a� Returns the callable used to validate a wanted type and the type name. :arg wanted: String or callable. If a string, get the corresponding validation function from DEFAULT_TYPE_VALIDATORS. If callable, get the name of the custom callable and return that for the type_checker. :returns: Tuple of callable function or None, and a string that is the name of the wanted type. NrH �__name__)�callable�DEFAULT_TYPE_VALIDATORS�get�getattrr �type)�wanted� type_checker� rZ �J/usr/lib/python3.9/site-packages/ansible/module_utils/common/parameters.py�_get_type_validator{ s r\ c C s* |d u rt | |�}t|�� �t| �� � S �N)�_handle_aliasesrI �keys)� argument_spec� parameters�aliasesrZ rZ r[ �_get_legal_inputs� s rc c C s� |du rt | |�}t� }|�� D ]r}||vr |}|rBt||g �}|�|� |dur t| |�}g } |D ]} | |v rtqf| �| � qf|�|| |fi� q |S )a� Check keys in parameters against those provided in legal_inputs to ensure they contain legal values. If legal_inputs are not supplied, they will be generated using the argument_spec. :arg argument_spec: Dictionary of parameters, their type, and valid values. :arg parameters: Dictionary of parameters. :arg legal_inputs: List of valid key names property names. Overrides values in argument_spec. :arg options_context: List of parent keys for tracking the context of where a parameter is defined. :returns: Set of unsupported parameters. Empty set if no unsupported parameters are found. N)rc �setr_ �tuple�addr^ �append�update) r` ra � legal_inputs�options_context�store_supported�unsupported_parameters�k�contextZsupported_aliasesZsupported_params�optionrZ rZ r[ �_get_unsupported_parameters� s$ rp c C s� i }| � � D ]�\}}|�dd�}|�dd�}|�dd�} |durn| | �dg �D ] } | �d�|v rP|�| � qP|dur�| r�td| ��|du r�q t|�r�t|ttf�r�td ��|D ]>} ||| < | |v r�||v r�|dur�|�|| f� || ||< q�q |S ) aU Process aliases from an argument_spec including warnings and deprecations. Modify ``parameters`` by adding a new key for each alias with the supplied value from ``parameters``. If a list is provided to the alias_warnings parameter, it will be filled with tuples (option, alias) in every case where both an option and its alias are specified. If a list is provided to alias_deprecations, it will be populated with dictionaries, each containing deprecation information for each alias found in argument_spec. :param argument_spec: Dictionary of parameters, their type, and valid values. :type argument_spec: dict :param parameters: Dictionary of parameters. :type parameters: dict :param alias_warnings: :type alias_warnings: list :param alias_deprecations: :type alias_deprecations: list rb N�default�requiredFZdeprecated_aliases�namezBinternal error: required and default are mutually exclusive for %sz/internal error: aliases must be a list or tuple) �itemsrU rg � ValueErrorr � isinstancer$ r' � TypeError) r` ra �alias_warnings�alias_deprecationsZaliases_resultsrm �vrb rq rr �aliasrZ rZ r[ r^ � s, r^ � c C s� g }| � � D ]�\}}||v r |r.d||f }n|}|�d�durd|�d| |�d�|�d�d�� n0|�d�dur�|�d| |�d�|�d�d�� |�d �}|dur || }t|t�r�|g}t|t�r |D ]"} t| t�r�|�t|| |d �� q�q |S ) a� Return a list of deprecations :arg argument_spec: An argument spec dictionary :arg parameters: Dictionary of parameters :returns: List of dictionaries containing a message and version in which the deprecated parameter will be removed, or an empty list. :Example return: .. code-block:: python [ { 'msg': "Param 'deptest' is deprecated. See the module docs for more information", 'version': '2.9' } ] z%s["%s"]Zremoved_at_dateNzBParam '%s' is deprecated. See the module docs for more informationZremoved_from_collection)�msg�date�collection_nameZremoved_in_version)r} rG r �options)�prefix)rt rU rg rv r rI �extend�_list_deprecations) r` ra r� Z deprecations�arg_name�arg_optsZ sub_prefix�sub_argument_specZ sub_argumentsZ sub_paramsrZ rZ r[ r� � s8 � � r� c C s0 t � }| �� D �]\}}|�dd�r�|�|d�}|r�z|�t|�� W n8 ty~ } z td|t|�f ��W Y d}~n d}~0 0 |�d�}|dur|�d�}|�|�} | dur|dks�|dkr|�d d �dkrt| t�s�| g} | D ]F} t| t �� r�t | �} t| t ��std � || |���|�t || �� q�q|S ) z�Return set of no log values :arg argument_spec: An argument spec dictionary :arg params: Dictionary of all parameters :returns: :class:`set` of strings that should be hidden from output: r@ FNzFailed to convert "%s": %sr� rW rJ rI �elementsr| zXValue '{1}' in the sub parameter field '{0}' must by a {2}, not '{1.__class__.__name__}')rd rt rU rh �_return_datastructure_namerw r rv rI r& r3 r �format�_list_no_log_values) r` �params� no_log_valuesr� r� Z no_log_object�er� � wanted_type�sub_parametersZ sub_paramrZ rZ r[ r� 5 s4 * �r� c c s� t | ttf�r$| r t| dd�V dS t | t�rV| �� D ] }t|d �D ] }|V qFq6nvt| �r~| D ]}t|�D ] }|V qnqbnN| du s�t | t�r�dS t | t t t �t g ��r�t| dd�V nt dt| � ��dS )zu Return native stringified values from datastructures. For use with removing sensitive values pre-jsonification.�surrogate_or_strict��errorsN� Z simplerepr)Z nonstringzUnknown parameter type: %s)rv r' r$ r r rt r� r rK re rI r% rM rw rW )�obj�elementZ subelementrZ rZ r[ r� e s" r� c C s� t | ttf�r�| }t | t�r2d}trPt| dd�}n t | t�rPd}trPt| dd�}||v r\dS |D ]}|�|d�}q`|r�t |t�r�t|ddd �} n"|s�t |t�r�t|ddd �} n|} �n<t | t�r�t | t �r�t | �� }ng }|� | |f� |} �nt | t ��r.t | t ��rt | �� }nt� }|� | |f� |} n�t | t��rjt | t��rRt | �� }ni }|� | |f� |} n�t | ttttttf����r�t| ddd �}||v �r�dS |D ]}||v �r� dS �q�n2t | tjtjf��r�| �� } ntd t | �| f ��| S ) a� Helper function for :meth:`remove_values`. :arg value: The value to check for strings that need to be stripped :arg no_log_strings: set of strings which must be stripped out of any values :arg deferred_removals: List which holds information about nested containers that have to be iterated for removals. It is passed into this function so that more entries can be added to it if value is a container type. The format of each entry is a 2-tuple where the first element is the ``value`` parameter and the second value is a new container to copy the elements of ``value`` into once iterated. :returns: if ``value`` is a scalar, returns ``value`` with two exceptions: 1. :class:`~datetime.datetime` objects which are changed into a string representation. 2. objects which are in ``no_log_strings`` are replaced with a placeholder so that no sensitive data is leaked. If ``value`` is a container type, returns a new empty container. ``deferred_removals`` is added to as a side-effect of this function. .. warning:: It is up to the caller to make sure the order in which value is passed in is correct. For instance, higher level containers need to be passed in before lower level containers. For example, given ``{'level1': {'level2': 'level3': [True]} }`` first pass in the dictionary for ``level1``, then the dict for ``level2``, and finally the list for ``level3``. Tr� r� FZ#VALUE_SPECIFIED_IN_NO_LOG_PARAMETERz********zutf-8Zsurrogate_then_replace)�encodingr� � Value of unknown type: %s, %s) rv r' r$ r( r r) r �replacer r# rW rg r r" rd r r! re r r% rM rK �NoneTyper �datetimer~ Z isoformatrw )�value�no_log_strings�deferred_removalsZnative_str_valueZ value_is_textZomit_me� new_valueZ stringy_valuerZ rZ r[ �_remove_values_conditions~ s` r� Tc C s^ t � }| �� D ]J\}}|�dd�}||vr|dus6|r|�dd�rP|rP|�|� |||< q|S )a� Set default values for parameters when no value is supplied. Modifies parameters directly. :arg argument_spec: Argument spec :type argument_spec: dict :arg parameters: Parameters to evaluate :type parameters: dict :kwarg set_default: Whether or not to set the default values :type set_default: bool :returns: Set of strings that should not be logged. :rtype: set rq Nr@ F)rd rt rU rf )r` ra Z set_defaultr� �paramr� rq rZ rZ r[ � _set_defaults� s r� c C s t | ttf�r| S t | t�rHt | t�r2t| �� }ng }|�| |f� |S t | t�r�t | t�rht| �� }nt � }|�| |f� |S t | t �r�t | t �r�t| �� }ni }|�| |f� |S t | t t ttttf���r�| S t | tjtjf�r�| S tdt| �| f ��dS )za Helper method to :func:`sanitize_keys` to build ``deferred_removals`` and avoid deep recursion. r� N)rv r' r$ r r# rW rg r r" rd r r! re r r% rM rK r� r� r~ rw )r� r� � ignore_keysr� r� rZ rZ r[ �_sanitize_keys_conditions s2 r� c C s� |d u rt � }t| �\}}g }i }|dkrft| t�rft|t�rH||d< n t|t�rft|�� �d |d< |D ]�} z|�|| fi |��� W qj tt fy� } zRd| } |r�| dd� |� 7 } | dt | �|t | �f 7 } |�t | �� W Y d } ~ qjd } ~ 0 0 qj|S )NrH r� r z Elements value for option '%s'z found in '%s'� -> z6 is of type %s and we were unable to convert to %s: %s)r r\ rv r& rJ rI r_ rg rw ru �joinrW r r ) r� Z parameter�valuesrj r� rY Zwanted_element_typeZvalidated_parameters�kwargsr� r� r} rZ rZ r[ �_validate_elements' s( &r� c C s� |du rt � }| �� D �]x\}}||vr*q|| }|du r<q|�d�}t|�\} } i } | dkr�t|t�r�t|�� �d | d< |r�|| d< z�| |fi | ��||< |�dd�} | �r|| } |dks�t| t��sd | | f }|r�|d d �|� 7 }|d 7 }|� t |�� t | || ||�||< W q t t f�y� } zVd |t|�f }|�rX|d d �|� 7 }|d| t|�f 7 }|� t |�� W Y d}~qd}~0 0 qdS )a& Validate that parameter types match the type in the argument spec. Determine the appropriate type checker function and run each parameter value through that function. All error messages from type checker functions are returned. If any parameter fails to validate, it will not be in the returned parameters. :arg argument_spec: Argument spec :type argument_spec: dict :arg parameters: Parameters :type parameters: dict :kwarg prefix: Name of the parent key that contains the spec. Used in the error message :type prefix: str :kwarg options_context: List of contexts? :type options_context: list :returns: Two item tuple containing validated and coerced parameters and a list of any errors that were encountered. :rtype: tuple NrW rH r r� r� r� rI z Invalid type %s for option '%s'z found in '%s'.r� z9, elements value check is supported only with 'list' typezargument '%s' is of type %sz( and we were unable to convert to %s: %s)r rt rU r\ rv r& rI r_ r� rg r r� rw ru rW r )r` ra r� rj r� r� �specr� r� rY Z wanted_namer� Zelements_wanted_typer� r} r� rZ rZ r[ �_validate_argument_typesC sB r� c s� |du rt � }| �� D �]�\}}|�d�� � du r4qt� tttf��r�t� ttf��s�||v �r�t|| t �rڇ fdd�|| D �}|r�d� dd� � D ��}d� |�}d|||f } |r�d� | d � |��} |� t | �� n�|| � v�r�|| d k�rt�� �} t| �d k�r| \||< || d k�rHt�� �} t| �d k�rH| \||< || � v�r�d� d d� � D ��}d|||| f } |�r�d� | d � |��} |� t | �� qd|� f } |�r�d� | d � |��} |� t| �� qdS )zPEnsure all arguments have the requested values, and there are no stray argumentsN�choicesc s g | ]}|� vr|�qS rZ rZ )�.0�item�r� rZ r[ � <listcomp>� � z-_validate_argument_values.<locals>.<listcomp>z, c S s g | ] }t |��qS rZ �r �r� �crZ rZ r[ r� � r� z<value of %s must be one or more of: %s. Got no match for: %sz{0} found in {1}r� �Falser� �Truec S s g | ] }t |��qS rZ r� r� rZ rZ r[ r� � r� z'value of %s must be one of: %s, got: %sz<internal error: choices for argument %s are not iterable: %s)r rt rU rv � frozensetr r r$ r' rI r� r� rg r r � intersection�lenr r ) r` ra rj r� r� r� Z diff_list� choices_strZdiff_strr} ZoverlaprZ r� r[ �_validate_argument_values� sH " r� c C s* |du r g }|du rt � }|du r(t� }|du r6t� }|du rDt� }| �� D �]�\} } | �d�} | dks�| dkrL| �dd�dkrL| �d�} | �dd �r�| durL|�| �du r�i || < q�qLn | du sL| |vsL|| du r�qL|�| � t|| t��rt|| t��r|| g} n|| } t | �D �]�\}}|� t | |�� t|t��sZ|�t d | �� �q || }| dk�rx|d | 7 }|d 7 }g }g }zt | |||�}W n@ ttf�y� } z"i }|�tt|��� W Y d}~n d}~0 0 |D ] \}}td ||||f � �q�|du�rH|D ]8}|�d||d f |�d�|�d�|�d�d�� �qz|� t| |�� W n8 t�y� } z |�tt|��� W Y d}~n d}~0 0 t| ||�}|� t| ||||d�� zt| �d�||� W n8 t�y } z |�tt|��� W Y d}~n d}~0 0 |� t| |d �� zt| ||� W n8 t�yd } z |�tt|��� W Y d}~n d}~0 0 t | ||||d� t | |||d� t D ]b}z |d | �|d �||� W n< t�y� } z"|�|d t|��� W Y d}~n d}~0 0 �q�|� t| |�� t | ||||||||� �q |� � qLdS )zAValidate sub argument spec. This function is recursive. NrW rJ rI r� r| r� Zapply_defaultsFz3value of '%s' must be of type dict or list of dictsz[%d]�.z,Both option %s%s and its alias %s%s are set.z%s%srs rG r~ r )rs rG r~ r )rk Zmutually_exclusiver� r; r< r= )!r rd rJ rt rU rg rv r r& � enumeraterh � set_fallbacksr r^ rw ru r r r r� r rc rp r* r r� r+ r r� r� �_ADDITIONAL_CHECKS�_validate_sub_spec�pop)r` ra r� rj r� r� rl Zsupported_parametersry r� r� rX Zsub_specr� �idxr� � new_prefixrx Zalias_deprecations_subZoptions_aliasesr� ro r{ Z deprecation�teri �checkrZ rZ r[ r� � s� ( � ( �� (( 0 �r� c O s* | D ] }|t jv rt j| S qt�dS )z$Load value from environment variableN)�os�environr )�argsr� �argrZ rZ r[ � env_fallback? s r� c C s� t � }| �� D ]�\}}|�dd�}|d }g }i }||vr|d ur|dd � D ]} t| t�rb| }qN| }qNz||i |��} W n ty� Y qY q0 |�dd�r�| r�|�| � | ||< q|S )N�fallbackr] r r� r@ F)rd rt rU rv rJ r rf ) r` ra r� r� r� r� Zfallback_strategyZ fallback_argsZfallback_kwargsr� Zfallback_valuerZ rZ r[ r� H s& r� c C s� t � }dd� |D �}t| |||�}|r�|�� \}}t|t�r�|�� D ]L\}}||v s^|�d�rrt||||�||< qDt||d�} t||||�|| < qDq"|D ]F} t| |||�} t|t�r�|� | � q�t|t �r�|� | � q�t d��q�q"|S )aS Sanitize the keys in a container object by removing ``no_log`` values from key names. This is a companion function to the :func:`remove_values` function. Similar to that function, we make use of ``deferred_removals`` to avoid hitting maximum recursion depth in cases of large data structures. :arg obj: The container object to sanitize. Non-container objects are returned unmodified. :arg no_log_strings: A set of string values we do not want logged. :kwarg ignore_keys: A set of string values of keys to not sanitize. :returns: An object with sanitized keys. c S s g | ]}t |d d��qS �r� r� r� �r� �srZ rZ r[ r� q r� z!sanitize_keys.<locals>.<listcomp>Z_ansibleNzIUnknown container type encountered when removing private values from keys) r r� �popleftrv r rt � startswithr� r# rg r" rf rw ) r� r� r� r� r� �old_data�new_data�old_key�old_elemZnew_key�elem�new_elemrZ rZ r[ � sanitize_keysa s& r� c C s� t � }dd� |D �}t| ||�}|r�|�� \}}t|t�rb|�� D ] \}}t|||�}|||< qBq |D ]D} t| ||�}t|t�r�|�|� qft|t�r�|� |� qft d��qfq |S )av Remove strings in ``no_log_strings`` from value. If value is a container type, then remove a lot more. Use of ``deferred_removals`` exists, rather than a pure recursive solution, because of the potential to hit the maximum recursion depth when dealing with large amounts of data (see `issue #24560 <https://github.com/ansible/ansible/issues/24560>`_). c S s g | ]}t |d d��qS r� r� r� rZ rZ r[ r� � r� z!remove_values.<locals>.<listcomp>zKUnknown container type encountered when removing private values from output) r r� r� rv r rt r# rg r" rf rw ) r� r� r� r� r� r� r� r� r� r� rZ rZ r[ � remove_values� s" r� )N)NNN)NN)r| )T)NN)r| NN)NN)r| NNNNNN)aZ __future__r r r rW Z __metaclass__r� r� � collectionsr � itertoolsr Z'ansible.module_utils.common.collectionsr Z+ansible.module_utils.common.text.convertersr r r Z+ansible.module_utils.common.text.formattersr Z$ansible.module_utils.common.warningsr Zansible.module_utils.errorsr r r r r r r r r r r r r r Z)ansible.module_utils.parsing.convert_boolr r Z/ansible.module_utils.common._collections_compatr r r r r! r" r# Zansible.module_utils.sixr$ r% r& r' r( r) Z&ansible.module_utils.common.validationr* r+ r, r- r. r/ r0 r1 r2 r3 r4 r5 r6 r7 r8 r9 r: r� r� Z PASS_VARSZ PASS_BOOLSrT r\ rc rp r^ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rZ rZ rZ r[ �<module> s� @$ L � �� ) 9 60^ %& F 5 � ,