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

Class DeprecatedTool

source code

object --+    
         |    
      Tool --+
             |
            DeprecatedTool

Instance Methods [hide private]
 
__init__(self, point, warnmsg=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__call__(self, *args, **kwargs)
Compile-time decorator (turn on the tool in config).
source code
 
_setup(self)
Hook this tool into cherrypy.request.
source code

Inherited from Tool (private): _get_on, _merged_args, _set_on, _setargs

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  _name = None
hash(x)
  warnmsg = 'This Tool is deprecated.'

Inherited from Tool: namespace

Properties [hide private]

Inherited from Tool: on

Inherited from object: __class__

Method Details [hide private]

__init__(self, point, warnmsg=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

__call__(self, *args, **kwargs)
(Call operator)

source code 

Compile-time decorator (turn on the tool in config).

For example:

   @tools.proxy()
   def whats_my_base(self):
       return cherrypy.request.base
   whats_my_base.exposed = True
Overrides: Tool.__call__
(inherited documentation)

_setup(self)

source code 

Hook this tool into cherrypy.request.

The standard CherryPy request object will automatically call this method when the tool is "turned on" in config.

Overrides: Tool._setup
(inherited documentation)