schrodinger.tasks.jobtasks module

class schrodinger.tasks.jobtasks.IncorporationMode

Bases: enum.Enum

An enumeration.

APPEND = 1

APPENDINPLACE = 2

REPLACE = 3

IGNORE = 4

class schrodinger.tasks.jobtasks.IncorporationParam(*args, allowed_modes=(<IncorporationMode.APPEND: 1>, <IncorporationMode.APPENDINPLACE: 2>, <IncorporationMode.IGNORE: 4>), **kwargs)

Bases: schrodinger.models.parameters.EnumParam

DEFAULT_ALLOWED_MODES = (<IncorporationMode.APPEND: 1>, <IncorporationMode.APPENDINPLACE: 2>, <IncorporationMode.IGNORE: 4>)

__init__(*args, allowed_modes=(<IncorporationMode.APPEND: 1>, <IncorporationMode.APPENDINPLACE: 2>, <IncorporationMode.IGNORE: 4>), **kwargs)

EnumParam must be initialized with the Enum class that this param is to be based on as well as the default value.

Parameters:

• enum_class (enum.Enum) – the enum class to base this pram on
• default_value (a member of the enum_class) – The default enum value. If not provided, the param will default to the first value of the enum.

DataClass

alias of builtins.object

blockSignals(self, bool) → bool

childEvent(self, QChildEvent)

children(self) → object

connectNotify(self, QMetaMethod)

customEvent(self, QEvent)

classmethod defaultValue(*args, **kwargs)

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]

classmethod getParamSignal(*args, **kwargs)

classmethod getParamValue(*args, **kwargs)

inherits(self, str) → bool

initAbstract()

installEventFilter(self, QObject)

classmethod isAbstract()

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]

classmethod owner()

classmethod ownerChain()

Returns a list of param owners starting from the toplevel param and ending with self. Examples:

foo.bar.atom.coord.ownerChain() will return [foo, bar, atom, coord] where every item is a concrete param.

Foo.bar.atom.coord.x.ownerChain() will return [Foo, Foo.bar, Foo.atom.coord, Foo.atom.coord.x] where every item is an abstract params.

classmethod paramName()

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)

classmethod setParamValue(*args, **kwargs)

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.jobtasks.AllowedHostTypes

Bases: enum.Enum

An enumeration.

CPU_ONLY = 1

GPU_ONLY = 2

CPU_AND_GPU = 3

class schrodinger.tasks.jobtasks.HostParam(default_value=NULLHOST (0), allowed_types=<AllowedHostTypes.CPU_ONLY: 1>, *args, **kwargs)

Bases: schrodinger.models.parameters.Param

DataClass

alias of schrodinger.ui.qt.config_dialog.Host

__init__(default_value=NULLHOST (0), allowed_types=<AllowedHostTypes.CPU_ONLY: 1>, *args, **kwargs)

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

blockSignals(self, bool) → bool

childEvent(self, QChildEvent)

children(self) → object

connectNotify(self, QMetaMethod)

customEvent(self, QEvent)

classmethod defaultValue(*args, **kwargs)

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]

classmethod getParamSignal(*args, **kwargs)

classmethod getParamValue(*args, **kwargs)

inherits(self, str) → bool

initAbstract()

installEventFilter(self, QObject)

classmethod isAbstract()

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]

classmethod owner()

classmethod ownerChain()

Returns a list of param owners starting from the toplevel param and ending with self. Examples:

foo.bar.atom.coord.ownerChain() will return [foo, bar, atom, coord] where every item is a concrete param.

Foo.bar.atom.coord.x.ownerChain() will return [Foo, Foo.bar, Foo.atom.coord, Foo.atom.coord.x] where every item is an abstract params.

classmethod paramName()

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)

classmethod setParamValue(*args, **kwargs)

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

schrodinger.tasks.jobtasks.get_hosts()

schrodinger.tasks.jobtasks.get_default_host()

class schrodinger.tasks.jobtasks.JobConfig(default_value=<object object>, param_type=<object object>, **kwargs)

Bases: schrodinger.models.parameters.ParamModel

jobname

host = None

incorporation = None

num_subjobs = None

initializeValue()

DataClass

alias of builtins.object

__init__(default_value=<object object>, param_type=<object object>, **kwargs)

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

classmethod addSubParam(name, param, update_owner=True)

