
    vKg>,                         S SK r S SKJr  S SKJr  S SKJr  S SKJr  S SK	J
r
  S SKJr  S SKJrJr   " S	 S
\
5      r SS jr SS jr SS jrg)    N)
xform_name)DocumentStructure)get_instance_public_methods)DocumentedShape)NestedDocumenter)%document_model_driven_resource_method)add_resource_type_overviewget_resource_ignore_paramsc                        \ rS rSrS rS rSrg)CollectionDocumenter   c                    U R                   R                  R                  R                  n/ n[	        USSSS9  X0R
                  S'   U GH9  nUR                  UR                  5        [        UR                  SS9nUR                  S5      nUR                  R                  U R                  S	5        UR                  S
UR                   35        UR                  UR                  5        UR                  UR                  SU R                   S30S9nU R!                  Xt5        ["        R$                  R'                  U R(                  U R*                   U R,                   5      nUR/                  XR                  5        GM<     g )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_modelr   r	   
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)	selfr   r   collections_list
collectioncollection_docbreadcrumb_sectioncollection_sectioncollections_dir_paths	            U/var/www/highfloat_scraper/venv/lib/python3.13/site-packages/boto3/docs/collection.pydocument_collections)CollectionDocumenter.document_collections   s]   nn))88DD"'3 +	
 *:&%J##JOO4.zvNN!/!?!?!M$$(()B)BGL$$'7
7H%IJ,,Z__=!/!?!?$(9&;< "@ " %%&8E $&77<<$$%%&**+$ 
 (()=O+ &    c           
         [        [        U R                  UR                  5      5      n[	        X5        0 nUR
                   H  nXTUR                  '   M     [        U5       GH  nUR                  U5      nXd;   a  [        UU R                  U R                  R                  R                  R                  R                  XF   UU R                  R                  R                  R                  R                  S9  M  [        UU R                  UU R                  R                  R                  R                  R                  UU R                  R                  R                  R                  R                  S9  GM     g )N)r   resource_nameevent_emitterbatch_action_modelcollection_modelservice_model)r   r>   action_namer?   rA   rB   )r   getattrr   r"   document_collection_objectbatch_actionssortedr#   document_batch_action_resource_namer   clienteventsrB   document_collection_method)r2   r   r4   methodsrF   batch_actionmethodmethod_sections           r9   r*   )CollectionDocumenter._document_collectionA   s&   -DNNJOO4
 	#77&44L/;,++, 5 WoF$44V<N&%*"&"5"5"&.."5"5"<"<"A"A"H"H'4'<%/"&.."5"5"<"<"A"A"O"O +*"&"5"5 &"&.."5"5"<"<"A"A"H"H%/"&.."5"5"<"<"A"A"O"O &r<    N)__name__
__module____qualname____firstlineno__r:   r*   __static_attributes__rR   r<   r9   r   r      s    "PHr<   r   c                 @   U(       aE  U R                   R                  SS5       UR                   3nU R                  R	                  U5        U R                  SUR                  R                   S35        U R                  SUR                  R                   S35        g)zDocuments 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    zA collection of z resources.zA 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)r   rA   include_signaturefull_collection_names       r9   rE   rE   `   s     "";345E5J5J4KL 	 	**+?@
+4499:+F 
&&++, -/ 	0r<   c                    UR                  UR                  R                  5      n[        UR                  R                  5      nSn	UR
                  (       a  [        UR
                  R                  5      n	[        U5      n
UR                  U:X  a  Un
U	 SU
 SUR                   SUR                   3n[        U UR                  UUUR                  UUUUS9	  g)a=  Documents 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   )	r   method_nameoperation_modelr?   method_descriptionexample_prefixexclude_inputresource_action_modelr_   N)rd   request	operationr
   paramsr]   r   r^   service_namer"   r   documentation)r   r>   r?   r@   rB   rA   r_   rd   ignore_paramsexample_return_valueexample_resource_namerf   s               r9   rH   rH   }   s    : $33"",,O /""))M &"")*<*E*E*J*JK&}5!!]2 -,-S1F0GqIYI^I^H__`asaxax`yzN)&++'#*88%#0+
r<   c                    UR                  UR                  R                  5      n/ nUR                  (       a  UR                  R                  n[        U5      n	UR                  U:X  a  Un	SUR                  R                   S3[        UR                  R                  5       SU	 SUR                   S3US.SUR                  R                   SUR                  R                   S3[        UR                  R                  5       SU	 SUR                   S	3[        UR                  R                  5      S.S
UR                  R                   S3[        UR                  R                  5       SU	 SUR                   S3[        SSSS9/US.SUR                  R                   S3[        UR                  R                  5       SU	 SUR                   S3[        SSSS9/US.S.n
X*;   a  X   n[        SU UUUUUS.UD6  gg)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.
zCreates an iterable of all z resources in the collection.z_iterator = r   z.all)re   rf   rg   zD 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.filterz0Creates an iterable up to a specified amount of z.limitcountintegerz5The limit to the number of resources in the iterable.)r"   	type_namerm   )re   rf   include_inputrg   zs resources in the collection, but limits the number of items returned by each service call by the specified amount.z
.page_sizez1The number of items returned by each service call)allfilterlimit	page_size)r   rc   rd   r?   rh   r_   NrR   )rd   ri   rj   input_shapemembersr   rl   r]   r^   r"   r
   rk   r   r   )r   r>   rC   r?   rA   rB   r_   rd   underlying_operation_membersrp   custom_action_info_dictaction_infos               r9   rL   rL      s   6 $33  **O $& ""'6'B'B'J'J$&}5!!]2 -
 ..>.G.G.L.L-M N/ 0 ",,<,E,E,J,J!K LLYnXoop  rB  rG  rG  qH  HL  M9
 ..>.G.G.L.L-M N-66;;< =$% ",,<,E,E,J,J!K LLYnXoop  rB  rG  rG  qH  HO  P7 ((//
  C#,,1122OQ ",,<,E,E,J,J!K LLYnXoop  rB  rG  rG  qH  HN  O '+		 :!
( ..>.G.G.L.L-M NO P ",,<,E,E,J,J!K LLYnXoop  rB  rG  rG  qH  HR  S 'N	 :!
S;x --:- 	
#+'"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   rE   rH   rL   rR   r<   r9   <module>r      sR    
  9 < / , CA+ AN H 6@ m
r<   