exosim.utils.klass_factory

Functions

find_klass_in_file(python_file, baseclass)	It finds in the indicated python file a class that is a sublcass of the given one.
load_klass(input, baseclass)	It returns a class that is a subclass of the given base class.
find_task(input, baseclass)	It looks for a class that is a subclass of the base class indicated.
find_and_run_task(parameters, key, baseclass)	It looks in the input parameters for a class that is a subclass of the base class indicated, and it initialises it.

Module Contents

find_klass_in_file(python_file, baseclass)

It finds in the indicated python file a class that is a sublcass of the given one.

Parameters:

• python_file (str) – python file name

• baseclass (class) – reference class to search for

Returns:

class found in the python file.

Return type:

class

load_klass(input, baseclass)

It returns a class that is a subclass of the given base class.

Parameters:

• input (str or class) – if is a string, find_klass_in_file is used to return the right class. If is a class, it checks whether it is an eligible class or not.

• baseclass (class) – reference class to search for

Returns:

subclass of baseclass

Return type:

class

find_task(input, baseclass)

It looks for a class that is a subclass of the base class indicated.

Parameters:

• input (str or object) – can either be a string indicating a class name, a python file, or it can be a class.

• baseclass (object) – reference class

Return type:

object

find_and_run_task(parameters, key, baseclass)

It looks in the input parameters for a class that is a subclass of the base class indicated, and it initialises it.

Parameters:

• parameters (dict) – input dictionaty

• key (str) – string indicating the keyword for the class name

• baseclass (object) – reference class

Return type:

callable