wsgidav.dav_provider.DAVCollection#

class wsgidav.dav_provider.DAVCollection(path: str, environ: dict)[source]#

Bases: _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.begin_write(*[, content_type])

Open content as a stream for writing.

DAVCollection.copy_move_single(dest_path, *, ...)

Copy or move this resource to destPath (non-recursive).

DAVCollection.create_collection(name)

Create a new collection as member of self.

DAVCollection.create_empty_resource(name)

Create and return an empty (length-0) resource as member of self.

DAVCollection.delete()

Remove this resource (possibly recursive).

DAVCollection.end_write(*, with_errors)

Called when PUT has finished writing.

DAVCollection.finalize_headers(environ, ...)

Perform custom operations on the response headers.

DAVCollection.get_available_bytes()

Return available bytes of the DAV collection.

DAVCollection.get_content()

Open content as a stream for reading.

DAVCollection.get_content_length()

Contains the Content-Length header returned by a GET without accept headers.

DAVCollection.get_content_type()

Contains the Content-Type header returned by a GET without accept headers.

DAVCollection.get_creation_date()

Records the time and date the resource was created.

DAVCollection.get_descendants(*[, ...])

Return a list _DAVResource objects of a collection (children, grand-children, ...).

DAVCollection.get_directory_info()

Return a list of dictionaries with information for directory rendering.

DAVCollection.get_display_info()

Return additional info dictionary for displaying (optional).

DAVCollection.get_display_name()

Provides a name for the resource that is suitable for presentation to a user.

DAVCollection.get_etag()

See http://www.webdav.org/specs/rfc4918.html#PROPERTY_getetag

DAVCollection.get_href()

Convert path to a URL that can be passed to XML responses.

DAVCollection.get_last_modified()

Contains the Last-Modified header returned by a GET method without accept headers.

DAVCollection.get_member(name)

Return child resource with a given name (None, if not found).

DAVCollection.get_member_list()

Return a list of direct members (_DAVResource or derived objects).

DAVCollection.get_member_names()

Return list of (direct) collection member names (UTF-8 byte strings).

DAVCollection.get_preferred_path()

Return preferred mapping for a resource mapping.

DAVCollection.get_properties(mode, *[, ...])

Return properties as list of 2-tuples (name, value).

DAVCollection.get_property_names(*, is_allprop)

Return list of supported property names in Clark Notation.

DAVCollection.get_property_value(name)

Return the value of a property.

DAVCollection.get_ref_url()

Return the quoted, absolute, unique URL of a resource, relative to appRoot.

DAVCollection.get_used_bytes()

Return used bytes of the DAV collection.

DAVCollection.handle_copy(dest_path, *, ...)

Handle a COPY request natively.

DAVCollection.handle_delete()

Handle a DELETE request natively.

DAVCollection.handle_move(dest_path)

Handle a MOVE request natively.

DAVCollection.is_link()

DAVCollection.is_locked()

Return True, if URI is locked.

DAVCollection.move_recursive(dest_path)

Move this resource and members to destPath.

DAVCollection.prevent_locking()

Return True, to prevent locking.

DAVCollection.remove_all_locks(*, recursive)

DAVCollection.remove_all_properties(*, recursive)

Remove all associated dead properties.

DAVCollection.resolve(script_name, path_info)

Return a _DAVResource object for the path (None, if not found).

DAVCollection.set_last_modified(dest_path, ...)

Set last modified time for destPath to timeStamp on epoch-format

DAVCollection.set_property_value(name, value, *)

Set a property value or remove a property.

DAVCollection.support_content_length()

Return True, if this resource supports Content-Length.

DAVCollection.support_etag()

Return True, if this resource supports ETags.

DAVCollection.support_modified()

Return True, if this resource supports last modified dates.

DAVCollection.support_ranges()

Return True, if this non-resource supports Range on GET requests.

DAVCollection.support_recursive_delete()

Return True, if delete() may be called on non-empty collections (see comments there).

DAVCollection.support_recursive_move(dest_path)

Return True, if move_recursive() is available (see comments there).