t.w.s.File(StaticRenderMixin) : class documentation

Part of twisted.web2.static View Source View In Hierarchy

Implements interfaces: twisted.web2.iweb.IResource

File is a resource that represents a plain non-interpreted file (although it can look for an extension like .rpy or .cgi and hand the file to a processor for interpretation if you wish). Its constructor takes a file path.

Alternatively, you can give a directory path to the constructor. In this case the resource will represent that directory, and its children will be files underneath that directory. This provides access to an entire filesystem tree with a single Resource.

If you map the URL 'http://server/FILE' to a resource created as File('/tmp'), then http://server/FILE/ will return an HTML-formatted listing of the /tmp/ directory, and http://server/FILE/foo/bar.html will return the contents of /tmp/foo/bar.html .

Method __init__ Create a file with the given path.
Method exists
Method etag
Method lastModified
Method creationDate
Method contentLength
Method contentType
Method contentEncoding
Method displayName
Method ignoreExt Ignore the given extension.
Method directoryListing Undocumented
Method putChild Register a child with the given name with this resource.
Method getChild Look up a child resource.
Method listChildren
Method locateChild See IResource.locateChild.
Method renderHTTP See resource.RenderMixIn.renderHTTP.
Method render You know what you doing.
Method createSimilarFile Undocumented
Method _getContentTypes Undocumented
Method _initTypeAndEncoding Undocumented

Inherited from StaticRenderMixin:

Method checkPreconditions Checks all preconditions imposed by this resource upon a request made

Inherited from RenderMixin (via StaticRenderMixin):

Method allowedMethods
Method http_OPTIONS Respond to a OPTIONS request.
Method http_TRACE Respond to a TRACE request.
Method http_HEAD Respond to a HEAD request.
Method http_GET Respond to a GET request.
def _getContentTypes(self): (source)
Undocumented
def __init__(self, path, defaultType='text/plain', ignoredExts=(), processors=None, indexNames=None): (source)
Create a file with the given path.
def exists(self): (source)
overrides twisted.web2.static.MetaDataMixin.exists
ReturnsTrue if the resource exists on the server, False otherwise.
def etag(self): (source)
overrides twisted.web2.static.MetaDataMixin.etag
ReturnsThe current etag for the resource if available, None otherwise.
def lastModified(self): (source)
overrides twisted.web2.static.MetaDataMixin.lastModified
ReturnsThe last modified time of the resource if available, None otherwise.
def creationDate(self): (source)
overrides twisted.web2.static.MetaDataMixin.creationDate
ReturnsThe creation date of the resource if available, None otherwise.
def contentLength(self): (source)
overrides twisted.web2.static.MetaDataMixin.contentLength
ReturnsThe size in bytes of the resource if available, None otherwise.
def _initTypeAndEncoding(self): (source)
Undocumented
def contentType(self): (source)
overrides twisted.web2.static.MetaDataMixin.contentType
ReturnsThe MIME type of the resource if available, None otherwise.
def contentEncoding(self): (source)
overrides twisted.web2.static.MetaDataMixin.contentEncoding
ReturnsThe encoding of the resource if available, None otherwise.
def displayName(self): (source)
overrides twisted.web2.static.MetaDataMixin.displayName
ReturnsThe display name of the resource if available, None otherwise.
def ignoreExt(self, ext): (source)
Ignore the given extension.

Serve file.ext if file is requested

def directoryListing(self): (source)
Undocumented
def putChild(self, name, child): (source)
Register a child with the given name with this resource.
Parametersnamethe name of the child (a URI path segment)
childthe child to register
def getChild(self, name): (source)
Look up a child resource.
Returnsthe child of this resource with the given name.
def listChildren(self): (source)
Returnsa sequence of the names of all known children of this resource.
def locateChild(self, req, segments): (source)
from twisted.web2.iweb.IResource
See IResource.locateChild.
def renderHTTP(self, req): (source)
from twisted.web2.iweb.IResource
overrides twisted.web2.static.StaticRenderMixin.renderHTTP
See resource.RenderMixIn.renderHTTP.

This implementation automatically sets some headers on the response based on data available from MetaDataMixin methods.

def render(self, req): (source)
overrides twisted.web2.resource.RenderMixin.render
You know what you doing.
def createSimilarFile(self, path): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2010-07-05 15:03:32.