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, debug=False)
Set status, headers, and body in order to serve the given path.
source code
 
serve_fileobj(fileobj, content_type=None, disposition=None, name=None, debug=False)
Set status, headers, and body in order to serve the given file object.
source code
 
_serve_fileobj(fileobj, content_type, content_length, debug=False)
Internal.
source code
 
serve_download(path, name=None)
Serve 'path' as an application/x-download attachment.
source code
 
_attempt(filename, content_types, debug=False) source code
 
staticdir(section, dir, root='', match='', content_types=None, index='', debug=False)
Serve a static resource from the given (root +) dir.
source code
 
staticfile(filename, root=None, match='', content_types=None, debug=False)
Serve a static resource from the given (root +) filename.
source code
Variables [hide private]
  __package__ = 'cherrypy.lib'
Function Details [hide private]

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

source code 

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

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.

serve_fileobj(fileobj, content_type=None, disposition=None, name=None, debug=False)

source code 

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

The Content-Type header will be set to the content_type arg, if provided.

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

CAUTION: If the request contains a 'Range' header, one or more seek()s will be performed on the file object. This may cause undesired behavior if the file object is not seekable. It could also produce undesired results if the caller set the read position of the file object prior to calling serve_fileobj(), expecting that the data would be served starting from that position.

_serve_fileobj(fileobj, content_type, content_length, debug=False)

source code 

Internal. Set response.body to the given file object, perhaps ranged.

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

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

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

content_types
    If 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").

index
    If 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, debug=False)

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

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

content_types
    If 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").