File: //lib/python3.6/site-packages/botocore/__pycache__/model.cpython-36.pyc
3
�T_�n � @ sR d Z ddlmZ ddlmZmZmZ ddlmZ ddl m
Z
ddl m Z e � Z
G dd� de�ZG d d
� d
e�ZG d d � d e�ZG d
d� de�ZG dd� de�ZG dd� de �ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd � d e �ZG d d � d e �ZG d d � d e �Z G d!d"� d"e �Z G d#d$� d$e �Z G d%d&� d&e �Z d'S )(z-Abstractions to interact with service models.� )� defaultdict)�CachedProperty�instance_cache�hyphenize_service_id)� OrderedDict)�MissingServiceIdError)� UndefinedModelAttributeErrorc @ s e Zd ZdS )�NoShapeFoundErrorN)�__name__�
__module__� __qualname__� r
r
�/usr/lib/python3.6/model.pyr s r c @ s e Zd ZdS )�InvalidShapeErrorN)r
r r r
r
r
r r s r c @ s e Zd ZdS )�OperationNotFoundErrorN)r
r r r
r
r
r r s r c @ s e Zd ZdS )�InvalidShapeReferenceErrorN)r
r r r
r
r
r r $ s r c @ s e Zd Zdd� ZdS )� ServiceIdc C s t | �S )N)r )�selfr
r
r � hyphenize) s zServiceId.hyphenizeN)r
r r r r
r
r
r r ( s r c @ s� e Zd ZdZdddddddd d
d d d
dddddgZddddddddddg
ZeZd+d d �Ze d d � �Z
e d!d"� �Z e d#d$� �Z d%d&� Z
d'd(� Zed)d*� �Zd S ),�Shapez3Object representing a shape from the service model.� locationNameZ queryNameZ flattened�location�payloadZ streamingZtimestampFormatZ xmlNamespaceZ
resultWrapperZ xmlAttribute� eventstreamZeventZ eventheaderZ eventpayloadZ jsonvalueZ hostLabel�required�min�maxZ sensitive�enum�idempotencyToken�error� exceptionZendpointdiscoveryidZ retryableNc C sB || _ |d | _|jdd�| _|| _|dkr2t� }|| _i | _dS )a
:type shape_name: string
:param shape_name: The name of the shape.
:type shape_model: dict
:param shape_model: The shape model. This would be the value
associated with the key in the "shapes" dict of the
service model (i.e ``model['shapes'][shape_name]``)
:type shape_resolver: botocore.model.ShapeResolver
:param shape_resolver: A shape resolver object. This is used to
resolve references to other shapes. For scalar shape types
(string, integer, boolean, etc.), this argument is not
required. If a shape_resolver is not provided for a complex
type, then a ``ValueError`` will be raised when an attempt
to resolve a shape is made.
�type�
documentation� N)�name� type_name�getr" � _shape_model�UnresolvableShapeMap�_shape_resolver�_cache)r �
shape_name� shape_model�shape_resolverr
r
r �__init__= s
zShape.__init__c C sJ | j }i }x$| jD ]}|| j kr|| ||< qW d|krF|jd�|d< |S )a Serialization information about the shape.
This contains information that may be needed for input serialization
or response parsing. This can include:
* name
* queryName
* flattened
* location
* payload
* streaming
* xmlNamespace
* resultWrapper
* xmlAttribute
* jsonvalue
* timestampFormat
:rtype: dict
:return: Serialization information about the shape.
r r$ )r' �SERIALIZED_ATTRS�pop)r �model�
serialization�attrr
r
r r2 _ s
zShape.serializationc C s4 | j }i }x$| jD ]}|| j kr|| ||< qW |S )a2 Metadata about the shape.
This requires optional information about the shape, including:
* min
* max
* enum
* sensitive
* required
* idempotencyToken
:rtype: dict
:return: Metadata about the shape.
)r' �METADATA_ATTRS)r r1 �metadatar3 r
r
r r5 � s
zShape.metadatac C s | j jdg �S )z�A list of members that are required.
A structure shape can define members that are required.
This value will return a list of required members. If there
are no required members an empty list is returned.
r )r5 r& )r r
r
r �required_members� s zShape.required_membersc C s | j j|�S )N)r) �resolve_shape_ref)r � shape_refr
r
r �_resolve_shape_ref� s zShape._resolve_shape_refc C s d| j j| jf S )Nz<%s(%s)>)� __class__r
r$ )r r
r
r �__repr__� s zShape.__repr__c C s d S )Nr
)r r
r
r �event_stream_name� s zShape.event_stream_name)N)r
r r �__doc__r/ r4 r �MAP_TYPEr. r r2 r5 r6 r9 r; �propertyr< r
r
r
r r - s"
" ! r c @ s0 e Zd Zedd� �Zedd� �Zedd� �ZdS )�StructureShapec C s: | j d }| j� }x"|j� D ]\}}| j|�||< q W |S )N�members)r' r> �itemsr9 )r rA Z
shape_membersr$ r8 r
r
r rA � s
zStructureShape.membersc C s, x&| j j� D ]\}}|jjd�r |S q W d S )Nr )rA rB r2 r& )r � member_name�memberr
r
r r< � s z StructureShape.event_stream_namec C s8 | j jdd�sd S | j jdi �}|jd�}|r2|S | jS )Nr Fr �code)r5 r& r$ )r Zerror_metadatarE r
r
r �
error_code� s
zStructureShape.error_codeN)r
r r r rA r< rF r
r
r
r r@ � s r@ c @ s e Zd Zedd� �ZdS )� ListShapec C s | j | jd �S )NrD )r9 r' )r r
r
r rD � s zListShape.memberN)r
r r r rD r
r
r
r rG � s rG c @ s$ e Zd Zedd� �Zedd� �ZdS )�MapShapec C s | j | jd �S )N�key)r9 r' )r r
r
r rI � s z MapShape.keyc C s | j | jd �S )N�value)r9 r' )r r
r
r rJ � s zMapShape.valueN)r
r r r rI rJ r
r
r
r rH � s rH c @ s e Zd Zedd� �ZdS )� StringShapec C s | j jdg �S )Nr )r5 r& )r r
r
r r � s zStringShape.enumN)r
r r r r r
r
r
r rK � s rK c @ s e Zd ZdZd.dd�Zd/dd�Zdd� Zed d
� �Zd d � Z ed
d� �Z
edd� �Z e dd� �Z
edd� �Zedd� �Zedd� �Zedd� �Zedd � �Zed d � �Zed d � �Zed!d"� �Zed#d$� �Zed%d&� �Zd'd(� Zed)d*� �Zejd+d*� �Zd,d-� Z dS )0� ServiceModelzQ
:ivar service_description: The parsed service description dictionary.
Nc C s< || _ |jdi �| _t|jdi ��| _t| _|| _i | _dS )a�
:type service_description: dict
:param service_description: The service description model. This value
is obtained from a botocore.loader.Loader, or from directly loading
the file yourself::
service_description = json.load(
open('/path/to/service-description-model.json'))
model = ServiceModel(service_description)
:type service_name: str
:param service_name: The name of the service. Normally this is
the endpoint prefix defined in the service_description. However,
you can override this value to provide a more convenient name.
This is done in a few places in botocore (ses instead of email,
emr instead of elasticmapreduce). If this value is not provided,
it will default to the endpointPrefix defined in the model.
r5 �shapesN) �_service_descriptionr& r5 �
ShapeResolverr) �NOT_SET�_signature_version�
_service_nameZ_instance_cache)r Zservice_description� service_namer
r
r r. � s zServiceModel.__init__c C s | j j||�S )N)r) �get_shape_by_name)r r+ �
member_traitsr
r
r � shape_for s zServiceModel.shape_forc C s | j j|d �S )N)�_error_code_cacher& )r rF r
r
r �shape_for_error_code s z!ServiceModel.shape_for_error_codec C s& i }x | j D ]}|j}|||< q W |S )N)� error_shapesrF )r Zerror_code_cache� error_shaperE r
r
r rW s
z ServiceModel._error_code_cachec C s | j j|�S )N)r) r7 )r r8 r
r
r r7 s z ServiceModel.resolve_shape_refc C s t | jjdi ��S )NrM )�listrN r& )r r
r
r � shape_names s zServiceModel.shape_namesc C s: g }x0| j D ]&}| j|�}|jjdd�r |j|� q W |S )Nr F)r\ rV r5 r& �append)r rY r+ rZ r
r
r rY " s
zServiceModel.error_shapesc C s< y| j d | }W n tk
r. t|��Y nX t|| |�S )N�
operations)rN �KeyErrorr �OperationModel)r Zoperation_namer1 r
r
r �operation_model+ s
z ServiceModel.operation_modelc C s | j jdd�S )Nr" r# )rN r& )r r
r
r r" 3 s zServiceModel.documentationc C s t | jjdg ��S )Nr^ )r[ rN r& )r r
r
r �operation_names7 s z ServiceModel.operation_namesc C s | j dk r| j S | jS dS )a� The name of the service.
This defaults to the endpointPrefix defined in the service model.
However, this value can be overriden when a ``ServiceModel`` is
created. If a service_name was not provided when the ``ServiceModel``
was created and if there is no endpointPrefix defined in the
service model, then an ``UndefinedModelAttributeError`` exception
will be raised.
N)rR �endpoint_prefix)r r
r
r rS ; s
zServiceModel.service_namec C s4 yt | jd��S tk
r. t| jd��Y nX d S )NZ serviceId)rS )r �_get_metadata_propertyr r rR )r r
r
r �
service_idL s
zServiceModel.service_idc C s | j jd�}|dkr| j}|S )z�The name to use when computing signatures.
If the model does not define a signing name, this
value will be the endpoint prefix defined in the model.
Z signingNameN)r5 r& rc )r � signing_namer
r
r rf U s zServiceModel.signing_namec C s
| j d�S )NZ
apiVersion)rd )r r
r
r � api_versiona s zServiceModel.api_versionc C s
| j d�S )N�protocol)rd )r r
r
r rh e s zServiceModel.protocolc C s
| j d�S )NZendpointPrefix)rd )r r
r
r rc i s z ServiceModel.endpoint_prefixc C s( x"| j D ]}| j|�}|jr|S qW d S )N)rb ra � is_endpoint_discovery_operation)r � operationr1 r
r
r � endpoint_discovery_operationm s
z)ServiceModel.endpoint_discovery_operationc C s8 x2| j D ](}| j|�}|jd k r|jjd�rdS qW dS )Nr TF)rb ra �endpoint_discoveryr& )r rj r1 r
r
r �endpoint_discovery_requiredt s
z(ServiceModel.endpoint_discovery_requiredc C s4 y
| j | S tk
r. td|| f ��Y nX d S )Nz1"%s" not defined in the metadata of the model: %s)r5 r_ r )r r$ r
r
r rd } s
z#ServiceModel._get_metadata_propertyc C s" | j tkr | jjd�}|| _ | j S )NZsignatureVersion)rQ rP r5 r& )r �signature_versionr
r
r rn � s
z ServiceModel.signature_versionc C s
|| _ d S )N)rQ )r rJ r
r
r rn � s c C s d| j j| jf S )Nz%s(%s))r: r
rS )r r
r
r r; � s zServiceModel.__repr__)N)N) r
r r r= r. rV rX r rW r7 r\ rY r ra r" rb rS re rf rg rh rc rk rm rd r? rn �setterr; r
r
r
r rL � s.
rL c @ s& e Zd Zd6dd�Zedd� �Zedd� �Zedd � �Zed
d � �Z ed d
� �Z
edd� �Z edd� �Z edd� �Z
edd� �Zedd� �Zedd� �Zedd� �Zed d � �Zed d � �Zed d!� �Zed"d#� �Zd$d%� Zd&d'� Zd(d)� Zed*d+� �Zed,d-� �Zd.d/� Zd0d1� Z d2d3� Z d4d5� Z dS )7r` Nc C s8 || _ || _|| _|jd�| _|j| _|jdi �| _dS )a�
:type operation_model: dict
:param operation_model: The operation model. This comes from the
service model, and is the value associated with the operation
name in the service model (i.e ``model['operations'][op_name]``).
:type service_model: botocore.model.ServiceModel
:param service_model: The service model associated with the operation.
:type name: string
:param name: The operation name. This is the operation name exposed to
the users of this model. This can potentially be different from
the "wire_name", which is the operation name that *must* by
provided over the wire. For example, given::
"CreateCloudFrontOriginAccessIdentity":{
"name":"CreateCloudFrontOriginAccessIdentity2014_11_06",
...
}
The ``name`` would be ``CreateCloudFrontOriginAccessIdentity``,
but the ``self.wire_name`` would be
``CreateCloudFrontOriginAccessIdentity2014_11_06``, which is the
value we must send in the corresponding HTTP request.
r$ �httpN)�_operation_model�_service_model� _api_namer& Z
_wire_namer5 rp )r ra �
service_modelr$ r
r
r r. � s zOperationModel.__init__c C s | j d k r| j S | jS d S )N)rs � wire_name)r r
r
r r$ � s
zOperationModel.namec C s | j jd�S )aR The wire name of the operation.
In many situations this is the same value as the
``name``, value, but in some services, the operation name
exposed to the user is different from the operaiton name
we send across the wire (e.g cloudfront).
Any serialization code should use ``wire_name``.
r$ )rq r& )r r
r
r ru � s zOperationModel.wire_namec C s | j S )N)rr )r r
r
r rt � s z OperationModel.service_modelc C s | j jdd�S )Nr" r# )rq r& )r r
r
r r" � s z OperationModel.documentationc C s | j jdd�S )N�
deprecatedF)rq r& )r r
r
r rv � s zOperationModel.deprecatedc C s | j jdd �S )NZendpointdiscovery)rq r& )r r
r
r rl � s z!OperationModel.endpoint_discoveryc C s | j jdd�S )NZendpointoperationF)rq r& )r r
r
r ri � s z.OperationModel.is_endpoint_discovery_operationc C s d| j krd S | jj| j d �S )N�input)rq rr r7 )r r
r
r � input_shape� s
zOperationModel.input_shapec C s d| j krd S | jj| j d �S )N�output)rq rr r7 )r r
r
r � output_shape� s
zOperationModel.output_shapec C s" | j }|sg S dd� |jj� D �S )Nc S s( g | ] \}}d |j kr|j d r|�qS )r )r5 )�.0r$ �shaper
r
r �
<listcomp> s
z5OperationModel.idempotent_members.<locals>.<listcomp>)rx rA rB )r rx r
r
r �idempotent_members� s z!OperationModel.idempotent_membersc C s | j jd�S )NZauthtype)rq r& )r r
r
r � auth_type s zOperationModel.auth_typec s$ � j jdg �}t� fdd�|D ��S )N�errorsc 3 s | ]}� j j|�V qd S )N)rr r7 )r{ �s)r r
r � <genexpr>
s z.OperationModel.error_shapes.<locals>.<genexpr>)rq r& r[ )r rM r
)r r rY
s zOperationModel.error_shapesc C s | j jd�S )N�endpoint)rq r& )r r
r
r r� s zOperationModel.endpointc C s | j jdd�S )NZhttpChecksumRequiredF)rq r& )r r
r
r �http_checksum_required s z%OperationModel.http_checksum_requiredc C s | j � d k S )N)�get_event_stream_input)r r
r
r �has_event_stream_input s z%OperationModel.has_event_stream_inputc C s | j � d k S )N)�get_event_stream_output)r r
r
r �has_event_stream_output s z&OperationModel.has_event_stream_outputc C s | j | j�S )N)�_get_event_streamrx )r r
r
r r� s z%OperationModel.get_event_stream_inputc C s | j | j�S )N)r� rz )r r
r
r r� " s z&OperationModel.get_event_stream_outputc C s$ |dkr dS |j }|r |j| S dS )zAReturns the event stream member's shape if any or None otherwise.N)r< rA )r r| Z
event_namer
r
r r� % s
z OperationModel._get_event_streamc C s | j � d k S )N)�get_streaming_input)r r
r
r �has_streaming_input. s z"OperationModel.has_streaming_inputc C s | j � d k S )N)�get_streaming_output)r r
r
r �has_streaming_output2 s z#OperationModel.has_streaming_outputc C s | j | j�S )N)�_get_streaming_bodyrx )r r
r
r r� 6 s z"OperationModel.get_streaming_inputc C s | j | j�S )N)r� rz )r r
r
r r� 9 s z#OperationModel.get_streaming_outputc C s< |dkr dS |j jd�}|dk r8|j| }|jdkr8|S dS )z?Returns the streaming member's shape if any; or None otherwise.Nr �blob)r2 r& rA r% )r r| r Z
payload_shaper
r
r r� < s
z"OperationModel._get_streaming_bodyc C s d| j j| jf S )Nz %s(name=%s))r: r
r$ )r r
r
r r; G s zOperationModel.__repr__)N) r
r r r. r r$ r? ru rt r" rv rl ri rx rz r~ r rY r� r� r� r� r� r� r� r� r� r� r� r� r; r
r
r
r r` � s4
%
r` c @ s8 e Zd ZdZeeeed�Zdd� Z d
dd�Z
dd � Z dS ) rO zResolves shape references.)� structurer[ �map�stringc C s || _ i | _d S )N)�
_shape_mapZ _shape_cache)r � shape_mapr
r
r r. V s zShapeResolver.__init__Nc C s� y| j | }W n tk
r* t|��Y nX y| jj|d t�}W n tk
rb td| ��Y nX |rz|j� }|j|� |||| �}|S )Nr! z(Shape is missing required key 'type': %s) r� r_ r �
SHAPE_CLASSESr& r r �copy�update)r r+ rU r, Z shape_cls�resultr
r
r rT Z s
z ShapeResolver.get_shape_by_namec C sj t |�dkr"d|kr"| j|d �S |j� }y|jd�}W n tk
rX td| ��Y nX | j||�S d S )N� r| z*Invalid model, missing shape reference: %s)�lenrT r� r0 r_ r )r r8 rU r+ r
r
r r7 j s z ShapeResolver.resolve_shape_ref)N) r
r r r= r@ rG rH rK r� r. rT r7 r
r
r
r rO K s
rO c @ s" e Zd ZdZddd�Zdd� ZdS )r( zJA ShapeResolver that will throw ValueErrors when shapes are resolved.
Nc C s t d��d S )Nz>Attempted to lookup shape '%s', but no shape map was provided.)�
ValueError)r r+ rU r
r
r rT � s z&UnresolvableShapeMap.get_shape_by_namec C s t d��d S )Nz?Attempted to resolve shape '%s', but no shape map was provided.)r� )r r8 r
r
r r7 � s z&UnresolvableShapeMap.resolve_shape_ref)N)r
r r r= rT r7 r
r
r
r r( s
r( c @ sb e Zd ZdZddd�Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dd� Z
dS )� DenormalizedStructureBuildera� Build a StructureShape from a denormalized model.
This is a convenience builder class that makes it easy to construct
``StructureShape``s based on a denormalized model.
It will handle the details of creating unique shape names and creating
the appropriate shape map needed by the ``StructureShape`` class.
Example usage::
builder = DenormalizedStructureBuilder()
shape = builder.with_members({
'A': {
'type': 'structure',
'members': {
'B': {
'type': 'structure',
'members': {
'C': {
'type': 'string',
}
}
}
}
}
}).build_model()
# ``shape`` is now an instance of botocore.model.StructureShape
:type dict_type: class
:param dict_type: The dictionary type to use, allowing you to opt-in
to using OrderedDict or another dict type. This can
be particularly useful for testing when order
matters, such as for documentation.
Nc C s* t � | _t� | _|d kr&| jjd�| _d S )Nr� )r rA �ShapeNameGenerator�_name_generator�new_shape_namer$ )r r$ r
r
r r. � s z%DenormalizedStructureBuilder.__init__c C s
|| _ | S )zp
:type members: dict
:param members: The denormalized members.
:return: self
)�_members)r rA r
r
r � with_members� s z)DenormalizedStructureBuilder.with_membersc C sB t � }d| jd�}| j||| j� t|d�}t| j|| j |d�S )z�Build the model based on the provided members.
:rtype: botocore.model.StructureShape
:return: The built StructureShape object.
r� )r! rA )r� )r+ r, r- )r r� � _build_modelr$ rO r@ )r rM Z denormalizedZresolverr
r
r � build_model� s
z(DenormalizedStructureBuilder.build_modelc
C s� |d dkr | j ||�||< nh|d dkr<| j||�||< nJ|d dkrZ| j||�||< n,|d dkrv| j|�||< ntd|d ��d S )Nr! r� r[ r� r� �integer�booleanr� �float� timestamp�long�double�charzUnknown shape type: %s) r� r� r� r� r� r� r� r� r� )�_build_structure� _build_list�
_build_map�
_build_scalarr )r r1 rM r+ r
r
r r� � s z)DenormalizedStructureBuilder._build_modelc C sZ t � }| j|�}||d< x<|d j� D ],\}}| j|�}d|i||< | j|||� q&W |S )NrA r| )r �_build_initial_shaperB �_get_shape_namer� )r r1 rM rA r| r$ Z member_model�member_shape_namer
r
r r� � s
z-DenormalizedStructureBuilder._build_structurec C s6 | j |�}| j|�}d|i|d< | j|d ||� |S )Nr| rD )r� r� r� )r r1 rM r� r| r
r
r r� � s
z(DenormalizedStructureBuilder._build_listc C sf | j |d �}| j |d �}| j|�}d|i|d< d|i|d< | j|d ||� | j|d ||� |S )NrI rJ r| )r� r� r� )r r1 rM Zkey_shape_nameZvalue_shape_namer| r
r
r r� � s
z'DenormalizedStructureBuilder._build_mapc C sH d|d i}d|kr |d |d< x"t jD ]}||kr(|| ||< q(W |S )Nr! r" )r r4 )r r1 r| r3 r
r
r r� � s z1DenormalizedStructureBuilder._build_initial_shapec C s
| j |�S )N)r� )r r1 r
r
r r� s z*DenormalizedStructureBuilder._build_scalarc C s$ d|kr|d S | j j|d �S d S )Nr+ r! )r� r� )r r1 r
r
r r�
s z,DenormalizedStructureBuilder._get_shape_name)N)r
r r r= r. r� r� r� r� r� r� r� r� r� r
r
r
r r� � s #
r� c @ s e Zd ZdZdd� Zdd� ZdS )r� z�Generate unique shape names for a type.
This class can be used in conjunction with the DenormalizedStructureBuilder
to generate unique shape names for a given type.
c C s t t�| _d S )N)r �int� _name_cache)r r
r
r r. s zShapeNameGenerator.__init__c C s, | j | d7 < | j | }d|j� |f S )a� Generate a unique shape name.
This method will guarantee a unique shape name each time it is
called with the same type.
::
>>> s = ShapeNameGenerator()
>>> s.new_shape_name('structure')
'StructureType1'
>>> s.new_shape_name('structure')
'StructureType2'
>>> s.new_shape_name('list')
'ListType1'
>>> s.new_shape_name('list')
'ListType2'
:type type_name: string
:param type_name: The type name (structure, list, map, string, etc.)
:rtype: string
:return: A unique shape name for the given type
r� z%sType%s)r� �
capitalize)r r% Z
current_indexr
r
r r� s
z!ShapeNameGenerator.new_shape_nameN)r
r r r= r. r� r
r
r
r r� s r� N) r= � collectionsr Zbotocore.utilsr r r Zbotocore.compatr Zbotocore.exceptionsr r �objectrP � Exceptionr r r r �strr r r@ rG rH rK rL r` rO r( r� r� r
r
r
r �<module>
s4 "
2 44