blockSignals(self, bool) → bool

block_signal_propagation()

childEvent(self, QChildEvent)

children(self) → object

classmethod configureParam()

Override this class method to set up the abstract param class (e.g. setParamReference on child params.)

connectNotify(self, QMetaMethod)

customEvent(self, QEvent)

classmethod defaultValue(*args, **kwargs)

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]

classmethod fromJson(json_obj)

A factory method which constructs a new object from a given dict loaded from a json string or file.

Parameters:json_obj (dict) – A json-loaded dictionary to create an object from. Returns:An instance of this class.

:rtype : cls

classmethod fromJsonImplementation(json_dict)

Sets the value of this compound param value object from a JSON dict.

getAbstractParam(*args, **kwargs)

classmethod getParamSignal(*args, **kwargs)

classmethod getParamValue(*args, **kwargs)

classmethod getSubParam(name)

classmethod getSubParams()

get_version()

Method to get the version of a particular object. Defaults to the current version of mmshare. This class can be overridden for custom versioning behavior.

inherits(self, str) → bool

initAbstract()

initConcrete()

installEventFilter(self, QObject)

classmethod isAbstract()

isDefault(*args, **kwargs)

isSignalConnected(self, QMetaMethod) → bool

isWidgetType(self) → bool

isWindowType(self) → bool

jobnameChanged

jobnameReplaced

killTimer(self, int)

metaObject(self) → QMetaObject

moveToThread(self, QThread)

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

classmethod owner()

classmethod ownerChain()

Returns a list of param owners starting from the toplevel param and ending with self. Examples:

foo.bar.atom.coord.ownerChain() will return [foo, bar, atom, coord] where every item is a concrete param.

Foo.bar.atom.coord.x.ownerChain() will return [Foo, Foo.bar, Foo.atom.coord, Foo.atom.coord.x] where every item is an abstract params.

classmethod paramName()

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)

reset(*args, **kwargs)

sender(self) → QObject

senderSignalIndex(self) → int

setObjectName(self, str)

classmethod setParamValue(*args, **kwargs)

setParent(self, QObject)

setProperty(self, str, Any) → bool

setValue(*args, **kwargs)

signalsBlocked(self) → bool

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

thread(self) → QThread

timerEvent(self, QTimerEvent)

toDict(*args, **kwargs)

toJson(_mark_version=True)

Create and returns a data structure made up of jsonable items.

Return type:An instance of one the classes from NATIVE_JSON_DATATYPES

toJsonImplementation(*args, **kwargs)

tr(self, str, disambiguation: str = None, n: int = -1) → str

valueChanged

schrodinger.tasks.jobtasks.job_config_factory(allowed_host_types=<AllowedHostTypes.CPU_ONLY: 1>, default_incorp_mode=None, supports_subjobs=False)

Generate JobConfig objects with typical options.

Parameters:

• allowed_host_types (AllowedHostTypes or None) – Whether this job accepts cpu hosts, gpu hosts, or both. Pass None to disable remote hosts (always run on localhost)
• default_incorp_mode (IncorporationMode or None) – The default disposition. Pass None for jobs that do not incorporate at all.
• supports_subjobs (bool) – whether this job can be split into subjobs

class schrodinger.tasks.jobtasks.JobInput(default_value=<object object>, param_type=<object object>, **kwargs)

Bases: schrodinger.models.parameters.CompoundParam

DASH_STRING = '--'

toCmdArgs()

DataClass

alias of builtins.object

__init__(default_value=<object object>, param_type=<object object>, **kwargs)

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

classmethod addSubParam(name, param, update_owner=True)

blockSignals(self, bool) → bool

block_signal_propagation()

childEvent(self, QChildEvent)

children(self) → object

classmethod configureParam()

Override this class method to set up the abstract param class (e.g. setParamReference on child params.)

connectNotify(self, QMetaMethod)

customEvent(self, QEvent)

classmethod defaultValue(*args, **kwargs)

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]

classmethod fromJson(json_obj)

A factory method which constructs a new object from a given dict loaded from a json string or file.

Parameters:json_obj (dict) – A json-loaded dictionary to create an object from. Returns:An instance of this class.

:rtype : cls

classmethod fromJsonImplementation(json_dict)

Sets the value of this compound param value object from a JSON dict.

getAbstractParam(*args, **kwargs)

