aiida.orm.nodes.process package#

Module with Node sub classes for processes.

Subpackages#

Submodules#

Module with Node sub class for processes.

class aiida.orm.nodes.process.process.ProcessNode(backend: Optional[StorageBackend] = None, user: Optional[aiida.orm.users.User] = None, computer: Optional[aiida.orm.computers.Computer] = None, **kwargs: Any)[source]#

Bases: aiida.orm.utils.mixins.Sealable, aiida.orm.nodes.node.Node

Base class for all nodes representing the execution of a process

This class and its subclasses serve as proxies in the database, for actual Process instances being run. The Process instance in memory will leverage an instance of this class (the exact sub class depends on the sub class of Process) to persist important information of its state to the database. This serves as a way for the user to inspect the state of the Process during its execution as well as a permanent record of its execution in the provenance graph, after the execution has terminated.

CHECKPOINT_KEY = 'checkpoints'#

EXCEPTION_KEY = 'exception'#

EXIT_MESSAGE_KEY = 'exit_message'#

EXIT_STATUS_KEY = 'exit_status'#

METADATA_INPUTS_KEY: str = 'metadata_inputs'#

PROCESS_LABEL_KEY = 'process_label'#

PROCESS_PAUSED_KEY = 'paused'#

PROCESS_STATE_KEY = 'process_state'#

PROCESS_STATUS_KEY = 'process_status'#

_CLS_NODE_CACHING#: alias of aiida.orm.nodes.process.process.ProcessNodeCaching

_CLS_NODE_LINKS#: alias of aiida.orm.nodes.process.process.ProcessNodeLinks

__abstractmethods__ = frozenset({})#

__annotations__ = {'METADATA_INPUTS_KEY': <class 'str'>, '_CLS_COLLECTION': 'Type[CollectionType]', '__plugin_type_string': 'ClassVar[str]', '__query_type_string': 'ClassVar[str]', '_hash_ignored_attributes': 'Tuple[str, ...]', '_logger': 'Optional[Logger]', '_updatable_attributes': 'Tuple[str, ...]'}#

__module__ = 'aiida.orm.nodes.process.process'#

__parameters__ = ()#

__str__() → str[source]#: Return str(self).

_abc_impl = <_abc._abc_data object>#

_logger: Optional[Logger] = <Logger aiida.orm.nodes.process.process.ProcessNode (REPORT)>#

_unstorable_message = 'only Data, WorkflowNode, CalculationNode or their subclasses can be stored'#

_updatable_attributes: Tuple[str, ...] = ('sealed', 'paused', 'checkpoints', 'exception', 'exit_message', 'exit_status', 'process_label', 'process_state', 'process_status')#

property called: List[aiida.orm.nodes.process.process.ProcessNode]#

Return a list of nodes that the process called

Returns: list of process nodes called by this process

property called_descendants: List[aiida.orm.nodes.process.process.ProcessNode]#

Return a list of all nodes that have been called downstream of this process

This will recursively find all the called processes for this process and its children.

property caller: Optional[aiida.orm.nodes.process.process.ProcessNode]#

Return the process node that called this process node, or None if it does not have a caller

Returns: process node that called this process node instance or None

property checkpoint: Optional[str]#

Return the checkpoint bundle set for the process

Returns: checkpoint bundle if it exists, None otherwise

delete_checkpoint() → None[source]#: Delete the checkpoint bundle set for the process

property exception: Optional[str]#

Return the exception of the process or None if the process is not excepted.

If the process is marked as excepted yet there is no exception attribute, an empty string will be returned.

Returns: the exception message or None

property exit_code: Optional[ExitCode]#

Return the exit code of the process.

It is reconstituted from the exit_status and exit_message attributes if both of those are defined.

Returns: The exit code if defined, or None.

property exit_message: Optional[str]#

Return the exit message of the process

Returns: the exit message

property exit_status: Optional[int]#

Return the exit status of the process

Returns: the exit status, an integer exit code or None

get_builder_restart() → ProcessBuilder[source]#

Return a ProcessBuilder that is ready to relaunch the process that created this node.

The process class will be set based on the process_type of this node and the inputs of the builder will be prepopulated with the inputs registered for this node. This functionality is very useful if a process has completed and you want to relaunch it with slightly different inputs.

Returns: ~aiida.engine.processes.builder.ProcessBuilder instance

get_metadata_inputs() → Optional[Dict[str, Any]][source]#: Return the mapping of inputs corresponding to metadata ports that were passed to the process.

property is_excepted: bool#

Return whether the process has excepted

Excepted means that during execution of the process, an exception was raised that was not caught.

Returns: True if during execution of the process an exception occurred, False otherwise
Return type: bool

property is_failed: bool#

Return whether the process has failed

Failed means that the process terminated nominally but it had a non-zero exit status.

Returns: True if the process has failed, False otherwise
Return type: bool

property is_finished: bool#

Return whether the process has finished

