l.s.d.a.AtmosDriver(StorageDriver) : class documentation

@param    key:    API key or username to be used (required)
@type     key:    C{str}

@param    secret: Secret password to be used (required)
@type     secret: C{str}

@param    secure: Weither to use HTTPS or HTTP. Note: Some providers
                    only support HTTPS, and it is on by default.
@type     secure: C{bool}

@param    host: Override hostname used for connections.
@type     host: C{str}

@param    port: Override port used for connections.
@type     port: C{int}

@param    api_version: Optional API version. Only used by drivers
                         which support multiple API versions.
@type     api_version: C{str}

@rtype: C{None}

Return a generator of containers for the given account

@return: A generator of Container instances.
@rtype: C{generator} of L{Container}

Return a container instance.

@param container_name: Container name.
@type container_name: C{str}

@return: L{Container} instance.
@rtype: L{Container}

Create a new container.

@type container_name: C{str}
@param container_name: Container name.

@return: C{Container} instance on success.
@rtype: L{Container}

Delete a container.

@type container: L{Container}
@param container: Container instance

@return: True on success, False otherwise.
@rtype: C{bool}

Return an object instance.

@param container_name: Container name.
@type  container_name: C{str}

@param object_name: Object name.
@type  object_name: C{str}

@return: L{Object} instance.
@rtype: L{Object}

Upload an object currently located on a disk.

@param file_path: Path to the object on disk.
@type file_path: C{str}

@param container: Destination container.
@type container: L{Container}

@param object_name: Object name.
@type object_name: C{str}

@param verify_hash: Verify hash
@type verify_hash: C{bool}

@param extra: (optional) Extra attributes (driver specific).
@type extra: C{dict}

@rtype: C{object}

Upload an object using an iterator.

If a provider supports it, chunked transfer encoding is used and you
don't need to know in advance the amount of data to be uploaded.

Otherwise if a provider doesn't support it, iterator will be exhausted
so a total size for data to be uploaded can be determined.

Note: Exhausting the iterator means that the whole data must be
buffered in memory which might result in memory exhausting when
uploading a very large object.

If a file is located on a disk you are advised to use upload_object
function which uses fs.stat function to determine the file size and it
doesn't need to buffer whole object in the memory.

@type iterator: C{object}
@param iterator: An object which implements the iterator interface.

@type container: L{Container}
@param container: Destination container.

@type object_name: C{str}
@param object_name: Object name.

@type extra: C{dict}
@param extra: (optional) Extra attributes (driver specific). Note:
    This dictionary must contain a 'content_type' key which represents
    a content type of the stored object.

@rtype: C{object}

Download an object to the specified destination path.

@param obj: Object instance.
@type obj: L{Object}

@param destination_path: Full path to a file or a directory where the
                        incoming file will be saved.
@type destination_path: C{str}

@param overwrite_existing: True to overwrite an existing file,
    defaults to False.
@type overwrite_existing: C{bool}

@param delete_on_failure: True to delete a partially downloaded file if
the download was not successful (hash mismatch / file size).
@type delete_on_failure: C{bool}

@return: True if an object has been successfully downloaded, False
otherwise.
@rtype: C{bool}

Return a generator which yields object data.

@param obj: Object instance
@type obj: L{Object}

@param chunk_size: Optional chunk size (in bytes).
@type chunk_size: C{int}

@rtype: C{object}

Delete an object.

@type obj: L{Object}
@param obj: Object instance.

@return: C{bool} True on success.
@rtype: C{bool}

Enable object CDN.

@param obj: Object instance
@type  obj: L{Object}

@rtype: C{bool}

Return a object CDN URL.

@param obj: Object instance
@type  obj: L{Object}

@param expiry: Expiry
@type expiry: C{str}

@param use_object: Use object
@type use_object: C{bool}

@rtype: C{str}

Return a generator of objects for the given container.

@param container: Container instance
@type container: L{Container}

@return: A generator of Object instances.
@rtype: C{generator} of L{Object}