a sequence of ConfigBlock objects
This could in principle just be a simple python list, and maybe we
change it to that at some point (10 Mar 22). Having it as its own
class allows to implement some helper functions.
This implements an interface similar to ConfigBlock, but it
doesn't derive from it, as ConfigBlock will likely gain
functionality in the future that wouldn't work for a sequence (or
wouldn't work in the same way).
Definition at line 28 of file ConfigSequence.py.
def python.ConfigSequence.ConfigSequence.reorderAlgs |
( |
|
self | ) |
|
Check for blocks with dependencies.
If a block required another block that is not present, will
throw an error; Otherwise, will move block immediately after
required block. If dependency is not required, will move
after other block, if it is present.
Note: this implementation can only move blocks forward.
Definition at line 77 of file ConfigSequence.py.
77 def reorderAlgs(self):
79 Check for blocks with dependencies.
81 If a block required another block that is not present, will
82 throw an error; Otherwise, will move block immediately after
83 required block. If dependency is not required, will move
84 after other block, if it is present.
86 Note: this implementation can only move blocks forward.
88 def moveBlock(blocks):
89 for i, block
in enumerate(blocks):
91 ignore = block.getOptionValue(
'ignoreDependencies')
92 if block.hasDependencies():
94 for dep
in block.getDependencies():
99 lastIdx =
max(index
for index,value
in enumerate(blocks)
if value == dep.blockName)
103 raise ValueError(f
"{dep} block is required"
104 f
" for {block} but was not found.")
107 logCPAlgCfgSeq.info(f
"Moving {block} after {blocks[depIdx]}")
109 blocks.insert(depIdx, blocks.pop(i))
114 for _
in range(MAXTRIES):
115 if moveBlock(self._blocks):
119 raise Exception(
"Could not order blocks based on dependencies"
120 f
" in {MAXTRIES} moves.")
def python.ConfigSequence.ConfigSequence.setOptionValue |
( |
|
self, |
|
|
|
name, |
|
|
|
value, |
|
|
** |
kwargs |
|
) |
| |
set the given option on the sequence
The name should generally be of the form
"groupName.optionName" to identify what group the option
belongs to.
For simplicity I also allow a ".optionName" here, which will
then set the property in the last group added. That makes it
fairly straightforward to add new blocks, set options on them,
and then move on to the next blocks. Please note that this
mechanism ought to be viewed as strictly as a temporary
convenience, and this short cut may go away once better
alternatives are available.
WARNING: The backend to option handling is slated to be
replaced at some point. This particular function may change
behavior, interface or be removed/replaced entirely.
Definition at line 141 of file ConfigSequence.py.
141 def setOptionValue (self, name, value, **kwargs) :
142 """set the given option on the sequence
144 The name should generally be of the form
145 "groupName.optionName" to identify what group the option
148 For simplicity I also allow a ".optionName" here, which will
149 then set the property in the last group added. That makes it
150 fairly straightforward to add new blocks, set options on them,
151 and then move on to the next blocks. Please note that this
152 mechanism ought to be viewed as strictly as a temporary
153 convenience, and this short cut may go away once better
154 alternatives are available.
156 WARNING: The backend to option handling is slated to be
157 replaced at some point. This particular function may change
158 behavior, interface or be removed/replaced entirely.
160 names = name.split(
'.')
162 optionName = names.pop(-1)
165 groupName = names.pop(0)
if names
else ''
167 raise ValueError(f
'Option name can be either <groupName>.<optionName>'
168 f
' or <optionName> not {name}')
169 blocks = self._blocks
172 groupName = blocks[-1].getOptionValue(
'groupName')
177 if ( block.getOptionValue(
'groupName') == groupName
178 and block.hasOption(optionName) ):
179 block.setOptionValue (optionName, value, **kwargs)
182 raise ValueError(f
'{optionName} not found in blocks with '
183 f
'group name {groupName}')
186 blocks[-1].setOptionValue (optionName, value, **kwargs)