U
    O8Úcñ  ã                   @   s*   d dl mZ d dlmZ G dd„ dƒZdS )é    )Úaccepts_kwargs)ÚInvalidSubscriberMethodErrorc                       sN   e Zd ZdZdddgZ‡ fdd„Zedd„ ƒZd	d
„ Zdd„ Z	dd„ Z
‡  ZS )ÚBaseSubscriberz¶The base subscriber class

    It is recommended that all subscriber implementations subclass and then
    override the subscription methods (i.e. on_{subsribe_type}() methods).
    ZqueuedÚprogressÚdonec                    s   |   ¡  tƒ  | ¡S )N)Ú_validate_subscriber_methodsÚsuperÚ__new__)ÚclsÚargsÚkwargs©Ú	__class__© ú:/tmp/pip-unpacked-wheel-6hpttf6a/s3transfer/subscribers.pyr	      s    zBaseSubscriber.__new__c                 C   sF   | j D ]:}t| d| ƒ}t|ƒs,td| ƒ‚t|ƒstd| ƒ‚qd S )NZon_z&Subscriber method %s must be callable.z=Subscriber method %s must accept keyword arguments (**kwargs))ÚVALID_SUBSCRIBER_TYPESÚgetattrÚcallabler   r   )r
   Zsubscriber_typeZsubscriber_methodr   r   r   r      s    
ÿÿÿÿz+BaseSubscriber._validate_subscriber_methodsc                 K   s   dS )aù  Callback to be invoked when transfer request gets queued

        This callback can be useful for:

            * Keeping track of how many transfers have been requested
            * Providing the expected transfer size through
              future.meta.provide_transfer_size() so a HeadObject would not
              need to be made for copies and downloads.

        :type future: s3transfer.futures.TransferFuture
        :param future: The TransferFuture representing the requested transfer.
        Nr   ©ÚselfÚfuturer   r   r   r   Ú	on_queued.   s    zBaseSubscriber.on_queuedc                 K   s   dS )aj  Callback to be invoked when progress is made on transfer

        This callback can be useful for:

            * Recording and displaying progress

        :type future: s3transfer.futures.TransferFuture
        :param future: The TransferFuture representing the requested transfer.

        :type bytes_transferred: int
        :param bytes_transferred: The number of bytes transferred for that
            invocation of the callback. Note that a negative amount can be
            provided, which usually indicates that an in-progress request
            needed to be retried and thus progress was rewound.
        Nr   )r   r   Zbytes_transferredr   r   r   r   Úon_progress=   s    zBaseSubscriber.on_progressc                 K   s   dS )aä  Callback to be invoked once a transfer is done

        This callback can be useful for:

            * Recording and displaying whether the transfer succeeded or
              failed using future.result()
            * Running some task after the transfer completed like changing
              the last modified time of a downloaded file.

        :type future: s3transfer.futures.TransferFuture
        :param future: The TransferFuture representing the requested transfer.
        Nr   r   r   r   r   Úon_doneO   s    zBaseSubscriber.on_done)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   r	   Úclassmethodr   r   r   r   Ú__classcell__r   r   r   r   r      s   

r   N)Zs3transfer.compatr   Zs3transfer.exceptionsr   r   r   r   r   r   Ú<module>   s   