File: //opt/alt/python37/lib/python3.7/site-packages/boto3/docs/__pycache__/action.cpython-37.pyc
B
�P�e� � @ s� d dl Z d dlmZ d dlmZ d dlmZmZ d dlm Z d dl
m Z d dl m
Z
d dlmZ d d lmZmZmZ d
Zd d eiiZd d d
giiZG dd� de
�Zddd�Zddd�ZdS )� N)�
xform_name)�DocumentStructure)�document_custom_method� document_model_driven_method)�OperationModel)�get_service_module_name)�NestedDocumenter)�%document_model_driven_resource_method)�add_resource_type_overview�get_resource_ignore_params�get_resource_public_actionsa?
.. warning::
It is recommended to use the :py:meth:`put_metric_data`
:doc:`client method <../../cloudwatch/client/put_metric_data>`
instead. If you would still like to use this resource method,
please make sure that ``MetricData[].MetricName`` is equal to
the metric resource's ``name`` attribute.
ZMetricZput_data� Namespacec @ s e Zd Zdd� ZdS )�ActionDocumenterc
C s� | j j}i }x|D ]}|||j< qW t| jj�}t|�| jd< t|dddd� t �
| j i �}�x0t|�D �]"}t |dd�}|�
d�} | j�| jd � | �d
|� �� |�|� |�
|�}
|
d k r�|�
d ��|
� |j
|d | j� d
�id�} |dk�r&| j j�r&t| || j | jjjjj| j j| jd� n@||k�rVt| | j | jjjjj|| | jd� nt| ||| � t j � | j | j � | j!� �} |�"| |� qhW d S )N�actionsZActionsz�Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes.Z
actions_intro)�sectionZ
resource_type� descriptionZ
intro_link�html)�targetZ
breadcrumb�indexz / Action / �warning� qualifier�.)�context)�load�reload)r � action_name�
resource_name�
event_emitter�
load_model�
service_model)r r r � action_modelr )#Z_resource_modelr �namer Z _resource� __class__�sorted�
member_mapr
�WARNING_MESSAGES�getZ_resource_namer Zadd_new_section�style�refZ_resource_class_name�writeZadd_title_section�
class_namer �document_load_reload_action�meta�client�eventsZ_service_model�document_actionr �os�path�joinZ_root_docs_pathZ
_service_nameZ_resource_sub_pathZ
write_to_file)
�selfr Zmodeled_actions_listZmodeled_actionsZmodeled_actionZresource_actionsZresource_warningsr Z
action_docZbreadcrumb_sectionZwarning_messageZaction_sectionZactions_dir_path� r4 �B/opt/alt/python37/lib/python3.7/site-packages/boto3/docs/action.py�document_actions1 s^
z!ActionDocumenter.document_actionsN)�__name__�
__module__� __qualname__r6 r4 r4 r4 r5 r 0 s r Tc C s� |� |jj�}t�|i ��|jt|jj��}d}|jrBt |jj
�}t |�} |j |krX|} d� || |j�}
| j
�dd�� |j� �} t| | |||j|
|||d� dS )a� Documents a resource action
:param section: The section to write to
:param resource_name: The name of the resource
:param event_emitter: The event emitter to use to emit events
:param action_model: The model of the action
:param service_model: The model of the service
:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
�responsez
{} = {}.{}r � ) r � method_name�operation_modelr �method_description�example_prefixZ
exclude_inputZresource_action_model�include_signatureN)r= �request� operation�
IGNORE_PARAMSr& r! r �params�resourcer �type� service_name�formatr r Z
documentation) r r r r r r@ r= Z
ignore_paramsZexample_return_value�example_resource_namer? �full_action_namer4 r4 r5 r/ r s0
r/ c C st d� t|�t|jj�|�}t|�}|j|kr0|}|� d|� �} | j�dd�� |� �}
t| |
t i |�||| |d� dS )a� Documents the resource load action
:param section: The section to write to
:param action_name: The name of the loading action should be load or reload
:param resource_name: The name of the resource
:param event_emitter: The event emitter to use to emit events
:param load_model: The model of the load action
:param service_model: The model of the service
:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
z�Calls :py:meth:`{}.Client.{}` to update the attributes of the {} resource. Note that the load and reload methods are the same method and can be used interchangeably.r r r; )r r< r= r r> r? r@ N)
rH r r rA rB rG r r& r r ) r r r r r r r@ r rI r? rJ r4 r4 r5 r+ � s"
r+ )T)T)r0 Zbotocorer Zbotocore.docs.bcdoc.restdocr Zbotocore.docs.methodr r Zbotocore.modelr Zbotocore.utilsr Zboto3.docs.baser Zboto3.docs.methodr Zboto3.docs.utilsr
r r ZPUT_DATA_WARNING_MESSAGEr% rC r r/ r+ r4 r4 r4 r5 �<module>
s
H
8