python.ConfigSequence Namespace Reference

Classes
class	ConfigSequence

Functions
	groupBlocks (func)

Variables
	logCPAlgCfgSeq = logging.getLogger('CPAlgCfgSeq')
	_instanceNameExpr = re.compile ('^[_a-zA-Z0-9]*$')

Function Documentation

groupBlocks()

groupBlocks

(

func

)

Decorates a configSequence or function with 'seq' as a
argument.

Sets groupName to the name of the decorated function or
class plus an integer for each ConfigBlock in the configSequence.

Blocks with the same groupName can be configured together.

Definition at line 13 of file ConfigSequence.py.

def groupBlocks(func):
    """
    Decorates a configSequence or function with 'seq' as a
    argument.
 
    Sets groupName to the name of the decorated function or
    class plus an integer for each ConfigBlock in the configSequence.
 
    Blocks with the same groupName can be configured together.
    """
    @wraps(func)
    def wrapper(**kwargs):
        func(**kwargs)
        groupName = f"{func.__name__}_{randrange(10**8):08}"
        for block in kwargs['seq']:
            block.setOptionValue('groupName', groupName)
    return wrapper
 

Variable Documentation

_instanceNameExpr

python.ConfigSequence._instanceNameExpr = re.compile ('^[_a-zA-Z0-9]*$')

protected

Definition at line 11 of file ConfigSequence.py.

logCPAlgCfgSeq

python.ConfigSequence.logCPAlgCfgSeq = logging.getLogger('CPAlgCfgSeq')

Definition at line 5 of file ConfigSequence.py.