Package cherrypy :: Module _cptools
[hide private]
[frames] | no frames]

Module _cptools

source code

CherryPy tools. A "tool" is any helper, adapted to CP.

Tools are usually designed to be used in a variety of ways (although some
may only offer one if they choose):
    
    Library calls:
        All tools are callables that can be used wherever needed.
        The arguments are straightforward and should be detailed within the
        docstring.
    
    Function decorators:
        All tools, when called, may be used as decorators which configure
        individual CherryPy page handlers (methods on the CherryPy tree).
        That is, "@tools.anytool()" should "turn on" the tool via the
        decorated function's _cp_config attribute.
    
    CherryPy config:
        If a tool exposes a "_setup" callable, it will be called
        once per Request (if the feature is "turned on" via config).

Tools may be implemented as any object with a namespace. The builtins
are generally either modules or instances of the tools.Tool class.



Classes [hide private]
  Tool
A registered function for use with CherryPy request-processing hooks.
  HandlerTool
Tool which is called 'before main', that may skip normal handlers.
  ErrorTool
Tool which is used to replace the default request.error_response.
  SessionTool
Session Tool for CherryPy.
  XMLRPCController
  WSGIAppTool
A tool for running any WSGI middleware/application within CP.
  SessionAuthTool
  CachingTool
Caching Tool for CherryPy.
  Toolbox
A collection of Tools.
Variables [hide private]
  default_toolbox = <cherrypy._cptools.Toolbox object at 0x40646...
Variables Details [hide private]

default_toolbox

Value:
_cptools.default_toolbox