|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/boto/sdb/__pycache__/ |
Upload File : |
o
ckF[�e � @ s� d dl Zd dlZd dlZd dlmZ d dlmZ d dlmZm Z d dl
m Z d dl m
Z
d dlmZ G dd � d ej�ZG d
d � d e�ZdS ) � N)�handler)�AWSQueryConnection)�Domain�DomainMetaData)�Item)�
SDBRegionInfo)�SDBResponseErrorc s( e Zd ZdZ� fdd�Zdd� Z� ZS )�
ItemThreadaj
A threaded :class:`Item <boto.sdb.item.Item>` retriever utility class.
Retrieved :class:`Item <boto.sdb.item.Item>` objects are stored in the
``items`` instance variable after :py:meth:`run() <run>` is called.
.. tip:: The item retrieval will not start until
the :func:`run() <boto.sdb.connection.ItemThread.run>` method is called.
c s0 t t| �j|d� || _t� | _|| _g | _dS )a�
:param str name: A thread name. Used for identification.
:param str domain_name: The name of a SimpleDB
:class:`Domain <boto.sdb.domain.Domain>`
:type item_names: string or list of strings
:param item_names: The name(s) of the items to retrieve from the specified
:class:`Domain <boto.sdb.domain.Domain>`.
:ivar list items: A list of items retrieved. Starts as empty list.
)�nameN)�superr �__init__� domain_name�
SDBConnection�conn�
item_names�items)�selfr
r
r �� __class__� �5/usr/lib/python3/dist-packages/boto/sdb/connection.pyr ( s
zItemThread.__init__c C s, | j D ]}| j�| j|�}| j�|� qdS )z�
Start the threaded retrieval of items. Populates the
``items`` list with :class:`Item <boto.sdb.item.Item>` objects.
N)r r �get_attributesr
r �append)r � item_name�itemr r r �run9 s
�zItemThread.run)�__name__�
__module__� __qualname__�__doc__r r �
__classcell__r r r r r s r c s e Zd ZdZdZdZdZeZ d8� fd d
� Z d d � Z
d
d� Z d9dd�Z dd� Z
d:dd�Zdd� Zdd� Zdd � Zd;d d �Zd;d d �Zd<d!d"�Zd#d$� Zd%d&� Zd'd(� Zd)d*� Z d=d+d,�Zd;d-d.�Z d>d/d0�Z d<d1d2�Z d3d4� Z d?d6d7�Z � Z S )@r a�
This class serves as a gateway to your SimpleDB region (defaults to
us-east-1). Methods within allow access to SimpleDB
:class:`Domain <boto.sdb.domain.Domain>` objects and their associated
:class:`Item <boto.sdb.item.Item>` objects.
.. tip::
While you may instantiate this class directly, it may be easier to
go through :py:func:`boto.connect_sdb`.
z us-east-1zsdb.us-east-1.amazonaws.comz
2009-04-15NTr �/c s� | s t j�dd| j�}t j�� D ] }|j|kr|} nq| | _tt | �j
||||||||| jj | |
| |||d� d| _ |
| _
t| _dS )aZ
For any keywords that aren't documented, refer to the parent class,
:py:class:`boto.connection.AWSAuthConnection`. You can avoid having
to worry about these keyword arguments by instantiating these objects
via :py:func:`boto.connect_sdb`.
:type region: :class:`boto.sdb.regioninfo.SDBRegionInfo`
:keyword region: Explicitly specify a region. Defaults to ``us-east-1``
if not specified. You may also specify the region in your ``boto.cfg``:
.. code-block:: cfg
[SDB]
region = eu-west-1
�SDB�region)�security_token�validate_certs� profile_nameg N)�boto�config�get�DefaultRegionName�sdb�regionsr
r# r r r �endpoint� box_usage� converterr �item_cls)r �aws_access_key_id�aws_secret_access_key� is_secure�port�proxy�
proxy_port�
proxy_user�
proxy_pass�debug�https_connection_factoryr# �pathr/ r$ r% r& � region_name�regr r r r T s*
� �
zSDBConnection.__init__c C s dgS )Nr+ r �r r r r �_required_auth_capability s z'SDBConnection._required_auth_capabilityc C s
|| _ dS )a
While the default item class is :py:class:`boto.sdb.item.Item`, this
default may be overridden. Use this method to change a connection's
item class.
:param object cls: The new class to set as this connection's item
class. See the default item class for inspiration as to what your
replacement should/could look like.
N)r0 )r �clsr r r � set_item_cls� s
zSDBConnection.set_item_clsF� Attributec
C s� t |�� �}d}|D ]_}|| }t|t�rB|D ])} ||d||f < | jr*| j�| �} | |d||f < |r<d|d||f < |d7 }qn#||d||f < | jrS| j�|�}||d||f < |red|d||f < |d7 }q
d S )N� z
%s.%d.Namez %s.%d.Value�truez
%s.%d.Replace)�sorted�keys�
isinstance�listr/ �encode)
r �params�
attributes�replace�labelrF �i�key�value�vr r r �_build_name_value_list� s,
�
�z$SDBConnection._build_name_value_listc C sL |d |d< |d du rd|d< d S |d du r d|d< d S |d |d < d S )
Nr zExpected.1.NamerC TrD zExpected.1.ExistsF�falsezExpected.1.Valuer )r rJ �expected_valuer r r �_build_expected_value� s z#SDBConnection._build_expected_valuec
C s |� � }d}|D ]|}||d| < d}|| }|d ur�|� � } | D ]_}
||
} t| t�rX| D ])} | jr8| j�| �} |
|d||f < | |d||f < |rRd|d||f < |d7 }q-q |
|d||f < | jri| j�| �} | |d||f < |r{d|d||f < |d7 }q |d7 }qd S )Nr zItem.%d.ItemNamezItem.%d.Attribute.%d.NamezItem.%d.Attribute.%d.ValuerD z Item.%d.Attribute.%d.ReplacerC )rF rG rH r/ rI )
r rJ r rL r rN r �jr �
attr_names� attr_namerP rQ r r r �_build_batch_list� s:
�
�z SDBConnection._build_batch_listc C s. d}|� � |D ] }||d| < |d7 }qd S )NrC zAttribute.%d.Name)�sort)r rJ �attribute_namesrN r
r r r �_build_name_list� s
�z SDBConnection._build_name_listc C s | j S )a�
Returns the BoxUsage (in USD) accumulated on this specific SDBConnection
instance.
.. tip:: This can be out of date, and should only be treated as a
rough estimate. Also note that this estimate only applies to the
requests made on this specific connection instance. It is by
no means an account-wide estimate.
:rtype: float
:return: The accumulated BoxUsage of all requests made on the connection.
)r. r> r r r � get_usage� s
zSDBConnection.get_usagec C s( t d| j � | jd }t d| � dS )a�
Print the BoxUsage and approximate costs of all requests made on
this specific SDBConnection instance.
.. tip:: This can be out of date, and should only be treated as a
rough estimate. Also note that this estimate only applies to the
requests made on this specific connection instance. It is by
no means an account-wide estimate.
z Total Usage: %f compute secondsg�Q� ��?zApproximate Cost: $%fN)�printr. )r �costr r r � print_usage� s
zSDBConnection.print_usagec C s" t | |�}|r| �|d| � |S )a�
Retrieves a :py:class:`boto.sdb.domain.Domain` object whose name
matches ``domain_name``.
:param str domain_name: The name of the domain to retrieve
:keyword bool validate: When ``True``, check to see if the domain
actually exists. If ``False``, blindly return a
:py:class:`Domain <boto.sdb.domain.Domain>` object with the
specified name set.
:raises:
:py:class:`boto.exception.SDBResponseError` if ``validate`` is
``True`` and no match could be found.
:rtype: :py:class:`boto.sdb.domain.Domain`
:return: The requested domain
zselect * from `%s` limit 1)r �select�r r
�validate�domainr r r �
get_domain� s
zSDBConnection.get_domainc C s$ z | � ||�}W |S d}Y |S )a�
Lookup an existing SimpleDB domain. This differs from
:py:meth:`get_domain` in that ``None`` is returned if ``validate`` is
``True`` and no match was found (instead of raising an exception).
:param str domain_name: The name of the domain to retrieve
:param bool validate: If ``True``, a ``None`` value will be returned
if the specified domain can't be found. If ``False``, a
:py:class:`Domain <boto.sdb.domain.Domain>` object will be dumbly
returned, regardless of whether it actually exists.
:rtype: :class:`boto.sdb.domain.Domain` object or ``None``
:return: The Domain object or ``None`` if the domain does not exist.
N)re rb r r r �lookup s �zSDBConnection.lookupc C s0 i }|r||d< |r||d< | � d|dtfg�S )aI
Returns a :py:class:`boto.resultset.ResultSet` containing
all :py:class:`boto.sdb.domain.Domain` objects associated with
this connection's Access Key ID.
:keyword int max_domains: Limit the returned
:py:class:`ResultSet <boto.resultset.ResultSet>` to the specified
number of members.
:keyword str next_token: A token string that was returned in an
earlier call to this method as the ``next_token`` attribute
on the returned :py:class:`ResultSet <boto.resultset.ResultSet>`
object. This attribute is set if there are more than Domains than
the value specified in the ``max_domains`` keyword. Pass the
``next_token`` value from you earlier query in this keyword to
get the next 'page' of domains.
�MaxNumberOfDomains� NextToken� ListDomains�
DomainName)�get_listr )r � max_domains�
next_tokenrJ r r r �get_all_domains s z SDBConnection.get_all_domainsc C s d|i}| � d|t�}||_|S )z�
Create a SimpleDB domain.
:type domain_name: string
:param domain_name: The name of the new domain
:rtype: :class:`boto.sdb.domain.Domain` object
:return: The newly created domain
rj � CreateDomain)�
get_objectr r
)r r
rJ �dr r r �
create_domain6 s
zSDBConnection.create_domainc C s" t |t�r
||jfS | �|�|fS )a�
Given a ``str`` or :class:`boto.sdb.domain.Domain`, return a
``tuple`` with the following members (in order):
* In instance of :class:`boto.sdb.domain.Domain` for the requested
domain
* The domain's name as a ``str``
:type domain_or_name: ``str`` or :class:`boto.sdb.domain.Domain`
:param domain_or_name: The domain or domain name to get the domain
and name for.
:raises: :class:`boto.exception.SDBResponseError` when an invalid
domain name is specified.
:rtype: tuple
:return: A ``tuple`` with contents outlined as per above.
)rG r r
re )r �domain_or_namer r r �get_domain_and_nameE s
z!SDBConnection.get_domain_and_namec C s" | � |�\}}d|i}| �d|�S )aX
Delete a SimpleDB domain.
.. caution:: This will delete the domain and all items within the domain.
:type domain_or_name: string or :class:`boto.sdb.domain.Domain` object.
:param domain_or_name: Either the name of a domain or a Domain object
:rtype: bool
:return: True if successful
rj � DeleteDomain)rt �
get_status)r rs rd r
rJ r r r �
delete_domain] s
zSDBConnection.delete_domainc C s. | � |�\}}d|i}| �d|t�}||_|S )aR
Get the Metadata for a SimpleDB domain.
:type domain_or_name: string or :class:`boto.sdb.domain.Domain` object.
:param domain_or_name: Either the name of a domain or a Domain object
:rtype: :class:`boto.sdb.domain.DomainMetaData` object
:return: The newly created domain metadata object
rj �DomainMetadata)rt rp r rd )r rs rd r
rJ rq r r r �domain_metadatan s
z SDBConnection.domain_metadatac C sB | � |�\}}||d�}| �|||� |r| �||� | �d|�S )a�
Store attributes for a given item in a domain.
:type domain_or_name: string or :class:`boto.sdb.domain.Domain` object.
:param domain_or_name: Either the name of a domain or a Domain object
:type item_name: string
:param item_name: The name of the item whose attributes are being
stored.
:type attribute_names: dict or dict-like object
:param attribute_names: The name/value pairs to store as attributes
:type expected_value: list
:param expected_value: If supplied, this is a list or tuple consisting
of a single attribute name and expected value. The list can be
of the form:
* ['name', 'value']
In which case the call will first verify that the attribute "name"
of this item has a value of "value". If it does, the delete
will proceed, otherwise a ConditionalCheckFailed error will be
returned. The list can also be of the form:
* ['name', True|False]
which will simply check for the existence (True) or
non-existence (False) of the attribute.
:type replace: bool
:param replace: Whether the attribute values passed in will replace
existing values or will be added as addition values.
Defaults to True.
:rtype: bool
:return: True if successful
�rj �ItemName�
PutAttributes)rt rR rU rv ) r rs r rK rL rT rd r
rJ r r r �put_attributes~ s (� z SDBConnection.put_attributesc C s4 | � |�\}}d|i}| �|||� | jd|dd�S )a|
Store attributes for multiple items in a domain.
:type domain_or_name: string or :class:`boto.sdb.domain.Domain` object.
:param domain_or_name: Either the name of a domain or a Domain object
:type items: dict or dict-like object
:param items: A dictionary-like object. The keys of the dictionary are
the item names and the values are themselves dictionaries
of attribute names/values, exactly the same as the
attribute_names parameter of the scalar put_attributes
call.
:type replace: bool
:param replace: Whether the attribute values passed in will replace
existing values or will be added as addition values.
Defaults to True.
:rtype: bool
:return: True if successful
rj �BatchPutAttributes�POST��verb�rt rY rv )r rs r rL rd r
rJ r r r �batch_put_attributes� s z"SDBConnection.batch_put_attributesc C s� | � |�\}}||d�}|rd|d< |r#t|t�s |g}| �||d� | �d|�} | �� }
| jdkrK|du r<| �||�}t� || �} t
j � |
| � |S t
| j| j|
��)a
Retrieve attributes for a given item in a domain.
:type domain_or_name: string or :class:`boto.sdb.domain.Domain` object.
:param domain_or_name: Either the name of a domain or a Domain object
:type item_name: string
:param item_name: The name of the item whose attributes are
being retrieved.
:type attribute_names: string or list of strings
:param attribute_names: An attribute name or list of attribute names.
This parameter is optional. If not supplied, all attributes will
be retrieved for the item.
:type consistent_read: bool
:param consistent_read: When set to true, ensures that the most recent
data is returned.
:type item: :class:`boto.sdb.item.Item`
:keyword item: Instead of instantiating a new Item object, you may
specify one to update.
:rtype: :class:`boto.sdb.item.Item`
:return: An Item with the requested attribute name/values set on it
rz rD �ConsistentRead�
AttributeName�
GetAttributes�� N)rt rG rH �build_list_params� make_request�read�statusr0 r �
XmlHandler�xml�sax� parseStringr �reason) r rs r r[ �consistent_readr rd r
rJ �response�body�hr r r r � s& �
z SDBConnection.get_attributesc C sr | � |�\}}||d�}|r+t|t�r| �||� nt|t�s%t|| j�r+| �||� |r3| �||� | �d|�S )a�
Delete attributes from a given item in a domain.
:type domain_or_name: string or :class:`boto.sdb.domain.Domain` object.
:param domain_or_name: Either the name of a domain or a Domain object
:type item_name: string
:param item_name: The name of the item whose attributes are being
deleted.
:type attributes: dict, list or :class:`boto.sdb.item.Item`
:param attributes: Either a list containing attribute names which
will cause all values associated with that attribute
name to be deleted or a dict or Item containing the
attribute names and keys and list of values to
delete as the value. If no value is supplied,
all attribute name/values for the item will be
deleted.
:type expected_value: list
:param expected_value: If supplied, this is a list or tuple consisting
of a single attribute name and expected value. The list can be
of the form:
* ['name', 'value']
In which case the call will first verify that the attribute "name"
of this item has a value of "value". If it does, the delete
will proceed, otherwise a ConditionalCheckFailed error will be
returned. The list can also be of the form:
* ['name', True|False]
which will simply check for the existence (True) or
non-existence (False) of the attribute.
:rtype: bool
:return: True if successful
rz �DeleteAttributes) rt rG rH r\ �dictr0 rR rU rv )r rs r rW rT rd r
rJ r r r �delete_attributes� s )�
z SDBConnection.delete_attributesc C s4 | � |�\}}d|i}| �||d� | jd|dd�S )a]
Delete multiple items in a domain.
:type domain_or_name: string or :class:`boto.sdb.domain.Domain` object.
:param domain_or_name: Either the name of a domain or a Domain object
:type items: dict or dict-like object
:param items: A dictionary-like object. The keys of the dictionary are
the item names and the values are either:
* dictionaries of attribute names/values, exactly the
same as the attribute_names parameter of the scalar
put_attributes call. The attribute name/value pairs
will only be deleted if they match the name/value
pairs passed in.
* None which means that all attributes associated
with the item should be deleted.
:return: True if successful
rj F�BatchDeleteAttributesr r� r� )r rs r rd r
rJ r r r �batch_delete_attributes. s z%SDBConnection.batch_delete_attributes� c
C sx | � |�\}}d|i}|rd|d< |r||d< z| jd|d| jfg|d�W S ty; } z
d||jf |_|�d }~ww )
a�
Returns a set of Attributes for item names within domain_name that
match the query. The query must be expressed in using the SELECT
style syntax rather than the original SimpleDB query language.
Even though the select request does not require a domain object,
a domain object must be passed into this method so the Item objects
returned can point to the appropriate domain.
:type domain_or_name: string or :class:`boto.sdb.domain.Domain` object
:param domain_or_name: Either the name of a domain or a Domain object
:type query: string
:param query: The SimpleDB query to be performed.
:type consistent_read: bool
:param consistent_read: When set to true, ensures that the most recent
data is returned.
:rtype: ResultSet
:return: An iterator containing the results.
�SelectExpressionrD r� rh �Selectr )�parentz Query: %s
%sN)rt rk r0 r r� ) r rs �queryrm r� rd r
rJ �er r r ra H s ���zSDBConnection.select)NNTNNNNNr NNr! NNTN)FrB )F)T)NN)TN)NFN)r� NF) r r r r r* �DefaultRegionEndpoint�
APIVersionr �
ResponseErrorr r? rA rR rU rY r\ r] r` re rf rn rr rt rw ry r} r� r r� r� ra r r r r r r D sV
�+
�
�
0
�0
�5�r )�xml.saxr� � threadingr' r �boto.connectionr �boto.sdb.domainr r �
boto.sdb.itemr �boto.sdb.regioninfor �boto.exceptionr �Threadr r r r r r �<module> s %