|
Server : LiteSpeed System : Linux server51.dnsbootclub.com 4.18.0-553.62.1.lve.el8.x86_64 #1 SMP Mon Jul 21 17:50:35 UTC 2025 x86_64 User : nandedex ( 1060) PHP Version : 8.1.33 Disable Function : NONE Directory : /opt/cppython/lib/python3.8/site-packages/boto3/docs/__pycache__/ |
U
Q��g ; � @ 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__� �@/opt/cppython/lib/python3.8/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+ Z
title_sectionr r r r : s
z ResourceDocumenter._add_titlec
C s� g }| j jr&| j jD ]}|�|j� qt|�}|�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_classr5 �_add_description� _add_example�_add_params_descriptionZend_sphinx_py_class)
r r+ �identifier_names�
identifierZ
class_argsr2 Zdescription_sectionZexample_sectionZ
param_sectionr9 r r r r" > s"
�
z ResourceDocumenter._add_introc C s& t | j�}|�d|� d| j� �� d S )NzA resource representing an � )r �_service_model�writer �r r+ Zofficial_service_namer r r r= [ s
�z#ResourceDocumenter._add_descriptionc
C s� |j �� |j �� |�d� |j �� |j �� |�| j� d| j� d�� |j �� t|�}|�t| j�� d| j� d| j� d|� d�� |j �� d S )N� import boto3� = boto3.resource('�')z = �.r3 r4 ) r/ �start_codeblock�new_linerD r r r r �
end_codeblock)r r+ r@ Zexample_valuesr r r r> a s
�
$�z ResourceDocumenter._add_examplec C sV |D ]L}t | j|�}|�d|� d�� |j�� |�d|� d|� �� |j�� qd S )Nz:type z: stringz:param z: )r r rD r/ rK )r r+ r@ Zidentifier_namer6 r r r r? q s �
z*ResourceDocumenter._add_params_descriptionc C sR |j �� |�d|� d�� |j �� |j �� | j| D ]}|j �|� � q:d S )Nz#These are the resource's available �:)r/ rK rD 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� |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<|r�| �|d� d S )Nr: Z IdentifierszYIdentifiers are properties of a resource that are set upon instantiation of the resource.� identifiers_attributes_intro�r+ Z
resource_typer6 Z
intro_link�html��target�
breadcrumb�indexz / Identifier / � qualifierrI ��context)r+ �
resource_nameZidentifier_model)� _resource�meta�resource_modelr: r. rN r r; r< r r/ �ref�_resource_class_namerD �add_title_sectionr5 r r �os�path�joinr r r �
write_to_filerP ) r r+ r: Z member_listrA Zidentifier_doc�breadcrumb_sectionZidentifier_sectionZidentifiers_dir_pathr r r r# � sF
�
���z#ResourceDocumenter._add_identifiersc
C sH | j jjjj}i }| j jjjr@|�| j jjj�}| j jj�|�}|�d�}g }|rlt |dddd� || j
d< t |�D ]�}|| \}}|� |� t
|dd�} | �d�}
|
j�| jd � |
�d
|� �� | �|� | j|d | j� d �id
�} t| | j| j|| j jjjj|d� tj�| j| j� | j � �} | � | |� qt|�rD| � |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.rQ rR rS rT rV rW z / Attribute / rX rI rY )r+ � service_namer[ � attr_nameZ
event_emitterZ
attr_model) r\ r] �client�
service_modelr^ �shapeZ shape_forZget_attributesr. r rN �sortedr; r r/ r_ r` rD ra r5 r r r �eventsrb rc rd r r re rP )
r r+ rk rg rl Zattribute_listri �_Z
attr_shapeZ
attribute_docrf Zattribute_sectionZattributes_dir_pathr r r r$ � s^
�
�
�
� �
�z"ResourceDocumenter._add_attributesc C s� |� d�}| jjjj}g }|r8t|dddd� || jd< |D ]�}|�|j� t |jdd�}|� d�}|j
� | j d � |�
d
|j� �� |�|j� |j |jd | j� d �id
�}t||d� tj�| j| j� | j� �}|�||j� q<|r�| �|d� d S )N�
referencesZ
ReferenceszNReferences are related resource instances that have a belongs-to relationship.Zreferences_introrR rS rT rV rW z / Reference / rX rI rY )r+ Zreference_model)r. r\ r] r^ rp r rN r; r< r r/ r_ r` rD ra r5 r rb rc rd r r r re rP ) r r+ rp Zreference_list� referenceZ
reference_docrf Zreference_sectionZreferences_dir_pathr r r r% � sD
�
���z"ResourceDocumenter._add_referencesc C sJ |� d�}| jjjj}|rFt| j| j�}| j|_|�|� | � |d� d S )N�actions)
r. r\ r] r^ rr r r rN Zdocument_actionsrP )r r+ rr �
documenterr r r r& s
z ResourceDocumenter._add_actionsc C sJ |� d�}| jjjj}|rFt| j| j�}| j|_|�|� | � |d� d S )Nz
sub-resources)
r. r\ r] r^ Z subresourcesr r rN Zdocument_sub_resourcesrP )r r+ Z
sub_resourcesrs r r r r' s
�
z%ResourceDocumenter._add_sub_resourcesc C sJ |� d�}| jjjj}|rFt| j| j�}| j|_|�|� | � |d� d S )N� collections)
r. r\ r] r^ rt r
r rN Zdocument_collectionsrP )r r+ rt rs r r r r( ( s
�
z#ResourceDocumenter._add_collectionsc C sZ |� d�}| jjjj}|rV| j�| j�}t| j|| j �}| j
|_
|� |� | � |d� d S )N�waiters)
r. r\ r] r^ ru r Zget_waiter_modelr r r rN Zdocument_resource_waitersrP )r r+ ru Zservice_waiter_modelrs r r r r) 3 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_noterD Zend_noter* r r r r! A s
�z%ResourceDocumenter._add_resource_note)�__name__�
__module__� __qualname__r r, r r" r= r> r? rP 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 r5 M s z$ServiceResourceDocumenter.class_namec C s |� d�}|j�d� d S )Nr- zService Resource)r. r/ r0 r1 r r r r Q s
z$ServiceResourceDocumenter._add_titlec C s t | j�}|�d|� �� d S )NzA resource representing )r rC rD rE r r r r= U s
z*ServiceResourceDocumenter._add_descriptionc C sZ |j �� |j �� |�d� |j �� |j �� |�| j� d| j� d�� |j �� d S )NrF rG rH )r/ rJ rK rD r rL )r r+ r@ r r r r> Y s
�z&ServiceResourceDocumenter._add_exampleN)rv rw rx �propertyr5 r r= r> r r r r rz L s
rz ) rb 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 rz r r r r �<module>
s )