File: //opt/alt/python37/lib/python3.7/site-packages/boto3/docs/__pycache__/resource.cpython-37.pyc
B
�P�e< � @ s� d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
m Z m Z d dl
mZ d dlmZ d d lmZ d d
lmZmZmZmZ d d lmZ G d d
� d
e�ZG dd� de�ZdS )� N)�
xform_name)�DocumentStructure)�get_official_service_name)�ActionDocumenter)�document_attribute�document_identifier�document_reference)�BaseDocumenter)�CollectionDocumenter)�SubResourceDocumenter)�add_resource_type_overview�!get_identifier_args_for_signature�get_identifier_description�!get_identifier_values_for_example)�WaiterResourceDocumenterc s� e Zd Z� fdd�Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd � Zd d � Zd d � Z� ZS )!�ResourceDocumenterc s: t � �|� || _|| _| j�� | _| j| jkr6d| _d S )Nzservice-resource)�super�__init__�_botocore_session�_root_docs_path�_resource_name�lower�_resource_sub_path�
_service_name)�self�resourceZbotocore_sessionZroot_docs_path)� __class__� �D/opt/alt/python37/lib/python3.7/site-packages/boto3/docs/resource.pyr & s zResourceDocumenter.__init__c C sh | � |� | �|� | �|� | �|� | �|� | �|� | �|� | �|� | �|� | � |� d S )N)
�
_add_title�_add_resource_note�
_add_intro�_add_identifiers�_add_attributes�_add_references� _add_actions�_add_sub_resources�_add_collections� _add_waiters)r �sectionr r r �document_resource. s
z$ResourceDocumenter.document_resourcec C s |� d�}|j�| j� d S )N�title)�add_new_section�style�h2r )r r) �
title_sectionr r r r : s
z ResourceDocumenter._add_titlec
C s� g }| j jr*x | j jD ]}|�|j� qW t|�}|�d�}|jj| j� d|� d�d� |�d�}| � |� |�d�}| �
||� |�d�}| � ||� |�d�} | j� � d S ) N� start_class�(�))�
class_name� description�example�params� end_class)
Z_resource_model� identifiers�append�namer
r, r- Zstart_sphinx_py_classr3 �_add_description� _add_example�_add_params_descriptionZend_sphinx_py_class)
r r) �identifier_names�
identifierZ
class_argsr0 Zdescription_sectionZexample_sectionZ
param_sectionr7 r r r r! > s
z ResourceDocumenter._add_introc C s" t | j�}|�d�|| j�� d S )Nz A resource representing an {} {})r �_service_model�write�formatr )r r) �official_service_namer r r r; [ s
z#ResourceDocumenter._add_descriptionc C s� |j �� |j �� |�d� |j �� |j �� |�d�| j| j�� |j �� t|�}|�d�t| j�| j| j|�� |j � � d S )Nz import boto3z{} = boto3.resource('{}')z{} = {}.{}({}))
r- �start_codeblock�new_linerA rB r r r r �
end_codeblock)r r) r> Zexample_valuesr r r r< c s"
z ResourceDocumenter._add_examplec C sZ xT|D ]L}t | j|�}|�d|� d�� |j�� |�d|� d|� �� |j�� qW d S )Nz:type z: stringz:param z: )r r rA r- rE )r r) r> Zidentifier_namer4 r r r r= z s
z*ResourceDocumenter._add_params_descriptionc C sV |j �� |�d|� d�� |j �� |j �� x | j| D ]}|j �|� � q<W d S )Nz#These are the resource's available �:)r- rE rA Ztoctree�
member_mapZtocitem)r r) Zresource_member_type�memberr r r � _add_overview_of_member_type� s
z/ResourceDocumenter._add_overview_of_member_typec C s | j jjj}|�d�}g }|r8|| jd< t|dddd� x�|D ]�}|�|j� t |jdd�}|�d�}|j
� | j d � |�
d
|j� �� |�|j� |j|jd | j� d �id
�}t|| j|d� tj�| j| j� | j� �}|�||j� q>W |r�| �|d� d S )Nr8 Z IdentifierszYIdentifiers are properties of a resource that are set upon instantiation of the resource.� identifiers_attributes_intro)r) �
resource_typer4 �
intro_link�html)�target�
breadcrumb�indexz / Identifier / � qualifier�.)�context)r) �
resource_nameZidentifier_model)� _resource�meta�resource_modelr8 r, rH r r9 r: r r- �ref�_resource_class_namerA �add_title_sectionr3 r r �os�path�joinr r r �
write_to_filerJ ) r r) r8 Z member_listr? Zidentifier_doc�breadcrumb_sectionZidentifier_sectionZidentifiers_dir_pathr r r r" � s>
z#ResourceDocumenter._add_identifiersc
C sL | j jjjj}i }| j jjjr@|�| j jjj�}| j jj�|�}|�d�}g }|rlt |dddd� || j
d< x�t |�D ]�}|| \}}|� |� t
|dd�} | �d�}
|
j�| jd � |
�d
|� �� | �|� | j|d | j� d �id
�} t| | j| j|| j jjjj|d� tj�| j| j� | j � �} | � | |� qvW |�rH| � |d� d S )N�
attributesZ
Attributesz�Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.rK )r) rL r4 rM rN )rO rP rQ z / Attribute / rR rS )rT )r) � service_namerU � attr_nameZ
event_emitterZ
attr_model) rV rW �client�
service_modelrX �shapeZ shape_forZget_attributesr, r rH �sortedr9 r r- rY rZ rA r[ r3 r r r �eventsr\ r] r^ r r r_ rJ )
r r) re ra rf Zattribute_listrc �_Z
attr_shapeZ
attribute_docr` Zattribute_sectionZattributes_dir_pathr r r r# � sR
z"ResourceDocumenter._add_attributesc C s
|� d�}| jjjj}g }|rDt|dddd� || jd< | �|d� x�|D ]�}|�|j � t
|j dd�}|� d�}|j � | j
d � |�d
|j � �� |�|j � |j |j d | j� d �id
�}t||d� tj�| j| j� | j� �}|�||j � qJW |�r| �|d� d S )N�
referencesZ
ReferenceszNReferences are related resource instances that have a belongs-to relationship.Zreferences_intro)r) rL r4 rM rN )rO rP rQ z / Reference / rR rS )rT )r) Zreference_model)r, rV rW rX rj r rH rJ r9 r: r r- rY rZ rA r[ r3 r r\ r] r^ r r r r_ ) r r) rj Zreference_list� referenceZ
reference_docr` Zreference_sectionZreferences_dir_pathr r r r$ � s>
z"ResourceDocumenter._add_referencesc C sJ |� d�}| jjjj}|rFt| j| j�}| j|_|�|� | � |d� d S )N�actions)
r, rV rW rX rl r r rH Zdocument_actionsrJ )r r) rl �
documenterr r r r% s
z ResourceDocumenter._add_actionsc C sJ |� d�}| jjjj}|rFt| j| j�}| j|_|�|� | � |d� d S )Nz
sub-resources)
r, rV rW rX Z subresourcesr r rH Zdocument_sub_resourcesrJ )r r) Z
sub_resourcesrm r r r r& ' s
z%ResourceDocumenter._add_sub_resourcesc C sJ |� d�}| jjjj}|rFt| j| j�}| j|_|�|� | � |d� d S )N� collections)
r, rV rW rX rn r
r rH Zdocument_collectionsrJ )r r) rn rm r r r r' 2 s
z#ResourceDocumenter._add_collectionsc C sZ |� d�}| jjjj}|rV| j�| j�}t| j|| j �}| j
|_
|� |� | � |d� d S )N�waiters)
r, rV rW rX ro r Zget_waiter_modelr r r rH Zdocument_resource_waitersrJ )r r) ro Zservice_waiter_modelrm r r r r( = s
z ResourceDocumenter._add_waitersc C s, |� d�}|j�� |�d� |j�� d S )Nzfeature-freezez�Before using anything on this page, please refer to the resources :doc:`user guide <../../../../guide/resources>` for the most recent guidance on using resources.)r, r- Z
start_noterA Zend_note)r r) r r r r K s
z%ResourceDocumenter._add_resource_note)�__name__�
__module__� __qualname__r r* r r! r; r< r= rJ r" r# r$ r% r& r' r( r �
__classcell__r r )r r r % s
,9+ r c @ s0 e Zd Zedd� �Zdd� Zdd� Zdd� Zd S )
�ServiceResourceDocumenterc C s | j � d�S )Nz.ServiceResource)Z_service_docs_name)r r r r r3 W s z$ServiceResourceDocumenter.class_namec C s |� d�}|j�d� d S )Nr+ zService Resource)r, r- r. )r r) r/ r r r r [ s
z$ServiceResourceDocumenter._add_titlec C s t | j�}|�d|� �� d S )NzA resource representing )r r@ rA )r r) rC r r r r; _ s
z*ServiceResourceDocumenter._add_descriptionc C sZ |j �� |j �� |�d� |j �� |j �� |�| j� d| j� d�� |j �� d S )Nz import boto3z = boto3.resource('z'))r- rD rE rA r rF )r r) r> r r r r< c s
z&ServiceResourceDocumenter._add_exampleN)rp rq rr �propertyr3 r r; r< r r r r rt V s rt ) r\ Zbotocorer Zbotocore.docs.bcdoc.restdocr Zbotocore.docs.utilsr Zboto3.docs.actionr Zboto3.docs.attrr r r Zboto3.docs.baser Zboto3.docs.collectionr
Zboto3.docs.subresourcer Zboto3.docs.utilsr r
r r Zboto3.docs.waiterr r rt r r r r �<module>
s 3