From 64dd8d41f08eae8dd4f793348e498c8ef3dc75b0 Mon Sep 17 00:00:00 2001 From: drebs Date: Thu, 2 Nov 2017 12:30:56 -0200 Subject: [doc] add blobs api doc --- src/leap/soledad/client/_db/blobs/errors.py | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) (limited to 'src/leap/soledad/client/_db/blobs') 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 . """ -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. + """ -- cgit v1.2.3