classmethod getParamSignal(*args, **kwargs)

classmethod getParamValue(*args, **kwargs)

classmethod getSubParam(name)

classmethod getSubParams()

get_version()

Method to get the version of a particular object. Defaults to the current version of mmshare. This class can be overridden for custom versioning behavior.

inherits(self, str) → bool

initAbstract()

initConcrete()

initializeValue()

installEventFilter(self, QObject)

classmethod isAbstract()

isDefault(*args, **kwargs)

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]

classmethod owner()

classmethod ownerChain()

Returns a list of param owners starting from the toplevel param and ending with self. Examples:

foo.bar.atom.coord.ownerChain() will return [foo, bar, atom, coord] where every item is a concrete param.

Foo.bar.atom.coord.x.ownerChain() will return [Foo, Foo.bar, Foo.atom.coord, Foo.atom.coord.x] where every item is an abstract params.

classmethod paramName()

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)

reset(*args, **kwargs)

sender(self) → QObject

senderSignalIndex(self) → int

setObjectName(self, str)

classmethod setParamValue(*args, **kwargs)

setParent(self, QObject)

setProperty(self, str, Any) → bool

setValue(*args, **kwargs)

signalsBlocked(self) → bool

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

thread(self) → QThread

timerEvent(self, QTimerEvent)

toDict(*args, **kwargs)

toJson(_mark_version=True)

Create and returns a data structure made up of jsonable items.

Return type:An instance of one the classes from NATIVE_JSON_DATATYPES

toJsonImplementation(*args, **kwargs)

tr(self, str, disambiguation: str = None, n: int = -1) → str

valueChanged

class schrodinger.tasks.jobtasks.AbstractJobTask(*args, **kwargs)

Bases: schrodinger.tasks.tasks.AbstractTask

config

input_files

A Param to represent lists. Values of this param will have a mutated signal that will be emitted whenever any mutation method is called.

The constructor optionally takes a item_class keyword argument to specify what type of class the items in the list will be. This information will be used for jsonifying the list if specified.

output_files

A Param to represent lists. Values of this param will have a mutated signal that will be emitted whenever any mutation method is called.

The constructor optionally takes a item_class keyword argument to specify what type of class the items in the list will be. This information will be used for jsonifying the list if specified.

backend_name = None

input

initConcrete(*args, **kwargs)

replicate()

Create a new task with the same input and settings (but no output)

DONE = 3

DataClass

alias of builtins.object

FAILED = 2

RUNNING = 1

WAITING = 0

__init__(*args, **kwargs)

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

classmethod addSubParam(name, param, update_owner=True)

blockSignals(self, bool) → bool

block_signal_propagation()

childEvent(self, QChildEvent)

children(self) → object

configChanged

configReplaced

classmethod configureParam()

Override this class method to set up the abstract param class (e.g. setParamReference on child params.)

connectNotify(self, QMetaMethod)

customEvent(self, QEvent)

classmethod defaultValue(*args, **kwargs)

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]

classmethod fromJson(json_obj)

A factory method which constructs a new object from a given dict loaded from a json string or file.

Parameters:json_obj (dict) – A json-loaded dictionary to create an object from. Returns:An instance of this class.

:rtype : cls

classmethod fromJsonFilename(filename)

classmethod fromJsonImplementation(json_dict)

Sets the value of this compound param value object from a JSON dict.

getAbstractParam(*args, **kwargs)

classmethod getParamSignal(*args, **kwargs)

classmethod getParamValue(*args, **kwargs)

classmethod getSubParam(name)

classmethod getSubParams()

getTaskDirectory()

Return the absolute path of the task directory

getTaskFilename(fname)

Return the appropriate absolute path for an input or output file

get_version()

Method to get the version of a particular object. Defaults to the current version of mmshare. This class can be overridden for custom versioning behavior.

guard()

Context manager that saves any Exception raised inside

inherits(self, str) → bool

initAbstract()

initializeValue()

inputChanged

inputReplaced

input_filesChanged

input_filesReplaced

installEventFilter(self, QObject)

classmethod isAbstract()

isDefault(*args, **kwargs)

isSignalConnected(self, QMetaMethod) → bool

isStartable()

isWidgetType(self) → bool

isWindowType(self) → bool

killTimer(self, int)

max_progress

max_progressChanged

max_progressReplaced

