API reference

API reference#

This page provides an auto-generated summary of processor_tools’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

Processors#

processor.BaseProcessor

Base class for processor implementations

processor.ProcessorFactory

Container for sets of processor objects

processor.NullProcessor

Null processor for processing variables where no processing is required.

context.Context

Class to determine and store processing state

context.set_global_supercontext

Sets a context object to become a global supercontext for other context objects

context.clear_global_supercontext

Unsets all global supercontexts

Utilities#

config.config_io.read_config

Read configuration file, supported file types:

config.config_io.write_config

Write configuration file, supported file types:

config.config_io.build_configdir

Writes set of configuration files to defined directory

config.config_io.find_config

Returns configuration files in directory (i.e. files that can be read by read_config).

config.init_config.ConfigInit

Defines and initialises a set of configuration files for a package.