HEX
Server: LiteSpeed
System: Linux us-phx-web1284.main-hosting.eu 4.18.0-553.109.1.lve.el8.x86_64 #1 SMP Thu Mar 5 20:23:46 UTC 2026 x86_64
User: u300739242 (300739242)
PHP: 8.2.30
Disabled: system, shell_exec, passthru, mysql_list_dbs, ini_alter, dl, symlink, link, chgrp, leak, popen, apache_child_terminate, virtual, mb_send_mail
Upload Files
File: //opt/alt/python311/lib/python3.11/site-packages/boto3/docs/__pycache__/collection.cpython-311.pyc
�

/�;f�-���ddlZddlmZddlmZddlmZddlmZddl	m
Z
ddlmZddl
mZmZGd	�d
e
��Z	dd�Z	dd
�Z	dd�ZdS)�N)�
xform_name)�DocumentStructure)�get_instance_public_methods)�DocumentedShape)�NestedDocumenter)�%document_model_driven_resource_method)�add_resource_type_overview�get_resource_ignore_paramsc��eZdZd�Zd�ZdS)�CollectionDocumenterc���|jjjj}g}t	|ddd���||jd<|D�](}|�|j��t|jd���}|�	d��}|j
�|jd	��|�
d
|j����|�|j��|�	|jd|j�d�i�
��}|�||��t"j�|j|j�|j���}|�||j����*dS)N�CollectionszUCollections provide an interface to iterate over and manipulate groups of resources. �guide_collections)�section�
resource_type�description�
intro_link�collections�html)�target�
breadcrumb�indexz / Collection / �	qualifier�.)�context)�	_resource�meta�resource_modelrr	�
member_map�append�namer�add_new_section�style�ref�_resource_class_name�write�add_title_section�
class_name�_document_collection�os�path�join�_root_docs_path�
_service_name�_resource_sub_path�
write_to_file)	�selfrr�collections_list�
collection�collection_doc�breadcrumb_section�collection_section�collections_dir_paths	         �H/opt/alt/python311/lib/python3.11/site-packages/boto3/docs/collection.py�document_collectionsz)CollectionDocumenter.document_collectionss����n�)�8�D����"��'�3�+�	
�	
�	
�	
�*:���
�&�%�	P�	P�J��#�#�J�O�4�4�4�.�z��v�N�N�N�N�!/�!?�!?��!M�!M���$�(�(��)B�G�L�L�L��$�$�%I�
��%I�%I�J�J�J��,�,�Z�_�=�=�=�!/�!?�!?���$���&;�&;�&;�<�"@�"�"��
�%�%�&8�*�E�E�E�$&�7�<�<��$��%�'��*�,�$�$� �

�(�(�)=�z��O�O�O�O�+	P�	P�c	�4�tt|j|j����}t	||��i}|jD]}|||j<�
t
|��D]�}|�|��}||vrSt||j	|jj
jj
j||||jj
jj
j
����nt||j	||jj
jj
j||jj
jj
j
�����dS)N)r�
resource_name�
event_emitter�batch_action_model�collection_model�
service_model)rr<�action_namer=r?r@)r�getattrrr!�document_collection_object�
batch_actions�sortedr"�document_batch_action�_resource_namer�client�eventsr@�document_collection_method)r1rr3�methodsrD�batch_action�method�method_sections        r8r)z)CollectionDocumenter._document_collectionAs9��-��D�N�J�O�4�4�
�
��	#�7�J�7�7�7��
�&�4�	<�	<�L�/;�M�,�+�,�,��W�o�o�	�	�F�$�4�4�V�<�<�N���&�&�%�*�"&�"5�"&�.�"5�"<�"A�"H�'4�V�'<�%/�"&�.�"5�"<�"A�"O�
�����+�*�"&�"5� &�"&�.�"5�"<�"A�"H�%/�"&�.�"5�"<�"A�"O�
�����	�	r:N)�__name__�
__module__�__qualname__r9r)�r:r8rrs6������"P�"P�"P�H����r:rTc��|r>|j�dd���|j��}|j�|��|�d|jj�d���|�d|jj�d���dS)a
Documents a collection resource object

    :param section: The section to write to

    :param collection_model: The model of the collection

    :param include_signature: Whether or not to include the signature.
        It is useful for generating docstrings.
    r�zA collection of z resources.zA z� Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.N)r�getr!r#�start_sphinx_py_attr�include_doc_string�resource�type)rr?�include_signature�full_collection_names    r8rCrC`s����A���"�"�;��3�3�L�5E�5J�L�L�	�	�
