File: //home/arjun/projects/env/lib/python3.10/site-packages/botocore/__pycache__/model.cpython-310.pyc
o
*we�w � @ s| d Z ddlmZ ddlmZmZ ddlmZ ddlm Z m
Z
ddl m Z m
Z
mZ e� ZG dd� de�ZG d d
� d
e�ZG d d � d e�ZG d
d� de�ZG dd� de�ZG dd� d�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�Z G dd � d e�Z G d d � d e�Z G d d � d e�Z G d!d"� d"�Z G d#d$� d$�Z!G d%d&� d&�Z"G d'd(� d(�Z#G d)d*� d*�Z$G d+d,� d,�Z%d-S ).z-Abstractions to interact with service models.� )� defaultdict)�
NamedTuple�Union)� OrderedDict)�MissingServiceIdError� UndefinedModelAttributeError)�CachedProperty�hyphenize_service_id�instance_cachec @ � e Zd ZdS )�NoShapeFoundErrorN��__name__�
__module__� __qualname__� r r �G/home/arjun/projects/env/lib/python3.10/site-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, s 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�pattern� sensitive�enum�idempotencyToken�error� exception�endpointdiscoveryid� retryable�document�union� contextParam�clientContextParams�requiresLengthNc 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�getr> � _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@ )rC �SERIALIZED_ATTRS�pop)r �model�
serialization�attrr r r rN � 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
* pattern
* enum
* sensitive
* required
* idempotencyToken
* document
* union
* contextParam
* clientContextParams
* requiresLength
:rtype: dict
:return: Metadata about the shape.
)rC �METADATA_ATTRS)r rM �metadatarO r r r rQ � 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- �rQ rB r r r r �required_members� s zShape.required_membersc C � | j �|�S r �rE �resolve_shape_ref�r � shape_refr r r �_resolve_shape_ref� � zShape._resolve_shape_refc C s d| j j� d| j� d�S )N�<�(z)>�� __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__rK rP r �MAP_TYPErJ r rN rQ rT rZ r` �propertyra r r r r r 0 s
"
r c @ sH e Zd Zedd� �Zedd� �Zedd� �Zedd� �Zed d
� �Zd S ) �StructureShapec C s> | j �d| �� �}| �� }|�� D ] \}}| �|�||< q|S )N�members)rC rB rc �itemsrZ )r rf �
shape_membersr@ rY r r r rf � s
zStructureShape.membersc C s, | j �� D ]\}}|j�d�r| S qd S )Nr' )rf rg rN rB )r � member_name�memberr r r ra � s
�z StructureShape.event_stream_namec C s8 | j �dd�s d S | j �di �}|�d�}|r|S | jS )Nr5 Fr4 �code)rQ rB r@ )r �error_metadatark r r r �
error_code� s
zStructureShape.error_codec C � | j �dd�S )Nr8 FrS r r r r �is_document_type� � z StructureShape.is_document_typec C rn )Nr9 FrS r r r r �is_tagged_union� rp z StructureShape.is_tagged_unionN) r r r r rf ra rm ro rq r r r r re � s
re c @ � e Zd Zedd� �ZdS )� ListShapec C � | � | jd �S )Nrj �rZ rC r r r r rj � zListShape.memberN)r r r r rj r r r r rs � � rs c @ s$ e Zd Zedd� �Zedd� �ZdS )�MapShapec C rt )N�keyru r r r r ry rv z MapShape.keyc C rt )N�valueru r r r r rz
rv zMapShape.valueN)r r r r ry rz r r r r rx s
rx c @ rr )� StringShapec C rR )Nr2 rS r r r r r2 rp zStringShape.enumN)r r r r r2 r r r r r{ rw r{ c @ s& e Zd ZU eed< eeef ed< dS )�StaticContextParameterr@ rz N)r r r �str�__annotations__r �boolr r r r r| s
r| c @ s e Zd ZU eed< eed< dS )�ContextParameterr@ ri N�r r r r} r~ r r r r r� s
r� c @ s& e Zd ZU eed< eed< eed< dS )�ClientContextParameterr@ r= r> Nr� r r r r r� s
r� c @ s e Zd ZdZd0dd�Zd0dd�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&� �Zed'd(� �Zd)d*� Zed+d,� �Zej d-d,� �Zd.d/� Z dS )1� 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.
rQ �shapesN) �_service_descriptionrB rQ �
ShapeResolverrE �NOT_SET�_signature_version�
_service_name�_instance_cache)r �service_description� service_namer r r rJ , s
�
zServiceModel.__init__c C s | j �||�S r )rE �get_shape_by_name�r rG �
member_traitsr r r � shape_forK s �zServiceModel.shape_forc C s | j �|d �S r )�_error_code_cacherB )r rm r r r �shape_for_error_codeP � z!ServiceModel.shape_for_error_codec C s" i }| j D ] }|j}|||< q|S r )� error_shapesrm )r �error_code_cache� error_shaperk r r r r� S s
z ServiceModel._error_code_cachec C rU r rV rX r r r rW [ r[ z ServiceModel.resolve_shape_refc C s t | j�di ��S )Nr� ��listr� rB r r r r � shape_names^ � zServiceModel.shape_namesc C s6 g }| j D ]}| �|�}|j�dd�r|�|� q|S )Nr5 F)r� r� rQ rB �append)r r� rG r� r r r r� b s
�zServiceModel.error_shapesc C s6 z | j d | }W n ty t|��w t|| |�S �N�
operations)r� �KeyErrorr �OperationModel)r �operation_namerM r r r �operation_modelk s � z ServiceModel.operation_modelc C rn �Nr> r? )r� rB r r r r r> s rp zServiceModel.documentationc C s t | j�dg ��S r� r� r r r r �operation_namesw 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� { 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_id� 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)rQ rB r� )r � signing_namer r r r� � s zServiceModel.signing_namec C �
| � d�S )N�
apiVersion�r� r r r r � api_version� �
zServiceModel.api_versionc C r� )N�protocolr� r r r r r� � r� zServiceModel.protocolc C r� )N�endpointPrefixr� r r r r r� � r� z ServiceModel.endpoint_prefixc C s( | j D ]}| �|�}|jr| S qd S r )r� r� � is_endpoint_discovery_operation�r � operationrM r r r � endpoint_discovery_operation� s
��z)ServiceModel.endpoint_discovery_operationc C s6 | j D ]}| �|�}|jd ur|j�d�r dS qdS )Nr- TF)r� r� �endpoint_discoveryrB r� r r r �endpoint_discovery_required� s
��z(ServiceModel.endpoint_discovery_requiredc C � | j �di �}dd� |�� D �S )Nr; c S s& g | ]\}}t ||d |d d��qS )r= r> )r@ r= r> )r� )�.0�
param_name� param_valr r r �
<listcomp>� s ���z:ServiceModel.client_context_parameters.<locals>.<listcomp>)r� rB rg �r �paramsr r r �client_context_parameters� s �z&ServiceModel.client_context_parametersc C s0 z| j | W S ty td|� d| � ���w )N�"z," not defined in the metadata of the model: )rQ 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� r� rQ rB )r �signature_versionr r r r� � s
z ServiceModel.signature_versionc C s
|| _ d S r )r� )r rz r r r r� � r� c C � | j j� d| j� d�S )Nr] �))r_ r r� r r r r r` � � zServiceModel.__repr__r ) r r r rb rJ r� r� r r� rW r� r� r
r� r> r� r� r� r� r� r� r� r� r� r� r� rd r� �setterr` r r r r r� % sT
r� c @ sV e Zd Zd>dd�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#� �Zed$d%� �Zed&d'� �Zed(d)� �Zed*d+� �Zd,d-� Zd.d/� Zd0d1� Z ed2d3� �Z ed4d5� �Z d6d7� Z d8d9� Z d:d;� Z!d<d=� Z"dS )?r� 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_namerB �
_wire_namerQ r� )r r� �
service_modelr@ r r r rJ � 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 operation name
we send across the wire (e.g cloudfront).
Any serialization code should use ``wire_name``.
r@ �r� rB 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 rn r� r� r r r r r> " rp z OperationModel.documentationc C rn )N�
deprecatedFr� r r r r r� & rp zOperationModel.deprecatedc C s | j �dd �S )N�endpointdiscoveryr� r r r r r� * s z!OperationModel.endpoint_discoveryc C rn )N�endpointoperationFr� r r r r r� 0 rp z.OperationModel.is_endpoint_discovery_operationc C � d| j vrd S | j�| j d �S )N�input�r� r� rW r r r r � input_shape4 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 )r3 )rQ �r� r@ �shaper r r r� O s
��z5OperationModel.idempotent_members.<locals>.<listcomp>�r� rf rg )r r� r r r �idempotent_membersI s �z!OperationModel.idempotent_membersc C r� )N�staticContextParamsc S s" g | ]
\}}t ||�d �d��qS )rz )r@ rz )r| rB )r� r@ �propsr r r r� Y s ��z<OperationModel.static_context_parameters.<locals>.<listcomp>)r� rB rg r� r r r �static_context_parametersV s �z(OperationModel.static_context_parametersc C s | j sg S dd� | j j�� D �S )Nc S s> g | ]\}}d |j v r d|j d v rt|j d d |d��qS )r: r@ )r@ ri )rQ r� r� r r r r� c s
� �z5OperationModel.context_parameters.<locals>.<listcomp>r� r r r r �context_parameters^ s
�z!OperationModel.context_parametersc C r� )N�requestcompressionr� r r r r �request_compressionm � z"OperationModel.request_compressionc C r� )N�authtyper� r r r r � auth_typeq r� zOperationModel.auth_typec s$ � j �dg �}t� fdd�|D ��S )N�errorsc 3 s � | ] }� j �|�V qd S r )r� rW )r� �sr r r � <genexpr>x s � z.OperationModel.error_shapes.<locals>.<genexpr>)r� rB r� )r r� r r r r� u s zOperationModel.error_shapesc C r� )N�endpointr� r r r r r� z r� zOperationModel.endpointc C rn )N�httpChecksumRequiredFr� r r r r �http_checksum_required~ rp z%OperationModel.http_checksum_requiredc C s | j �di �S )N� httpChecksumr� r r r r �
http_checksum� rp z OperationModel.http_checksumc 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� � r[ z%OperationModel.get_event_stream_inputc C r� r )r� r� r r r r r� � r[ 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)ra rf )r r� �
event_namer r r r� � 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� � r[ z"OperationModel.get_streaming_inputc C r� r )r� r� r r r r r� � r[ 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)rN rB rf rA )r r� r! �
payload_shaper r r r� � s
z"OperationModel._get_streaming_bodyc C r� )Nz(name=r� r^ r r r r r` � r� zOperationModel.__repr__r )#r r r rJ r r@ rd r� r� r> r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r` r r r r r� � sj
%
r� c @ s8 e Zd ZdZeeeed�Zdd� Z d
dd�Z
dd � Z dS ) r� zResolves shape references.)� structurer� �map�stringc C s || _ i | _d S r )�
_shape_map� _shape_cache)r � shape_mapr r r rJ � s
zShapeResolver.__init__Nc C s� z| j | }W n ty t|��w z | j�|d t�}W n ty, td|� ���w |r8|�� }|�|� |||| �}|S )Nr= z&Shape is missing required key 'type': ) r r� r �
SHAPE_CLASSESrB r r �copy�update)r rG r� rH � shape_cls�resultr r r r� � s" � ��
z ShapeResolver.get_shape_by_namec C sb t |�dkrd|v r| �|d �S |�� }z|�d�}W n ty* td|� ���w | �||�S )N� r� z(Invalid model, missing shape reference: )�lenr� r rL r� r )r rY r� rG r r r rW � s �� z ShapeResolver.resolve_shape_refr ) r r r rb re rs rx r{ r rJ r� rW r r r r r� � s �
r� c @ s" e Zd ZdZddd�Zdd� ZdS )rD zEA ShapeResolver that will throw ValueErrors when shapes are resolved.Nc C � t d|� d���)NzAttempted to lookup shape '�!', but no shape map was provided.��
ValueErrorr� r r r r� � �
�z&UnresolvableShapeMap.get_shape_by_namec C r
)Nz Attempted to resolve shape 'r r rX r r r rW � r z&UnresolvableShapeMap.resolve_shape_refr )r r r rb r� rW r r r r rD � s
rD c @ sf e Zd ZdZdZddd�Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dd� ZdS )� 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.
) r� �integer�booleanr� �float� timestamp�long�double�charNc C s. t � | _t� | _|d u r| j�d�| _d S d S )Nr� )r rf �ShapeNameGenerator�_name_generator�new_shape_namer@ r� r r r rJ 0 s
�z%DenormalizedStructureBuilder.__init__c C s
|| _ | S )zp
:type members: dict
:param members: The denormalized members.
:return: self
)�_members)r rf r r r � with_members6 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� )r= rf )r )rG rH rI )r r � _build_modelr@ r� re )r r� � denormalized�resolverr r r � build_modelB s �
�z(DenormalizedStructureBuilder.build_modelc C s� |d dkr| � ||�||< d S |d dkr | �||�||< d S |d dkr0| �||�||< d S |d | jv r@| �|�||< d S td|d � ���)Nr= r� r� r� zUnknown shape type: )�_build_structure� _build_list�
_build_map� SCALAR_TYPES�
_build_scalarr )r rM r� rG r r r r V s z)DenormalizedStructureBuilder._build_modelc C s\ t � }| �|�}||d< |�dt � ��� D ]\}}| �|�}d|i||< | �|||� q|S )Nrf r� )r �_build_initial_shaperB rg �_get_shape_namer )r rM r� rf r� r@ � member_model�member_shape_namer r r r b s
z-DenormalizedStructureBuilder._build_structurec C s6 | � |�}| �|�}d|i|d< | �|d ||� |S )Nr� rj �r& r% r )r rM r� r( r� r r r r! m s
z(DenormalizedStructureBuilder._build_listc C sf | � |d �}| � |d �}| �|�}d|i|d< d|i|d< | �|d ||� | �|d ||� |S )Nry rz r� r) )r rM r� �key_shape_name�value_shape_namer� r r r r" t s
z'DenormalizedStructureBuilder._build_mapc C sD d|d i}d|v r|d |d< t jD ] }||v r || ||< q|S )Nr= r> )r rP )r rM r� rO r r r r% ~ s �
�z1DenormalizedStructureBuilder._build_initial_shapec C s
| � |�S r )r% �r rM r r r r$ � s
z*DenormalizedStructureBuilder._build_scalarc C s d|v r|d S | j �|d �S )NrG r= )r r r, r r r r& � s z,DenormalizedStructureBuilder._get_shape_namer )r r r rb r# rJ 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 rJ � r� zShapeNameGenerator.__init__c C s. | j | d7 < | j | }|�� � d|� �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 �Type)r. �
capitalize)r rA �
current_indexr r r r � s
z!ShapeNameGenerator.new_shape_nameN)r r r rb rJ r r r r r r � s r N)&rb � collectionsr �typingr r �botocore.compatr �botocore.exceptionsr r �botocore.utilsr r r
�objectr� � Exceptionr r r r r} r r re rs rx r{ r| r� r� r� r� r� rD r r r r r r �<module> s< &*
? X6