Attention

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

wsgidav.dav_provider.DAVCollection

class wsgidav.dav_provider.DAVCollection(path, environ)

Bases: wsgidav.dav_provider._DAVResource

A DAVCollection is a _DAVResource, that has members (like a ‘folder’ on a filesystem).

A DAVCollecion ‘knows’ its members, and how to obtain them from the backend storage. There is also optional built-in support for member caching.

See also _DAVResource

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