File: //lib/python3/dist-packages/botocore/__pycache__/model.cpython-310.pyc
o
.&�a;p � @ 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 @ � e Zd ZdS )�NoShapeFoundErrorN��__name__�
__module__� __qualname__� r r �0/usr/lib/python3/dist-packages/botocore/model.pyr
� r
c @ r )�InvalidShapeErrorNr r r r r r r r c @ r )�OperationNotFoundErrorNr r r r r r ! r r c @ r )�InvalidShapeReferenceErrorNr r r r r r % r r c @ s e Zd Zdd� ZdS )� ServiceIdc C s t | �S �N)r ��selfr r r � hyphenize* � zServiceId.hyphenizeN)r r
r r r r r r r ) s r c @ sn e Zd ZdZg d�Zg d�ZeZddd�Ze dd� �Z
e d d
� �Z e d d � �Z d
d� Z
dd� Zedd� �ZdS )�Shapez3Object representing a shape from the service model.)� locationName� queryName� flattened�location�payload� streaming�timestampFormat� xmlNamespace�
resultWrapper� xmlAttribute� eventstream�event� eventheader� eventpayload� jsonvaluer" � hostLabel) �required�min�max� sensitive�enum�idempotencyToken�error� exception�endpointdiscoveryid� retryable�document�unionNc C sB || _ |d | _|�dd�| _|| _|du rt� }|| _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�getr9 � _shape_model�UnresolvableShapeMap�_shape_resolver�_cache)r �
shape_name� shape_model�shape_resolverr r r �__init__> s
zShape.__init__c C sF | j }i }| jD ]
}|| j v r|| ||< qd|v r!|�d�|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 rI ` s
�zShape.serializationc C s0 | j }i }| jD ]
}|| j v r|| ||< q|S )a] Metadata about the shape.
This requires optional information about the shape, including:
* min
* max
* enum
* sensitive
* required
* idempotencyToken
* document
* union
:rtype: dict
:return: Metadata about the shape.
)r> �METADATA_ATTRS)r rH �metadatarJ r r r rL � s
�zShape.metadatac C � | j �dg �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, �rL r= r r r r �required_members� s zShape.required_membersc C � | j �|�S r �r@ �resolve_shape_ref�r � shape_refr r r �_resolve_shape_ref� � zShape._resolve_shape_refc C � d| j j| jf S )Nz<%s(%s)>�� __class__r r; r r r r �__repr__� s �zShape.__repr__c C s d S r r r r r r �event_stream_name� s zShape.event_stream_namer )r r
r �__doc__rF rK r �MAP_TYPErE r rI rL rO rU rZ �propertyr[ r r r r r . s
"
r c @ sH e Zd Zedd� �Zedd� �Zedd� �Zedd� �Zed d
� �Zd S ) �StructureShapec C s> | j �d| �� �}| �� }|�� D ] \}}| �|�||< q|S )N�members)r> r= r] �itemsrU )r r` �
shape_membersr; rT r r r r` � s
zStructureShape.membersc C s, | j �� D ]\}}|j�d�r| S qd S )Nr& )r` ra rI r= )r � member_name�memberr r r r[ � s
�z StructureShape.event_stream_namec C s8 | j �dd�s d S | j �di �}|�d�}|r|S | jS )Nr3 Fr2 �code)rL r= r; )r �error_metadatare r r r �
error_code� s
zStructureShape.error_codec C � | j �dd�S )Nr6 FrN r r r r �is_document_type� � z StructureShape.is_document_typec C rh )Nr7 FrN r r r r �is_tagged_union� rj z StructureShape.is_tagged_unionN) r r
r r r` r[ rg ri rk r r r r r_ � s
r_ c @ � e Zd Zedd� �ZdS )� ListShapec C � | � | jd �S )Nrd �rU r> r r r r rd � � zListShape.memberN)r r
r r rd r r r r rm � � rm c @ s$ e Zd Zedd� �Zedd� �ZdS )�MapShapec C rn )N�keyro r r r r rs � rp z MapShape.keyc C rn )N�valuero r r r r rt � rp zMapShape.valueN)r r
r r rs rt r r r r rr � s
rr c @ rl )� StringShapec C rM )Nr0 rN r r r r r0 � rj zStringShape.enumN)r r
r r r0 r r r r ru � rq ru 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 )/� ServiceModelzQ
:ivar service_description: The parsed service description dictionary.
Nc C s< || _ |�di �| _t|�di ��| _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.
rL �shapesN) �_service_descriptionr= rL �
ShapeResolverr@ �NOT_SET�_signature_version�
_service_name�_instance_cache)r �service_description� service_namer r r rE � s
�
zServiceModel.__init__c C s | j �||�S r )r@ �get_shape_by_name�r rB �
member_traitsr r r � shape_for s �zServiceModel.shape_forc C s | j �|d �S r )�_error_code_cacher= )r rg r r r �shape_for_error_code � z!ServiceModel.shape_for_error_codec C s" i }| j D ] }|j}|||< q|S r )� error_shapesrg )r �error_code_cache� error_shapere r r r r� s
z ServiceModel._error_code_cachec C rP r rQ rS r r r rR & rV z ServiceModel.resolve_shape_refc C s t | j�di ��S )Nrw ��listrx r= r r r r � shape_names) � zServiceModel.shape_namesc C s6 g }| j D ]}| �|�}|j�dd�r|�|� q|S )Nr3 F)r� r� rL r= �append)r r� rB r� r r r r� - s
�zServiceModel.error_shapesc C s6 z | j d | }W n ty t|��w t|| |�S �N�
operations)rx �KeyErrorr �OperationModel)r �operation_namerH r r r �operation_model6 s � z ServiceModel.operation_modelc C rh �Nr9 r: )rx r= r r r r r9 > rj zServiceModel.documentationc C s t | j�dg ��S r� r� r r r r �operation_namesB r� z ServiceModel.operation_namesc C s | j dur| j S | jS )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)r| �endpoint_prefixr r r r r F s
zServiceModel.service_namec C s, zt | �d��W S ty t| jd��w )N� serviceId)r )r �_get_metadata_propertyr r r| r r r r �
service_idW s ��zServiceModel.service_idc C s | j �d�}|du r
| 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.
� signingNameN)rL r= r� )r � signing_namer r r r� ` s zServiceModel.signing_namec C �
| � d�S )N�
apiVersion�r� r r r r � api_versionl �
zServiceModel.api_versionc C r� )N�protocolr� r r r r r� p r� zServiceModel.protocolc C r� )N�endpointPrefixr� r r r r r� t r� z ServiceModel.endpoint_prefixc C s( | j D ]}| �|�}|jr| S qd S r )r� r� � is_endpoint_discovery_operation�r � operationrH r r r � endpoint_discovery_operationx s
��z)ServiceModel.endpoint_discovery_operationc C s6 | j D ]}| �|�}|jd ur|j�d�r dS qdS )Nr, TF)r� r� �endpoint_discoveryr= r� r r r �endpoint_discovery_required s
��z(ServiceModel.endpoint_discovery_requiredc C s, z| j | W S ty td|| f ��w )Nz1"%s" not defined in the metadata of the model: %s)rL r� r �r r; r r r r� � s ���z#ServiceModel._get_metadata_propertyc C s" | j tu r| j�d�}|| _ | j S )N�signatureVersion)r{ rz rL r= )r �signature_versionr r r r� � s
z ServiceModel.signature_versionc C s
|| _ d S r )r{ )r rt r r r r� � r� c C rW )Nz%s(%s))rY r r r r r r rZ � � zServiceModel.__repr__r ) r r
r r\ rE r� r� r r� rR r� r� r r� r9 r� r r� r� r� r� r� r� r� r� r^ r� �setterrZ r r r r rv � sP
rv 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 || _ || _|| _|�d�| _|j| _|�di �| _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= �
_wire_namerL r� )r r� �
service_modelr; r r r rE � s zOperationModel.__init__c C s | j d ur| j S | jS r )r� � wire_namer r r r r; � s
zOperationModel.namec C � | j �d�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; �r� r= r r r r r� � s zOperationModel.wire_namec C s | j S r )r� r r r r r� � s z OperationModel.service_modelc C rh r� r� r r r r r9 � rj z OperationModel.documentationc C rh )N�
deprecatedFr� r r r r r� � rj zOperationModel.deprecatedc C s | j �dd �S )N�endpointdiscoveryr� r r r r r� � s z!OperationModel.endpoint_discoveryc C rh )N�endpointoperationFr� r r r r r� � rj z.OperationModel.is_endpoint_discovery_operationc C � d| j vrd S | j�| j d �S )N�input�r� r� rR r r r r � input_shape� s
�zOperationModel.input_shapec C r� )N�outputr� r r r r � output_shape� s
�zOperationModel.output_shapec C s" | j }|sg S dd� |j�� D �S )Nc S s( g | ]\}}d |j v r|j d r|�qS )r1 )rL )�.0r; �shaper r r �
<listcomp> s
��z5OperationModel.idempotent_members.<locals>.<listcomp>)r� r` ra )r r� r r r �idempotent_members s �z!OperationModel.idempotent_membersc C r� )N�authtyper� r r r r � auth_type � zOperationModel.auth_typec s$ � j �dg �}t� fdd�|D ��S )N�errorsc 3 s � | ] }� j �|�V qd S r )r� rR )r� �sr r r � <genexpr> s � z.OperationModel.error_shapes.<locals>.<genexpr>)r� r= r� )r rw r r r r� s zOperationModel.error_shapesc C r� )N�endpointr� r r r r r� r� zOperationModel.endpointc C rh )N�httpChecksumRequiredFr� r r r r �http_checksum_required! rj z%OperationModel.http_checksum_requiredc C � | � � d uS r )�get_event_stream_inputr r r r �has_event_stream_input% r� z%OperationModel.has_event_stream_inputc C r� r )�get_event_stream_outputr r r r �has_event_stream_output) r� z&OperationModel.has_event_stream_outputc C � | � | j�S r )�_get_event_streamr� r r r r r� - rV z%OperationModel.get_event_stream_inputc C r� r )r� r� r r r r r� 0 rV z&OperationModel.get_event_stream_outputc C s$ |du rdS |j }|r|j| S dS )zAReturns the event stream member's shape if any or None otherwise.N)r[ r` )r r� �
event_namer r r r� 3 s
z OperationModel._get_event_streamc C r� r )�get_streaming_inputr r r r �has_streaming_input< r� z"OperationModel.has_streaming_inputc C r� r )�get_streaming_outputr r r r �has_streaming_output@ r� z#OperationModel.has_streaming_outputc C r� r )�_get_streaming_bodyr� r r r r r� D rV z"OperationModel.get_streaming_inputc C r� r )r� r� r r r r r� G rV z#OperationModel.get_streaming_outputc C s< |du rdS |j �d�}|dur |j| }|jdkr |S dS )z?Returns the streaming member's shape if any; or None otherwise.Nr �blob)rI r= r` r< )r r� r �
payload_shaper r r r� J s
z"OperationModel._get_streaming_bodyc C rW )Nz %s(name=%s)rX r r r r rZ U r� zOperationModel.__repr__r ) r r
r rE r r; r^ r� r� r9 r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rZ r r r r r� � sZ
%
r� c @ s8 e Zd ZdZeeeed�Zdd� Z d
dd�Z
dd � Z dS ) ry zResolves shape references.)� structurer� �map�stringc C s || _ i | _d S r )�
_shape_map� _shape_cache)r � shape_mapr r r rE d s
zShapeResolver.__init__Nc C s~ z| j | }W n ty t|��w z | j�|d t�}W n
ty+ td| ��w |r7|�� }|�|� |||| �}|S )Nr8 z(Shape is missing required key 'type': %s) r� r� r
�
SHAPE_CLASSESr= r r �copy�update)r rB r� rC � shape_cls�resultr r r r� h s" � ��
z ShapeResolver.get_shape_by_namec C s` t |�dkrd|v r| �|d �S |�� }z|�d�}W n
ty) td| ��w | �||�S )N� r� z*Invalid model, missing shape reference: %s)�lenr� r� rG r� r )r rT r� rB r r r rR x s �� z ShapeResolver.resolve_shape_refr ) r r
r r\ r_ rm rr ru r� rE r� rR r r r r ry Y s �
ry c @ s" e Zd ZdZddd�Zdd� ZdS )r? zJA ShapeResolver that will throw ValueErrors when shapes are resolved.
Nc C � t d��)Nz>Attempted to lookup shape '%s', but no shape map was provided.��
ValueErrorr� r r r r� � r z&UnresolvableShapeMap.get_shape_by_namec C r� )Nz?Attempted to resolve shape '%s', but no shape map was provided.r� rS r r r rR � r z&UnresolvableShapeMap.resolve_shape_refr )r r
r r\ r� rR 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 u r| j�d�| _d S d S )Nr� )r r` �ShapeNameGenerator�_name_generator�new_shape_namer; r� r r r rE � s
�z%DenormalizedStructureBuilder.__init__c C s
|| _ | S )zp
:type members: dict
:param members: The denormalized members.
:return: self
)�_members)r r` r r r � with_members� s z)DenormalizedStructureBuilder.with_membersc C sB t � }d| jd�}| �||| 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� )r8 r` )r� )rB rC rD )r r� � _build_modelr; ry r_ )r rw � denormalized�resolverr r r � build_model� s �
�z(DenormalizedStructureBuilder.build_modelc C s� |d dkr| � ||�||< d S |d dkr | �||�||< d S |d dkr0| �||�||< d S |d dv r?| �|�||< d S td|d ��)Nr8 r� r� r� ) r� �integer�booleanr� �float� timestamp�long�double�charzUnknown shape type: %s)�_build_structure� _build_list�
_build_map�
_build_scalarr )r rH rw rB r r r r� � s z)DenormalizedStructureBuilder._build_modelc C s\ t � }| �|�}||d< |�dt � ��� D ]\}}| �|�}d|i||< | �|||� q|S )Nr` r� )r �_build_initial_shaper= ra �_get_shape_namer� )r rH rw r` r� r; � member_model�member_shape_namer r r r� � s
z-DenormalizedStructureBuilder._build_structurec C s6 | � |�}| �|�}d|i|d< | �|d ||� |S )Nr� rd �r r r� )r rH rw r r� r r r r� � s
z(DenormalizedStructureBuilder._build_listc C sf | � |d �}| � |d �}| �|�}d|i|d< d|i|d< | �|d ||� | �|d ||� |S )Nrs rt r� r )r rH rw �key_shape_name�value_shape_namer� r r r r s
z'DenormalizedStructureBuilder._build_mapc C sD d|d i}d|v r|d |d< t jD ] }||v r || ||< q|S )Nr8 r9 )r rK )r rH r� rJ r r r r
s �
�z1DenormalizedStructureBuilder._build_initial_shapec C s
| � |�S r )r �r rH r r r r s
z*DenormalizedStructureBuilder._build_scalarc C s d|v r|d S | j �|d �S )NrB r8 )r� r� r r r r r s z,DenormalizedStructureBuilder._get_shape_namer )r r
r r\ rE 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 r )r �int� _name_cacher r r r rE & r� zShapeNameGenerator.__init__c C s, | j | d7 < | j | }d|�� |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< �
current_indexr r r r� ) s
�z!ShapeNameGenerator.new_shape_nameN)r r
r r\ rE r� r r r r r� s r� N) r\ � collectionsr �botocore.utilsr r r �botocore.compatr �botocore.exceptionsr r �objectrz � Exceptionr
r r r �strr r r_ rm rr ru rv r� ry r? r� r� r r r r �<module> s6 *
3 64