Attention

You are looking at outdated documentation for version 2.x. A newer version is available.

wsgidav.fs_dav_provider.FileResource

class wsgidav.fs_dav_provider.FileResource(path, environ, filePath)

Bases: wsgidav.dav_provider.DAVNonCollection

Represents a single existing DAV resource instance.

See also _DAVResource, DAVNonCollection, and FilesystemProvider.

FileResource.beginWrite([contentType])	Open content as a stream for writing.
FileResource.copyMoveSingle(destPath, isMove)	See DAVResource.copyMoveSingle()
FileResource.createCollection(name)	Create a new collection as member of self.
FileResource.createEmptyResource(name)	Create and return an empty (length-0) resource as member of self.
FileResource.delete()	Remove this resource or collection (recursive).
FileResource.endWrite(withErrors)	Called when PUT has finished writing.
FileResource.finalizeHeaders(environ, …)	Perform custom operations on the response headers.
FileResource.getContent()	Open content as a stream for reading.
FileResource.getContentLength()	Returns the byte length of the content.
FileResource.getContentType()	Contains the Content-Type header returned by a GET without accept headers.
FileResource.getCreationDate()	Records the time and date the resource was created.
FileResource.getDescendants([collections, …])	Return a list _DAVResource objects of a collection (children, grand-children, …).
FileResource.getDirectoryInfo()	Return a list of dictionaries with information for directory rendering.
FileResource.getDisplayInfo()	Return additional info dictionary for displaying (optional).
FileResource.getDisplayName()	Provides a name for the resource that is suitable for presentation to a user.
FileResource.getEtag()	See http://www.webdav.org/specs/rfc4918.html#PROPERTY_getetag
FileResource.getHref()	Convert path to a URL that can be passed to XML responses.
FileResource.getLastModified()	Contains the Last-Modified header returned by a GET method without accept headers.
FileResource.getMemberList()	Return a list of direct members (_DAVResource or derived objects).
FileResource.getMemberNames()	Return list of (direct) collection member names (UTF-8 byte strings).
FileResource.getPreferredPath()	Return preferred mapping for a resource mapping.
FileResource.getProperties(mode[, nameList])	Return properties as list of 2-tuples (name, value).
FileResource.getPropertyNames(isAllProp)	Return list of supported property names in Clark Notation.
FileResource.getPropertyValue(propname)	Return the value of a property.
FileResource.getRefUrl()	Return the quoted, absolute, unique URL of a resource, relative to appRoot.
FileResource.handleCopy(destPath, depthInfinity)	Handle a COPY request natively.
FileResource.handleDelete()	Handle a DELETE request natively.
FileResource.handleMove(destPath)	Handle a MOVE request natively.
FileResource.isLocked()	Return True, if URI is locked.
FileResource.moveRecursive(destPath)	See DAVResource.moveRecursive()
FileResource.preventLocking()	Return True, to prevent locking.
FileResource.removeAllLocks(recursive)
FileResource.removeAllProperties(recursive)	Remove all associated dead properties.
FileResource.resolve(scriptName, pathInfo)	Return a _DAVResource object for the path (None, if not found).
FileResource.setLastModified(destPath, …)	Set last modified time for destPath to timeStamp on epoch-format
FileResource.setPropertyValue(propname, value)	Set a property value or remove a property.
FileResource.supportContentLength()	Return True, if this resource supports Content-Length.
FileResource.supportEtag()	Return True, if this resource supports ETags.
FileResource.supportModified()	Return True, if this resource supports last modified dates.
FileResource.supportRanges()	Return True, if this non-resource supports Range on GET requests.
FileResource.supportRecursiveDelete()	Return True, if delete() may be called on non-empty collections (see comments there).
FileResource.supportRecursiveMove(destPath)	Return True, if moveRecursive() is available (see comments there).