More documentation on all the core storage API methods

This commit is contained in:
Christopher Allan Webber 2011-04-09 14:26:41 -05:00
parent ef10e3a2c7
commit b0de01cf01

View File

@ -84,11 +84,22 @@ class StorageInterface(object):
# Subclasses should override this method.
self.__raise_not_implemented()
def get_file(self, filepath):
def get_file(self, filepath, mode):
"""
Return a file-like object for reading/writing from this filepath.
Should create directories, buckets, whatever, as necessary.
"""
# Subclasses should override this method.
self.__raise_not_implemented()
def delete_file(self, filepath):
"""
Delete or dereference the file at filepath.
This might need to delete directories, buckets, whatever, for
cleanliness. (Be sure to avoid race conditions on that though)
"""
# Subclasses should override this method.
self.__raise_not_implemented()