HEX

File: //lib/python3/dist-packages/botocore/__pycache__/loaders.cpython-310.pyc
o

.&�a�C�@s�dZddlZddlZddlmZddlmZddlmZddlm	Z	m
Z
ddlmZe�
e�Zdd	�ZGd
d�de�Zddd
�ZGdd�de�ZGdd�de�ZdS)a�Module for loading various model files.

This module provides the classes that are used to load models used
by botocore.  This can include:

    * Service models (e.g. the model for EC2, S3, DynamoDB, etc.)
    * Service model extras which customize the service models
    * Other models associated with a service (pagination, waiters)
    * Non service-specific config (Endpoint data, retry config)

Loading a module is broken down into several steps:

    * Determining the path to load
    * Search the data_path for files to load
    * The mechanics of loading the file
    * Searching for extras and applying them to the loaded file

The last item is used so that other faster loading mechanism
besides the default JSON loader can be used.

The Search Path
===============

Similar to how the PATH environment variable is to finding executables
and the PYTHONPATH environment variable is to finding python modules
to import, the botocore loaders have the concept of a data path exposed
through AWS_DATA_PATH.

This enables end users to provide additional search paths where we
will attempt to load models outside of the models we ship with
botocore.  When you create a ``Loader``, there are two paths
automatically added to the model search path:

    * <botocore root>/data/
    * ~/.aws/models

The first value is the path where all the model files shipped with
botocore are located.

The second path is so that users can just drop new model files in
``~/.aws/models`` without having to mess around with the AWS_DATA_PATH.

The AWS_DATA_PATH using the platform specific path separator to
separate entries (typically ``:`` on linux and ``;`` on windows).


Directory Layout
================

The Loader expects a particular directory layout.  In order for any
directory specified in AWS_DATA_PATH to be considered, it must have
this structure for service models::

    <root>
      |
      |-- servicename1
      |   |-- 2012-10-25
      |       |-- service-2.json
      |-- ec2
      |   |-- 2014-01-01
      |   |   |-- paginators-1.json
      |   |   |-- service-2.json
      |   |   |-- waiters-2.json
      |   |-- 2015-03-01
      |       |-- paginators-1.json
      |       |-- service-2.json
      |       |-- waiters-2.json
      |       |-- service-2.sdk-extras.json


That is:

    * The root directory contains sub directories that are the name
      of the services.
    * Within each service directory, there's a sub directory for each
      available API version.
    * Within each API version, there are model specific files, including
      (but not limited to): service-2.json, waiters-2.json, paginators-1.json

The ``-1`` and ``-2`` suffix at the end of the model files denote which version
schema is used within the model.  Even though this information is available in
the ``version`` key within the model, this version is also part of the filename
so that code does not need to load the JSON model in order to determine which
version to use.

The ``sdk-extras`` and similar files represent extra data that needs to be
applied to the model after it is loaded. Data in these files might represent
information that doesn't quite fit in the original models, but is still needed
for the sdk. For instance, additional operation parameters might be added here
which don't represent the actual service api.
�N)�
BOTOCORE_ROOT)�json)�OrderedDict)�DataNotFoundError�UnknownServiceError��
deep_mergecs�fdd�}|S)aCache the result of a method on a per instance basis.

    This is not a general purpose caching decorator.  In order
    for this to be used, it must be used on methods on an
    instance, and that instance *must* provide a
    ``self._cache`` dictionary.

    cs^�jf|}t|���D]}||7}q||jvr|j|S�|g|�Ri|��}||j|<|S�N)�__name__�sorted�items�_cache)�self�args�kwargs�key�pair�data��func��2/usr/lib/python3/dist-packages/botocore/loaders.py�_wrapper~s



z instance_cache.<locals>._wrapperr)rrrrr�instance_cacheus		rc@� eZdZdZdd�Zdd�ZdS)�JSONFileLoaderzeLoader JSON files.

    This class can load the default format of models, which is a JSON file.

    cCstj�|d�S)z�Checks if the file exists.

        :type file_path: str
        :param file_path: The full path to the file to load without
            the '.json' extension.

        :return: True if file path exists, False otherwise.

        �.json)�os�path�isfile)r�	file_pathrrr�exists�s
