python.ConfigFactory.FactoryBlock Class Reference

Collaboration diagram for python.ConfigFactory.FactoryBlock:

Public Member Functions
	makeConfig (self, funcOptions)

Public Attributes
	factoryName

Static Public Attributes
dict	subAlgs = field(default_factory=dict)

Detailed Description

Definition at line 48 of file ConfigFactory.py.

Member Function Documentation

makeConfig()

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

Parameters
----------
funcOptions: dict
    dictionary containing options for the algorithm read from the YAML file

Returns
-------
    configSequence, and the names of the arguments passed to the algorithm

Definition at line 59 of file ConfigFactory.py.

    def makeConfig(self, funcOptions):
        """
        Parameters
        ----------
        funcOptions: dict
            dictionary containing options for the algorithm read from the YAML file
 
        Returns
        -------
            configSequence, and the names of the arguments passed to the algorithm
        """
        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)
        configSeq.setFactoryName(self.factoryName)
        return configSeq, args.keys()
 
 

Member Data Documentation

factoryName

python.ConfigFactory.FactoryBlock.factoryName

Definition at line 101 of file ConfigFactory.py.

subAlgs

dict python.ConfigFactory.FactoryBlock.subAlgs = field(default_factory=dict)

static

Definition at line 56 of file ConfigFactory.py.

---

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

• ConfigFactory.py