�*�*�+?�@�@�@����F�+�4�9�F�F�F�������	0�
�
&�
+�	0�	0�	0�����r:c�z�|�|jj��}t|jj��}d}	|jrt
|jj��}	t
|��}
|j|kr|}
d�	|	|
|j
|j
��}t||j
|||j||||��	�	dS)aiDocuments a collection's batch action

    :param section: The section to write to

    :param resource_name: The name of the resource

    :param action_name: The name of collection action. Currently only
        can be all, filter, limit, or page_size

    :param event_emitter: The event emitter to use to emit events

    :param batch_action_model: The model of the batch action

    :param collection_model: The model of the collection

    :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_prefix�
exclude_input�resource_action_modelrZN)
r_�request�	operationr
�paramsrXrrY�service_name�formatr!r�
documentation)rr<r=r>r@r?rZr_�
ignore_params�example_return_value�example_resource_nameras            r8rFrF}s���:$�3�3��"�,���O�/��"�)���M�&���"�L�)�*<�*E�*J�K�K��&�}�5�5���!�]�2�2� -��$�+�+�������	��N�*��&�+�'�#�*�8�%�#�0�+�
�
�
�
�
�
r:c
��|�|jj��}g}|jr|jj}t|��}	|j|kr|}	d|jj�d�d�	t|jj��|	|j
��|d�d|jj�d|jj�d�d�	t|jj��|	|j
��t|jj��d�d|jj�d�d	�	t|jj��|	|j
��td
dd�
��g|d�d|jj�d�d�	t|jj��|	|j
��td
dd�
��g|d�d�}
||
vr|
|}td||||||d�|��dSdS)a#Documents a collection method

    :param section: The section to write to

    :param resource_name: The name of the resource

    :param action_name: The name of collection action. Currently only
        can be all, filter, limit, or page_size

    :param event_emitter: The event emitter to use to emit events

    :param collection_model: The model of the collection

    :param service_model: The model of the service

    :param include_signature: Whether or not to include the signature.
        It is useful for generating docstrings.
    zCreates an iterable of all z resources in the collection.z{}_iterator = {}.{}.all)r`rarbzD resources in the collection filtered by kwargs passed to method. A z� collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.z{}_iterator = {}.{}.filterz0Creates an iterable up to a specified amount of z{}_iterator = {}.{}.limit�count�integerz5The limit to the number of resources in the iterable.)r!�	type_nameri)r`ra�
include_inputrbzs resources in the collection, but limits the number of items returned by each service call by the specified amount.z{}_iterator = {}.{}.page_sizez1The number of items returned by each service call)�all�filter�limit�	page_size)rr^r_r=rcrZNrR)r_rdre�input_shape�membersrrgrXrYrhr!r
rfrr)rr<rAr=r?r@rZr_�underlying_operation_membersrl�custom_action_info_dict�action_infos            r8rJrJ�s���6$�3�3�� �*���O�$&� ��"�K�'6�'B�'J�$�&�}�5�5���!�]�2�2� -��
0�.>�.G�.L�0�0�0�8�>�>��+�4�9�:�:�%� �%���
:�
�
�%�.>�.G�.L�%�%�-�6�;�%�%�%�;�A�A��+�4�9�:�:�%� �%���
8� �(�/���
�
�(Q�#�,�1�Q�Q�Q�:�@�@��+�4�9�:�:�%� �%��� � �'�+�	���	�:�)
�
�0P�.>�.G�.L�P�P�P�>�D�D��+�4�9�:�:�%� �%��� � �'�N�	����:�)
�
�kK�K��X�-�-�-�-�k�:��-�	
��#�+�'�"2�/�
	
�	
��	
�	
�	
�	
�	
�.�-r:)T)r*�botocorer�botocore.docs.bcdoc.restdocr�botocore.docs.methodr�botocore.docs.utilsr�boto3.docs.baser�boto3.docs.methodr�boto3.docs.utilsr	r
rrCrFrJrRr:r8�<module>r�s5��
�	�	�	�������9�9�9�9�9�9�<�<�<�<�<�<�/�/�/�/�/�/�,�,�,�,�,�,�C�C�C�C�C�C���������A�A�A�A�A�+�A�A�A�N�����H�;�;�;�;�J�}
�}
�}
�}
�}
�}
r: