File: //usr/lib/python3/dist-packages/s3transfer/__pycache__/futures.cpython-310.pyc
o
�y�`�R � @ sB d dl mZ d dlmZ d dlZd dlZd dlZd dlZd dlm Z d dlm
Z
d dl m Z m
Z
d dlmZ d dlmZ e�e�ZG d d
� d
e�ZG d d � d e�ZG d
d� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�Z G dd� de �Z G dd � d e�Z ed d g�Z e d �Z e d �Z!dS )!� )�futures)�
namedtupleN)�MAXINT)�six)�CancelledError�TransferNotDoneError)�FunctionContainer)�
TaskSemaphorec @ s0 e Zd Zedd� �Zdd� Zdd� Zdd� Zd S )
�BaseTransferFuturec C � t d��)z-The metadata associated to the TransferFuture�meta��NotImplementedError��self� r �4/usr/lib/python3/dist-packages/s3transfer/futures.pyr � zBaseTransferFuture.metac C r )zmDetermines if a TransferFuture has completed
:returns: True if completed. False, otherwise.
zdone()r
r r r r �done$ s zBaseTransferFuture.donec C r )��Waits until TransferFuture is done and returns the result
If the TransferFuture succeeded, it will return the result. If the
TransferFuture failed, it will raise the exception associated to the
failure.
zresult()r
r r r r �result+ s zBaseTransferFuture.resultc C r )z6Cancels the request associated with the TransferFuturezcancel()r
r r r r �cancel4 s zBaseTransferFuture.cancelN)�__name__�
__module__� __qualname__�propertyr r r r r r r r r
s
r
c @ s0 e Zd Zedd� �Zedd� �Zedd� �ZdS )�BaseTransferMetac C r )�*The call args used in the transfer request� call_argsr
r r r r r : r zBaseTransferMeta.call_argsc C r )� The unique id of the transfer� transfer_idr
r r r r r ? r z BaseTransferMeta.transfer_idc C r )�.A dictionary that requesters can store data in� user_contextr
r r r r r" D r z BaseTransferMeta.user_contextN)r r r r r r r" r r r r r 9 s
r c @ sB e Zd Zddd�Zedd� �Zdd� Zdd � Zd
d � Zd d
� Z dS )�TransferFutureNc C s4 || _ |du r t� | _ || _|du rt� | _dS dS )a� The future associated to a submitted transfer request
:type meta: TransferMeta
:param meta: The metadata associated to the request. This object
is visible to the requester.
:type coordinator: TransferCoordinator
:param coordinator: The coordinator associated to the request. This
object is not visible to the requester.
N)�_meta� TransferMeta� _coordinator�TransferCoordinator)r r � coordinatorr r r �__init__K s �zTransferFuture.__init__c C � | j S �N)r$ r r r r r ^ � zTransferFuture.metac C �
| j �� S r+ )r& r r r r r r b �
zTransferFuture.donec
C s2 z| j �� W S ty } z| �� |�d }~ww r+ )r& r �KeyboardInterruptr )r �er r r r e s ��zTransferFuture.resultc C s | j �� d S r+ )r& r r r r r r o s zTransferFuture.cancelc C s$ | � � std��| jj|dd� dS )z!Sets the exception on the future.z?set_exception can only be called once the transfer is complete.T)�overrideN)r r r& �
set_exception)r � exceptionr r r r2 r s
�z TransferFuture.set_exception�NN)
r r r r) r r r r r r2 r r r r r# J s
r# c @ sR e Zd ZdZddd�Zedd� �Zedd� �Zed d
� �Zed d � �Z d
d� Z
dS )r% z'Holds metadata about the TransferFutureNc C s || _ || _d | _i | _d S r+ )�
_call_args� _transfer_id�_size�
_user_context)r r r r r r r) } s
zTransferMeta.__init__c C r* )r )r5 r r r r r � � zTransferMeta.call_argsc C r* )r )r6 r r r r r � r9 zTransferMeta.transfer_idc C r* )z)The size of the transfer request if known�r7 r r r r �size� r9 zTransferMeta.sizec C r* )r! )r8 r r r r r" � r9 zTransferMeta.user_contextc C �
|| _ dS )z�A method to provide the size of a transfer request
By providing this value, the TransferManager will not try to
call HeadObject or use the use OS to determine the size of the
transfer.
Nr: )r r; r r r �provide_transfer_size� s
z"TransferMeta.provide_transfer_sizer4 ) r r r �__doc__r) r r r r; r" r= r r r r r% { s
r% c @ s� e Zd ZdZd5dd�Zdd� Zedd� �Zed d
� �Zed d � �Z ed
d� �Z
dd� Z d6dd�Z dd� Z
defdd�Zdd� Zdd � Zd d � Zd5d d �Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+d,� Zd-d.� Zd/d0� Zd1d2� Z d3d4� Z dS )7r' z*A helper class for managing TransferFutureNc C sb || _ d| _d | _d | _t� | _g | _g | _t� � | _
t� � | _ t� � | _
t� � | _t� � | _d S )N� not-started)r �_status�_result�
_exception�set�_associated_futures�_failure_cleanups�_done_callbacks� threading�Event� _done_event�Lock�_lock�_associated_futures_lock�_done_callbacks_lock�_failure_cleanups_lock)r r r r r r) � s
z TransferCoordinator.__init__c C s d| j j| jf S )Nz%s(transfer_id=%s))� __class__r r r r r r �__repr__� s
�z TransferCoordinator.__repr__c C r* r+ )rB r r r r r3 � r, z TransferCoordinator.exceptionc C s6 | j � t�| j�W d � S 1 sw Y dS )z�The list of futures associated to the inprogress TransferFuture
Once the transfer finishes this list becomes empty as the transfer
is considered done and there should be no running futures left.
N)rL �copyrD r r r r �associated_futures� s
$�z&TransferCoordinator.associated_futuresc C r* )z;The list of callbacks to call when the TransferFuture fails)rE r r r r �failure_cleanups� r9 z$TransferCoordinator.failure_cleanupsc C r* )a� The status of the TransferFuture
The currently supported states are:
* not-started - Has yet to start. If in this state, a transfer
can be canceled immediately and nothing will happen.
* queued - SubmissionTask is about to submit tasks
* running - Is inprogress. In-progress as of now means that
the SubmissionTask that runs the transfer is being executed. So
there is no guarantee any transfer requests had been made to
S3 if this state is reached.
* cancelled - Was cancelled
* failed - An exception other than CancelledError was thrown
* success - No exceptions were thrown and is done.
)r@ r r r r �status� s zTransferCoordinator.statusc C s> | j � d| _|| _d| _W d � dS 1 sw Y dS )a� Set a result for the TransferFuture
Implies that the TransferFuture succeeded. This will always set a
result because it is invoked on the final task where there is only
ever one final task and it is ran at the very end of a transfer
process. So if a result is being set for this final task, the transfer
succeeded even if something came a long and canceled the transfer
on the final task.
N�success)rK rB rA r@ �r r r r r �
set_result� s
"�z TransferCoordinator.set_resultFc C sT | j � | �� r
|r|| _d| _W d � dS W d � dS 1 s#w Y dS )z�Set an exception for the TransferFuture
Implies the TransferFuture failed.
:param exception: The exception that cause the transfer to fail.
:param override: If True, override any existing state.
�failedN)rK r rB r@ )r r3 r1 r r r r2 � s �"�z!TransferCoordinator.set_exceptionc C s | j �t� | jr | j�| jS )r )rI �waitr rB rA r r r r r � s zTransferCoordinator.result� c C s� | j �; | �� s.d}t�d| |� ||�| _| jdkr d}d| _|r6| �� W d � dS W d � dS W d � dS 1 sAw Y dS )z�Cancels the TransferFuture
:param msg: The message to attach to the cancellation
:param exc_type: The type of exception to set for the cancellation
Fz%s cancel(%s) calledr? T� cancelledN)rK r �logger�debugrB r@ �
announce_done)r �msg�exc_type�should_announce_doner r r r s
��"�zTransferCoordinator.cancelc C � | � d� dS )z+Sets the TransferFutrue's status to running�queuedN�� _transition_to_non_done_stater r r r �set_status_to_queued � z(TransferCoordinator.set_status_to_queuedc C rb )z+Sets the TransferFuture's status to running�runningNrd r r r r �set_status_to_running! rg z)TransferCoordinator.set_status_to_runningc C sL | j � | �� rtd| j|f ��|| _W d � d S 1 s w Y d S )Nz=Unable to transition from done state %s to non-done state %s.)rK r � RuntimeErrorrT r@ )r �
desired_stater r r re % s ��"�z1TransferCoordinator._transition_to_non_done_statec C sD t �d||| jf � |j||d�}| �|� |�t| j|�� |S )a� Submits a task to a provided executor
:type executor: s3transfer.futures.BoundedExecutor
:param executor: The executor to submit the callable to
:type task: s3transfer.tasks.Task
:param task: The task to submit to the executor
:type tag: s3transfer.futures.TaskTag
:param tag: A tag to associate to the submitted task
:rtype: concurrent.futures.Future
:returns: A future representing the submitted task
z;Submitting task %s to executor %s for transfer request: %s.)�tag)r\ r] r �submit�add_associated_future�add_done_callbackr �remove_associated_future)r �executor�taskrl �futurer r r rm - s ��
�zTransferCoordinator.submitc C s
| j dv S )z�Determines if a TransferFuture has completed
:returns: False if status is equal to 'failed', 'cancelled', or
'success'. True, otherwise
)rX r[ rU )rT r r r r r H s
zTransferCoordinator.donec C �8 | j � | j�|� W d � dS 1 sw Y dS )z6Adds a future to be associated with the TransferFutureN)rL rD �add�r rs r r r rn P � "�z)TransferCoordinator.add_associated_futurec C rt )z4Removes a future's association to the TransferFutureN)rL rD �removerv r r r rp U rw z,TransferCoordinator.remove_associated_futurec O �J | j � | j�t|g|�R i |��� W d � dS 1 s w Y dS )z7Add a done callback to be invoked when transfer is doneN)rM rF �appendr �r �function�args�kwargsr r r ro Z �
�"�z%TransferCoordinator.add_done_callbackc O ry )z$Adds a callback to call upon failureN)rN rE rz r r{ r r r �add_failure_cleanupa r z'TransferCoordinator.add_failure_cleanupc C s( | j dkr | �� | j�� | �� dS )aM Announce that future is done running and run associated callbacks
This will run any failure cleanups if the transfer failed if not
they have not been run, allows the result() to be unblocked, and will
run any done callbacks associated to the TransferFuture if they have
not already been ran.
rU N)rT �_run_failure_cleanupsrI rC �_run_done_callbacksr r r r r^ g s
z!TransferCoordinator.announce_donec C s> | j � | �| j� g | _W d � d S 1 sw Y d S r+ )rM �_run_callbacksrF r r r r r� t � "�z'TransferCoordinator._run_done_callbacksc C s> | j � | �| j� g | _W d � d S 1 sw Y d S r+ )rN r� rS rE r r r r r� | r� z)TransferCoordinator._run_failure_cleanupsc C s |D ]}| � |� qd S r+ )�
_run_callback)r � callbacks�callbackr r r r� � s �z"TransferCoordinator._run_callbacksc C s4 z|� W d S t y tjd| dd� Y d S w )NzException raised in %s.T)�exc_info)� Exceptionr\ r] )r r� r r r r� � s
�z!TransferCoordinator._run_callbackr+ )F) r r r r> r) rP r r3 rR rS rT rW r2 r r r rf ri re rm r rn rp ro r� r^ r� r� r� r� r r r r r' � s<
r' c @ s4 e Zd ZejZ d dd�Zd
dd�Zd dd�ZdS ) �BoundedExecutorNc C s6 || _ |du r
| j}|| j d�| _t|�| _|| _dS )aD An executor implentation that has a maximum queued up tasks
The executor will block if the number of tasks that have been
submitted and is currently working on is past its maximum.
:params max_size: The maximum number of inflight futures. An inflight
future means that the task is either queued up or is currently
being executed. A size of None or 0 means that the executor will
have no bound in terms of the number of inflight futures.
:params max_num_threads: The maximum number of threads the executor
uses.
:type tag_semaphores: dict
:params tag_semaphores: A dictionary where the key is the name of the
tag and the value is the semaphore to use when limiting the
number of tasks the executor is processing at a time.
:type executor_cls: BaseExecutor
:param underlying_executor_cls: The executor class that
get bounded by this executor. If None is provided, the
concurrent.futures.ThreadPoolExecutor class is used.
N)� max_workers)�_max_num_threads� EXECUTOR_CLS� _executorr �
_semaphore�_tag_semaphores)r �max_size�max_num_threads�tag_semaphores� executor_clsr r r r) � s
zBoundedExecutor.__init__Tc C sP | j }|r
| j| }|�|j|�}t|j|j|�}t| j�|��}|� |� |S )a1 Submit a task to complete
:type task: s3transfer.tasks.Task
:param task: The task to run __call__ on
:type tag: s3transfer.futures.TaskTag
:param tag: An optional tag to associate to the task. This
is used to override which semaphore to use.
:type block: boolean
:param block: True if to wait till it is possible to submit a task.
False, if not to wait and raise an error if not able to submit
a task.
:returns: The future assocaited to the submitted task
)
r� r� �acquirer r �release�ExecutorFuturer� rm ro )r rr rl �block� semaphore�
acquire_token�release_callbackrs r r r rm � s
�
zBoundedExecutor.submitc C s | j �|� d S r+ )r� �shutdown�r rY r r r r� � s zBoundedExecutor.shutdownr4 �NT�T) r r r r �ThreadPoolExecutorr� r) rm r� r r r r r� � s
�
%r� c @ s, e Zd Zdd� Zdd� Zdd� Zdd� Zd S )
r� c C r< )a� A future returned from the executor
Currently, it is just a wrapper around a concurrent.futures.Future.
However, this can eventually grow to implement the needed functionality
of concurrent.futures.Future if we move off of the library and not
affect the rest of the codebase.
:type future: concurrent.futures.Future
:param future: The underlying future
N)�_futurerv r r r r) � s
zExecutorFuture.__init__c C r- r+ )r� r r r r r r � r. zExecutorFuture.resultc s � fdd�}| j �|� dS )a Adds a callback to be completed once future is done
:parm fn: A callable that takes no arguments. Note that is different
than concurrent.futures.Future.add_done_callback that requires
a single argument for the future.
c s � � S r+ r )�future_passed_to_callback��fnr r �
done_callback� � z7ExecutorFuture.add_done_callback.<locals>.done_callbackN)r� ro )r r� r� r r� r ro � s
z ExecutorFuture.add_done_callbackc C r- r+ )r� r r r r r r � r. zExecutorFuture.doneN)r r r r) r ro r r r r r r� � s
r� c @ s, e Zd ZdZd
dd�Zdd� Zd dd �ZdS ) � BaseExecutorzABase Executor class implementation needed to work with s3transferNc C � d S r+ r )r r� r r r r) � zBaseExecutor.__init__c O r )Nzsubmit()r
)r r� r} r~ r r r rm � zBaseExecutor.submitTc C r )Nz
shutdown()r
r� r r r r� r� zBaseExecutor.shutdownr+ r� )r r r r> r) rm r� r r r r r� s
r� c @ s" e Zd ZdZdd� Zddd�ZdS ) �NonThreadedExecutorz@A drop-in replacement non-threaded version of ThreadPoolExecutorc O sj t � }z||i |��}|�|� W |S ty4 t�� dd � \}}t�d|||� |�||� Y |S w )N� z0Setting exception for %s to %s with traceback %s)�NonThreadedExecutorFuturerW r� �sysr� r\ r] �set_exception_info)r r� r} r~ rs r r0 �tbr r r rm s ���zNonThreadedExecutor.submitTc C r� r+ r r� r r r r� r� z NonThreadedExecutor.shutdownNr� )r r r r> rm r� r r r r r� s r� c @ sR e Zd ZdZdd� Zdd� Zdd� Zdd d
�Zd d � Zd
d� Z dd� Z
dd� Z dS )r� z�The Future returned from NonThreadedExecutor
Note that this future is **not** thread-safe as it is being used
from the context of a non-threaded environment.
c C s" d | _ d | _d | _d| _g | _d S )NF)rA rB �
_traceback�_donerF r r r r r) & s
z"NonThreadedExecutorFuture.__init__c C s || _ | �� d S r+ )rA � _set_donerV r r r rW - s z$NonThreadedExecutorFuture.set_resultc C s || _ || _| �� d S r+ )rB r� r� )r r3 � tracebackr r r r� 1 s z,NonThreadedExecutorFuture.set_exception_infoNc C s$ | j rt�t| j �| j | j� | jS r+ )rB r �reraise�typer� rA )r �timeoutr r r r 6 s
�z NonThreadedExecutorFuture.resultc C s& d| _ | jD ]}| �|� qg | _d S r� )r� rF �_invoke_done_callback�r r� r r r r� < s
z#NonThreadedExecutorFuture._set_donec C s || �S r+ r r� r r r r� B r� z/NonThreadedExecutorFuture._invoke_done_callbackc C r* r+ )r� r r r r r E r� z NonThreadedExecutorFuture.donec C s$ | j r
| �|� d S | j�|� d S r+ )r� r� rF rz )r r� r r r ro H s z+NonThreadedExecutorFuture.add_done_callbackr+ ) r r r r> r) rW r� r r� r� r ro r r r r r� s
r� �TaskTag�name�in_memory_upload�in_memory_download)"�
concurrentr � collectionsr rQ �loggingr� rG �s3transfer.compatr r �s3transfer.exceptionsr r �s3transfer.utilsr r � getLoggerr r\ �objectr
r r# r% r' r� r� r� r� r� r� �IN_MEMORY_UPLOAD_TAG�IN_MEMORY_DOWNLOAD_TAGr r r r �<module> s4
1& qL# /