a ތxd<@sddlZddlmZddlmZddlmZddlmZddl m Z m Z m Z ddl mZddlmZdd lmZdd lmZmZmZmZdd lmZGd d d eZGdddeZdS)N) xform_name)DocumentStructure)get_official_service_name)ActionDocumenter)document_attributedocument_identifierdocument_reference)BaseDocumenter)CollectionDocumenter)SubResourceDocumenter)add_resource_type_overview!get_identifier_args_for_signatureget_identifier_description!get_identifier_values_for_example)WaiterResourceDocumentercseZdZfddZddZddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZddZddZdd ZZS)!ResourceDocumentercs:t|||_||_|j|_|j|jkr6d|_dS)Nzservice-resource)super__init___botocore_session_root_docs_path_resource_namelower_resource_sub_path _service_name)selfresourceZbotocore_sessionZroot_docs_path __class__K/var/www/html/Ranjet/env/lib/python3.9/site-packages/boto3/docs/resource.pyr&s    zResourceDocumenter.__init__cCsh||||||||||||||||||| |dS)N) _add_title_add_resource_note _add_intro_add_identifiers_add_attributes_add_references _add_actions_add_sub_resources_add_collections _add_waitersrsectionrrrdocument_resource.s         z$ResourceDocumenter.document_resourcecCs|d}|j|jdS)Ntitle)add_new_sectionstyleh2rrr+Z title_sectionrrrr :s zResourceDocumenter._add_titlec Csg}|jjr&|jjD]}||jqt|}|d}|jj|jd|dd|d}| ||d}| |||d}| |||d} | j dS) N start_class()) class_name descriptionZexampleparams end_class) Z_resource_model identifiersappendnamer r.r/Zstart_sphinx_py_classr5_add_description _add_example_add_params_descriptionZend_sphinx_py_class) rr+identifier_names identifierZ class_argsr2Zdescription_sectionZexample_sectionZ param_sectionr8rrrr">s"         zResourceDocumenter._add_introcCs"t|j}|d||jdS)Nz A resource representing an {} {})r_service_modelwriteformatrrr+Zofficial_service_namerrrr<[s  z#ResourceDocumenter._add_descriptioncCs|j|j|d|j|j|d|j|j|jt|}|dt|j|j|j||j dS)N import boto3z{} = boto3.resource('{}')z{} = {}.{}({})) r/start_codeblocknew_linerBrCrrrr end_codeblock)rr+r?Zexample_valuesrrrr=cs*      zResourceDocumenter._add_examplecCsV|D]L}t|j|}|d|d|j|d|d||jqdS)Nz:type z: stringz:param z: )rrrBr/rG)rr+r?Zidentifier_namer6rrrr>zs z*ResourceDocumenter._add_params_descriptioncCsR|j|d|d|j|j|j|D]}|j|q:dS)Nz#These are the resource's available :)r/rGrBZtoctree member_mapZtocitem)rr+Zresource_member_typememberrrr_add_overview_of_member_types    z/ResourceDocumenter._add_overview_of_member_typec Cs|jjjj}|d}g}|r8||jd<t|dddd|D]}||jt |jdd}|d}|j |j d | d |j||j|j|jd |jd id }t||j|dtj|j|j|j}|||jq<|r||ddS)Nr9Z IdentifierszYIdentifiers are properties of a resource that are set upon instantiation of the resource.identifiers_attributes_intror+Z resource_typer6Z intro_linkhtmltarget breadcrumbindexz / Identifier / qualifier.context)r+ resource_nameZidentifier_model) _resourcemetaresource_modelr9r.rJr r:r;rr/ref_resource_class_namerBadd_title_sectionr5rrospathjoinrrr write_to_filerL) rr+r9Z member_listr@Zidentifier_docbreadcrumb_sectionZidentifier_sectionZidentifiers_dir_pathrrrr#sF       z#ResourceDocumenter._add_identifiersc CsH|jjjjj}i}|jjjjr@||jjjj}|jjj|}|d}g}|rlt |dddd||j d<t |D]}||\}}| |t |dd} | d} | j|jd | d || || j|d |jd id } t| |j|j||jjjjj|dtj|j|j|j} | | |qt|rD||ddS)N attributes AttributeszAttributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.rMrNrOrPrRrSz / Attribute / rTrUrV)r+ service_namerX attr_nameZ event_emitterZ attr_model)rYrZclient service_modelr[shapeZ shape_forZget_attributesr.r rJsortedr:rr/r\r]rBr^r5rrreventsr_r`rarrrbrL) rr+rirdrjZattribute_listrg_Z attr_shapeZ attribute_docrcZattribute_sectionZattributes_dir_pathrrrr$s^             z"ResourceDocumenter._add_attributesc Cs|d}|jjjj}g}|rDt|dddd||jd<||d|D]}||j t |j dd}|d}|j |j d |d |j ||j |j|j d |jd id }t||dtj|j|j|j}|||j qH|r||ddS)N referencesZ ReferenceszNReferences are related resource instances that have a belongs-to relationship.Zreferences_introrNrOrPrRrSz / Reference / rTrUrV)r+Zreference_model)r.rYrZr[rnr rJrLr:r;rr/r\r]rBr^r5rr_r`rarrrrb) rr+rnZreference_list referenceZ reference_docrcZreference_sectionZreferences_dir_pathrrrr%sF       z"ResourceDocumenter._add_referencescCsJ|d}|jjjj}|rFt|j|j}|j|_||| |ddS)Nactions) r.rYrZr[rprrrJZdocument_actionsrL)rr+rp documenterrrrr&s   zResourceDocumenter._add_actionscCsJ|d}|jjjj}|rFt|j|j}|j|_||| |ddS)Nz sub-resources) r.rYrZr[Z subresourcesr rrJZdocument_sub_resourcesrL)rr+Z sub_resourcesrqrrrr''s   z%ResourceDocumenter._add_sub_resourcescCsJ|d}|jjjj}|rFt|j|j}|j|_||| |ddS)N collections) r.rYrZr[rrr rrJZdocument_collectionsrL)rr+rrrqrrrr(2s   z#ResourceDocumenter._add_collectionscCsZ|d}|jjjj}|rV|j|j}t|j||j }|j |_ | || |ddS)Nwaiters) r.rYrZr[rsrZget_waiter_modelrrrrJZdocument_resource_waitersrL)rr+rsZservice_waiter_modelrqrrrr)=s    zResourceDocumenter._add_waiterscCs,|d}|j|d|jdS)Nzfeature-freezezBefore 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_noterBZend_noter*rrrr!Ks   z%ResourceDocumenter._add_resource_note)__name__ __module__ __qualname__rr,r r"r<r=r>rLr#r$r%r&r'r(r)r! __classcell__rrrrr%s     ,9+   rc@s0eZdZeddZddZddZddZd S) ServiceResourceDocumentercCs |jdS)Nz.ServiceResource)Z_service_docs_name)rrrrr5Wsz$ServiceResourceDocumenter.class_namecCs|d}|jddS)Nr-zService Resource)r.r/r0r1rrrr [s z$ServiceResourceDocumenter._add_titlecCst|j}|d|dS)NzA resource representing )rrArBrDrrrr<_s z*ServiceResourceDocumenter._add_descriptioncCsZ|j|j|d|j|j||jd|jd|jdS)NrEz = boto3.resource('z'))r/rFrGrBrrH)rr+r?rrrr=cs     z&ServiceResourceDocumenter._add_exampleN)rtrurvpropertyr5r r<r=rrrrrxVs  rx)r_ZbotocorerZbotocore.docs.bcdoc.restdocrZbotocore.docs.utilsrZboto3.docs.actionrZboto3.docs.attrrrrZboto3.docs.baser Zboto3.docs.collectionr Zboto3.docs.subresourcer Zboto3.docs.utilsr r rrZboto3.docs.waiterrrrxrrrr s        3