| Current File : //usr/lib/python3/dist-packages/boto3/docs/__pycache__/subresource.cpython-312.pyc |
�
��e� � �t � d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
m Z m Z m
Z
G d� de� Z d
d �Zy) � N)�
xform_name)�DocumentStructure)�get_service_module_name)�NestedDocumenter)�add_resource_type_overview�!get_identifier_args_for_signature�get_identifier_description�!get_identifier_values_for_examplec � � e Zd Zd� Zy)�SubResourceDocumenterc �^ � t |ddd�� t | j j j j
d� �� }g }|| j d< |D �]Q }|j |j � t |j d� � }|j d
� }|j j | j d � |j d |j � �� |j |j � |j |j d
| j � d�i�� }t# || j$ || j& �� t( j* j- | j. | j0 � | j2 � � }|j5 ||j � ��T y )Nz
Sub-resourcesz�Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.�subresources_intro)�section�
resource_type� description�
intro_linkc � � | j S )N)�name)� sub_resources �8/usr/lib/python3/dist-packages/boto3/docs/subresource.py�<lambda>z>SubResourceDocumenter.document_sub_resources.<locals>.<lambda>* s � �\�%6�%6� � )�keyz
sub-resources�html)�target�
breadcrumb�indexz / Sub-Resource / � qualifier�.)�context)r �
resource_name�sub_resource_model�
service_model)r �sorted� _resource�meta�resource_model� subresources�
member_map�appendr r �add_new_section�style�ref�_resource_class_name�write�add_title_section�
class_name�document_sub_resource�_resource_name�_service_model�os�path�join�_root_docs_path�
_service_name�_resource_sub_path�
write_to_file) �selfr �
sub_resources�sub_resources_listr �sub_resource_doc�breadcrumb_section�sub_resource_section�sub_resources_dir_paths r �document_sub_resourcesz,SubResourceDocumenter.document_sub_resources s� � �"��)�'� ,�
� � �N�N� � � .� .� ;� ;�6�
�
� ��+=�����(� )� �L� � %� %�l�&7�&7� 8� 0� �!�!�&� � � "2�!A�!A�,�!O� � � $� $� (� (��)B�)B�G� L� � $� $�'9�,�:K�:K�9L�%M� N� � .� .�|�/@�/@� A�#3�#C�#C� �!�!�$�� � �(9��&;�<� $D� $� �
"�,� "� 1� 1�#/� "� 1� 1�
� &(�W�W�\�\��$�$��%�%�&��*�*�+�&� "�
� *� *�&� �(9�(9�
�9 r N)�__name__�
__module__� __qualname__rC � r r r r s � �/r r c �� � g }|j j D ]6 }|j dk( s�|j t |j
� � �8 |rQt
|� }| j j dd� � |j � �}| j j ||� | j d� } d|j j � d�}
| j |
� | j d� } t |� } t |� }
|j |k( r|}
dj# t |j j � |
|j | � }| j j% � | j' |� | j j) � | j d � }|D ]x }t+ |j |� }
|j' d
|� d �� |j j- � |j' d |� d
|
� �� |j j- � �z | j d� }|j j- � |j' dj# t/ |� |j j � � |j j- � |j' d|j j � d�� |j j- � y)aj Documents a resource action
:param section: The section to write to
:param resource_name: The name of the resource
:param sub_resource_model: The model of the subresource
:param service_model: The model of the service
:param include_signature: Whether or not to include the signature.
It is useful for generating docstrings.
�inputr � z method-introz
Creates a z
resource.�examplez{} = {}.{}({})�paramsz:type z: stringz:param z: �returnz:rtype: :py:class:`{}.{}`z :returns: A z resourceN)�resource� identifiers�sourcer* r r r r �getr r, �start_sphinx_py_methodr+ �type�include_doc_stringr
� service_name�format�start_codeblockr/ �
end_codeblockr �new_liner )r r! r" r# �include_signature�identifiers_needed�
identifier�signature_args�full_sub_resource_name�method_intro_sectionr �example_section�example_values�example_resource_namerK �
param_section�return_sections r r2 r2 O s� � �( ��(�1�1�=�=� E�
� � � �� '� � %� %�j��1B�1B�&C� D�E� �:�;M�N�����"�"�;��3�4�5G�5L�5L�4M� N� � �
�
�,�,� "�N�
� #�2�2�>�B�� � 1� :� :� ?� ?� @�
�K�K��+�+�K�8� �-�-�i�8�O�6�7I�J�N� &�}� 5���!�!�]�2� -� � �%�%��%�.�.�3�3�4� �� � �� �G� ���)�)�+����'�"����'�'�)��+�+�H�5�M�(� '�
�0� � #� #�Z�
� � ���f�Z�L�� 9�:����$�$�&����g�j�\��K�=� A�B����$�$�&�'� �,�,�X�6�N����!�!�#����#�*�*� #�M� 2� � '� '� ,� ,�
�� ���!�!�#����
�)�2�2�7�7�8� �B�� ���!�!�#r )T)r5 �botocorer �botocore.docs.bcdoc.restdocr �botocore.utilsr �boto3.docs.baser �boto3.docs.utilsr r r r
r r2 rG r r �<module>rj s9 ��
� � 9� 2� ,�� �0� ,� 0�p � J$r