pyanno4rt.input_check

Input checking module.

This module aims to provide classes and functions to perform input parameter checks.

Subpackages

Overview

Classes
`InputChecker`	Input checker class.

Classes

class pyanno4rt.input_check.InputChecker[source]

Input checker class.

This class provides methods to perform input checks on the user-defined parameters for objects of any class from base. It ensures the validity of the internal program steps with regard to the exogenous variables.

check_map

Dictionary with all mappings between parameter names and validity check functions.

Type:: dict

Raises:: ValueError – If non-unique parameter names are found.

Notes

The InputChecker class relies on the uniqueness of the parameter names to create a dictionary-based mapping. Hence, make sure to assign unique labels for all parameters to be checked!

Overview

Methods
`approve`(input_dictionary)	Approve the input dictionary items (parameter names and values) by running the corresponding check functions.

Members

approve(input_dictionary)[source]

Approve the input dictionary items (parameter names and values) by running the corresponding check functions.

Parameters:: input_dictionary (dict) – Dictionary with the mappings between parameter names and values to be checked.