U EZh>,@sddlZddlmZddlmZddlmZddlmZddl m Z ddl m Z ddl mZmZGd d d e Zdd d ZdddZdddZdS)N) xform_name)DocumentStructure)get_instance_public_methods)DocumentedShape)NestedDocumenter)%document_model_driven_resource_method)add_resource_type_overviewget_resource_ignore_paramsc@seZdZddZddZdS)CollectionDocumenterc Cs|jjjj}g}t|dddd||jd<|D]}||jt|jdd}| d}|j |j d | d |j||j|j |jd |jd id }|||tj|j|j|j}|||jq.dS)NZ CollectionszUCollections provide an interface to iterate over and manipulate groups of resources. Zguide_collections)sectionZ resource_type descriptionZ intro_link collectionshtml)targetZ breadcrumbindexz / Collection / qualifier.)context) _resourcemetaZresource_modelr r member_mapappendnameradd_new_sectionstylerefZ_resource_class_namewriteZadd_title_section class_name_document_collectionospathjoinZ_root_docs_pathZ _service_nameZ_resource_sub_pathZ write_to_file) selfr r Zcollections_list collectionZcollection_docZbreadcrumb_sectionZcollection_sectionZcollections_dir_pathr$\/home/aprabhat/apps/x.techxrdev.in/venv/lib/python3.8/site-packages/boto3/docs/collection.pydocument_collectionss6      z)CollectionDocumenter.document_collectionsc Cstt|j|j}t||i}|jD]}|||j<q&t|D]p}||}||krt||j |jj j j j ||||jj j j j dq>t||j ||jj j j j ||jj j j j dq>dS)N)r resource_name event_emitterbatch_action_modelcollection_model service_model)r r' action_namer(r*r+)rgetattrrrdocument_collection_object batch_actionssortedrdocument_batch_actionZ_resource_namerclienteventsr+document_collection_method)r"r r#methodsr/Z batch_actionmethodZmethod_sectionr$r$r%rAs4           z)CollectionDocumenter._document_collectionN)__name__ __module__ __qualname__r&rr$r$r$r%r s$r TcCsX|r(|jdd|j}|j||d|jjd|d|jjddS)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. rzA 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)rgetrrZstart_sphinx_py_attrZinclude_doc_stringresourcetype)r r*include_signatureZfull_collection_namer$r$r%r.`s r.c Cs||jj}t|jj}d} |jr0t|jj} t|} |j|krF|} | d| d|j d|j } t ||j |||j | |||d 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) r method_nameoperation_modelr(method_descriptionexample_prefix exclude_inputresource_action_modelr>N) rArequest operationr paramsr<rr= service_namerr documentation) r r'r(r)r+r*r>rAZ ignore_paramsZexample_return_valueexample_resource_namerCr$r$r%r1}s0  r1c Csd||jj}g}|jr |jj}t|} |j|kr6|} d|jjdt|jjd| d|j d|dd|jjd|jjdt|jjd| d|j d t |jj dd |jjdt|jjd| d|j d t d d ddg|dd|jjdt|jjd| d|j dt d d ddg|dd} || kr`| |} t f||||||d| dS)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 = rz.all)rBrCrDzD 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.limitcountintegerz5The limit to the number of resources in the iterable.)r type_namerJ)rBrCZ include_inputrDzs 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)allfilterlimitZ page_size)r r@rAr(rEr>N)rArFrGZ input_shapemembersrrIr<r=rr rHrr) r r'r,r(r*r+r>rAZunderlying_operation_membersrKZcustom_action_info_dictZ action_infor$r$r%r4sh    < r4)T)T)T)rZbotocorerZbotocore.docs.bcdoc.restdocrZbotocore.docs.methodrZbotocore.docs.utilsrZboto3.docs.baserZboto3.docs.methodrZboto3.docs.utilsrr r r.r1r4r$r$r$r% s      G $ @