Package cherrypy :: Package lib :: Module static
[hide private]
[frames] | no frames]

Module static

source code

Functions [hide private]
 
serve_file(path, content_type=None, disposition=None, name=None)
Set status, headers, and body in order to serve the given file.
source code
 
serve_download(path, name=None)
Serve 'path' as an application/x-download attachment.
source code
 
_attempt(filename, content_types) source code
 
staticdir(section, dir, root='', match='', content_types=None, index='')
Serve a static resource from the given (root +) dir.
source code
 
staticfile(filename, root=None, match='', content_types=None)
Serve a static resource from the given (root +) filename.
source code
Function Details [hide private]

serve_file(path, content_type=None, disposition=None, name=None)

source code 

Set status, headers, and body in order to serve the given file.

The Content-Type header will be set to the content_type arg, if provided. If not provided, the Content-Type will be guessed by the file extension of the 'path' argument.

If disposition is not None, the Content-Disposition header will be set to "<disposition>; filename=<name>". If name is None, it will be set to the basename of path. If disposition is None, no Content-Disposition header will be written.

staticdir(section, dir, root='', match='', content_types=None, index='')

source code 

Serve a static resource from the given (root +) dir.

If 'match' is given, request.path_info will be searched for the given regular expression before attempting to serve static content.

If content_types is given, it should be a Python dictionary of {file-extension: content-type} pairs, where 'file-extension' is a string (e.g. "gif") and 'content-type' is the value to write out in the Content-Type response header (e.g. "image/gif").

If 'index' is provided, it should be the (relative) name of a file to serve for directory requests. For example, if the dir argument is '/home/me', the Request-URI is 'myapp', and the index arg is 'index.html', the file '/home/me/myapp/index.html' will be sought.

staticfile(filename, root=None, match='', content_types=None)

source code 

Serve a static resource from the given (root +) filename.

If 'match' is given, request.path_info will be searched for the given regular expression before attempting to serve static content.

If content_types is given, it should be a Python dictionary of {file-extension: content-type} pairs, where 'file-extension' is a string (e.g. "gif") and 'content-type' is the value to write out in the Content-Type response header (e.g. "image/gif").