File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/baredoc.cpython-310.pyc
Back
o ;jK, � @ s� d Z ddlZddlZddlZddlZddlmZ ddlZddl Zddl m Z e� e �Zdedefdd�Zdefd d �Zd edefd d �Zd!dd�Zdededefdd�Zd"defdd�Zd#dd�Zd#dd �Zd d � Zd d � ZdS )$z� Baredoc walks the installed module and state directories and generates dictionaries and lists of the function names and their arguments. .. versionadded:: 3001 � N)� OrderedDict)�ArgumentValueError�filename�returnc C sb t j�|��d�d }dd� | jD �}|D ]}z|jd jdkr$|jj}W q t y. Y qw |S )zT Returns the value of __virtual__ if found. Otherwise, returns filename �.r c S � g | ] }t |tj�r|�qS � �� isinstance�astZAssign��.0�noder r �H/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/baredoc.py� <listcomp> � z$_get_module_name.<locals>.<listcomp>Z__virtualname__) �os�path�basename�split�body�targets�id�value�s�AttributeError)�treer � module_name� assignments�assignr r r �_get_module_name s � �r c C sx i }dd� | j D �}|D ]-}z"|jd jdkr/t�|jj|jj�D ] \}}|�|j |j i� q!W q t y9 Y q w |S )z< Get __func_alias__ dict for mapping function names c S r r r r r r r r + r z%_get_func_aliases.<locals>.<listcomp>r Z__func_alias__) r r r � itertools� zip_longestr �keys�values�updater r )r � fun_aliasesr r �keyr r r r �_get_func_aliases& s �� �r( �functionc C s g }| j j }|r|D ]}|�|j� q g }| j j}|rF|D ](}t|tj�r,|�|j� q t|tj�r9|�|j � q t|tj �rE|�|j � q t t �t|�t|���}t tt|�� ���}z | j jj|d< W n tyn Y nw z | j jj|d< W |S ty� Y |S w )z> Given a function def, returns arguments and defaults �args�kwargs)r* �append�arg�defaultsr r Z NameConstantr ZStrr ZNum�nr r! r" �reversed�list�items�varargr �kwarg) r) � arg_stringsZlist_of_argumentsr- Zarg_default_stringsZlist_arg_defaultsZ arg_defaultZbackwards_argsZ ordered_argsr r r � _get_args8 s@ �� � ��r6 c C s i }t jjj| ddd��t}t�|�� �}t|| �}|r d|vr&t�|�||< t |�}dd� |j D �}|D ]D}t�|�} |j � d�sx|j } |rV|� � D ] \} } |j | krU| } qJ|rod|v ro| |�d�d krn| ||� d| � �< q4| ||� d| � �< q4W d � n1 s�w Y t jj�|�S ) zM Gather module docstrings or module.function doc string if requested �r�utf8��encodingr c S r r �r r Z FunctionDefr r r r r p r z&_parse_module_docs.<locals>.<listcomp>�_� N)�salt�utils�files�fopenr �parse�readr Z get_docstringr( r �name� startswithr2 r �docZ strip_rst) Z module_path�mod_name�ret�cur_filer r r& � functions�fnZ doc_string� function_name�k�vr r r �_parse_module_docsb s4 � ��� �rO � module_py� return_typec C s� i }t jjj| ddd��`}t�|�� �}t|| �}t|�}dd� |j D �}g }|D ]6} | j � d�s_| j } |rF|� � D ] \} } | j | krE| } q:t | �} |dkrT|�| � q)i }| || < |�|� q)|||< W d � |S 1 sow Y |S ) zw Parse module files for proper module_name and function name, then gather functions and possibly arguments r7 r8 r9 c S r r r; r r r r r � r z+_parse_module_functions.<locals>.<listcomp>r< �namesN)r> r? r@ rA r rB rC r r( r rD rE r2 r6 r, )rP rQ rH rI r r r& rJ Z func_listrK rL rM rN r* Z fun_entryr r r �_parse_module_functions� s6 � � ��rS F�statesr* c C s@ g }g }|dkr!|� tj�td d�� |� tj�td d�� n |dkr=|� tj�td d�� |� tj�td d�� | rqd| v rR|dkrKtd��| �d�d } |D ]}tj�|| d �}tj�|�rn|� |� | S qT|S t |�D ](}z t� |�D ]}|� d �r�|d kr�|� tj�||�� q}W qu t y� Y quw |S ) z� Determine if modules/states directories or files are requested return_type = names == names_only=True return_type = args == names_only=Fals return_type = docs �modulesZextension_modulesZsaltpathrT r �docszFunction name givenr z.pyz __init__.py) r, r r �joinZ__opts__Z __grains__r r �existsr0 �listdir�endswith�FileNotFoundError)rD �typerQ �dirs� found_files�dirZ file_pathrP r r r � _get_files� s> � ��� �r` c C �L i }|rd}nd}t | d|d�}|D ] }|�t||d�� qtt|�� ��S )aC Walk the Salt install tree for state modules and return a dictionary or a list of their functions as well as their arguments. :param name: specify a specific module to list. If not specified, all modules will be listed. :param names_only: Return only a list of the callable functions instead of a dictionary with arguments CLI Example: (example truncated for brevity) .. code-block:: bash salt myminion baredoc.list_states myminion: ---------- [...] at: - present: name: null timespec: null tag: null user: null job: null unique_tag: false - absent: name: null jobid: null kwargs: kwargs - watch: name: null timespec: null tag: null user: null job: null unique_tag: false - mod_watch: name: null kwargs: kwargs [...] rR r* rT �r\ rQ �rQ �r` r% rS r �sortedr2 �rD Z names_onlyrH rQ r^ �filer r r � list_states� s +rh c C ra )a� Walk the Salt install tree for execution modules and return a dictionary or a list of their functions as well as their arguments. :param name: specify a specific module to list. If not specified, all modules will be listed. :param names_only: Return only a list of the callable functions instead of a dictionary with arguments CLI Example: .. code-block:: bash salt myminion baredoc.list_modules myminion: ---------- [...] at: - atq: tag: null - atrm: args: args - at: args: args kwargs: kwargs - atc: jobid: null - jobcheck: kwargs: kwargs [...] rR r* rU rb rc rd rf r r r � list_modules s ri c G � d}i }| r$| D ]}t |d|d�d }|�t||�� qtt|�� ��S g }|�t d|d�� |D ] }|�t|�� q1tt|�� ��S )a Return the docstrings for all state modules. Optionally, specify a state module or a function to narrow the selection. :param name: specify a specific module to list. CLI Example: .. code-block:: bash salt myminion baredoc.state_docs at rV rT rb r �r` r% rO r re r2 �extend�rR rQ rH rD rg r^ r r r � state_docs. � rn c G rj )a Return the docstrings for all modules. Optionally, specify a module or a function to narrow the selection. :param name: specify a specific module to list. CLI Example: .. code-block:: bash salt myminion baredoc.module_docs rV rU rb r rk rm r r r � module_docsJ ro rp )N)FrT r* )FF) �__doc__r r! �loggingr � collectionsr Zsalt.utils.docr> Zsalt.utils.filesZsalt.exceptionsr � getLogger�__name__�log�strr �dictr( r6 rO rS r1 r` rh ri rn rp r r r r �<module> s( * ! + 6*
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings