l.p.f.UploadFileSystem : class documentation

Part of lp.poppy.filesystem View In Hierarchy

Implements interfaces: zope.server.interfaces.ftp.IFileSystem

No class docstring
Method __init__ Undocumented
Method type Return the file type at path
Method names Return a sequence of the names in a directory
Method ls Return a sequence of information objects.
Method readfile Outputs the file at path to a stream.
Method lsinfo Return information for a unix-style ls listing for the path
Method mtime Return the modification time for the file
Method size Return the size of the file at path
Method mkdir Create a directory.
Method remove Remove a file.
Method rmdir Remove a directory.
Method rename Rename a file.
Method writefile Write data to a file.
Method writable Return boolean indicating whether a file at path is writable.
Method _full Returns the full path name (i.e. rootpath + path)
Method _sanitize Undocumented
def __init__(self, rootpath):
Undocumented
def _full(self, path):
Returns the full path name (i.e. rootpath + path)
def _sanitize(self, path):
Undocumented
def type(self, path):
Return the file type at path

The 'type' command returns 'f' for a file, 'd' for a directory and None if there is no file.

def names(self, path, filter=None):
Return a sequence of the names in a directory

If the filter is not None, include only those names for which the filter returns a true value.

def ls(self, path, filter=None):
Return a sequence of information objects.

It considers the names in the given path (returned self.name()) and builds file information using self.lsinfo().

def readfile(self, path, outstream, start=0, end=None):
Outputs the file at path to a stream.

Not allowed - see filesystem.txt.

def lsinfo(self, path):
Return information for a unix-style ls listing for the path

See zope3's interfaces/ftp.py:IFileSystem for details of the dictionary's content.

def mtime(self, path):
Return the modification time for the file
def size(self, path):
Return the size of the file at path
def mkdir(self, path):
Create a directory.
def remove(self, path):
Remove a file.
def rmdir(self, path):
Remove a directory.

Remove a target path recursively.

def rename(self, old, new):
Rename a file.
def writefile(self, path, instream, start=None, end=None, append=False):
Write data to a file.

See zope3's interfaces/ftp.py:IFileSystem for details of the handling of the various arguments.

def writable(self, path):
Return boolean indicating whether a file at path is writable.
API Documentation for Launchpad, generated by pydoctor at 2010-09-27 00:00:11.