libcloud.storage.base.StorageDriver : API documentation

Method	__init__	Undocumented
Method	list_containters	Return a list of containers.
Method	list_container_objects	Return a list of objects for the given container.
Method	get_container	Return a container instance.
Method	get_container_cdn_url	Return a container CDN URL.
Method	get_object	Return an object instance.
Method	get_object_cdn_url	Return a container CDN URL.
Method	enable_container_cdn	Undocumented
Method	enable_object_cdn	Undocumented
Method	download_object	Download an object to the specified destination path.
Method	download_object_as_stream	Return a generator which yields object data.
Method	upload_object	Upload an object.
Method	upload_object_via_stream
Method	delete_object	Delete an object.
Method	create_container	Create a new container.
Method	delete_container	Delete a container.
Method	_get_object	Call passed callback and start transfer of the object'
Method	_save_object	Save object to the provided path.
Method	_upload_object	Helper function for setting common request headers and calling the passed in callback which uploads an object.
Method	_stream_data	Stream a data over an http connection.
Method	_upload_file	Upload a file to the server.

def __init__(self, key, secret=None, secure=True, host=None, port=None): (source)

overridden in libcloud.storage.drivers.dummy.DummyStorageDriver

Undocumented

def list_containters(self): (source)

Return a list of containers.

Returns A list of Container instances.

def list_container_objects(self, container): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver, libcloud.storage.drivers.s3.S3StorageDriver

Return a list of objects for the given container.

Parameters	container	Container instance (type: `Container`)
Returns	A list of Object instances.

def get_container(self, container_name): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver, libcloud.storage.drivers.s3.S3StorageDriver

Return a container instance.

Parameters	container_name	Container name. (type: `str`)
Returns	`Container` instance.

def get_container_cdn_url(self, container): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver

Return a container CDN URL.

Parameters	container	Container instance (type: `Container`)
Returns	A CDN URL for this container.

def get_object(self, container_name, object_name): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver, libcloud.storage.drivers.s3.S3StorageDriver

Return an object instance.

Parameters	container_name	Container name. (type: `str`)
	object_name	Object name. (type: `str`)
Returns	`Object` instance.

def get_object_cdn_url(self, obj): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver

Return a container CDN URL.

Parameters	obj	Object instance (type: `Object`)
Returns	A CDN URL for this object.

def enable_container_cdn(self, container): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver

Undocumented

def enable_object_cdn(self, obj): (source)

Undocumented

def download_object(self, obj, destination_path, overwrite_existing=False, delete_on_failure=True): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver, libcloud.storage.drivers.s3.S3StorageDriver

Download an object to the specified destination path.

Parameters	obj	Object instance. (type: `Object`)
	destination_path	Full path to a file or a directory where the incoming file will be saved. (type: `str`)
	overwrite_existing	True to overwrite an existing file, defaults to False. (type: `bool`)
	delete_on_failure	True to delete a partially downloaded file if the download was not successful (hash mismatch / file size). (type: `bool`)
Returns	True if an object has been successfully downloaded, False otherwise. (type: `bool`)

def download_object_as_stream(self, obj, chunk_size=None): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver, libcloud.storage.drivers.s3.S3StorageDriver

Return a generator which yields object data.

Parameters	obj	Object instance (type: `Object`)
	chunk_size	Optional chunk size (in bytes). (type: `int`)

def upload_object(self, file_path, container, object_name, extra=None, verify_hash=True): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver, libcloud.storage.drivers.s3.S3StorageDriver

Upload an object.

Parameters	file_path	Path to the object on disk. (type: `str`)
	container	Destination container. (type: `Container`)
	object_name	Object name. (type: `str`)
	extra	(optional) Extra attributes (driver specific). (type: `dict`)
	verify_hash	True to do a file integrity check. (type: `boolean`)

def upload_object_via_stream(self, iterator, container, object_name, extra=None): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver, libcloud.storage.drivers.s3.S3StorageDriver

Parameters	iterator	An object which implements the iterator interface. (type: `object`)
	container	Destination container. (type: `Container`)
	object_name	Object name. (type: `str`)
	extra	(optional) Extra attributes (driver specific). (type: `dict`)

def delete_object(self, obj): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver, libcloud.storage.drivers.s3.S3StorageDriver

Delete an object.

Parameters	obj	Object instance. (type: `Object`)
Returns	`bool` True on success.

def create_container(self, container_name): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver, libcloud.storage.drivers.s3.S3StorageDriver

Create a new container.

Parameters	container_name	Container name. (type: `str`)
Returns	`Container` instance on success.

def delete_container(self, container): (source)

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver, libcloud.storage.drivers.dummy.DummyStorageDriver, libcloud.storage.drivers.s3.S3StorageDriver

Delete a container.

Parameters	container	Container instance (type: `Container`)
Returns	True on success, False otherwise. (type: `bool`)

def _get_object(self, obj, callback, callback_kwargs, response, success_status_code=None): (source)

Call passed callback and start transfer of the object'

Parameters	obj	Object instance. (type: `Object`)
	callback	Function which is called with the passed callback_kwargs (type: `Function`)
	callback_kwargs	Keyword arguments which are passed to the callback. (type: `dict`)
	response	Response instance.
	success_status_code	Status code which represents a successful transfer (defaults to httplib.OK) (type: `int`)
Returns	True on success, False otherwise. (type: `bool`)
Unknown Field: typed	response	`Response`

def _save_object(self, response, obj, destination_path, overwrite_existing=False, delete_on_failure=True, chunk_size=None): (source)

Save object to the provided path.

Parameters	response	RawResponse instance. (type: `RawResponse`)
	obj	Object instance. (type: `Object`)
	destination_path	Destination directory. (type: `Str`)
	delete_on_failure	True to delete partially downloaded object if the download fails. (type: `bool`)
	overwrite_existing	True to overwrite a local path if it already exists. (type: `bool`)
	chunk_size	Optional chunk size (defaults to `libcloud.storage.base.CHUNK_SIZE`, 8kb) (type: `int`)
Returns	True on success, False otherwise. (type: `bool`)

def _upload_object(self, object_name, content_type, upload_func, upload_func_kwargs, request_path, request_method='PUT', headers=None, file_path=None, iterator=None): (source)

Helper function for setting common request headers and calling the passed in callback which uploads an object.

def _stream_data(self, response, iterator, chunked=False, calculate_hash=True, chunk_size=None): (source)

Stream a data over an http connection.

Parameters	response	RawResponse object. (type: `RawResponse`)
	response	An object which implements an iterator interface or a File like object with read method. (type: `RawResponse`)
	chunk_size	Optional chunk size (defaults to CHUNK_SIZE) (type: `int`)
Returns	First item is a boolean indicator of success, second one is the uploaded data MD5 hash and the third one is the number of transferred bytes. (type: `tuple`)

def _upload_file(self, response, file_path, chunked=False, calculate_hash=True): (source)

Upload a file to the server.

Parameters	response	RawResponse object. (type: `RawResponse`)
	file_path	Path to a local file. (type: `str`)
	response	An object which implements an iterator interface (File object, etc.) (type: `RawResponse`)
Returns	First item is a boolean indicator of success, second one is the uploaded data MD5 hash and the third one is the number of transferred bytes. (type: `tuple`)

l.s.b.StorageDriver(object) : class documentation