Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions s3transfer/futures.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@ def get_context():
class BaseTransferFuture:
@property
def meta(self):
"""The metadata associated to the TransferFuture"""
"""The metadata associated with the TransferFuture.

This typically includes transfer id, call arguments and other context
visible to the requester.
"""
raise NotImplementedError('meta')

def done(self):
Expand Down Expand Up @@ -305,7 +309,7 @@ def cancel(self, msg='', exc_type=CancelledError):
self.announce_done()

def set_status_to_queued(self):
"""Sets the TransferFutrue's status to running"""
"""Sets the TransferFuture's status to 'queued'."""
self._transition_to_non_done_state('queued')

def set_status_to_running(self):
Expand Down Expand Up @@ -349,10 +353,10 @@ def submit(self, executor, task, tag=None):
return future

def done(self):
"""Determines if a TransferFuture has completed
"""Determines if a TransferFuture has completed.

:returns: False if status is equal to 'failed', 'cancelled', or
'success'. True, otherwise
:returns: True if status is 'failed', 'cancelled', or 'success'.
False otherwise.
"""
return self.status in ['failed', 'cancelled', 'success']

Expand Down
You are viewing a condensed version of this merge commit. You can view the full changes here.