File: //opt/alt/python37/lib/python3.7/site-packages/botocore/docs/__pycache__/client.cpython-37.pyc
B
�P�e�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 �E/opt/alt/python37/lib/python3.7/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 )N)r r �_filter_client_methods)r r) r r r r% < s
z$ClientDocumenter._get_client_methodsc C s< i }x2|� � D ]&\}}| j||| jd�}|r|||< qW |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* x$| j D ]}|f |�}|d k r|S qW dS )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)�style�h2)r r( r r r r# V s zClientDocumenter._add_titlec C s� |� d�}t| jjj�}|�d|� �� |j�� |�| jjjj � | �
|� |j� � |j� � |�
d� |j�� x(t|�D ] }|j�| j� d|� �� q�W d S )NZintroz A low-level client representing z These are the available methods:z/client/)�add_new_sectionr r r r �writer2 �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)r2 �start_sphinx_py_classr )r r( r r r r$ r s z%ClientDocumenter._add_class_signaturec C s6 |j �� |j �� |�dj| jd�� |j �� d S )Nz+client = session.create_client('{service}'))Zservice)r2 �start_codeblockr6 r5 �formatr �
end_codeblock)r r( r r r r9 w s
z-ClientDocumenter._add_client_creation_examplec C sT xNt |�D ]B}t|dd�}| �|||| � tj�| j| jd�}|�||� q
W d 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)
r4 r2 �refr r r5 �add_title_section�_is_custom_method�_add_custom_method�_add_model_driven_method)r r( r r, �breadcrumb_sectionZmethod_sectionr r r rG � s
z#ClientDocumenter._add_client_methodc C s || j jjkS )N)r r �method_to_api_mapping)r r r r r rQ � s z"ClientDocumenter._is_custom_methodc C s t |||� d S )N)r )r r( r r, r r r rR � s z#ClientDocumenter._add_custom_methodc C s` |� d�}|j�� |j�d� |j�� x0|jD ]&}| j� d|j� �}|j�d| � q2W d S )N�
exceptionsZ
Exceptionsz.Client.exceptions.z:py:class:`%s`)r4 r2 r6 �bold� error_shapesr �nameZli)r r( �operation_modelZ
error_section�errorr@ 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
rn| � ||� | j �|�}|r�t
||||� d S )Nzresponse = client.%srM � )�
event_emitterZmethod_description�example_prefix)r r r rU rZ rN �getr �eventsr8 rX r\ r r
) r r( r r �operation_namerZ r_ Zfull_method_namer! r r r rS � s$
z)ClientDocumenter._add_model_driven_method)N)r �
__module__� __qualname__r r0 r" r* r% r+ r. r# r& r$ r9 r' rG rQ rR r\ rS 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.)rY � type_namer8 �Messagez;A descriptive message explaining why the exception occured.)rY rh r8 �membersc C s* || _ | j jj| _| j jjj| _|| _d S )N) 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 )N)r# �
_add_overview�_add_exceptions_list�_add_exception_classes)r r( r r r �document_exceptions� s
z.ClientExceptionsDocumenter.document_exceptionsc C s |j �d� d S )NzClient Exceptions)r2 r3 )r r( 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�.)r2 r6 r5 �
external_link�_USER_GUIDE_LINK)r r( r r r rk s
z(ClientExceptionsDocumenter._add_overviewc C s | j � d|j� �S )Nz.Client.exceptions.)r rY )r �shaper r r �_exception_class_name s z0ClientExceptionsDocumenter._exception_class_namec C s| | j jjj}|s2|j�� |�d� |j�� d S |j�� |�d� |j�� x&|D ] }|j� | j
� d|j � �� qVW d S )Nz-This client has no modeled exception classes.z$The available client exceptions are:z/client/exceptions/) r r r rX r2 r6 r5 r< r= r? r rY )r r( rX rt r r r rl s
z/ClientExceptionsDocumenter._add_exceptions_listc C sX xR| j jjjD ]B}t|jdd�}| �||� tj� | j
| j dd�}|� ||j� qW d S )NrE )rF r rV )
r r r rX r rY �_add_exception_classrH rI rJ r r rK )r rt Zexception_doc_structureZexception_dir_pathr r r rm ( s z1ClientExceptionsDocumenter._add_exception_classesc C s� |� d�}|j�| jd| j� �� |�d|j� �� |�|j� |� |j�}| �|�}|jj |d� | �
||� | � ||� | � ||� |j�
� d S )NrL z ../../../z / Client / exceptions / )r@ )r4 r2 rO r r r5 rY rP ru rA � _add_top_level_documentation� _add_exception_catch_example�_add_response_attrZend_sphinx_py_class)r r( rt rT Z
class_sectionr@ r r r rv ; s
z/ClientExceptionsDocumenter._add_exception_classc C s* |j r&|j�� |�|j � |j�� d S )N)r8 r2 r6 r7 )r r( rt r r r rw J s
z7ClientExceptionsDocumenter._add_top_level_documentationc C s� |j �� |j �d� |j �� |j �� |�d� |j �� |j �� |�d� |j �� |j �� |�d|j � |j �� |j �� |�d� |j �� |j � � d S )NZExampleztry:z...z!except client.exceptions.%s as e:zprint(e.response))
r2 r6 rW r; rB r5 �indentr: rY rD )r r( rt r r r rx P s
z7ClientExceptionsDocumenter._add_exception_catch_examplec C sF |� d�}|j�d� | �|� | �||� | �||� |j�� d S )N�response)r4 r2 Zstart_sphinx_py_attr� _add_response_attr_description�_add_response_example�_add_response_paramsZend_sphinx_py_attr)r r( rt Zresponse_sectionr r r ry b 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.)r2 r6 r7 )r r( r r r r| j 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 rb r^ )r/ ) r4 r2 r6 rW r; r r r r ra Zdocument_example�_GENERIC_ERROR_SHAPE)r r( rt Zexample_section�
documenterr r r r} t s
z0ClientExceptionsDocumenter._add_response_examplec C sX |� d�}|j�� |j�d� |j�� t| jd | jjj d�}|j
||| j gd� d S )NZ Structure)r rb r^ )r/ ) r4 r2 r6 rW r; r r r r ra Zdocument_paramsr� )r r( rt Zparams_sectionr� r r r r~ � s
z/ClientExceptionsDocumenter._add_response_paramsN)r rc rd rs r r r� r" rn r# rk ru rl rm rv rw rx ry r| r} r~ r r r r re � s<
re 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 )N)r �_context_params)r r Zcontext_paramsr r r r" � s z&ClientContextParamsDocumenter.__init__c C s" | � |� | �|� | �|� d S )N)r# rk �_add_context_params_list)r r( r r r �document_context_params� s
z5ClientContextParamsDocumenter.document_context_paramsc C s |j �d� d S )NzClient Context Parameters)r2 r3 )r r( 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 guide)ro rp rq )r2 r6 r5 rr �_CONFIG_GUIDE_LINK)r r( r r r rk � s
z+ClientContextParamsDocumenter._add_overviewc C sz |j �� d| j� d�}|�d|� d�� xJ| jD ]@}|j �� dt|j�� d�}|�d|� d|j� d|j � �� q2W d S )Nz``zThe available z client context params are:z* z (z) - )
r2 r6 r r< r� r rY r5 �typer8 )r r( Zsn�paramrY r r r r� � s
z6ClientContextParamsDocumenter._add_context_params_listN)
r rc rd r� ZOMITTED_CONTEXT_PARAMSr" r� r# rk r� r r r r r� � s r� )rH 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 re r� r r r r �<module>
s 2 B