schrodinger.tasks.runners module

class schrodinger.tasks.runners.TaskRunner(task_class, param_mapper=None, reporter=None)

Bases: PyQt5.QtCore.QObject

stateChanged
startRequested
startFailed
taskStarted
taskEnded
taskValueChanged
resetAllRequested
nameChanged
__init__(task_class, param_mapper=None, reporter=None)

Initialize self. See help(type(self)) for accurate signature.

updateParams()
updateTarget()
getStandardName()
nextName()
setCustomName(name)
reportValidation(results)

Present validation messages to the user. This is an implmentation of the ValidationMixin interface and does not need to be called directly.

Parameters:results (ValidationResults) – Set of results generated by validate()
loadNextTask()
nextTask()
start()
startTask(task)
tasks()
trackTask(task)
onTaskStatusChanged()
isRunning()
error(text, title='Error')
warning(text, title='Warning')
question(text, title='Question')
info(text, title='Info')
blockSignals(self, bool) → bool
childEvent(self, QChildEvent)
children(self) → object
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
deleteLater(self)
destroyed

destroyed(self, QObject = None) [signal]

disconnect(self)
disconnectNotify(self, QMetaMethod)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) → object
event(self, QEvent) → bool
eventFilter(self, QObject, QEvent) → bool
findChild(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject

findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject

findChildren(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]

inherits(self, str) → bool
installEventFilter(self, QObject)
isSignalConnected(self, QMetaMethod) → bool
isWidgetType(self) → bool
isWindowType(self) → bool
killTimer(self, int)
metaObject(self) → QMetaObject
moveToThread(self, QThread)
objectName(self) → str
objectNameChanged

objectNameChanged(self, str) [signal]

parent(self) → QObject
property(self, str) → Any
pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

receivers(self, PYQT_SIGNAL) → int
removeEventFilter(self, QObject)
sender(self) → QObject
senderSignalIndex(self) → int
setObjectName(self, str)
setParent(self, QObject)
setProperty(self, str, Any) → bool
signalsBlocked(self) → bool
startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int
staticMetaObject = <PyQt5.QtCore.QMetaObject object>
thread(self) → QThread
timerEvent(self, QTimerEvent)
tr(self, str, disambiguation: str = None, n: int = -1) → str
class schrodinger.tasks.runners.JobTaskRunner(task_class, param_mapper=None, reporter=None, create_job_dir=True)

Bases: schrodinger.tasks.runners.TaskRunner

__init__(task_class, param_mapper=None, reporter=None, create_job_dir=True)

Initialize self. See help(type(self)) for accurate signature.

setConfig(config)
getNextConfig()
jobOptions()
loadNextTask()
write()
writeTask(task)
blockSignals(self, bool) → bool
childEvent(self, QChildEvent)
children(self) → object
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
deleteLater(self)
destroyed

destroyed(self, QObject = None) [signal]

disconnect(self)
disconnectNotify(self, QMetaMethod)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) → object
error(text, title='Error')
event(self, QEvent) → bool
eventFilter(self, QObject, QEvent) → bool
findChild(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject

findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject

findChildren(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]

getStandardName()
info(text, title='Info')
inherits(self, str) → bool
installEventFilter(self, QObject)
isRunning()
isSignalConnected(self, QMetaMethod) → bool
isWidgetType(self) → bool
isWindowType(self) → bool
killTimer(self, int)
metaObject(self) → QMetaObject
moveToThread(self, QThread)
nameChanged
nextName()
nextTask()
objectName(self) → str
objectNameChanged

objectNameChanged(self, str) [signal]

onTaskStatusChanged()
parent(self) → QObject
property(self, str) → Any
pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

question(text, title='Question')
receivers(self, PYQT_SIGNAL) → int
removeEventFilter(self, QObject)
reportValidation(results)

Present validation messages to the user. This is an implmentation of the ValidationMixin interface and does not need to be called directly.

Parameters:results (ValidationResults) – Set of results generated by validate()
resetAllRequested
sender(self) → QObject
senderSignalIndex(self) → int
setCustomName(name)
setObjectName(self, str)
setParent(self, QObject)
setProperty(self, str, Any) → bool
signalsBlocked(self) → bool
start()
startFailed
startRequested
startTask(task)
startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int
stateChanged
staticMetaObject = <PyQt5.QtCore.QMetaObject object>
taskEnded
taskStarted
taskValueChanged
tasks()
thread(self) → QThread
timerEvent(self, QTimerEvent)
tr(self, str, disambiguation: str = None, n: int = -1) → str
trackTask(task)
updateParams()
updateTarget()
warning(text, title='Warning')
class schrodinger.tasks.runners.AbstractTaskReporter

Bases: object

error(text, title='Error')
warning(text, title='Warning')
question(text, title='Question')
info(text, title='Info')
__init__

Initialize self. See help(type(self)) for accurate signature.

class schrodinger.tasks.runners.CmdlineTaskReporter

Bases: schrodinger.tasks.runners.AbstractTaskReporter

error(text, title='Error')
warning(text, title='Warning')
question(text, title='Question')
info(text, title='Info')
__init__

Initialize self. See help(type(self)) for accurate signature.

class schrodinger.tasks.runners.PanelTaskReporter(panel=None)

Bases: schrodinger.tasks.runners.AbstractTaskReporter

__init__(panel=None)

Initialize self. See help(type(self)) for accurate signature.

setPanel(panel)
getPanel()
error(text, title='Error')
warning(text, title='Warning')
question(text, title='Question')
info(text, title='Info')