File: //usr/lib/python3/dist-packages/s3transfer/__pycache__/bandwidth.cpython-310.pyc
o
�y�`-= � @ s� d dl Z d dlZG dd� de�ZG dd� de�ZG dd� de�ZG dd � d e�ZG d
d � d e�ZG d d
� d
e�Z G dd� de�Z
G dd� de�Z dS )� Nc s e Zd Z� fdd�Z� ZS )�RequestExceededExceptionc s, || _ || _d||f }tt| ��|� dS )a� Error when requested amount exceeds what is allowed
The request that raised this error should be retried after waiting
the time specified by ``retry_time``.
:type requested_amt: int
:param requested_amt: The originally requested byte amount
:type retry_time: float
:param retry_time: The length in time to wait to retry for the
requested amount
z<Request amount %s exceeded the amount available. Retry in %sN)�
requested_amt�
retry_time�superr �__init__)�selfr r �msg�� __class__� �6/usr/lib/python3/dist-packages/s3transfer/bandwidth.pyr s
��z!RequestExceededException.__init__)�__name__�
__module__� __qualname__r �
__classcell__r r r r r s r c @ s e Zd ZdZdS )� RequestTokenzDA token to pass as an identifier when consuming from the LeakyBucketN)r
r r �__doc__r r r r r ( s r c @ s e Zd Zdd� Zdd� ZdS )� TimeUtilsc C s t � � S )zgGet the current time back
:rtype: float
:returns: The current time in seconds
)�time�r r r r r . s zTimeUtils.timec C s
t �|�S )zwSleep for a designated time
:type value: float
:param value: The time to sleep for in seconds
)r �sleep)r �valuer r r r 6 s
zTimeUtils.sleepN)r
r r r r r r r r r - s r c @ s" e Zd Zddd�Z ddd�ZdS ) �BandwidthLimiterNc C s$ || _ || _|du rt� | _dS dS )a Limits bandwidth for shared S3 transfers
:type leaky_bucket: LeakyBucket
:param leaky_bucket: The leaky bucket to use limit bandwidth
:type time_utils: TimeUtils
:param time_utils: Time utility to use for interacting with time.
N)�
_leaky_bucket� _time_utilsr )r � leaky_bucket�
time_utilsr r r r @ s
�zBandwidthLimiter.__init__Tc C s" t || j|| j�}|s|�� |S )a� Wraps a fileobj in a bandwidth limited stream wrapper
:type fileobj: file-like obj
:param fileobj: The file-like obj to wrap
:type transfer_coordinator: s3transfer.futures.TransferCoordinator
param transfer_coordinator: The coordinator for the general transfer
that the wrapped stream is a part of
:type enabled: boolean
:param enabled: Whether bandwidth limiting should be enabled to start
)�BandwidthLimitedStreamr r �disable_bandwidth_limiting)r �fileobj�transfer_coordinator�enabled�streamr r r �get_bandwith_limited_streamN s �z,BandwidthLimiter.get_bandwith_limited_stream�N)T)r
r r r r# r r r r r ? s
�r c @ sr e Zd Z d dd�Zdd� Zdd� Zd d
� Zd d � Zd
d� Zdd� Z d dd�Z
dd� Z dd� Z dd� Z
dd� ZdS ) r N� c C sF || _ || _|| _|| _|du rt� | _d| _t� | _d| _|| _ dS )a[ Limits bandwidth for reads on a wrapped stream
:type fileobj: file-like object
:param fileobj: The file like object to wrap
:type leaky_bucket: LeakyBucket
:param leaky_bucket: The leaky bucket to use to throttle reads on
the stream
:type transfer_coordinator: s3transfer.futures.TransferCoordinator
param transfer_coordinator: The coordinator for the general transfer
that the wrapped stream is a part of
:type time_utils: TimeUtils
:param time_utils: The time utility to use for interacting with time
NTr )
�_fileobjr �_transfer_coordinatorr r �_bandwidth_limiting_enabledr �_request_token� _bytes_seen�_bytes_threshold)r r r r r �bytes_thresholdr r r r e s
z BandwidthLimitedStream.__init__c C �
d| _ dS )z0Enable bandwidth limiting on reads to the streamTN�r( r r r r �enable_bandwidth_limiting� �
z0BandwidthLimitedStream.enable_bandwidth_limitingc C r- )z1Disable bandwidth limiting on reads to the streamFNr. r r r r r � r0 z1BandwidthLimitedStream.disable_bandwidth_limitingc C sL | j s | j�|�S | j|7 _| j| jk r | j�|�S | �� | j�|�S )zhRead a specified amount
Reads will only be throttled if bandwidth limiting is enabled.
)r( r& �readr* r+ � _consume_through_leaky_bucket)r �amountr r r r1 � s zBandwidthLimitedStream.readc
C sj | j js1z| j�| j| j� d| _W d S ty, } z
| j�|j � W Y d }~nd }~ww | j jr| j j�)Nr )
r' � exceptionr �consumer* r) r r r r )r �er r r r2 � s ���� z4BandwidthLimitedStream._consume_through_leaky_bucketc C � | � � dS )z6Signal that data being read is being transferred to S3N)r/ r r r r �signal_transferring� � z*BandwidthLimitedStream.signal_transferringc C r7 )z:Signal that data being read is not being transferred to S3N)r r r r r �signal_not_transferring� r9 z.BandwidthLimitedStream.signal_not_transferringr c C s | j �||� d S r$ )r& �seek)r �where�whencer r r r; � s zBandwidthLimitedStream.seekc C s
| j �� S r$ )r& �tellr r r r r> � s
zBandwidthLimitedStream.tellc C s" | j r
| jr
| �� | j�� d S r$ )r( r* r2 r& �closer r r r r? � s z BandwidthLimitedStream.closec C s | S r$ r r r r r � __enter__� s z BandwidthLimitedStream.__enter__c O s | � � d S r$ )r? )r �args�kwargsr r r �__exit__� s z BandwidthLimitedStream.__exit__)Nr% )r )r
r r r r/ r r1 r2 r8 r: r; r> r? r@ rC r r r r r d s
�
r c @ sB e Zd Z ddd�Zdd� Zdd� Zdd � Zd
d � Zd d
� ZdS )� LeakyBucketNc C s^ t |�| _|| _|du rt� | _t�� | _|| _|du r t� | _|| _ |du r-t
� | _ dS dS )a9 A leaky bucket abstraction to limit bandwidth consumption
:type rate: int
:type rate: The maximum rate to allow. This rate is in terms of
bytes per second.
:type time_utils: TimeUtils
:param time_utils: The time utility to use for interacting with time
:type rate_tracker: BandwidthRateTracker
:param rate_tracker: Tracks bandwidth consumption
:type consumption_scheduler: ConsumptionScheduler
:param consumption_scheduler: Schedules consumption retries when
necessary
N) �float� _max_rater r � threading�Lock�_lock�
_rate_tracker�BandwidthRateTracker�_consumption_scheduler�ConsumptionScheduler)r �max_rater � rate_tracker�consumption_schedulerr r r r � s
�zLeakyBucket.__init__c C s� | j �= | j�� }| j�|�r | �|||�W d � S | �||�r+| �|||� n
| �||�W d � S W d � dS 1 sCw Y dS )ac Consume an a requested amount
:type amt: int
:param amt: The amount of bytes to request to consume
:type request_token: RequestToken
:param request_token: The token associated to the consumption
request that is used to identify the request. So if a
RequestExceededException is raised the token should be used
in subsequent retry consume() request.
:raises RequestExceededException: If the consumption amount would
exceed the maximum allocated bandwidth
:rtype: int
:returns: The amount consumed
N) rI r r rL � is_scheduled�,_release_requested_amt_for_scheduled_request� _projected_to_exceed_max_rate�!_raise_request_exceeded_exception�_release_requested_amt�r �amt�
request_token�time_nowr r r r5 � s
�� �
�"�zLeakyBucket.consumec C s | j �||�}|| jkS r$ )rJ �get_projected_raterF )r rW rY �projected_rater r r rS
s
z)LeakyBucket._projected_to_exceed_max_ratec C s | j �|� | �||�S r$ )rL � process_scheduled_consumptionrU rV r r r rR s � z8LeakyBucket._release_requested_amt_for_scheduled_requestc C s* |t | j� }| j�|||�}t||d��)N)r r )rE rF rL �schedule_consumptionr )r rW rX rY �allocated_timer r r r rT s ��z-LeakyBucket._raise_request_exceeded_exceptionc C s | j �||� |S r$ )rJ �record_consumption_rate)r rW rY r r r rU s z"LeakyBucket._release_requested_amt)NNN) r
r r r r5 rS rR rT rU r r r r rD � s
� rD c @ s, e Zd Zdd� Zdd� Zdd� Zdd� Zd S )
rM c C s i | _ d| _dS )z*Schedules when to consume a desired amountr N)� _tokens_to_scheduled_consumption� _total_waitr r r r r ! s
z ConsumptionScheduler.__init__c C s
|| j v S )z�Indicates if a consumption request has been scheduled
:type token: RequestToken
:param token: The token associated to the consumption
request that is used to identify the request.
)r` )r �tokenr r r rQ & s
z!ConsumptionScheduler.is_scheduledc C s& | j |7 _ | j |d�| j|< | j S )a� Schedules a wait time to be able to consume an amount
:type amt: int
:param amt: The amount of bytes scheduled to be consumed
:type token: RequestToken
:param token: The token associated to the consumption
request that is used to identify the request.
:type time_to_consume: float
:param time_to_consume: The desired time it should take for that
specific request amount to be consumed in regardless of previously
scheduled consumption requests
:rtype: float
:returns: The amount of time to wait for the specific request before
actually consuming the specified amount.
)�
wait_duration�time_to_consume)ra r` )r rW rb rd r r r r] / s
�z)ConsumptionScheduler.schedule_consumptionc C s& | j �|�}t| j|d d�| _dS )z�Processes a scheduled consumption request that has completed
:type token: RequestToken
:param token: The token associated to the consumption
request that is used to identify the request.
rd r N)r` �pop�maxra )r rb �scheduled_retryr r r r\ I s
�z2ConsumptionScheduler.process_scheduled_consumptionN)r
r r r rQ r] r\ r r r r rM s
rM c @ sB e Zd Zddd�Zedd� �Zdd� Zdd � Zd
d � Zd d
� Z dS )rK 皙�����?c C s || _ d| _d| _dS )a� Tracks the rate of bandwidth consumption
:type a: float
:param a: The constant to use in calculating the exponentional moving
average of the bandwidth rate. Specifically it is used in the
following calculation:
current_rate = alpha * new_rate + (1 - alpha) * current_rate
This value of this constant should be between 0 and 1.
N)�_alpha�
_last_time�
_current_rate)r �alphar r r r V s
z BandwidthRateTracker.__init__c C s | j du rdS | jS )zmThe current transfer rate
:rtype: float
:returns: The current tracked transfer rate
N� )rj rk r r r r � current_ratef s
z!BandwidthRateTracker.current_ratec C s | j du rdS | �||�S )aZ Get the projected rate using a provided amount and time
:type amt: int
:param amt: The proposed amount to consume
:type time_at_consumption: float
:param time_at_consumption: The proposed time to consume at
:rtype: float
:returns: The consumption rate if that amt and time were consumed
Nrm )rj �*_calculate_exponential_moving_average_rate�r rW �time_at_consumptionr r r rZ q s
�z'BandwidthRateTracker.get_projected_ratec C s2 | j du r
|| _ d| _dS | �||�| _|| _ dS )a Record the consumption rate based off amount and time point
:type amt: int
:param amt: The amount that got consumed
:type time_at_consumption: float
:param time_at_consumption: The time at which the amount was consumed
Nrm )rj rk ro rp r r r r_ � s
�
z,BandwidthRateTracker.record_consumption_ratec C s" || j }|dkr
td�S || S )Nr �inf)rj rE )r rW rq �
time_deltar r r �_calculate_rate� s
z$BandwidthRateTracker._calculate_ratec C s& | � ||�}| j| d| j | j S )N� )rt ri rk )r rW rq �new_rater r r ro � s z?BandwidthRateTracker._calculate_exponential_moving_average_rateN)rh )
r
r r r �propertyrn rZ r_ rt ro r r r r rK U s
rK ) r rG � Exceptionr �objectr r r r rD rM rK r r r r �<module> s %jR5