pyworkflow.project.config module

class pyworkflow.project.config.Label(name='', color=None)

Bases: Scalar

Store Label information

EMPTY_OLD_NAME = None

clearOldName()

get()

Get the value, if internal value is None the default argument passed is returned.

getColor() → str

getName() → str

getObjValue()

Return the internal value for storage. This is a good place to do some update of the internal value before been stored

getOldName() → str

hasOldName() → bool

setColor(color)

setName(newName)

class pyworkflow.project.config.LabelsList

Bases: List

Store all labels information

addLabel(label)

clear()

Remove all items from list.

deleteLabel(label)

getLabel(name)

updateDict()

class pyworkflow.project.config.MenuConfig(text=None, value=None, icon=None, tag=None, shortCut=None, openItem=False, visible=True)

Bases: object

Menu configuration in a tree fashion. Each menu can contain submenus. Leaf elements can contain actions

Constructor for the Menu config item. Arguments:

text: text to be displayed value: internal value associated with the item. icon: display an icon with the item tag: put some tags to items

**args: pass other options to base class.

addSubMenu(text, value=None, **args)

isEmpty()

class pyworkflow.project.config.NodeConfig(nodeId=0, x=None, y=None, selected=False, expanded=True, visible=True)

Bases: Scalar

Store Graph node information such as x, y.

get()

Get the value, if internal value is None the default argument passed is returned.

getId()

getLabels()

getObjValue()

Return the internal value for storage. This is a good place to do some update of the internal value before been stored

getPosition()

getX()

getY()

isExpanded()

isSelected()

isVisible()

setExpanded(expanded)

setLabels(labels)

setPosition(x, y)

setSelected(selected)

setVisible(visible)

setX(x)

setY(y)

class pyworkflow.project.config.NodeConfigList

Bases: List

Store all nodes information items and also store a dictionary for quick access to nodes query.

addNode(nodeId, **kwargs)

clear()

Remove all items from list.

getNode(nodeId)

removeNode(nodeId)

Removes a node with the id = nodeId

updateDict()

class pyworkflow.project.config.ProjectConfig(**args)

Bases: Object

A simple base class to store ordered parameters

class pyworkflow.project.config.ProjectSettings(confs={}, **kwargs)

Bases: Object

Store settings related to a project.

COLOR_MODES = (0, 1, 2, 3)

COLOR_MODE_AGE = 2

COLOR_MODE_LABELS = 1

COLOR_MODE_SIZE = 3

COLOR_MODE_STATUS = 0

addNode(nodeId, **kwargs)

ageColorMode()

cleanUpNodes(runsIds, toRemove=True)

This will clean up all the nodes that do not have a matching run. This is because until now, the nodes here weren’t removes when protocols were removed.

Parameters

• runsIds – iterable with protocol’s objId to be removed.

• toRemove – Passed is are to be removed. Otherwise, are the ones to keep

commit()

Commit changes made.

getColorMode()

getConfig()

getCreationTime()

getLabels()

getLifeTime()

getNodeById(nodeId)

getNodes()

getProtocolView()

getReadOnly()

getRunsView()

labelsColorMode()

classmethod load(dbPath)

Load a ProjectSettings from dbPath.

removeNode(nodeId)

Removes a graphical node based on its id

setColorMode(colorMode)

Set the color mode to use when drawing the graph.

setCreationTime(value)

setLifeTime(value)

setProtocolView(protocolView)

Set the new protocol Menu given its index. The new ProtocolMenu will be returned.

setReadOnly(value)

setRunsView(value)

sizeColorMode()

statusColorMode()

write(dbPath=None)