zJSONFileLoader.existscCsj|d}tj�|�sdSt|d��}|���d�}Wd�n1s#wYt�d|�tj	|t
d�S)z�Attempt to load the file path.

        :type file_path: str
        :param file_path: The full path to the file to load without
            the '.json' extension.

        :return: The loaded data if it exists, otherwise None.

        rN�rbzutf-8zLoading JSON file: %s)�object_pairs_hook)rrr�open�read�decode�logger�debugr�loadsr)rr �	full_path�fp�payloadrrr�	load_file�s
�zJSONFileLoader.load_fileN)r
�
__module__�__qualname__�__doc__r!r-rrrrr�srcCsP|durt�Sg}|�tj�}|D]}tj�tj�|��}|�|�qt|d�S)a�Create a Loader class.

    This factory function creates a loader given a search string path.

    :type search_string_path: str
    :param search_string_path: The AWS_DATA_PATH value.  A string
        of data path values separated by the ``os.path.pathsep`` value,
        which is typically ``:`` on POSIX platforms and ``;`` on
        windows.

    :return: A ``Loader`` instance.

    N)�extra_search_paths)�Loader�splitr�pathsepr�
expanduser�
expandvars�append)�search_path_string�paths�extra_pathsrrrr�
create_loader�s
r;c@s�eZdZdZeZej�e	d�Z
ej�ej�d�dd�ZdgZ
			dd	d
�Zedd��Zed
d��Zedd��Zedd��Zedd��Zeddd��Zdd�Zedd��Z		d dd�ZdS)!r2z�Find and load data models.

    This class will handle searching for and loading data models.

    The main method used here is ``load_service_model``, which is a
    convenience method over ``load_data`` and ``determine_latest_version``.

    r�~z.aws�models�sdkNTcCsni|_|dur|��}||_|dur||_ng|_|r%|j�|j|jg�g|_|r1|j�|j�t	�|_
dSr	)r
�FILE_LOADER_CLASS�file_loader�
_search_paths�extend�CUSTOMER_DATA_PATH�BUILTIN_DATA_PATH�
_extras_types�BUILTIN_EXTRAS_TYPES�ExtrasProcessor�_extras_processor)rr1r@�cache�include_default_search_paths�include_default_extrasrrr�__init__�s
�zLoader.__init__cC�|jSr	)rA�rrrr�search_paths��zLoader.search_pathscCrMr	)rErNrrr�extras_types�rPzLoader.extras_typesc	s�t�}|��D]9��fdd�t���D�}|D](}tj��|�}t�|�}|D]}tj�|||�}|j�|�r>|�|�nq'qqt	|�S)apList all known services.

        This will traverse the search path and look for all known
        services.

        :type type_name: str
        :param type_name: The type of the service (service-2,
            paginators-1, waiters-2, etc).  This is needed because
            the list of available services depends on the service
            type.  For example, the latest API version available for
            a resource-1.json file may not be the latest API version
            available for a services-2.json file.

        :return: A list of all services.  The list of services will
            be sorted.

        cs&g|]}tj�tj��|��r|�qSr)rr�isdir�join)�.0�d��
possible_pathrr�
<listcomp>s��z2Loader.list_available_services.<locals>.<listcomp>)
�set�_potential_locationsr�listdirrrSr@r!�addr)	r�	type_name�services�possible_services�service_name�full_dirname�api_versions�api_version�full_load_pathrrVr�list_available_services�s(
�
�
���
zLoader.list_available_servicescCst|�||��S)aFind the latest API version available for a service.

        :type service_name: str
        :param service_name: The name of the service.

        :type type_name: str
        :param type_name: The type of the service (service-2,
            paginators-1, waiters-2, etc).  This is needed because
            the latest API version available can depend on the service
            type.  For example, the latest API version available for
            a resource-1.json file may not be the latest API version
            available for a services-2.json file.

        :rtype: str
        :return: The latest API version.  If the service does not exist
            or does not have any available API data, then a
            ``DataNotFoundError`` exception will be raised.

        )�max�list_api_versions)rr`r]rrr�determine_latest_version"szLoader.determine_latest_versioncCsht�}|j|ddd�D]}t�|�D]}tj�|||�}|j�|�r'|�|�qq|s0t	|d��t
|�S)ayList all API versions available for a particular service type

        :type service_name: str
        :param service_name: The name of the service

        :type type_name: str
        :param type_name: The type name for the service (i.e service-2,
            paginators-1, etc.)

        :rtype: list
        :return: A list of API version strings in sorted order.

        T)�
must_exist�is_dir��	data_path)rYrZrr[rrSr@r!r\rr)rr`r]�known_api_versionsrW�dirnamer*rrrrg9s
�
��
zLoader.list_api_versionscCsv|�|�}||vrt|d�t|��d��|dur|�||�}tj�|||�}|�|�}|�|||�}|j	�
||�|S)aJLoad a botocore service model

        This is the main method for loading botocore models (e.g. a service
        model, pagination configs, waiter configs, etc.).

        :type service_name: str
        :param service_name: The name of the service (e.g ``ec2``, ``s3``).

        :type type_name: str
        :param type_name: The model type.  Valid types include, but are not
            limited to: ``service-2``, ``paginators-1``, ``waiters-2``.

        :type api_version: str
        :param api_version: The API version to load.  If this is not
            provided, then the latest API version will be used.

        :type load_extras: bool
        :param load_extras: Whether or not to load the tool extras which
            contain additional data to be added to the model.

        :raises: UnknownServiceError if there is no known service with
            the provided service_name.

        :raises: DataNotFoundError if no data could be found for the
            service_name/type_name/api_version.

        :return: The loaded data, as a python type (e.g. dict, list, etc).
        z, )r`�known_service_namesN)rerrSrrhrr�	load_data�_find_extrasrH�process)rr`r]rc�known_servicesr*�model�extras_datarrr�load_service_modelWs
 ��
zLoader.load_service_modelc	csP�|jD]!}d||f}tj�|||�}z|�|�VWqty%YqwdS)z-Creates an iterator over all the extras data.z%s.%s-extrasN)rQrrrSrpr)rr`r]rc�extras_type�extras_namer*rrrrq�s�
��zLoader._find_extrascCs6|�|�D]}|j�|�}|dur|Sqt|d��)a0Load data given a data path.

        This is a low level method that will search through the various
        search paths until it's able to load a value.  This is typically
        only needed to load *non* model files (such as _endpoints and
        _retry).  If you need to load model files, you should prefer
        ``load_service_model``.

        :type name: str
        :param name: The data path, i.e ``ec2/2015-03-01/service-2``.

        :return: The loaded data.  If no data could be found then
            a DataNotFoundError is raised.

        Nrk)rZr@r-r)r�namerW�foundrrrrp�s�
zLoader.load_dataFccsn�|jD]0}tj�|�r4|}|durtj�||�}|s|Vq|r+tj�|�r+|Vqtj�|�r4|VqdSr	)rOrrrRrSr!)rryrirjrr*rrrrZ�s�
��zLoader._potential_locations)NNNTTr	)NFF)r
r.r/r0rr?rrrSrrDr5rCrFrL�propertyrOrQrrerhrgrvrqrprZrrrrr2�s<�
�


(

0
�r2c@r)rGz5Processes data from extras files into service models.cCs|D]}|�||�qdS)a$Processes data from a list of loaded extras files into a model

        :type original_model: dict
        :param original_model: The service model to load all the extras into.

        :type extra_models: iterable of dict
        :param extra_models: A list of loaded extras models.
        N)�_process)r�original_model�extra_models�extrasrrrrr�s	�zExtrasProcessor.processcCsd|vr
t||d�dSdS)z3Process a single extras model into a service model.�mergeNr)rrt�extra_modelrrrr|�s�zExtrasProcessor._processN)r
r.r/r0rrr|rrrrrG�srGr	)r0r�logging�botocorer�botocore.compatrr�botocore.exceptionsrr�botocore.utilsr�	getLoggerr
r'r�objectrr;r2rGrrrr�<module>s[

)s