python.ConfigFactory.FactoryBlock Class Reference

Collaboration diagram for python.ConfigFactory.FactoryBlock:

Public Member Functions
def	__init__ (self, alg, algName, options, defaults, subAlgs=None)
def	makeConfig (self, funcOptions)

Public Attributes
	alg
	algName
	options
	defaults
	subAlgs

Detailed Description

Definition at line 46 of file ConfigFactory.py.

Constructor & Destructor Documentation

__init__()

def python.ConfigFactory.FactoryBlock.__init__	(		self,
			alg,
			algName,
			options,
			defaults,
			subAlgs = None
	)

Definition at line 49 of file ConfigFactory.py.

    def __init__(self, alg, algName, options, defaults, subAlgs=None):
        self.alg = alg
        self.algName = algName
        self.options = options
        self.defaults = defaults
        if subAlgs is None:
            self.subAlgs = {}
        else:
            self.subAlgs = subAlgs
 
 

Member Function Documentation

makeConfig()

def python.ConfigFactory.FactoryBlock.makeConfig	(		self,
			funcOptions
	)

Parameters
----------
funcName: str
    name associated with the algorithm. This name must have been added to the
    list of available algorithms
funcOptions: dict
    dictionary containing options for the algorithm read from the YAML file

Returns
-------
    configSequence

Definition at line 60 of file ConfigFactory.py.

    def makeConfig(self, funcOptions):
            """
            Parameters
            ----------
            funcName: str
                name associated with the algorithm. This name must have been added to the
                list of available algorithms
            funcOptions: dict
                dictionary containing options for the algorithm read from the YAML file
 
            Returns
            -------
                configSequence
            """
            configSeq = ConfigSequence()
 
            func = self.alg
            funcName = self.algName
            funcDefaults = getDefaultArgs(func)
            defaults = self.defaults
 
            args = {}
            # loop over all options for the function
            for arg in getFuncArgs(func):
                # supplied from config file
                if arg in funcOptions:
                    args[arg] = funcOptions[arg]
                # defaults set in function def
                elif arg in funcDefaults:
                    args[arg] = funcDefaults[arg]
                # defaults provided when func was added
                elif defaults is not None and arg in defaults:
                    args[arg] = defaults[arg]
                elif arg == 'seq':
                    # 'seq' should be first arg of func (not needed for class)
                    args[arg] = configSeq
                elif arg == 'kwargs':
                    # cannot handle arbitrary parameters
                    continue
                else:
                    raise ValueError(f"{arg} is required for {funcName}")
            if inspect.isclass(func):
                configSeq.append(func(**args))
            else:
                func(**args)
            return configSeq, args.keys()
 
 

Member Data Documentation

alg

python.ConfigFactory.FactoryBlock.alg

Definition at line 50 of file ConfigFactory.py.

algName

python.ConfigFactory.FactoryBlock.algName

Definition at line 51 of file ConfigFactory.py.

defaults

python.ConfigFactory.FactoryBlock.defaults

Definition at line 53 of file ConfigFactory.py.

options

python.ConfigFactory.FactoryBlock.options

Definition at line 52 of file ConfigFactory.py.

subAlgs

python.ConfigFactory.FactoryBlock.subAlgs

Definition at line 55 of file ConfigFactory.py.

---

The documentation for this class was generated from the following file:

• ConfigFactory.py