Axon.debugConfigFile

Reading debugging configuration files

readConfig(filename)

Debugging configuration file format

The readConfig() method reads debugging configuration from the specified file.

Axon.debug.debug uses this to read configuration for itself.

Each call to output debugging information specifies what section it belongs to and the level of detail it represents. A configuration file specifies what sections should be expected and what maximum level of detail should be output for each.

Debugging configuration file format

Debugging configuration files are simple text files.

Comments are lines beginning with a hash '#' character
Blank lines are permitted
Configuration lines are a space (not tab) separated triple of section name, level of detail, and location

For example:

# The following tags are for debugging the debug system
#

debugTestClass.even         5  default
debugTestClass.triple       10 default
debugTestClass.run          1  default
debugTestClass.__init__     5  default
debugTestClass.randomChange 10 default

For a given section, the level number specifies the maximum level of detail that you want outputted. Any calls to output debugging information for that section but with a higher level number will be filtered out.

The final location field is currently not used. It is recommended to specify "default" for the moment.

Axon.debugConfigFile.readConfig

readConfig(filename)

Reads debug configuration from the specified file.

Returns a dictionary mapping debugging section names to maximum levels of detail to be output for that section.

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 01 Feb 2010 at 04:00:28 UTC/GMT

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)