관리-도구
편집 파일: arg_spec.cpython-39.pyc
a �)g / � @ s� d dl mZmZmZ eZd dlmZ d dlm Z m Z m Z m Z m Z mZmZmZmZmZmZ d dlmZ d dlmZmZ d dlmZmZ d dl m Z m Z m Z m Z m!Z!m"Z"m#Z#m$Z$ G dd � d �Z%G d d � d �Z&G d d � d e&�Z'dS )� )�absolute_import�division�print_function)�deepcopy) �_ADDITIONAL_CHECKS�_get_legal_inputs�_get_unsupported_parameters�_handle_aliases�_list_deprecations�_list_no_log_values� _set_defaults�_validate_argument_types�_validate_argument_values�_validate_sub_spec� set_fallbacks)� to_native)� deprecate�warn)�check_mutually_exclusive�check_required_arguments)� AliasError� AnsibleValidationErrorMultiple�DeprecationError�MutuallyExclusiveError� NoLogError�RequiredDefaultError� RequiredError�UnsupportedErrorc @ s< e Zd ZdZdd� Zedd� �Zedd� �Zedd � �Zd S ) �ValidationResultz�Result of argument spec validation. This is the object returned by :func:`ArgumentSpecValidator.validate() <ansible.module_utils.common.arg_spec.ArgumentSpecValidator.validate()>` containing the validated parameters and any errors. c C s@ t � | _t � | _t� | _t|�| _g | _g | _i | _ t � | _ dS )zx :arg parameters: Terms to be validated and coerced to the correct type. :type parameters: dict N) �set�_no_log_values�_unsupported_parameters�dict�_supported_parametersr �_validated_parameters� _deprecations� _warnings�_aliasesr �errors)�self� parameters� r+ �H/usr/lib/python3.9/site-packages/ansible/module_utils/common/arg_spec.py�__init__4 s zValidationResult.__init__c C s | j S )z!Validated and coerced parameters.)r$ �r) r+ r+ r, �validated_parametersK s z%ValidationResult.validated_parametersc C s | j S )z,:class:`set` of unsupported parameter names.)r! r. r+ r+ r, �unsupported_parametersP s z'ValidationResult.unsupported_parametersc C s | j jS )zJ:class:`list` of all error messages from each exception in :attr:`errors`.)r( �messagesr. r+ r+ r, �error_messagesU s z ValidationResult.error_messagesN) �__name__� __module__� __qualname__�__doc__r- �propertyr/ r0 r2 r+ r+ r+ r, r , s r c @ s" e Zd ZdZddd�Zdd� ZdS )�ArgumentSpecValidatorz�Argument spec validation class Creates a validator based on the ``argument_spec`` that can be used to validate a number of parameters using the :meth:`validate` method. Nc C s� || _ || _|| _|| _|| _t� | _|| _t| j� � �D ]J}| j| � d�}|rv| j� dj |d� t|��d�g� q:| j� |g� q:dS )a :arg argument_spec: Specification of valid parameters and their type. May include nested argument specs. :type argument_spec: dict[str, dict] :kwarg mutually_exclusive: List or list of lists of terms that should not be provided together. :type mutually_exclusive: list[str] or list[list[str]] :kwarg required_together: List of lists of terms that are required together. :type required_together: list[list[str]] :kwarg required_one_of: List of lists of terms, one of which in each list is required. :type required_one_of: list[list[str]] :kwarg required_if: List of lists of ``[parameter, value, [parameters]]`` where one of ``[parameters]`` is required if ``parameter == value``. :type required_if: list :kwarg required_by: Dictionary of parameter names that contain a list of parameters required by each key in the dictionary. :type required_by: dict[str, list[str]] �aliasesz{key} ({aliases})�, )�keyr9 N)�_mutually_exclusiveZ_required_togetherZ_required_one_ofZ _required_ifZ _required_byr Z_valid_parameter_names� argument_spec�sorted�keys�get�update�format�join) r) r= Zmutually_exclusiveZrequired_togetherZrequired_one_ofZ required_ifZ required_byr; r9 r+ r+ r, r- b s !$z ArgumentSpecValidator.__init__c O s� t |�}|j�t| j|j�� g }g }z |j�t| j|j||�� W n< tt fy� } z |j � t t |��� W Y d}~n d}~0 0 t| j|j|j�}|D ]\} } |j� | | d�� q�|D ]4} |j� d| d | �d�| �d�| �d�d�� q�z|j�t| j|j�� W n: t�yB } z |j � tt | ��� W Y d} ~ n d} ~ 0 0 z|j�t| j|j�� W n: t�y� } z |j � tt | ��� W Y d} ~ n d} ~ 0 0 z"|j�t| j|j||jd �� W nr t�y� } z |j � tt | ��� W Y d} ~ nBd} ~ 0 t �y. } z |j � t t | ��� W Y d} ~ n d} ~ 0 0 zt| j |j� W n: t�y| } z |j � t t | ��� W Y d} ~ n d} ~ 0 0 |j�t | j|jd �� zt | j|j� W n: t�y� } z |j � t t |��� W Y d}~n d}~0 0 t!| j|j|j d � t"| j|j|j d � t#D ]l}z&|d t$| d j%|d d��|j� W n> t�yx } z$|j � |d t | ��� W Y d} ~ n d} ~ 0 0 �q|j�t | j|j�� g }t&| j|j|j |j|j|j|d� |D ]6} |j� d| d | �d�| �d�| �d�d�� �q�|j�r�g }|jD ].}t'|t(��r*|� d�)|�� n |� |� �qd�)t*t+|���}g }}|j�|��r�t*t+|j| d ��}t*t+|j| d ��}d�)|�}|�r�d�)|�}|d| 7 }d�%||�}|j � t,|�� |S )aL Validate ``parameters`` against argument spec. Error messages in the :class:`ValidationResult` may contain no_log values and should be sanitized with :func:`~ansible.module_utils.common.parameters.sanitize_keys` before logging or displaying. :arg parameters: Parameters to validate against the argument spec :type parameters: dict[str, dict] :return: :class:`ValidationResult` containing validated parameters. :Simple Example: .. code-block:: text argument_spec = { 'name': {'type': 'str'}, 'age': {'type': 'int'}, } parameters = { 'name': 'bo', 'age': '42', } validator = ArgumentSpecValidator(argument_spec) result = validator.validate(parameters) if result.error_messages: sys.exit("Validation failed: {0}".format(", ".join(result.error_messages)) valid_params = result.validated_parameters N��option�aliaszBAlias '%s' is deprecated. See the module docs for more information�name�version�date�collection_name)�msgrH rI rJ )Zstore_supportedF)r( �funcz_{attr}�attr)rM �err)r( Z no_log_valuesr0 Zsupported_parameters�alias_deprecations�.r: r � z (%s)z'{0}. Supported parameters include: {1}.)-r r rA r r= r$ r' r � TypeError� ValueErrorr( �appendr r r r& r% r@ r r �extendr r r! r r# r r r< r r r r r r r �getattrrB r � isinstance�tuplerC r> �listr )r) r* �args�kwargs�resultZalias_warningsrO �eZ legal_inputsrE rF Z deprecation�te�ve�checkZflattened_names�itemZunsupported_stringZsupported_paramsZsupported_aliasesZsupported_stringZaliases_stringrK r+ r+ r, �validate� s� " * � **��(***&2 � � z ArgumentSpecValidator.validate)NNNNN)r3 r4 r5 r6 r- rb r+ r+ r+ r, r8 [ s � 0r8 c s, e Zd ZdZ� fdd�Z� fdd�Z� ZS )�ModuleArgumentSpecValidatorz�Argument spec validation class used by :class:`AnsibleModule`. This is not meant to be used outside of :class:`AnsibleModule`. Use :class:`ArgumentSpecValidator` instead. c s t t| �j|i |�� d S )N)�superrc r- )r) rZ r[ �� __class__r+ r, r- ) s z$ModuleArgumentSpecValidator.__init__c sl t t| ��|�}|jD ]*}t|d |�d�|�d�|�d�d� q|jD ] }tdj|d |d d �� qH|S ) NrK rH rI rJ )rH rI rJ z3Both option {option} and its alias {alias} are set.rE rF rD ) rd rc rb r% r r@ r& r rB )r) r* r\ �d�wre r+ r, rb , s � z$ModuleArgumentSpecValidator.validate)r3 r4 r5 r6 r- rb � __classcell__r+ r+ re r, rc " s rc N)(Z __future__r r r �typeZ __metaclass__�copyr Z&ansible.module_utils.common.parametersr r r r r r r r r r r Z+ansible.module_utils.common.text.convertersr Z$ansible.module_utils.common.warningsr r Z&ansible.module_utils.common.validationr r Zansible.module_utils.errorsr r r r r r r r r r8 rc r+ r+ r+ r, �<module> s 4 ( / H