metaObject(self) → QMetaObject

moveToThread(self, QThread)

name

nameChanged

nameReplaced

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

output

Inherit all functionality of CompoundParam with name that designates this class as a model. Models should themselves be parameters so that their corresponding view can be easily incorporated into a parent view. In this case, the model of the parent view will contain the model of the child view as a parameter.

WARNING: as descriptors, instances of this class will not behave normally if used as class variables.

outputChanged

outputReplaced

output_filesChanged

output_filesReplaced

classmethod owner()

classmethod ownerChain()

Returns a list of param owners starting from the toplevel param and ending with self. Examples:

foo.bar.atom.coord.ownerChain() will return [foo, bar, atom, coord] where every item is a concrete param.

Foo.bar.atom.coord.x.ownerChain() will return [Foo, Foo.bar, Foo.atom.coord, Foo.atom.coord.x] where every item is an abstract params.

classmethod paramName()

parent(self) → QObject

preprocessors()

Returns:A list of bound preprocessing methods

progress

progressChanged

progressReplaced

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)

reportValidation(results)

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

This method assumes that error and question methods have been defined in the subclass, as in e.g. widget_mixins.MessageBoxMixin.

Parameters:results (validation.ValidationResults) – Set of validation results generated by validate Returns:if True, there were no validation errors and the user decided to continue despite any warnings. If False, there was at least one validation error or the user decided to abort when faced with a warning.

reset(*args, **kwargs)

run()

runValidation(silent=False, validate_children=True, stop_on_fail=True)

Runs validation and reports the results (unless run silently).

Parameters:

• silent (bool) – run without any reporting (i.e. error messages to the user). This is useful if we want to programmatically test validity. Changes return value of this method from ValidationResults to a boolean.
• validate_children (bool) – run validation on all child objects. See _validateChildren for documentation on what this entails.
• stop_on_fail (bool) – stop validation when first failure is encountered

Returns:

if silent is False, returns the validation results. If silent is True, returns a boolean generated by reportValidation.

Return type:

ValidationResults or bool

sender(self) → QObject

senderSignalIndex(self) → int

setAutoTaskDir(auto_task_dir)

setObjectName(self, str)

classmethod setParamValue(*args, **kwargs)

setParent(self, QObject)

setProperty(self, str, Any) → bool

setValue(*args, **kwargs)

signalsBlocked(self) → bool

start(skip_preprocessing=False)

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

status

statusChanged

statusReplaced

taskDone

taskFailed

taskStarted

taskdir

thread(self) → QThread

timerEvent(self, QTimerEvent)

toDict(*args, **kwargs)

toJson(_mark_version=True)

Create and returns a data structure made up of jsonable items.

Return type:An instance of one the classes from NATIVE_JSON_DATATYPES

toJsonImplementation(*args, **kwargs)

tr(self, str, disambiguation: str = None, n: int = -1) → str

valueChanged

wait(timeout=None)

Block until the task is finished executing or timeout seconds have passed.

Parameters:timeout (NoneType or int) – Amount of time in seconds to wait before timing out. If None or a negative number, this method will wait until the task is finished.

class schrodinger.tasks.jobtasks.CmdJobTask(*args, cmd_list=None, **kwargs)

Bases: schrodinger.tasks.jobtasks.AbstractJobTask

Class for running backends that already support jobcontrol.

CmdJobTask can either be subclassed to implement custom input/output params and other behavior, or can be instantiated and run directly by supplying the optional cmd_list constructor argument. For example:

task = jobtasks.CmdJobTask(cmd_list=[‘testapp’, ‘-t’, ‘1’]) task.start()

Note that specifying cmd_list will bypass some custom functionality and should not be used with CmdJobTask subclasses.

__init__(*args, cmd_list=None, **kwargs)

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

run()

toCmd()

getInputArgs()

DONE = 3

DataClass

alias of builtins.object

FAILED = 2

RUNNING = 1

WAITING = 0

classmethod addSubParam(name, param, update_owner=True)

backend_name = None

blockSignals(self, bool) → bool

block_signal_propagation()

childEvent(self, QChildEvent)

children(self) → object

config

configChanged

configReplaced

classmethod configureParam()

Override this class method to set up the abstract param class (e.g. setParamReference on child params.)

connectNotify(self, QMetaMethod)

customEvent(self, QEvent)

