t.v.b.o.OSDirectory(OSNode) : class documentation

Part of twisted.vfs.backends.osfs View Source View In Hierarchy

Implements interfaces: twisted.vfs.ivfs.IFileSystemContainer

No class docstring
Method children See IFileSystemContainer.
Method child See IFileSystemContainer.
Class Method childDirFactory Returns a callable that will be used to construct instances for
Method childFileFactory Returns a callable that will be used to construct instances for files
Method createDirectory See IFileSystemContainer.
Method createFile See IFileSystemContainer.
Method create Undocumented
Method remove Removes this node.
Method exists See IFileSystemContainer.

Inherited from OSNode:

Method __init__ Undocumented
Method getMetadata Feturns a map of arbitrary metadata. As an example, here's what SFTP
Method setMetadata Undocumented
Method rename Rename this node to newName.
def children(self): (source)
from twisted.vfs.ivfs.IFileSystemContainer
See IFileSystemContainer.
def child(self, childName): (source)
from twisted.vfs.ivfs.IFileSystemContainer
See IFileSystemContainer.
@classmethod
def childDirFactory(cls): (source)
Returns a callable that will be used to construct instances for subdirectories of this OSDirectory. The callable should accept the same interface as OSDirectory.__init__; i.e. take three args (path, name, parent), and return an IFileSystemContainer.

By default, this will be the class of the child's parent. Override this method if you want a different behaviour.

def childFileFactory(self): (source)
Returns a callable that will be used to construct instances for files in this OSDirectory. The callable should accept the same interface as OSFile.__init__; i.e. take three args (path, name, parent), and return an IFileSystemLeaf.

By default, this will be OSFile. Override this method if you want a different behaviour.

def createDirectory(self, childName): (source)
from twisted.vfs.ivfs.IFileSystemContainer
See IFileSystemContainer.
def createFile(self, childName, exclusive=True): (source)
from twisted.vfs.ivfs.IFileSystemContainer
See IFileSystemContainer.
def create(self): (source)
Undocumented
def remove(self): (source)
from twisted.vfs.ivfs.IFileSystemNode
overrides twisted.vfs.backends.osfs.OSNode.remove
Removes this node. An error is raised if the node is a directory and is not empty.
def exists(self, childName): (source)
from twisted.vfs.ivfs.IFileSystemContainer
See IFileSystemContainer.
API Documentation for Twisted, generated by pydoctor at 2010-07-05 15:03:32.