twisted.web.static

module documentation
(source)

Static resources for twisted.web.

Variable dangerousPathError Undocumented
Function isDangerous Undocumented
Class Data This is a static, in-memory resource.
Function addSlash Add a trailing slash to request's URI. Deprecated, do not use.
Class Redirect Undocumented
Class Registry I am a Componentized object that will be made available to internal Twisted file-based dynamic web content such as .rpy and .epy scripts.
Function loadMimeTypes Produces a mapping of extensions (with leading dot) to MIME types.
Function getTypeAndEncoding Undocumented
Class File No summary
Class StaticProducer Superclass for classes that implement the business of producing.
Class NoRangeStaticProducer A StaticProducer that writes the entire file to the request.
Class SingleRangeStaticProducer A StaticProducer that writes a single chunk of a file to the request.
Class MultipleRangeStaticProducer A StaticProducer that writes several chunks of a file to the request.
Class ASISProcessor Serve files exactly as responses without generating a status-line or any headers. Inspired by Apache's mod_asis.
Function formatFileSize Format the given file size in bytes to human readable format.
Class DirectoryLister Print the content of a directory.
Function _addSlash Add a trailing slash to request's URI.
dangerousPathError = (source)

Undocumented

def isDangerous(path): (source)

Undocumented

def addSlash(request): (source)

Add a trailing slash to request's URI. Deprecated, do not use.

def _addSlash(request): (source)

Add a trailing slash to request's URI.

ParametersrequestThe incoming request to add the ending slash to. (type: An object conforming to twisted.web.iweb.IRequest)
ReturnsA URI with a trailing slash, with query and fragment preserved. (type: bytes)
def loadMimeTypes(mimetype_locations=None, init=mimetypes.init): (source)

Produces a mapping of extensions (with leading dot) to MIME types.

It does this by calling the init function of the mimetypes module. This will have the side effect of modifying the global MIME types cache in that module.

Multiple file locations containing mime-types can be passed as a list. The files will be sourced in that order, overriding mime-types from the files sourced beforehand, but only if a new entry explicitly overrides the current entry.

Parametersmimetype_locationsOptional. List of paths to mime.types style files that should be used. (type: iterable of paths or None)
initThe init function to call. Defaults to the global init function of the mimetypes module. For internal use (testing) only. (type: callable)
def getTypeAndEncoding(filename, types, encodings, defaultType): (source)

Undocumented

def formatFileSize(size): (source)

Format the given file size in bytes to human readable format.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.