classmethod defaultValue(*args, **kwargs)

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]

classmethod fromJson(json_obj)

A factory method which constructs a new object from a given dict loaded from a json string or file.

Parameters:json_obj (dict) – A json-loaded dictionary to create an object from. Returns:An instance of this class.

:rtype : cls

classmethod fromJsonFilename(filename)

classmethod fromJsonImplementation(json_dict)

Sets the value of this compound param value object from a JSON dict.

getAbstractParam(*args, **kwargs)

classmethod getParamSignal(*args, **kwargs)

classmethod getParamValue(*args, **kwargs)

classmethod getSubParam(name)

classmethod getSubParams()

getTaskDirectory()

Return the absolute path of the task directory

getTaskFilename(fname)

Return the appropriate absolute path for an input or output file

get_version()

Method to get the version of a particular object. Defaults to the current version of mmshare. This class can be overridden for custom versioning behavior.

guard()

Context manager that saves any Exception raised inside

inherits(self, str) → bool

initAbstract()

initConcrete(*args, **kwargs)

initializeValue()

input

inputChanged

inputReplaced

input_files

A Param to represent lists. Values of this param will have a mutated signal that will be emitted whenever any mutation method is called.

The constructor optionally takes a item_class keyword argument to specify what type of class the items in the list will be. This information will be used for jsonifying the list if specified.

input_filesChanged

input_filesReplaced

installEventFilter(self, QObject)

classmethod isAbstract()

isDefault(*args, **kwargs)

isSignalConnected(self, QMetaMethod) → bool

isStartable()

isWidgetType(self) → bool

isWindowType(self) → bool

killTimer(self, int)

max_progress

max_progressChanged

max_progressReplaced

metaObject(self) → QMetaObject

moveToThread(self, QThread)

name

nameChanged

nameReplaced

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

output

Inherit all functionality of CompoundParam with name that designates this class as a model. Models should themselves be parameters so that their corresponding view can be easily incorporated into a parent view. In this case, the model of the parent view will contain the model of the child view as a parameter.

WARNING: as descriptors, instances of this class will not behave normally if used as class variables.

outputChanged

outputReplaced

output_files

A Param to represent lists. Values of this param will have a mutated signal that will be emitted whenever any mutation method is called.

The constructor optionally takes a item_class keyword argument to specify what type of class the items in the list will be. This information will be used for jsonifying the list if specified.

output_filesChanged

output_filesReplaced

classmethod owner()

classmethod ownerChain()

Returns a list of param owners starting from the toplevel param and ending with self. Examples:

foo.bar.atom.coord.ownerChain() will return [foo, bar, atom, coord] where every item is a concrete param.

Foo.bar.atom.coord.x.ownerChain() will return [Foo, Foo.bar, Foo.atom.coord, Foo.atom.coord.x] where every item is an abstract params.

classmethod paramName()

parent(self) → QObject

preprocessors()

Returns:A list of bound preprocessing methods

progress

progressChanged

progressReplaced

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)

replicate()

Create a new task with the same input and settings (but no output)

reportValidation(results)

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

This method assumes that error and question methods have been defined in the subclass, as in e.g. widget_mixins.MessageBoxMixin.

Parameters:results (validation.ValidationResults) – Set of validation results generated by validate Returns:if True, there were no validation errors and the user decided to continue despite any warnings. If False, there was at least one validation error or the user decided to abort when faced with a warning.

reset(*args, **kwargs)

runValidation(silent=False, validate_children=True, stop_on_fail=True)

Runs validation and reports the results (unless run silently).

Parameters:

• silent (bool) – run without any reporting (i.e. error messages to the user). This is useful if we want to programmatically test validity. Changes return value of this method from ValidationResults to a boolean.
• validate_children (bool) – run validation on all child objects. See _validateChildren for documentation on what this entails.
• stop_on_fail (bool) – stop validation when first failure is encountered

Returns:

if silent is False, returns the validation results. If silent is True, returns a boolean generated by reportValidation.

Return type:

ValidationResults or bool

sender(self) → QObject

senderSignalIndex(self) → int

setAutoTaskDir(auto_task_dir)

setObjectName(self, str)

classmethod setParamValue(*args, **kwargs)

setParent(self, QObject)

setProperty(self, str, Any) → bool

setValue(*args, **kwargs)

