wsgidav.fs_dav_provider.FileResource#

class wsgidav.fs_dav_provider.FileResource(path: str, environ: dict, file_path: str)[source]#

Bases: DAVNonCollection

Represents a single existing DAV resource instance.

See also _DAVResource, DAVNonCollection, and FilesystemProvider.

FileResource.begin_write(*[, content_type])

Open content as a stream for writing.

FileResource.copy_move_single(dest_path, *, ...)

See DAVResource.copy_move_single()

FileResource.create_collection(name)

Create a new collection as member of self.

FileResource.create_empty_resource(name)

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

FileResource.delete()

Remove this resource or collection (recursive).

FileResource.end_write(*, with_errors)

Called when PUT has finished writing.

FileResource.finalize_headers(environ, ...)

Perform custom operations on the response headers.

FileResource.get_available_bytes()

Return available bytes of the DAV collection.

FileResource.get_content()

Open content as a stream for reading.

FileResource.get_content_length()

Returns the byte length of the content.

FileResource.get_content_type()

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

FileResource.get_creation_date()

Records the time and date the resource was created.

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

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

FileResource.get_directory_info()

Return a list of dictionaries with information for directory rendering.

FileResource.get_display_info()

Return additional info dictionary for displaying (optional).

FileResource.get_display_name()

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

FileResource.get_etag()

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

FileResource.get_href()

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

FileResource.get_last_modified()

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

FileResource.get_member(name)

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

FileResource.get_member_list()

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

FileResource.get_member_names()

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

FileResource.get_preferred_path()

Return preferred mapping for a resource mapping.

FileResource.get_properties(mode, *[, name_list])

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

FileResource.get_property_names(*, is_allprop)

Return list of supported property names in Clark Notation.

FileResource.get_property_value(name)

Return the value of a property.

FileResource.get_ref_url()

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

FileResource.get_used_bytes()

Return used bytes of the DAV collection.

FileResource.handle_copy(dest_path, *, ...)

Handle a COPY request natively.

FileResource.handle_delete()

Handle a DELETE request natively.

FileResource.handle_move(dest_path)

Handle a MOVE request natively.

FileResource.is_link()

FileResource.is_locked()

Return True, if URI is locked.

FileResource.move_recursive(dest_path)

See DAVResource.move_recursive()

FileResource.prevent_locking()

Return True, to prevent locking.

FileResource.remove_all_locks(*, recursive)

FileResource.remove_all_properties(*, recursive)

Remove all associated dead properties.

FileResource.resolve(script_name, path_info)

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

FileResource.set_last_modified(dest_path, ...)

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

FileResource.set_property_value(name, value, *)

Set a property value or remove a property.

FileResource.support_content_length()

Return True, if this resource supports Content-Length.

FileResource.support_etag()

Return True, if this resource supports ETags.

FileResource.support_modified()

Return True, if this resource supports last modified dates.

FileResource.support_ranges()

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

FileResource.support_recursive_delete()

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

FileResource.support_recursive_move(dest_path)

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