Finished means that the process reached a terminal state nominally. Note that this does not necessarily mean successfully, but there were no exceptions and it was not killed.

Returns: True if the process has finished, False otherwise
Return type: bool

property is_finished_ok: bool#

Return whether the process has finished successfully

Finished successfully means that it terminated nominally and had a zero exit status.

Returns: True if the process has finished successfully, False otherwise
Return type: bool

property is_killed: bool#

Return whether the process was killed

Killed means the process was killed directly by the user or by the calling process being killed.

Returns: True if the process was killed, False otherwise
Return type: bool

property is_terminated: bool#

Return whether the process has terminated

Terminated means that the process has reached any terminal state.

Returns: True if the process has terminated, False otherwise
Return type: bool

property logger#

Get the logger of the Calculation object, so that it also logs to the DB.

Returns: LoggerAdapter object, that works like a logger, but also has the ‘extra’ embedded

pause() → None[source]#

Mark the process as paused by setting the corresponding attribute.

This serves only to reflect that the corresponding Process is paused and so this method should not be called by anyone but the Process instance itself.

property paused: bool#

Return whether the process is paused

Returns: True if the Calculation is marked as paused, False otherwise

property process_class: Type[Process]#

Return the process class that was used to create this node.

Returns: Process class
Raises: ValueError – if no process type is defined, it is an invalid process type string or cannot be resolved to load the corresponding class

property process_label: Optional[str]#

Return the process label

Returns: the process label

property process_state: Optional[plumpy.process_states.ProcessState]#

Return the process state

Returns: the process state instance of ProcessState enum

property process_status: Optional[str]#

Return the process status

The process status is a generic status message e.g. the reason it might be paused or when it is being killed

Returns: the process status

set_checkpoint(checkpoint: str) → None[source]#

Set the checkpoint bundle set for the process

Parameters: state – string representation of the stepper state info

set_exception(exception: str) → None[source]#

Set the exception of the process

Parameters: exception – the exception message

set_exit_message(message: Optional[str]) → None[source]#

Set the exit message of the process, if None nothing will be done

Parameters: message – a string message

set_exit_status(status: Union[None, enum.Enum, int]) → None[source]#

Set the exit status of the process

Parameters: state – an integer exit code or None, which will be interpreted as zero

set_metadata_inputs(value: Dict[str, Any]) → None[source]#: Set the mapping of inputs corresponding to metadata ports that were passed to the process.

set_process_label(label: str) → None[source]#

Set the process label

Parameters: label – process label string

set_process_state(state: Optional[Union[str, plumpy.process_states.ProcessState]])[source]#

Set the process state

Parameters: state – value or instance of ProcessState enum

set_process_status(status: Optional[str]) → None[source]#

Set the process status

The process status is a generic status message e.g. the reason it might be paused or when it is being killed. If status is None, the corresponding attribute will be deleted.

Parameters: status – string process status

set_process_type(process_type_string: str) → None[source]#

Set the process type string.

Parameters: process_type – the process type string identifying the class using this process node as storage.

unpause() → None[source]#

Mark the process as unpaused by removing the corresponding attribute.

This serves only to reflect that the corresponding Process is unpaused and so this method should not be called by anyone but the Process instance itself.

class aiida.orm.nodes.process.process.ProcessNodeCaching(node: Node)[source]#

Bases: aiida.orm.nodes.caching.NodeCaching

Interface to control caching of a node instance.

__annotations__ = {}#

__module__ = 'aiida.orm.nodes.process.process'#

_get_objects_to_hash() → List[Any][source]#: Return a list of objects which should be included in the hash.

_hash_ignored_inputs = ['CALL_CALC', 'CALL_WORK']#

property is_valid_cache: bool#

Return whether the node is valid for caching

Returns: True if this process node is valid to be used for caching, False otherwise

class aiida.orm.nodes.process.process.ProcessNodeLinks(node: Node)[source]#

Bases: aiida.orm.nodes.links.NodeLinks

Interface for links of a node instance.

__annotations__ = {}#

__module__ = 'aiida.orm.nodes.process.process'#

validate_incoming(source: aiida.orm.nodes.node.Node, link_type: aiida.common.links.LinkType, link_label: str) → None[source]#

Validate adding a link of the given type from a given node to ourself.

Adding an input link to a ProcessNode once it is stored is illegal because this should be taken care of by the engine in one go. If a link is being added after the node is stored, it is most likely not by the engine and it should not be allowed.

Parameters

source – the node from which the link is coming
link_type – the link type
link_label – the link label

Raises

TypeError – if source is not a Node instance or link_type is not a LinkType enum
ValueError – if the proposed link is invalid

validate_outgoing(target, link_type, link_label)[source]#

Validate adding a link of the given type from ourself to a given node.

Adding an outgoing link from a sealed node is forbidden.

Parameters

target – the node to which the link is going
link_type – the link type
link_label – the link label

Raises

aiida.common.ModificationNotAllowed – if the source node (self) is sealed