관리-도구
편집 파일: plugin_docs.cpython-39.pyc
a �)g�! � @ s� d dl mZmZmZ eZd dlZd dlZd dlm Z d dl m Z m Z d dlmZmZ d dlmZ d dlmZ e� Zdd d d d �Zd d� Zdd� Zd dd�Zd dd�Zd dd�Zd dd�Z dd� Z dS ) � )�absolute_import�division�print_functionN)� constants)� AnsibleError�AnsibleParserError)�to_text� to_native)� AnsibleLoader)�Display�doc� plainexamplesZ returndocs�metadata)� DOCUMENTATION�EXAMPLESZRETURNZANSIBLE_METADATAc C s& t �� D ]\}}|| kr| S qdS )z" reverse lookup of the dict above N)�string_to_vars�items)�value�k�v� r �?/usr/lib/python3.9/site-packages/ansible/parsing/plugin_docs.py� _var2string s r c C s dd� t �� D �S )z? initialize a return dict for docs with the expected structure c S s i | ] }|d �qS )Nr )�.0r r r r � <dictcomp>$ � z"_init_doc_dict.<locals>.<dictcomp>)r �valuesr r r r �_init_doc_dict" s r Tc C s� t � }i }zBt| d��$}t|�� | d��� }W d � n1 s@0 Y W nT ty� } z<d| t|�f }|s~t||d��n|r�t� |� W Y d}~n d}~0 0 |r�t D ]}|� |d�|t | < q�|S )z5 Read docs from 'sidecar' yaml file doc for a plugin �rb�� file_nameNz"Unable to parse yaml file '%s': %s�Zorig_exc) r �openr �read�get_single_data� Exceptionr r �display�errorr �get) �filename�verbose� ignore_errors�dataZ file_dataZyamlfile�e�msg�keyr r r � read_docstring_from_yaml_file' s 6 r0 c C s� t � }t� }d}t�| ���@}t�|j�}|D �] }|jtjkrj|jdkrj|j t v rj|j |vrjt |j }q.|dur.|jtj kr.|� |j � |j } | � d�r�| �d�} | � d�r�| �d�} |dkr�t| �||< nzzt| | d��� ||< W n` t�yF } zFd t|�| t| �f } |�s"t| | d ��n|�r2t�| � W Y d} ~ n d} ~ 0 0 d}q.W d � n1 �sd0 Y |�s�t| ||�}|S ) z� Use tokenization to search for assignment of the documentation variables in the given file. Parse from YAML and return the resulting python structure or None together with examples as plain text. N� )�r�br )�'�"z'"r r z1Unable to parse docs '%s' in python file '%s': %sr! )�setr �tokenizer" �generate_tokens�readline�type�NAME�start�stringr �STRING�add� startswith�lstrip�stripr r r$ r% r r r r& r' � read_docstring_from_python_file) r) r* r+ �seenr, Z next_string�f�tokens�tokenr r- r. r r r �!read_docstring_from_python_module> s> & rH c C sl t � }�zt| d�� }t�|�� �}W d � n1 s80 Y |jD ]�}t|tj�rH|jD ]�}z |j }W n( t y� t � d|| f � Y q^Y n0 |t v r^t | } t|jtj�r�t�|j�|| < n2|dkr�t|jj�|| < nt|jj| d��� || < t �d| � q^qHW nZ t�yf } z@d| t| �f } |�sBt| | d��n|�rRt �| � W Y d} ~ n d} ~ 0 0 |S ) z� Use ast to search for assignment of the DOCUMENTATION and EXAMPLES variables in the given file. Parse DOCUMENTATION from YAML and return the YAML doc or None together with EXAMPLES, as plain text. r NzBBuilding documentation, failed to assign id for %s on %s, skippingr r zDocumentation assigned: %sz5Unable to parse documentation in python file '%s': %sr! )r r" �ast�parser# �body� isinstanceZAssign�targets�id�AttributeErrorr& Zwarningr r �DictZ literal_evalr �sr r$ �debugr% r r r' ) r) r* r+ r, Z b_module_data�M�child�tZtheidZvarkeyr- r. r r r rC | s6 , rC c C sp | � tj�r t| ||d�}n0| � tj�r8t| ||d�}n|sLtdt| � ��|sd|sdtdt| � ��d|d< |S )zC returns a documentation dictionary from Ansible plugin docstrings )r* r+ z Unknown documentation format: %sz%Unable to parse documentation for: %sNZseealso)�endswith�CZYAML_DOC_EXTENSIONSr0 ZPYTHON_DOC_EXTENSIONSrH r r )r) r* r+ Z docstringr r r �read_docstring� s rX c C s� d}d}d}g }t | d���}|D ]�}|r�|rB|�|�rB|�|� q�|rV|�|�sV q�q�|�� �d�r�d}dt|�t|�� � d }|�|� q |�d�r d |v s�d |v r d}q W d � n1 s�0 Y d�|��� �d �}t|| d �� � }|S )z� Quickly find short_description using string methods instead of node parsing. This does not return a full set of documentation strings and is intended for operations like ansible-doc -l. F� r2 zshort_description:T� r1 r �=�:N�.r ) r" r@ �appendrA �len�joinrB �rstripr r$ ) r) Zin_documentationZ capturingZindent_detectionZdoc_stubZ t_module_data�lineZshort_descriptionr, r r r � read_docstub� s( $rc )TT)TT)TT)TT) Z __future__r r r r: Z __metaclass__rI r7 Zansibler rW Zansible.errorsr r Zansible.module_utils._textr r Zansible.parsing.yaml.loaderr Zansible.utils.displayr r& r r r r0 rH rC rX rc r r r r �<module> s* � > /