Package cherrypy :: Module _cpchecker :: Class Checker
[hide private]
[frames] | no frames]

Class Checker

source code

object --+
         |
        Checker

A checker for CherryPy sites and their mounted applications.

When this object is called at engine startup, it executes each of its own methods whose names start with ``check_``. If you wish to disable selected checks, simply add a line in your global config which sets the appropriate method to False:

   [global]
   checker.check_skipped_app_config = False

You may also dynamically add or replace ``check_*`` methods in this way.

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__call__(self)
Run all check_* methods.
source code
 
formatwarning(self, message, category, filename, lineno, line=None)
Function to format a warning.
source code
 
check_app_config_entries_dont_start_with_script_name(self)
Check for Application config with sections that repeat script_name.
source code
 
check_site_config_entries_in_app_config(self)
Check for mounted Applications that have site-scoped config.
source code
 
check_skipped_app_config(self)
Check for mounted Applications that have no config.
source code
 
check_app_config_brackets(self)
Check for Application config with extraneous brackets in section names.
source code
 
check_static_paths(self)
Check Application config for incorrect static paths.
source code
 
_compat(self, config)
Process config and warn on each obsolete or deprecated entry.
source code
 
check_compatibility(self)
Process config and warn on each obsolete or deprecated entry.
source code
 
_known_ns(self, app) source code
 
check_config_namespaces(self)
Process config and warn on each unknown config namespace.
source code
 
_populate_known_types(self) source code
 
_known_types(self, config) source code
 
check_config_types(self)
Assert that config values are of the same type as default values.
source code
 
check_localhost(self)
Warn if any socket_host is 'localhost'.
source code

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

Class Variables [hide private]
  on = True
If True (the default), run all checks; if False, turn off all checks.
  global_config_contained_paths = False
  obsolete = {'log_access_file': 'log.access_file', 'log_config_...
  deprecated = {}
  extra_config_namespaces = []
  known_config_types = {'engine.__class__': <type 'type'>, 'engi...
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)

check_localhost(self)

source code 

Warn if any socket_host is 'localhost'. See #711.


Class Variable Details [hide private]

obsolete

Value:
{'log_access_file': 'log.access_file',
 'log_config_options': None,
 'log_file': 'log.error_file',
 'log_file_not_found': None,
 'log_request_headers': 'tools.log_headers.on',
 'log_to_screen': 'log.screen',
 'profiler.on': 'cherrypy.tree.mount(profiler.make_app(cherrypy.Applic\
ation(Root())))',
...

known_config_types

Value:
{'engine.__class__': <type 'type'>,
 'engine.__dict__': <type 'dict'>,
 'engine.__doc__': <type 'str'>,
 'engine.__module__': <type 'str'>,
 'engine._priorities': <type 'dict'>,
 'engine.execv': <type 'bool'>,
 'engine.listeners': <type 'dict'>,
 'engine.max_cloexec_files': <type 'int'>,
...