Na}{

File Content: `subscribers.py`

# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from botocore.compat import six

from s3transfer.compat import accepts_kwargs
from s3transfer.exceptions import InvalidSubscriberMethodError


class BaseSubscriber(object):
    """The base subscriber class

    It is recommended that all subscriber implementations subclass and then
    override the subscription methods (i.e. on_{subsribe_type}() methods).
    """
    VALID_SUBSCRIBER_TYPES = [
        'queued',
        'progress',
        'done'
    ]

    def __new__(cls, *args, **kwargs):
        cls._validate_subscriber_methods()
        return super(BaseSubscriber, cls).__new__(cls)

    @classmethod
    def _validate_subscriber_methods(cls):
        for subscriber_type in cls.VALID_SUBSCRIBER_TYPES:
            subscriber_method = getattr(cls, 'on_' + subscriber_type)
            if not six.callable(subscriber_method):
                raise InvalidSubscriberMethodError(
                    'Subscriber method %s must be callable.' %
                    subscriber_method)

            if not accepts_kwargs(subscriber_method):
                raise InvalidSubscriberMethodError(
                    'Subscriber method %s must accept keyword '
                    'arguments (**kwargs)' % subscriber_method)

    def on_queued(self, future, **kwargs):
        """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.
        """
        pass

    def on_progress(self, future, bytes_transferred, **kwargs):
        """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.
        """
        pass

    def on_done(self, future, **kwargs):
        """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.
        """
        pass

Name	Size	Permission
__init__.py	28160 bytes	0644
__init__.pyc	28157 bytes	0644
compat.py	2983 bytes	0644
compat.pyc	2228 bytes	0644
copies.py	12972 bytes	0644
copies.pyc	8632 bytes	0644
delete.py	2583 bytes	0644
delete.pyc	2553 bytes	0644
download.py	27468 bytes	0644
download.pyc	25800 bytes	0644
exceptions.py	1090 bytes	0644
exceptions.pyc	1590 bytes	0644
futures.py	20376 bytes	0644
futures.pyc	23796 bytes	0644
manager.py	25764 bytes	0644
manager.pyc	21512 bytes	0644
subscribers.py	3628 bytes	0644
subscribers.pyc	3799 bytes	0644
tasks.py	15833 bytes	0644
tasks.pyc	11269 bytes	0644
upload.py	28944 bytes	0644
upload.pyc	25403 bytes	0644
utils.py	24555 bytes	0644
utils.pyc	27135 bytes	0644

File Content: subscribers.py

File Content: `subscribers.py`