summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authordrebs <drebs@riseup.net>2017-11-02 12:30:56 -0200
committerdrebs <drebs@riseup.net>2017-11-03 09:09:22 -0200
commit64dd8d41f08eae8dd4f793348e498c8ef3dc75b0 (patch)
tree33f276d265a74a59f41a209f92091178c389cc6c /src
parent3b77a3396fc1a4ade4e8705275d58411f8f1d482 (diff)
[doc] add blobs api doc
Diffstat (limited to 'src')
-rw-r--r--src/leap/soledad/client/_db/blobs/errors.py24
1 files changed, 18 insertions, 6 deletions
diff --git a/src/leap/soledad/client/_db/blobs/errors.py b/src/leap/soledad/client/_db/blobs/errors.py
index 90de9553..c6e70de7 100644
--- a/src/leap/soledad/client/_db/blobs/errors.py
+++ b/src/leap/soledad/client/_db/blobs/errors.py
@@ -15,26 +15,38 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
-Blobs exceptions
+This module contains the different errors that can happen when dealing with
+blobs.
"""
from leap.soledad.common.errors import SoledadError
class BlobAlreadyExistsError(SoledadError):
- pass
+ """
+ Raised on attempts to put local or remote blobs that already exist in
+ storage.
+ """
class BlobNotFoundError(SoledadError):
- pass
+ """
+ Raised on attemtps to get remote blobs that do not exist in storage.
+ """
class InvalidFlagsError(SoledadError):
- pass
+ """
+ Raised on attempts to set invalid flags for remotelly stored blobs.
+ """
class RetriableTransferError(Exception):
- pass
+ """
+ Raised for any blob transfer error that is considered retriable.
+ """
class MaximumRetriesError(Exception):
- pass
+ """
+ Raised when the maximum number of transfer retries has been reached.
+ """