File: //proc/self/root/lib/python3.6/site-packages/botocore/docs/__pycache__/client.cpython-36.pyc
3
�T_[- � @ s� d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
d dl m Z d d lm
Z
d d
lmZ G d d � d e�ZG d
d� de�ZdS )� N)�get_official_service_name)�document_custom_method)� document_model_driven_method)�get_instance_public_methods)�document_shared_examples)�ResponseExampleDocumenter)�ResponseParamsDocumenter)�DocumentedShape)� OrderedDictc @ sn e Zd Zddd�Zdd� Zdd� Zdd � Zd
d � Zd d
� Zdd� Z dd� Z
dd� Z dd� Z dd� Z
dd� ZdS )�ClientDocumenterNc C s. || _ || _| jd kr i | _| j jjj| _d S )N)�_client�_shared_examples�meta�
service_model� service_name�
_service_name)�self�client�shared_examples� r � /usr/lib/python3.6/client.py�__init__ s
zClientDocumenter.__init__c C s: | j |� | j|� t| j�}| j||� | j||� dS )z]Documents a client and its methods
:param section: The section to write to.
N)�
_add_title�_add_class_signaturer r �_add_client_intro�_add_client_methods)r �section�client_methodsr r r �document_client" s
z ClientDocumenter.document_clientc C s |j jd� d S )NZClient)�style�h2)r r r r r r - s zClientDocumenter._add_titlec C s� |j d�}t| jjj�}|jd| � | j|� |jj� |jd� |jj� | jj j
}x$t |�D ]}|jj d||f � qbW d S )NZintroz"A low-level client representing %sz These are the available methods:z:py:meth:`~%s.Client.%s`)
�add_new_sectionr r r r �write� _add_client_creation_exampler �new_line� __class__�__name__�sorted�li)r r r Zofficial_service_name�
class_name� method_namer r r r 0 s
z"ClientDocumenter._add_client_introc C s |j jd| jjj d� d S )Nz %s.Client)r) )r �start_sphinx_py_classr r% r& )r r r r r r D s z%ClientDocumenter._add_class_signaturec C s6 |j j� |j j� |jdj| jd�� |j j� d S )Nz+client = session.create_client('{service}'))Zservice)r �start_codeblockr$ r" �formatr �
end_codeblock)r r r r r r# H s
z-ClientDocumenter._add_client_creation_examplec C s2 |j d�}x"t|�D ]}| j|||| � qW d S )N�methods)r! r' �_add_client_method)r r r r* r r r r Q s
z$ClientDocumenter._add_client_methodsc C s4 |j |�}| j|�r$| j|||� n | j||� d S )N)r! �_is_custom_method�_add_custom_method�_add_model_driven_method)r r r* �methodr r r r0 W s
z#ClientDocumenter._add_client_methodc C s || j jjkS )N)r r �method_to_api_mapping)r r* r r r r1 ^ s z"ClientDocumenter._is_custom_methodc C s t |||� d S )N)r )r r r* r4 r r r r2 a s z#ClientDocumenter._add_custom_methodc C sf |j d�}|jj� |jjd� |jj� | jjj}x,|jD ]"}d||jf }|jj d| � q<W d S )N�
exceptionsZ
Exceptionsz%s.Client.exceptions.%sz:py:class:`%s`)
r! r r$ �boldr r% r& � error_shapes�namer( )r r �operation_modelZ
error_sectionZ client_name�errorr) r r r �_add_method_exceptions_listd s
z,ClientDocumenter._add_method_exceptions_listc C sz | j jj}| j jj| }|j|�}d| }t|||| j jj|j|d� |jrX| j ||� | j
j |�}|rvt ||||� d S )Nzresponse = client.%s)�
event_emitterZmethod_description�example_prefix)
r r r r5 r: r �events�
documentationr8 r< r
�getr )r r r* r �operation_namer: r> r r r r r3 n s
z)ClientDocumenter._add_model_driven_method)N)r& �
__module__� __qualname__r r r r r r# r r0 r1 r2 r< r3 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.)r9 � type_namer@ ZMessagez;A descriptive message explaining why the exception occured.)r9 rH r@ �membersc C s || _ | j jjj| _d S )N)r r r r r )r r r r r r � s z#ClientExceptionsDocumenter.__init__c C s, | j |� | j|� | j|� | j|� 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 jd� d S )NzClient Exceptions)r r )r r r r r r � s z%ClientExceptionsDocumenter._add_titlec C s> |j j� |jd� |j jd| jd� |jd� |j 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�.)r r$ r" Z
external_link�_USER_GUIDE_LINK)r r r r r rJ � s
z(ClientExceptionsDocumenter._add_overviewc C s | j jj}d||jf S )Nz%s.Client.exceptions.%s)r r% r& r9 )r �shapeZcls_namer r r �_exception_class_name� s
z0ClientExceptionsDocumenter._exception_class_namec C s| | j jjj}|s2|jj� |jd� |jj� d S |jj� |jd� |jj� x&|D ] }| j|�}|jjd| � qVW d S )Nz-This client has no modeled exception classes.z$The available client exceptions are:z:py:class:`%s`) r r r r8 r r$ r" rS r( )r r r8 rR r) r r r rK � s
z/ClientExceptionsDocumenter._add_exceptions_listc C s& x | j jjjD ]}| j||� qW d S )N)r r r r8 �_add_exception_class)r r rR r r r rL � s z1ClientExceptionsDocumenter._add_exception_classesc C sV |j |j�}| j|�}|jj|d� | j||� | j||� | j||� |jj� d S )N)r) ) r! r9 rS r r+ � _add_top_level_documentation� _add_exception_catch_example�_add_response_attrZend_sphinx_py_class)r r rR Z
class_sectionr) r r r rT � s
z/ClientExceptionsDocumenter._add_exception_classc C s* |j r&|jj� |j|j � |jj� d S )N)r@ r r$ �include_doc_string)r r rR r r r rU � s
z7ClientExceptionsDocumenter._add_top_level_documentationc C s� |j j� |j jd� |j j� |jd� |j j� |j j� |jd� |j j� |j j� |jd|j � |j j� |j j� |jd� |j j� |j j� d S )NZExampleztry:z...z!except client.exceptions.%s as e:zprint(e.response)) r r$ r7 r, r" �indent�dedentr9 r. )r r rR r r r rV � s
z7ClientExceptionsDocumenter._add_exception_catch_examplec C sF |j d�}|jjd� | j|� | j||� | j||� |jj� d S )NZresponse)r! r Zstart_sphinx_py_attr� _add_response_attr_description�_add_response_example�_add_response_paramsZend_sphinx_py_attr)r r rR Zresponse_sectionr r r rW � s
z-ClientExceptionsDocumenter._add_response_attrc C s" |j j� |jd� |j 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.)r r$ rX )r r r r r r[ � s
z9ClientExceptionsDocumenter._add_response_attr_descriptionc C sX |j d�}|jj� |jjd� |jj� t| jd | jjj d�}|j
||| j gd� d S )NZsyntaxZSyntax)r rB r= )�include) r! r r$ r7 �
new_paragraphr r r r r? Zdocument_example�_GENERIC_ERROR_SHAPE)r r rR Zexample_section�
documenterr r r r\ s
z0ClientExceptionsDocumenter._add_response_examplec C sX |j d�}|jj� |jjd� |jj� t| jd | jjj d�}|j
||| j gd� d S )NZ Structure)r rB r= )r^ ) r! r r$ r7 r_ r r r r r? Zdocument_paramsr` )r r rR Zparams_sectionra r r r r] s
z/ClientExceptionsDocumenter._add_response_paramsN)r& rC rD rQ r r
r` r rM r rJ rS rK rL rT rU rV rW r[ r\ r] r r r r rE � s8
rE )�inspectZbotocore.docs.utilsr Zbotocore.docs.methodr r r Zbotocore.docs.sharedexampler Zbotocore.docs.exampler Zbotocore.docs.paramsr r Zbotocore.compatr
�objectr rE r r r r �<module>
s l