File: //opt/cppython/lib/python3.8/site-packages/botocore/docs/__pycache__/client.cpython-38.pyc
U
KD�g�C � @ s� d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
m Z m Z d dl
mZ d dlmZ d d lmZmZ d
d � ZG d d
� d
�ZG dd� d�ZG dd� d�ZdS )� N)�
xform_name)� OrderedDict)�DocumentStructure)�ResponseExampleDocumenter)�document_custom_method� document_model_driven_method�get_instance_public_methods)�ResponseParamsDocumenter)�document_shared_examples)�DocumentedShape�get_official_service_namec K s | dkr d S |dkS )NZgenerate_presigned_url)�s3� )� method_name� service_name�kwargsr r �A/opt/cppython/lib/python3.8/site-packages/botocore/docs/client.py�!_allowlist_generate_presigned_url s r c @ s� e Zd ZegZd dd�Zdd� Zdd� Zdd � Zd
d � Z d d
� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd� Zdd� Zd d � Zd d � ZdS )!�ClientDocumenterNc C s@ || _ | j jj| _|| _|| _| jd kr.i | _| j jjj| _ d S �N)
�_client� __class__�__name__�_client_class_name�_root_docs_path�_shared_examples�meta�
service_modelr �
_service_name)�self�client�root_docs_path�shared_examplesr r r �__init__( s
zClientDocumenter.__init__c C s6 | � |� | �|� | �� }| �||� | �|� dS )z]Documents a client and its methods
:param section: The section to write to.
N)�
_add_title�_add_class_signature�_get_client_methods�_add_client_intro�_add_client_methods)r �section�client_methodsr r r �document_client1 s
z ClientDocumenter.document_clientc C s t | j�}| �|�S r )r r �_filter_client_methods)r r* r r r r& < s
z$ClientDocumenter._get_client_methodsc C s8 i }|� � D ]&\}}| j||| jd�}|r |||< q |S )N)�methodr r )�items�_filter_client_methodr )r r* Zfiltered_methodsr r- �includer r r r, @ s �
z'ClientDocumenter._filter_client_methodsc K s* | j D ] }|f |�}|d k r| S qdS )NT)�_CLIENT_METHODS_FILTERS)r r �filterZfilter_includer r r r/ L s
z&ClientDocumenter._filter_client_methodc C s |j �d� d S )NZClient��styleZh2�r r) r r r r$ V s zClientDocumenter._add_titlec C s� |� d�}t| jjj�}|�d|� �� |j�� |�| jjjj � | �
|� |j� � |j� � |�
d� |j�� t|�D ] }|j�| j� d|� �� q~d S )NZintroz A low-level client representing z These are the available methods:z/client/)�add_new_sectionr r r r �writer4 �new_line�include_doc_string�
documentation� _add_client_creation_example�dedent�
new_paragraph�writeln�toctree�sorted�tocitemr )r r) r* Zofficial_service_namer r r r r' Y s$
��
�
z"ClientDocumenter._add_client_introc C s |j j| j� d�d� d S )Nz.Client��
class_name)r4 �start_sphinx_py_classr r5 r r r r% r s
�z%ClientDocumenter._add_class_signaturec C s6 |j �� |j �� |�d| j� d�� |j �� d S )Nz client = session.create_client('z'))r4 �start_codeblockr8 r7 r �
end_codeblockr5 r r r r; w s
�z-ClientDocumenter._add_client_creation_examplec C sP t |�D ]B}t|dd�}| �|||| � tj�| j| jd�}|�||� qd S )N�html��targetr ) r@ r �_add_client_method�os�path�joinr r �
write_to_file)r r* r Zmethod_doc_structureZclient_dir_pathr r r r( s � � �z$ClientDocumenter._add_client_methodsc C s� |� d�}|j�| jd| j� �� |�d|� �� |�|� |j |d| j� d�id�}| �|�rp| �|||� n | � ||� d S )N�
breadcrumbz../../z / Client / � qualifierz.Client.)�context)
r6 r4 �refr r r7 �add_title_section�_is_custom_method�_add_custom_method�_add_model_driven_method)r r) r r- �breadcrumb_sectionZmethod_sectionr r r rJ � s$
�
�
�z#ClientDocumenter._add_client_methodc C s || j jjkS r )r r �method_to_api_mapping)r r r r r rT � s z"ClientDocumenter._is_custom_methodc C s t |||� d S r )r )r r) r r- r r r rU � s z#ClientDocumenter._add_custom_methodc C s` |� d�}|j�� |j�d� |j�� |jD ]*}| j� d|j� �}|j�d|� d�� q0d S )N�
exceptionsZ
Exceptions�.Client.exceptions.z :py:class:`�`)r6 r4 r8 �bold� error_shapesr �nameZli)r r) �operation_modelZ
error_section�errorrC r r r �_add_method_exceptions_list� s
�z,ClientDocumenter._add_method_exceptions_listc C s� | j jj}| j jj| }|�|�}d|� �}|j�dd�� |� �}t|||| j jj|j |d� |j
rp| � ||� | j �|�}|r�t
||||� d S )Nzresponse = client.rP � )�
event_emitterZmethod_description�example_prefix)r r r rX r_ rQ �getr �eventsr: r] ra r r
) r r) r r �operation_namer_ rd Zfull_method_namer" r r r rV � s0
��
�z)ClientDocumenter._add_model_driven_method)N)r �
__module__� __qualname__r r1 r# r+ r& r, r/ r$ r' r% r; r( rJ rT rU ra rV r r r r r # s" �
r c @ s� e Zd ZdZedddededddd�fd ed dd
d�fg�d �Zd d
� Zdd� Zdd� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(S ))�ClientExceptionsDocumenterzQhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/error-handling.html�ErrorZ structurez1Normalized access to common exception attributes.ZCode�stringz,An identifier specifying the exception type.)r^ � type_namer: �Messagez;A descriptive message explaining why the exception occured.)r^ rm r: �membersc C s* || _ | j jj| _| j jjj| _|| _d S r ) r r r r r r r r r )r r r! r r r r# � s z#ClientExceptionsDocumenter.__init__c C s* | � |� | �|� | �|� | �� d S r )r$ �
_add_overview�_add_exceptions_list�_add_exception_classesr5 r r r �document_exceptions� s
z.ClientExceptionsDocumenter.document_exceptionsc C s |j �d� d S )NzClient Exceptionsr3 r5 r r r r$ s z%ClientExceptionsDocumenter._add_titlec C s> |j �� |�d� |j jd| jd� |�d� |j �� d S )Nz�Client exceptions are available on a client instance via the ``exceptions`` property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling z
user guide��title�link�.)r4 r8 r7 �
external_link�_USER_GUIDE_LINKr5 r r r rp s
��
z(ClientExceptionsDocumenter._add_overviewc C s | j � d|j� �S )NrZ )r r^ )r �shaper r r �_exception_class_name s z0ClientExceptionsDocumenter._exception_class_namec C sx | j jjj}|s2|j�� |�d� |j�� d S |j�� |�d� |j�� |D ] }|j� | j
� d|j � �� qTd S )Nz-This client has no modeled exception classes.z$The available client exceptions are:z/client/exceptions/) r r r r] r4 r8 r7 r> r? rA r r^ )r r) r] rz r r r rq s
�z/ClientExceptionsDocumenter._add_exceptions_listc C sT | j jjjD ]B}t|jdd�}| �||� tj� | j
| j dd�}|� ||j� q d S )NrG rH r rY )
r r r r] r r^ �_add_exception_classrK rL rM r r rN )r rz Zexception_doc_structureZexception_dir_pathr r r rr & s � � �z1ClientExceptionsDocumenter._add_exception_classesc C s� |� d�}|j�| jd| j� �� |�d|j� �� |�|j� |� |j�}| �|�}|jj |d� | �
||� | � ||� | � ||� |j�
� d S )NrO z ../../../z / Client / exceptions / rB )r6 r4 rR r r r7 r^ rS r{ rD � _add_top_level_documentation� _add_exception_catch_example�_add_response_attrZend_sphinx_py_class)r r) rz rW Z
class_sectionrC r r r r| 9 s
�
z/ClientExceptionsDocumenter._add_exception_classc C s* |j r&|j�� |�|j � |j�� d S r )r: r4 r8 r9 �r r) rz r r r r} H s
z7ClientExceptionsDocumenter._add_top_level_documentationc C s� |j �� |j �d� |j �� |j �� |�d� |j �� |j �� |�d� |j �� |j �� |�d|j� d�� |j �� |j �� |�d� |j �� |j � � d S )NZExampleztry:z...zexcept client.exceptions.z as e:zprint(e.response))
r4 r8 r\ r= rE r7 �indentr< r^ rF r� r r r r~ N s
z7ClientExceptionsDocumenter._add_exception_catch_examplec C sF |� d�}|j�d� | �|� | �||� | �||� |j�� d S )N�response)r6 r4 Zstart_sphinx_py_attr� _add_response_attr_description�_add_response_example�_add_response_paramsZend_sphinx_py_attr)r r) rz Zresponse_sectionr r r r ` s
z-ClientExceptionsDocumenter._add_response_attrc C s" |j �� |�d� |j �� d S )Nz�The parsed error response. All exceptions have a top level ``Error`` key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.)r4 r8 r9 r5 r r r r� h s
�z9ClientExceptionsDocumenter._add_response_attr_descriptionc C sX |� d�}|j�� |j�d� |j�� t| jd | jjj d�}|j
||| j gd� d S )N�syntax�Syntax�r rg rc �r0 ) r6 r4 r8 r\ r= r r r r rf Zdocument_example�_GENERIC_ERROR_SHAPE)r r) rz Zexample_section�
documenterr r r r� r s
��z0ClientExceptionsDocumenter._add_response_examplec C sX |� d�}|j�� |j�d� |j�� t| jd | jjj d�}|j
||| j gd� d S )NZ Structurer� r� ) r6 r4 r8 r\ r= r r r r rf Zdocument_paramsr� )r r) rz Zparams_sectionr� r r r r� � s
��z/ClientExceptionsDocumenter._add_response_paramsN)r rh ri ry r r r� r# rs r$ rp r{ rq rr r| r} r~ r r� r� r� r r r r rj � sL ��� �����
rj c @ sB e Zd ZdZddd�Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dS )� ClientContextParamsDocumenterzPhttps://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html)Z
AccelerateZ DisableMultiRegionAccessPointsZForcePathStyle� UseArnRegion)r� )r
Z s3controlc C s || _ || _d S r )r �_context_params)r r Zcontext_paramsr r r r# � s z&ClientContextParamsDocumenter.__init__c C s" | � |� | �|� | �|� d S r )r$ rp �_add_context_params_listr5 r r r �document_context_params� s
z5ClientContextParamsDocumenter.document_context_paramsc C s |j �d� d S )NzClient Context Parametersr3 r5 r r r r$ � s z(ClientContextParamsDocumenter._add_titlec C s> |j �� |�d� |j jd| jd� |�d� |j �� d S )Nz�Client context parameters are configurable on a client instance via the ``client_context_params`` parameter in the ``Config`` object. For more detailed instructions and examples on the exact usage of context params see the zconfiguration guidert rw )r4 r8 r7 rx �_CONFIG_GUIDE_LINKr5 r r r rp � s
��
z+ClientContextParamsDocumenter._add_overviewc C sv |j �� d| j� d�}|�d|� d�� | jD ]@}|j �� dt|j�� d�}|�d|� d|j� d|j � �� q0d S )Nz``zThe available z client context params are:z* z (z) - )
r4 r8 r r> r� r r^ r7 �typer: )r r) Zsn�paramr^ r r r r� � s
z6ClientContextParamsDocumenter._add_context_params_listN)
r rh ri r� ZOMITTED_CONTEXT_PARAMSr# r� r$ rp r� r r r r r� � s ��
r� )rK Zbotocorer Zbotocore.compatr Zbotocore.docs.bcdoc.restdocr Zbotocore.docs.exampler Zbotocore.docs.methodr r r Zbotocore.docs.paramsr Zbotocore.docs.sharedexampler
Zbotocore.docs.utilsr r r r rj r� r r r r �<module>
s 0 B