# Source code for aiida.engine.processes.workchains.context

# -*- coding: utf-8 -*-
###########################################################################
# This file is part of the AiiDA code.                                    #
#                                                                         #
# The code is hosted on GitHub at https://github.com/aiidateam/aiida-core #
# For further information on the license, see the LICENSE.txt file        #
# For further information please visit http://www.aiida.net               #
###########################################################################
"""Convenience functions to add awaitables to the Context of a WorkChain."""
from typing import Union

from aiida.orm import ProcessNode
from .awaitable import construct_awaitable, Awaitable, AwaitableAction

__all__ = ('ToContext', 'assign_', 'append_')

ToContext = dict

[docs]def assign_(target: Union[Awaitable, ProcessNode]) -> Awaitable:
"""
Convenience function that will construct an Awaitable for a given class instance
with the context action set to ASSIGN. When the awaitable target is completed
it will be assigned to the context for a key that is to be defined later

:param target: an instance of a Process or Awaitable

:returns: the awaitable

"""
awaitable = construct_awaitable(target)
awaitable.action = AwaitableAction.ASSIGN
return awaitable

[docs]def append_(target: Union[Awaitable, ProcessNode]) -> Awaitable:
"""
Convenience function that will construct an Awaitable for a given class instance
with the context action set to APPEND. When the awaitable target is completed
it will be appended to a list in the context for a key that is to be defined later

:param target: an instance of a Process or Awaitable

:returns: the awaitable

"""
awaitable = construct_awaitable(target)
awaitable.action = AwaitableAction.APPEND
return awaitable