signalsBlocked(self) → bool

start(skip_preprocessing=False)

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

status

statusChanged

statusReplaced

taskDone

taskFailed

taskStarted

taskdir

thread(self) → QThread

timerEvent(self, QTimerEvent)

toDict(*args, **kwargs)

toJson(_mark_version=True)

Create and returns a data structure made up of jsonable items.

Return type:An instance of one the classes from NATIVE_JSON_DATATYPES

toJsonImplementation(*args, **kwargs)

tr(self, str, disambiguation: str = None, n: int = -1) → str

valueChanged

wait(timeout=None)

Block until the task is finished executing or timeout seconds have passed.

Parameters:timeout (NoneType or int) – Amount of time in seconds to wait before timing out. If None or a negative number, this method will wait until the task is finished.

class schrodinger.tasks.jobtasks.ScriptJobTask(*args, cmd_list=None, **kwargs)

Bases: schrodinger.tasks.jobtasks.CmdJobTask

toCmd()

wrapCmdInLaunchApi(cmd)

makeJobSpecFromCmd(cmd)

makeLaunchParams()

DONE = 3

DataClass

alias of builtins.object

FAILED = 2

RUNNING = 1

WAITING = 0

__init__(*args, cmd_list=None, **kwargs)

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

classmethod addSubParam(name, param, update_owner=True)

backend_name = None

blockSignals(self, bool) → bool

block_signal_propagation()

childEvent(self, QChildEvent)

children(self) → object

config

configChanged

configReplaced

classmethod configureParam()

Override this class method to set up the abstract param class (e.g. setParamReference on child params.)

connectNotify(self, QMetaMethod)

customEvent(self, QEvent)

classmethod defaultValue(*args, **kwargs)

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]

classmethod fromJson(json_obj)

A factory method which constructs a new object from a given dict loaded from a json string or file.

Parameters:json_obj (dict) – A json-loaded dictionary to create an object from. Returns:An instance of this class.

:rtype : cls

classmethod fromJsonFilename(filename)

classmethod fromJsonImplementation(json_dict)

Sets the value of this compound param value object from a JSON dict.

getAbstractParam(*args, **kwargs)

getInputArgs()

classmethod getParamSignal(*args, **kwargs)

classmethod getParamValue(*args, **kwargs)

classmethod getSubParam(name)

classmethod getSubParams()

getTaskDirectory()

Return the absolute path of the task directory

getTaskFilename(fname)

Return the appropriate absolute path for an input or output file

get_version()

Method to get the version of a particular object. Defaults to the current version of mmshare. This class can be overridden for custom versioning behavior.

guard()

Context manager that saves any Exception raised inside

inherits(self, str) → bool

initAbstract()

initConcrete(*args, **kwargs)

initializeValue()

input

inputChanged

inputReplaced

input_files

A Param to represent lists. Values of this param will have a mutated signal that will be emitted whenever any mutation method is called.

The constructor optionally takes a item_class keyword argument to specify what type of class the items in the list will be. This information will be used for jsonifying the list if specified.

input_filesChanged

input_filesReplaced

installEventFilter(self, QObject)

classmethod isAbstract()

isDefault(*args, **kwargs)

isSignalConnected(self, QMetaMethod) → bool

isStartable()

isWidgetType(self) → bool

isWindowType(self) → bool

killTimer(self, int)

max_progress

max_progressChanged

max_progressReplaced

metaObject(self) → QMetaObject

moveToThread(self, QThread)

name

nameChanged

nameReplaced

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

output

Inherit all functionality of CompoundParam with name that designates this class as a model. Models should themselves be parameters so that their corresponding view can be easily incorporated into a parent view. In this case, the model of the parent view will contain the model of the child view as a parameter.

WARNING: as descriptors, instances of this class will not behave normally if used as class variables.

outputChanged

outputReplaced

output_files

A Param to represent lists. Values of this param will have a mutated signal that will be emitted whenever any mutation method is called.

The constructor optionally takes a item_class keyword argument to specify what type of class the items in the list will be. This information will be used for jsonifying the list if specified.

output_filesChanged

output_filesReplaced

classmethod owner()

classmethod ownerChain()

Returns a list of param owners starting from the toplevel param and ending with self. Examples:

foo.bar.atom.coord.ownerChain() will return [foo, bar, atom, coord] where every item is a concrete param.

