U
    O8c                      @   s   d dl mZ d dlmZmZ d dlmZ d dlmZ d dl	m
Z
 d dlmZ d dlmZmZmZ G dd	 d	e
ZdddZdddZdS )    )
xform_name)document_custom_methoddocument_model_driven_method)OperationModel)get_service_module_name)BaseDocumenter)%document_model_driven_resource_method)add_resource_type_overviewget_resource_ignore_paramsget_resource_public_actionsc                   @   s   e Zd Zdd ZdS )ActionDocumenterc              	   C   s   | j j}i }|D ]}|||j< qt| jj}t|| jd< t|dddd t|D ]}|	|}|dkr| j j
rt||| j| jjjjj| j j
| jd qR||krt|| j| jjjjj|| | jd qRt||||  qRd S )	NactionsZActionszActions 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)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	   Zadd_new_sectionr   document_load_reload_actionZ_resource_namemetaclienteventsZ_service_modeldocument_actionr   )selfr   Zmodeled_actions_listZmodeled_actionsZmodeled_actionZresource_actionsr   Zaction_section r"   5/tmp/pip-unpacked-wheel-hml_76kf/boto3/docs/action.pydocument_actions   sL    
  z!ActionDocumenter.document_actionsN)__name__
__module____qualname__r$   r"   r"   r"   r#   r      s   r   Tc                 C   sx   | |jj}t|jj}d}|jr0t|jj}t|}	|j|krF|}	d	||	|j
}
t| |j
|||j|
|||d	 dS )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   method_nameoperation_modelr   method_descriptionexample_prefixZexclude_inputZresource_action_modelinclude_signatureN)r*   request	operationr
   paramsresourcer   typeservice_nameformatr   r   Zdocumentation)r   r   r   r   r   r-   r*   Zignore_paramsZexample_return_valueexample_resource_namer,   r"   r"   r#   r    L   s4    
  r    c           
   	   C   s^   d t|t|jj|}t|}|j|kr0|}| d| }	t| |ti ||||	|d dS )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.
    zCalls :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-   N)r4   r   r   r.   r/   r3   r   r   )
r   r   r   r   r   r   r-   r   r5   r,   r"   r"   r#   r   ~   s&    
	
r   N)T)T)Zbotocorer   Zbotocore.docs.methodr   r   Zbotocore.modelr   Zbotocore.utilsr   Zboto3.docs.baser   Zboto3.docs.methodr   Zboto3.docs.utilsr	   r
   r   r   r    r   r"   r"   r"   r#   <module>   s   4 
9 