|
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/sqs/__pycache__/ |
Upload File : |
o
ckF[tN � @ s0 d Z ddlmZ ddlmZ G dd� de�ZdS )z
Represents an SQS Queue
� )�urllib)�Messagec @ sj e Zd Zddefdd�Zdd� Zdd� Zee�Zdd � Z ee �Z
d
d � Z ee �Z d d
� Z
dd� Zdd� ZdKdd�Zdd� Zdd� Zdd� Zdd � Zd d � Z dLd d �ZdMd!d"�Zd#d$� ZdNd&d'�Z dOd)d*�Zd+d,� Zd-d.� Z d/d0� Z d1d2� Z d3d4� Z dPd6d7�Z dPd8d9�Z!dPd:d;�Z"dQd=d>�Z#dRd?d@�Z$dRdAdB�Z%e%Z&dCdD� Z'dMdEdF�Z(dRdGdH�Z)dRdIdJ�Z*e*Z+dS )S�QueueNc C s || _ || _|| _d | _d S �N)�
connection�url�
message_class�visibility_timeout)�selfr r r � r �0/usr/lib/python3/dist-packages/boto/sqs/queue.py�__init__ s
zQueue.__init__c C s
d| j S )Nz Queue(%s))r �r
r r r �__repr__% s
zQueue.__repr__c C s& | j rtj�| j �d }|S | j }|S )N� )r r �parse�urlparse�r
�valr r r �_id( s
�z Queue._idc C s0 | j rtj�| j �d �d�d }|S | j }|S )Nr �/)r r r r �splitr r r r �_name0 s
�z Queue._namec C sB | j �d�}| jjjdkrd}nd}d|| jjj|d |d f S )Nr z
cn-north-1zaws-cn�awszarn:%s:sqs:%s:%s:%s� r )�idr r �region�name)r
�parts� partitionr r r �_arn8 s �z
Queue._arnc C s d S r r )r
r �attrsr r r r � startElementB s zQueue.startElementc C s8 |dkr || _ d S |dkrt|�| _d S t| ||� d S )N�QueueUrl�VisibilityTimeout)r �intr �setattr)r
r �valuer r r r �
endElementE s
zQueue.endElementc C s
|| _ dS )aq
Set the message class that should be used when instantiating
messages read from the queue. By default, the class
:class:`boto.sqs.message.Message` is used but this can be overriden
with any class that behaves like a message.
:type message_class: Message-like class
:param message_class: The new Message class
N)r )r
r r r r �set_message_classM s
zQueue.set_message_class�Allc C � | j �| |�S )a�
Retrieves attributes about this queue object and returns
them in an Attribute instance (subclass of a Dictionary).
:type attributes: string
:param attributes: String containing one of:
ApproximateNumberOfMessages,
ApproximateNumberOfMessagesNotVisible,
VisibilityTimeout,
CreatedTimestamp,
LastModifiedTimestamp,
Policy
ReceiveMessageWaitTimeSeconds
:rtype: Attribute object
:return: An Attribute object which is a mapping type holding the
requested name/value pairs
)r �get_queue_attributes)r
�
attributesr r r �get_attributesY s zQueue.get_attributesc C s | j �| ||�S )a�
Set a new value for an attribute of the Queue.
:type attribute: String
:param attribute: The name of the attribute you want to set.
:param value: The new value for the attribute must be:
* For `DelaySeconds` the value must be an integer number of
seconds from 0 to 900 (15 minutes).
>>> queue.set_attribute('DelaySeconds', 900)
* For `MaximumMessageSize` the value must be an integer number of
bytes from 1024 (1 KiB) to 262144 (256 KiB).
>>> queue.set_attribute('MaximumMessageSize', 262144)
* For `MessageRetentionPeriod` the value must be an integer number of
seconds from 60 (1 minute) to 1209600 (14 days).
>>> queue.set_attribute('MessageRetentionPeriod', 1209600)
* For `Policy` the value must be an string that contains JSON formatted
parameters and values.
>>> queue.set_attribute('Policy', json.dumps({
... 'Version': '2008-10-17',
... 'Id': '/123456789012/testQueue/SQSDefaultPolicy',
... 'Statement': [
... {
... 'Sid': 'Queue1ReceiveMessage',
... 'Effect': 'Allow',
... 'Principal': {
... 'AWS': '*'
... },
... 'Action': 'SQS:ReceiveMessage',
... 'Resource': 'arn:aws:aws:sqs:us-east-1:123456789012:testQueue'
... }
... ]
... }))
* For `ReceiveMessageWaitTimeSeconds` the value must be an integer number of
seconds from 0 to 20.
>>> queue.set_attribute('ReceiveMessageWaitTimeSeconds', 20)
* For `VisibilityTimeout` the value must be an integer number of
seconds from 0 to 43200 (12 hours).
>>> queue.set_attribute('VisibilityTimeout', 43200)
* For `RedrivePolicy` the value must be an string that contains JSON formatted
parameters and values. You can set maxReceiveCount to a value between 1 and 1000.
The deadLetterTargetArn value is the Amazon Resource Name (ARN) of the queue that
will receive the dead letter messages.
>>> queue.set_attribute('RedrivePolicy', json.dumps({
... 'maxReceiveCount': 5,
... 'deadLetterTargetArn': "arn:aws:aws:sqs:us-east-1:123456789012:testDeadLetterQueue"
... }))
:rtype: bool
:return: True if successful, otherwise False.
)r �set_queue_attribute)r
� attributer' r r r �
set_attributem s <zQueue.set_attributec C s | � d�}t|d �S )z�
Get the visibility timeout for the queue.
:rtype: int
:return: The number of seconds as an integer.
r$ �r. r% )r
�ar r r � get_timeout� s
zQueue.get_timeoutc C s | � d|�}|r || _|S )z�
Set the visibility timeout for the queue.
:type visibility_timeout: int
:param visibility_timeout: The desired timeout in seconds
r$ )r1 r )r
r �retvalr r r � set_timeout� s zQueue.set_timeoutc C s | j �| |||�S )as
Add a permission to a queue.
:type label: str or unicode
:param label: A unique identification of the permission you are setting.
Maximum of 80 characters ``[0-9a-zA-Z_-]``
Example, AliceSendMessage
:type aws_account_id: str or unicode
:param principal_id: The AWS account number of the principal who
will be given permission. The principal must have an AWS account,
but does not need to be signed up for Amazon SQS. For information
about locating the AWS account identification.
:type action_name: str or unicode
:param action_name: The action. Valid choices are:
SendMessage|ReceiveMessage|DeleteMessage|
ChangeMessageVisibility|GetQueueAttributes|*
:rtype: bool
:return: True if successful, False otherwise.
)r �add_permission)r
�label�aws_account_id� action_namer r r r7 � s �zQueue.add_permissionc C r+ )a
Remove a permission from a queue.
:type label: str or unicode
:param label: The unique label associated with the permission
being removed.
:rtype: bool
:return: True if successful, False otherwise.
)r �remove_permission)r
r8 r r r r; � s zQueue.remove_permissionc C s* | j d|||d�}t|�dkr|d S dS )aD
Read a single message from the queue.
:type visibility_timeout: int
:param visibility_timeout: The timeout for this message in seconds
:type wait_time_seconds: int
:param wait_time_seconds: The duration (in seconds) for which the call
will wait for a message to arrive in the queue before returning.
If a message is available, the call will return sooner than
wait_time_seconds.
:type message_attributes: list
:param message_attributes: The name(s) of additional message
attributes to return. The default is to return no additional
message attributes. Use ``['All']`` or ``['.*']`` to return all.
:rtype: :class:`boto.sqs.message.Message`
:return: A single message or None if queue is empty
r )�wait_time_seconds�message_attributesr N)� get_messages�len)r
r r< r= �rsr r r �read� s � z
Queue.readc C s. | j j| |�� ||jd�}|j|_|j|_|S )a
Add a single message to the queue.
:type message: Message
:param message: The message to be written to the queue
:rtype: :class:`boto.sqs.message.Message`
:return: The :class:`boto.sqs.message.Message` object that was written.
)�
delay_secondsr= )r � send_message�get_body_encodedr= r �md5)r
�messagerB �new_msgr r r �write s
�z Queue.writec C r+ )a�
Delivers up to 10 messages in a single request.
:type messages: List of lists.
:param messages: A list of lists or tuples. Each inner
tuple represents a single message to be written
and consists of and ID (string) that must be unique
within the list of messages, the message body itself
which can be a maximum of 64K in length, an
integer which represents the delay time (in seconds)
for the message (0-900) before the message will
be delivered to the queue, and an optional dict of
message attributes like those passed to ``send_message``
in the connection class.
)r �send_message_batch�r
�messagesr r r � write_batch s zQueue.write_batch� c K s | j | |fi |��}| |_|S )z�
Create new message of appropriate class.
:type body: message body
:param body: The body of the newly created message (optional).
:rtype: :class:`boto.sqs.message.Message`
:return: A new Message object
)r �queue)r
�body�kwargs�mr r r � new_message* s
zQueue.new_messager c C s | j j| |||||d�S )a
Get a variable number of messages.
:type num_messages: int
:param num_messages: The maximum number of messages to read from
the queue.
:type visibility_timeout: int
:param visibility_timeout: The VisibilityTimeout for the messages read.
:type attributes: str
:param attributes: The name of additional attribute to return
with response or All if you want all attributes. The
default is to return no additional attributes. Valid
values: All SenderId SentTimestamp ApproximateReceiveCount
ApproximateFirstReceiveTimestamp
:type wait_time_seconds: int
:param wait_time_seconds: The duration (in seconds) for which the call
will wait for a message to arrive in the queue before returning.
If a message is available, the call will return sooner than
wait_time_seconds.
:type message_attributes: list
:param message_attributes: The name(s) of additional message
attributes to return. The default is to return no additional
message attributes. Use ``['All']`` or ``['.*']`` to return all.
:rtype: list
:return: A list of :class:`boto.sqs.message.Message` objects.
)�number_messagesr r- r< r= )r �receive_message)r
� num_messagesr r- r< r= r r r r> 9 s "�zQueue.get_messagesc C r+ )a
Delete a message from the queue.
:type message: :class:`boto.sqs.message.Message`
:param message: The :class:`boto.sqs.message.Message` object to delete.
:rtype: bool
:return: True if successful, False otherwise
)r �delete_message)r
rF r r r rV a �
zQueue.delete_messagec C r+ )z�
Deletes a list of messages in a single request.
:type messages: List of :class:`boto.sqs.message.Message` objects.
:param messages: A list of message objects.
)r �delete_message_batchrJ r r r rX m s zQueue.delete_message_batchc C r+ )ar
A batch version of change_message_visibility that can act
on up to 10 messages at a time.
:type messages: List of tuples.
:param messages: A list of tuples where each tuple consists
of a :class:`boto.sqs.message.Message` object and an integer
that represents the new visibility timeout for that message.
)r � change_message_visibility_batchrJ r r r rY v rW z%Queue.change_message_visibility_batchc C � | j �| �S )z#
Delete the queue.
)r � delete_queuer r r r �delete� � z Queue.deletec C rZ )z2
Purge all messages in the queue.
)r � purge_queuer r r r �purge� r] z Queue.purge�
c C s | � � S )z?Deprecated utility function to remove all messages from a queue)r_ )r
� page_size�vtimeoutr r r �clear� s z Queue.clearc C s | � d�}t|d �S )z�
Utility function to count the number of messages in a queue.
Note: This function now calls GetQueueAttributes to obtain
an 'approximate' count of the number of messages in a queue.
�ApproximateNumberOfMessagesr2 )r
ra rb r3 r r r �count� s
z Queue.countc C s: d}| � ||�}|r|D ]}|d7 }q | � ||�}|s
|S )a�
Deprecated. This is the old 'count' method that actually counts
the messages by reading them all. This gives an accurate count but
is very slow for queues with non-trivial number of messasges.
Instead, use get_attributes('ApproximateNumberOfMessages') to take
advantage of the new SQS capability. This is retained only for
the unit tests.
r r )r> )r
ra rb �n�lrQ r r r �
count_slow� s
�zQueue.count_slow�
c C sh t |d�}d}| �||�}|r.|D ]}|�|�� � |r!|�|� |d7 }q| �||�}|s|�� |S )zoUtility function to dump the messages in a queue to a file
NOTE: Page size must be < 10 else SQS errors�wbr r )�openr> rH �get_body�close) r
� file_namera rb �sep�fprf rg rQ r r r �dump� s
�z
Queue.dumpc C sN d}| � � }|r%|d7 }|�|�� � |r|�|� | �|� | � � }|s|S )a:
Read all messages from the queue and persist them to file-like object.
Messages are written to the file and the 'sep' string is written
in between messages. Messages are deleted from the queue after
being written to the file.
Returns the number of messages saved.
r r )rA rH rl rV )r
rp ro rf rQ r r r � save_to_file� s
�zQueue.save_to_filec C �" t |d�}| �||�}|�� |S )a4
Read all messages from the queue and persist them to local file.
Messages are written to the file and the 'sep' string is written
in between messages. Messages are deleted from the queue after
being written to the file.
Returns the number of messages saved.
rj )rk rr rm �r
rn ro rp rf r r r �save_to_filename� s
zQueue.save_to_filenamec C sV d}| � � }|r)|d7 }|�d| j|jf �}|�|�� � | �|� | � � }|s|S )a+
Read all messages from the queue and persist them to S3.
Messages are stored in the S3 bucket using a naming scheme of::
<queue_id>/<message_id>
Messages are deleted from the queue after being saved to S3.
Returns the number of messages saved.
r r z%s/%s)rA �new_keyr �set_contents_from_stringrl rV )r
�bucketrf rQ �keyr r r �
save_to_s3� s
�zQueue.save_to_s3c C s^ d}|r d| }n d| j dd� }|j|d�}|D ]}|d7 }| �|�� �}| �|� q|S )z7
Load messages previously saved to S3.
r z%s/r N)�prefix)r �listrR �get_contents_as_stringrH )r
rx r{ rf r@ ry rQ r r r � load_from_s3� s
zQueue.load_from_s3c C sb d}d}|� � }|r/||kr%t| |�}| �|� |d7 }td| � d}n|| }|� � }|s
|S )zDUtility function to load messages from a file-like object to a queuer rM r zwriting message %d)�readliner rH �print)r
rp ro rf rO rg rQ r r r �load_from_file s
�
zQueue.load_from_filec C rs )zBUtility function to load messages from a local filename to a queue�rb)rk r� rm rt r r r �load_from_filename s
zQueue.load_from_filename)r* )NNNr )rM )r NNNN)r` r` )r` r` ri )ri ),�__name__�
__module__� __qualname__r r
r r �propertyr r r r �arnr" r( r) r. r1 r4 r6 r7 r; rA rH rL rR r> rV rX rY r\ r_ rc re rh rq rr ru �saverz r~ r� r� �loadr r r r r sZ
>
�
�(
r N)�__doc__� boto.compatr �boto.sqs.messager �objectr r r r r �<module> s