Foo.bar.atom.coord.x.ownerChain() will return [Foo, Foo.bar, Foo.atom.coord, Foo.atom.coord.x] where every item is an abstract params.

classmethod paramName()

parent(self) → QObject

preprocessors()

Returns:A list of bound preprocessing methods

progress

progressChanged

progressReplaced

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)

replicate()

Create a new task with the same input and settings (but no output)

reportValidation(results)

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

This method assumes that error and question methods have been defined in the subclass, as in e.g. widget_mixins.MessageBoxMixin.

Parameters:results (validation.ValidationResults) – Set of validation results generated by validate Returns:if True, there were no validation errors and the user decided to continue despite any warnings. If False, there was at least one validation error or the user decided to abort when faced with a warning.

reset(*args, **kwargs)

run()

runValidation(silent=False, validate_children=True, stop_on_fail=True)

Runs validation and reports the results (unless run silently).

Parameters:

• silent (bool) – run without any reporting (i.e. error messages to the user). This is useful if we want to programmatically test validity. Changes return value of this method from ValidationResults to a boolean.
• validate_children (bool) – run validation on all child objects. See _validateChildren for documentation on what this entails.
• stop_on_fail (bool) – stop validation when first failure is encountered

Returns:

if silent is False, returns the validation results. If silent is True, returns a boolean generated by reportValidation.

Return type:

ValidationResults or bool

sender(self) → QObject

senderSignalIndex(self) → int

setAutoTaskDir(auto_task_dir)

setObjectName(self, str)

classmethod setParamValue(*args, **kwargs)

setParent(self, QObject)

setProperty(self, str, Any) → bool

setValue(*args, **kwargs)

signalsBlocked(self) → bool

start(skip_preprocessing=False)

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

status

statusChanged

statusReplaced

taskDone

taskFailed

taskStarted

taskdir

thread(self) → QThread

timerEvent(self, QTimerEvent)

toDict(*args, **kwargs)

toJson(_mark_version=True)

Create and returns a data structure made up of jsonable items.

Return type:An instance of one the classes from NATIVE_JSON_DATATYPES

toJsonImplementation(*args, **kwargs)

tr(self, str, disambiguation: str = None, n: int = -1) → str

valueChanged

wait(timeout=None)

Block until the task is finished executing or timeout seconds have passed.

Parameters:timeout (NoneType or int) – Amount of time in seconds to wait before timing out. If None or a negative number, this method will wait until the task is finished.

class schrodinger.tasks.jobtasks.ComboJobTask(*args, cmd_list=None, **kwargs)

Bases: schrodinger.tasks.jobtasks.ScriptJobTask

backend_name = 'combojobtask_entry_point.py'

json_filename

json_out_filename

prepareStart()

start(*args, **kwargs)

writeJsonFile(filename)

getInputArgs()

runBackend()

backendMain()

classmethod runFromCmdLine()

DONE = 3

DataClass

alias of builtins.object

FAILED = 2

RUNNING = 1

WAITING = 0

__init__(*args, cmd_list=None, **kwargs)

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

classmethod addSubParam(name, param, update_owner=True)

blockSignals(self, bool) → bool

block_signal_propagation()

childEvent(self, QChildEvent)

children(self) → object

config

configChanged

configReplaced

classmethod configureParam()

Override this class method to set up the abstract param class (e.g. setParamReference on child params.)

connectNotify(self, QMetaMethod)

customEvent(self, QEvent)

classmethod defaultValue(*args, **kwargs)

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]

classmethod fromJson(json_obj)

A factory method which constructs a new object from a given dict loaded from a json string or file.

Parameters:json_obj (dict) – A json-loaded dictionary to create an object from. Returns:An instance of this class.

:rtype : cls

classmethod fromJsonFilename(filename)

classmethod fromJsonImplementation(json_dict)

Sets the value of this compound param value object from a JSON dict.

getAbstractParam(*args, **kwargs)

classmethod getParamSignal(*args, **kwargs)

classmethod getParamValue(*args, **kwargs)

classmethod getSubParam(name)

classmethod getSubParams()

getTaskDirectory()

Return the absolute path of the task directory

getTaskFilename(fname)

Return the appropriate absolute path for an input or output file

get_version()

Method to get the version of a particular object. Defaults to the current version of mmshare. This class can be overridden for custom versioning behavior.

