File: //lib/python3/dist-packages/boto3/resources/__pycache__/collection.cpython-312.pyc
�
��e*K � � � d dl Z d dlZd dlmZ d dlmZ ddlmZ ddlm Z ddl
m Z dd l m
Z
ej e� Z G d
� d � Z G d � d
� Z G d� d� Zy)� N)�
xform_name)� merge_dicts� )� docstring� )� BatchAction)�create_request_parameters)�ResourceHandlerc �F � e Zd ZdZd� Zd� Zd� Zd� Zd� Zd� Z d� Z
d � Z d
� Z y ) �ResourceCollectiona�
Represents a collection of resources, which can be iterated through,
optionally with filtering. Collections automatically handle pagination
for you.
See :ref:`guide_collections` for a high-level overview of collections,
including when remote service requests are performed.
:type model: :py:class:`~boto3.resources.model.Collection`
:param model: Collection model
:type parent: :py:class:`~boto3.resources.base.ServiceResource`
:param parent: The collection's parent resource
:type handler: :py:class:`~boto3.resources.response.ResourceHandler`
:param handler: The resource response handler used to create resource
instances
c � � || _ || _ t |j j � | _ || _ t j |� | _ y �N)
�_model�_parentr �request� operation�_py_operation_name�_handler�copy�deepcopy�_params)�self�model�parent�handler�kwargss �</usr/lib/python3/dist-packages/boto3/resources/collection.py�__init__zResourceCollection.__init__. s> � ��� � �� �",�U�]�]�-D�-D�"E�� � ��
��}�}�V�,�� � c � � dj | j j | j dj | j j j
| j j j � � S �Nz
{}({}, {})z{}.{}� �format� __class__�__name__r �meta� service_namer �resource�type�r s r �__repr__zResourceCollection.__repr__5 �Z � ��"�"� �N�N� #� #� �L�L� �N�N�� � �!�!�.�.�� � �0D�0D�0I�0I�
�
�
r c # � K � | j j dd� }d}| j � D ] }|D ] }|�� |dz
}|��||k\ s� y � y�w)a�
A generator which yields resource instances after doing the
appropriate service operation calls and handling any pagination
on your behalf.
Page size, item limit, and filter parameters are applied
if they have previously been set.
>>> bucket = s3.Bucket('boto3')
>>> for obj in bucket.objects.all():
... print(obj.key)
'key1'
'key2'
�limitNr r )r �get�pages)r r. �count�page�items r �__iter__zResourceCollection.__iter__> sf � �� � � � � � ��$�/�����J�J�L� �D� �
���
� ��
���$��%� ��
� �s �AA�A� Ac �� � t j | j � }t ||d�� | j | j
| j | j fi |��}|S )aO
Create a clone of this collection. This is used by the methods
below to provide a chainable interface that returns copies
rather than the original. This allows things like:
>>> base = collection.filter(Param1=1)
>>> query1 = base.filter(Param2=2)
>>> query2 = base.filter(Param3=3)
>>> query1.params
{'Param1': 1, 'Param2': 2}
>>> query2.params
{'Param1': 1, 'Param3': 3}
:rtype: :py:class:`ResourceCollection`
:return: A clone of this resource collection
T�� append_lists)r r r r r$ r r r )r r �params�clones r �_clonezResourceCollection._clone[ sT � �" � � �t�|�|�,���F�F��6� ���� �K�K�� � �t�}�}�
�8>�
�� � r c # �� K � | j j j }| j j � }|j dd� }|j dd� }t
| j | j j � }t ||d�� |j | j � rst j d| j j j | j |� |j | j � } |j d d||d�i|��}n]t j d | j j j | j |� t# || j � d i |��g}d
}|D ]T } g }
| j% | j || � D ]" } |
j' | � |d z
}|�� ||k\ s�" n |
�� |��N||k\ s�T y y�w)
a�
A generator which yields pages of resource instances after
doing the appropriate service operation calls and handling
any pagination on your behalf. Non-paginated calls will
return a single page of items.
Page size, item limit, and filter parameters are applied
if they have previously been set.
>>> bucket = s3.Bucket('boto3')
>>> for page in bucket.objects.pages():
... for obj in page:
... print(obj.key)
'key1'
'key2'
:rtype: list(:py:class:`~boto3.resources.base.ServiceResource`)
:return: List of resource instances
r. N� page_sizeTr6 z Calling paginated %s:%s with %r�PaginationConfig)�MaxItems�PageSizezCalling %s:%s with %rr r � )r r& �clientr r �popr r r r � can_paginater �logger�debugr' �
get_paginator�paginate�getattrr �append) r rA �cleaned_paramsr. r< r8 � paginatorr0 r1 r2 �
page_itemsr3 s r r0 zResourceCollection.pagess s� � �� �( � � �"�"�)�)�� � � �*�*�,�� �"�"�7�D�1��"�&�&�{�D�9� �*�4�<�<����9L�9L�M���F�N��>� � � �t� 6� 6� 7� �L�L�1�� � �!�!�.�.��'�'��
� �,�,�T�-D�-D�E�I�&�I�&�&� �.3��!K����E�
�L�L�'�� � �!�!�.�.��'�'��
� >�W�V�T�%<�%<�=�G��G�H�E� ��� �D��J� �
�
�d�l�l�F�D�A�
���!�!�$�'� ��
���$��%� ��
� � � � �U�e�^�� �s �GG �G � G �G � G c �" � | j � S )a
Get all items from the collection, optionally with a custom
page size and item count limit.
This method returns an iterable generator which yields
individual resource instances. Example use::
# Iterate through items
>>> for queue in sqs.queues.all():
... print(queue.url)
'https://url1'
'https://url2'
# Convert to list
>>> queues = list(sqs.queues.all())
>>> len(queues)
2
�r: r* s r �allzResourceCollection.all� s � �& �{�{�}� r c �& � | j di |��S )a�
Get items from the collection, passing keyword arguments along
as parameters to the underlying service operation, which are
typically used to filter the results.
This method returns an iterable generator which yields
individual resource instances. Example use::
# Iterate through items
>>> for queue in sqs.queues.filter(Param='foo'):
... print(queue.url)
'https://url1'
'https://url2'
# Convert to list
>>> queues = list(sqs.queues.filter(Param='foo'))
>>> len(queues)
2
:rtype: :py:class:`ResourceCollection`
r@ rN �r r s r �filterzResourceCollection.filter� s � �, �t�{�{�$�V�$�$r c �& � | j |�� S )a�
Return at most this many resources.
>>> for bucket in s3.buckets.limit(5):
... print(bucket.name)
'bucket1'
'bucket2'
'bucket3'
'bucket4'
'bucket5'
:type count: int
:param count: Return no more than this many items
:rtype: :py:class:`ResourceCollection`
�r. rN �r r1 s r r. zResourceCollection.limit� s � � �{�{��{�'�'r c �& � | j |�� S )a3
Fetch at most this many resources per service request.
>>> for obj in s3.Bucket('boto3').objects.page_size(100):
... print(obj.key)
:type count: int
:param count: Fetch this many items per request
:rtype: :py:class:`ResourceCollection`
�r< rN rU s r r< z ResourceCollection.page_size� s � � �{�{�U�{�+�+r N)
r% �
__module__� __qualname__�__doc__r r+ r4 r: r0 rO rR r. r< r@ r r r r s6 � ��"-�
��:�0G�R �*%�0(�$ ,r r c �R � e Zd ZdZeZd� Zd� Zd� Zd� Z ej j e _ d� Z
ej j e
_ d� Z ej j e _ d� Z ej j e _ d � Z
ej j e
_ y
) �CollectionManagera
A collection manager provides access to resource collection instances,
which can be iterated and filtered. The manager exposes some
convenience functions that are also found on resource collections,
such as :py:meth:`~ResourceCollection.all` and
:py:meth:`~ResourceCollection.filter`.
Get all items::
>>> for bucket in s3.buckets.all():
... print(bucket.name)
Get only some items via filtering::
>>> for queue in sqs.queues.filter(QueueNamePrefix='AWS'):
... print(queue.url)
Get whole pages of items:
>>> for page in s3.Bucket('boto3').objects.pages():
... for obj in page:
... print(obj.key)
A collection manager is not iterable. You **must** call one of the
methods that return a :py:class:`ResourceCollection` before trying
to iterate, slice, or convert to a list.
See the :ref:`guide_collections` guide for a high-level overview
of collections, including when remote service requests are performed.
:type collection_model: :py:class:`~boto3.resources.model.Collection`
:param model: Collection model
:type parent: :py:class:`~boto3.resources.base.ServiceResource`
:param parent: The collection's parent resource
:type factory: :py:class:`~boto3.resources.factory.ResourceFactory`
:param factory: The resource factory to create new resources
:type service_context: :py:class:`~boto3.utils.ServiceContext`
:param service_context: Context about the AWS service
c �� � || _ | j j j }|| _ |j j
}t
|||j ||�� | _ y )N)� search_path�factory�resource_model�service_context�operation_name)r r r r r( �pathr
r )r �collection_modelr r_ ra rb r^ s r r zCollectionManager.__init__8 sW � �&�� � ���,�,�6�6�� �� �&�/�/�4�4� �'�#��+�4�4� +�)�
��
r c � � dj | j j | j dj | j j j
| j j j � � S r! r" r* s r r+ zCollectionManager.__repr__F r, r c �h � | j | j | j | j fi |��S )z�
Get a resource collection iterator from this manager.
:rtype: :py:class:`ResourceCollection`
:return: An iterable representing the collection of resources
)�_collection_clsr r r rQ s r �iteratorzCollectionManager.iteratorO s4 � � $�t�#�#� �K�K�� � �t�}�}�
�8>�
�
r c �" � | j � S r �rh r* s r rO zCollectionManager.all[ s � ��}�}�� r c �& � | j di |��S )Nr@ rj rQ s r rR zCollectionManager.filter` s � � �t�}�}�&�v�&�&r c �& � | j |�� S )NrT rj rU s r r. zCollectionManager.limite s � ��}�}�5�}�)�)r c �& � | j |�� S )NrW rj rU s r r< zCollectionManager.page_sizej s � ��}�}�u�}�-�-r c �> � | j � j � S r )rh r0 r* s r r0 zCollectionManager.pageso s � ��}�}��$�$�&�&r N)r% rX rY rZ r rg r r+ rh rO rR r. r< r0 r@ r r r\ r\ s� � �)�X )�O�
�
�
� � %�(�(�0�0�C�K�'� (�.�.�6�6�F�N�*� '�,�,�4�4�E�M�.� +�4�4�<�<�I��'� '�,�,�4�4�E�Mr r\ c �( � e Zd ZdZd� Zd� Zd� Zd� Zy)�CollectionFactoryz�
A factory to create new
:py:class:`CollectionManager` and :py:class:`ResourceCollection`
subclasses from a :py:class:`~boto3.resources.model.Collection`
model. These subclasses include methods to perform batch operations.
c � � i }|j }| j ||||j |� | j ||||j |t �� |j
|k( r dj
|j
|� }n dj
|j
||� }t t |� t f|� }| j ||||j |t �� ||d< |dz
}t t |� t f|� S )a�
Loads a collection from a model, creating a new
:py:class:`CollectionManager` subclass
with the correct properties and methods, named based on the service
and resource name, e.g. ec2.InstanceCollectionManager. It also
creates a new :py:class:`ResourceCollection` subclass which is used
by the new manager class.
:type resource_name: string
:param resource_name: Name of the resource to look up. For services,
this should match the ``service_name``.
:type service_context: :py:class:`~boto3.utils.ServiceContext`
:param service_context: Context about the AWS service
:type event_emitter: :py:class:`~botocore.hooks.HierarchialEmitter`
:param event_emitter: An event emitter
:rtype: Subclass of :py:class:`CollectionManager`
:return: The collection class.
)�attrs�
resource_namerd �
service_model�
event_emitter�
base_classz{}.{}Collectionz{}.{}.{}Collectionrg �Manager)
�name�_load_batch_actionsrt �#_load_documented_collection_methodsr r' r# r) �strr\ ) r rs rd ra ru rr �collection_name�cls_name�collection_clss r �load_from_definitionz&CollectionFactory.load_from_definition} s# � �0 ��*�/�/��
� � � � � � � )� )� �
�
�0�0��'� -�)�7�7�'�)�
1�
� � '� '�=� 8�(�/�/� �,�,�o��H� ,�2�2� �,�,�m�_��H� �c�(�m�.@�-B�E�J��
�0�0��'� -�)�7�7�'�(�
1�
� $2�� � ��I� ���C��M�$5�#7��?�?r c � � |j D ]0 }t |j � }| j ||||||� ||< �2 y)zv
Batch actions on the collection become methods on both
the collection manager and iterators.
N)�
batch_actionsr rx �_create_batch_action)r rr rs rd rt ru � action_model� snake_caseds r ry z%CollectionFactory._load_batch_actions� sP � � -� :� :� �L�$�\�%6�%6�7�K�!%�!:�!:� �� � � � �
"�E�+� � r c �V �� �fd�}t j |d|||d�� |_ ||d< �fd�}t j |d|||d�� |_ ||d< �fd�} t j |d|||d�� | _ | |d< �fd �}
t j |d
|||d�� |
_ |
|d
< y ) Nc �& �� �j | � S r )rO )r rv s �r rO zBCollectionFactory._load_documented_collection_methods.<locals>.all� s �� � �>�>�$�'� 'r rO F)rs � action_nameru rd rt �include_signaturec �* �� �j | fi |��S r )rR )r r rv s �r rR zECollectionFactory._load_documented_collection_methods.<locals>.filter� s �� �$�:�$�$�T�4�V�4� 4r rR c �( �� �j | |� S r rT �r r1 rv s �r r. zDCollectionFactory._load_documented_collection_methods.<locals>.limit s �� � �#�#�D�%�0� 0r r. c �( �� �j | |� S r rW r� s �r r< zHCollectionFactory._load_documented_collection_methods.<locals>.page_size s �� � �'�'��e�4� 4r r< )r �CollectionMethodDocstringrZ ) � factory_selfrr rs rd rt ru rv rO rR r. r< s ` r rz z5CollectionFactory._load_documented_collection_methods� s� �� � (� �9�9�'� �'� -�'� #�
�� � ��e� � 5� #�<�<�'� �'� -�'� #�
��� !��h�� 1� "�;�;�'� �'� -�'� #�
��
� ��g�� 5� &� ?� ?�'�#�'� -�'� #�
� �� '��k�r c � �� t |� ��fd�}t |� |_ t j |||||d�� |_ |S )zs
Creates a new method which makes a batch operation request
to the underlying service API.
c � �� �| g|��i |��S r r@ )r �argsr �actions �r � batch_actionz<CollectionFactory._create_batch_action.<locals>.batch_action0 s �� ��$�0��0��0� 0r F)rs ru �batch_action_modelrt rd r� )r r{ r% r �BatchActionDocstringrZ ) r� rs r� r� rd rt ru r� r� s @r r� z&CollectionFactory._create_batch_action! sP �� � �\�*�� 1� !$�K� 0� � � (� =� =�'�'� +�'� -� #�
� � � �r N)r% rX rY rZ r ry rz r� r@ r r rp rp u s � ��D@�L�.E'�N r rp )r �logging�botocorer �botocore.utilsr �docsr r� r r8 r �responser
� getLoggerr% rD r r\ rp r@ r r �<module>r� sW �� � � � &� � � -� %� �� � �8� $��j,� j,�Zi5� i5�XG � G r