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')

__class__

alias of sip.wrappertype

__delattr__

Implement delattr(self, name).

__dict__ = mappingproxy({'__module__': 'schrodinger.tasks.runners', 'stateChanged': <unbound PYQT_SIGNAL TaskRunner.stateChanged[]>, 'startRequested': <unbound PYQT_SIGNAL TaskRunner.startRequested[]>, 'startFailed': <unbound PYQT_SIGNAL TaskRunner.startFailed[]>, 'taskStarted': <unbound PYQT_SIGNAL TaskRunner.taskStarted[AbstractTask]>, 'taskEnded': <unbound PYQT_SIGNAL TaskRunner.taskEnded[AbstractTask]>, 'taskValueChanged': <unbound PYQT_SIGNAL TaskRunner.taskValueChanged[]>, 'resetAllRequested': <unbound PYQT_SIGNAL TaskRunner.resetAllRequested[]>, 'nameChanged': <unbound PYQT_SIGNAL TaskRunner.nameChanged[]>, '__init__': <function TaskRunner.__init__>, 'updateParams': <function TaskRunner.updateParams>, 'updateTarget': <function TaskRunner.updateTarget>, 'getStandardName': <function TaskRunner.getStandardName>, 'nextName': <function TaskRunner.nextName>, 'setCustomName': <function TaskRunner.setCustomName>, '_getTakenNames': <function TaskRunner._getTakenNames>, 'reportValidation': <function TaskRunner.reportValidation>, 'loadNextTask': <function TaskRunner.loadNextTask>, 'nextTask': <function TaskRunner.nextTask>, 'start': <function TaskRunner.start>, 'startTask': <function TaskRunner.startTask>, '_startTask': <function TaskRunner._startTask>, 'tasks': <function TaskRunner.tasks>, 'trackTask': <function TaskRunner.trackTask>, 'onTaskStatusChanged': <function TaskRunner.onTaskStatusChanged>, 'isRunning': <function TaskRunner.isRunning>, 'error': <function TaskRunner.error>, 'warning': <function TaskRunner.warning>, 'question': <function TaskRunner.question>, 'info': <function TaskRunner.info>, '__doc__': None})

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattr__(self, str) → object

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__module__ = 'schrodinger.tasks.runners'

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

__weakref__

list of weak references to the object (if defined)

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)

__class__

alias of sip.wrappertype

__delattr__

Implement delattr(self, name).

__dict__ = mappingproxy({'__module__': 'schrodinger.tasks.runners', '__init__': <function JobTaskRunner.__init__>, 'setConfig': <function JobTaskRunner.setConfig>, 'getNextConfig': <function JobTaskRunner.getNextConfig>, 'jobOptions': <function JobTaskRunner.jobOptions>, '_setupJobDir': <function JobTaskRunner._setupJobDir>, '_tryLockChDirMutex': <function JobTaskRunner._tryLockChDirMutex>, '_unlockChDirMutex': <function JobTaskRunner._unlockChDirMutex>, '_startTask': <function JobTaskRunner._startTask>, 'loadNextTask': <function JobTaskRunner.loadNextTask>, '_getTakenNames': <function JobTaskRunner._getTakenNames>, '_writeTask': <function JobTaskRunner._writeTask>, 'write': <function JobTaskRunner.write>, 'writeTask': <function JobTaskRunner.writeTask>, '__doc__': None})

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattr__(self, str) → object

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__module__ = 'schrodinger.tasks.runners'

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

__weakref__

list of weak references to the object (if defined)

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')

__class__

alias of builtins.type

__delattr__

Implement delattr(self, name).

__dict__ = mappingproxy({'__module__': 'schrodinger.tasks.runners', 'error': <function AbstractTaskReporter.error>, 'warning': <function AbstractTaskReporter.warning>, 'question': <function AbstractTaskReporter.question>, 'info': <function AbstractTaskReporter.info>, '__dict__': <attribute '__dict__' of 'AbstractTaskReporter' objects>, '__weakref__': <attribute '__weakref__' of 'AbstractTaskReporter' objects>, '__doc__': None})

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__

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

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__module__ = 'schrodinger.tasks.runners'

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

__weakref__

list of weak references to the object (if defined)

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')

__class__

alias of builtins.type

__delattr__

Implement delattr(self, name).

__dict__ = mappingproxy({'__module__': 'schrodinger.tasks.runners', 'error': <function CmdlineTaskReporter.error>, 'warning': <function CmdlineTaskReporter.warning>, 'question': <function CmdlineTaskReporter.question>, 'info': <function CmdlineTaskReporter.info>, '__doc__': None})

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__

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

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__module__ = 'schrodinger.tasks.runners'

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

__weakref__

list of weak references to the object (if defined)

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')

__class__

alias of builtins.type

__delattr__

Implement delattr(self, name).

__dict__ = mappingproxy({'__module__': 'schrodinger.tasks.runners', '__init__': <function PanelTaskReporter.__init__>, 'setPanel': <function PanelTaskReporter.setPanel>, 'getPanel': <function PanelTaskReporter.getPanel>, 'error': <function PanelTaskReporter.error>, 'warning': <function PanelTaskReporter.warning>, 'question': <function PanelTaskReporter.question>, 'info': <function PanelTaskReporter.info>, '__doc__': None})

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__module__ = 'schrodinger.tasks.runners'

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

__weakref__

list of weak references to the object (if defined)