guard()

Context manager that saves any Exception raised inside

inherits(self, str) → bool

initAbstract()

initConcrete(*args, **kwargs)

initializeValue()

input

inputChanged

inputReplaced

input_files

A Param to represent lists. Values of this param will have a mutated signal that will be emitted whenever any mutation method is called.

The constructor optionally takes a item_class keyword argument to specify what type of class the items in the list will be. This information will be used for jsonifying the list if specified.

input_filesChanged

input_filesReplaced

installEventFilter(self, QObject)

classmethod isAbstract()

isDefault(*args, **kwargs)

isSignalConnected(self, QMetaMethod) → bool

isStartable()

isWidgetType(self) → bool

isWindowType(self) → bool

killTimer(self, int)

makeJobSpecFromCmd(cmd)

makeLaunchParams()

max_progress

max_progressChanged

max_progressReplaced

metaObject(self) → QMetaObject

moveToThread(self, QThread)

name

nameChanged

nameReplaced

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

output

Inherit all functionality of CompoundParam with name that designates this class as a model. Models should themselves be parameters so that their corresponding view can be easily incorporated into a parent view. In this case, the model of the parent view will contain the model of the child view as a parameter.

WARNING: as descriptors, instances of this class will not behave normally if used as class variables.

outputChanged

outputReplaced

output_files

A Param to represent lists. Values of this param will have a mutated signal that will be emitted whenever any mutation method is called.

The constructor optionally takes a item_class keyword argument to specify what type of class the items in the list will be. This information will be used for jsonifying the list if specified.

output_filesChanged

output_filesReplaced

classmethod owner()

classmethod ownerChain()

Returns a list of param owners starting from the toplevel param and ending with self. Examples:

foo.bar.atom.coord.ownerChain() will return [foo, bar, atom, coord] where every item is a concrete param.

Foo.bar.atom.coord.x.ownerChain() will return [Foo, Foo.bar, Foo.atom.coord, Foo.atom.coord.x] where every item is an abstract params.

classmethod paramName()

parent(self) → QObject

preprocessors()

Returns:A list of bound preprocessing methods

progress

progressChanged

progressReplaced

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)

replicate()

Create a new task with the same input and settings (but no output)

reportValidation(results)

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

This method assumes that error and question methods have been defined in the subclass, as in e.g. widget_mixins.MessageBoxMixin.

Parameters:results (validation.ValidationResults) – Set of validation results generated by validate Returns:if True, there were no validation errors and the user decided to continue despite any warnings. If False, there was at least one validation error or the user decided to abort when faced with a warning.

reset(*args, **kwargs)

run()

runValidation(silent=False, validate_children=True, stop_on_fail=True)

Runs validation and reports the results (unless run silently).

Parameters:

• silent (bool) – run without any reporting (i.e. error messages to the user). This is useful if we want to programmatically test validity. Changes return value of this method from ValidationResults to a boolean.
• validate_children (bool) – run validation on all child objects. See _validateChildren for documentation on what this entails.
• stop_on_fail (bool) – stop validation when first failure is encountered

Returns:

if silent is False, returns the validation results. If silent is True, returns a boolean generated by reportValidation.

Return type:

ValidationResults or bool

sender(self) → QObject

senderSignalIndex(self) → int

setAutoTaskDir(auto_task_dir)

setObjectName(self, str)

classmethod setParamValue(*args, **kwargs)

setParent(self, QObject)

setProperty(self, str, Any) → bool

setValue(*args, **kwargs)

signalsBlocked(self) → bool

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

status

statusChanged

statusReplaced

taskDone

taskFailed

taskStarted

taskdir

thread(self) → QThread

timerEvent(self, QTimerEvent)

toCmd()

toDict(*args, **kwargs)

toJson(_mark_version=True)

Create and returns a data structure made up of jsonable items.

Return type:An instance of one the classes from NATIVE_JSON_DATATYPES

toJsonImplementation(*args, **kwargs)

tr(self, str, disambiguation: str = None, n: int = -1) → str

valueChanged

wait(timeout=None)

Block until the task is finished executing or timeout seconds have passed.

Parameters:timeout (NoneType or int) – Amount of time in seconds to wait before timing out. If None or a negative number, this method will wait until the task is finished.

wrapCmdInLaunchApi(cmd)