Rename MESSAGE_KEY to MESSAGE_TEXT_KEY

aiidateam · Dec 17, 2024 · 05c36fa · 05c36fa
1 parent a84b93c
commit 05c36fa
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/src/plumpy/process_comms.py b/src/plumpy/process_comms.py
@@ -28,7 +28,7 @@
 ProcessStatus = Any
 
 INTENT_KEY = 'intent'
-MESSAGE_KEY = 'message'
+MESSAGE_TEXT_KEY = 'message'
 FORCE_KILL_KEY = 'force_kill'
 
 
@@ -52,23 +52,23 @@ def play(cls, text: str | None = None) -> MessageType:
         """The play message send over communicator."""
         return {
             INTENT_KEY: Intent.PLAY,
-            MESSAGE_KEY: text,
+            MESSAGE_TEXT_KEY: text,
         }
 
     @classmethod
     def pause(cls, text: str | None = None) -> MessageType:
         """The pause message send over communicator."""
         return {
             INTENT_KEY: Intent.PAUSE,
-            MESSAGE_KEY: text,
+            MESSAGE_TEXT_KEY: text,
         }
 
     @classmethod
     def kill(cls, text: str | None = None, force_kill: bool = False) -> MessageType:
         """The kill message send over communicator."""
         return {
             INTENT_KEY: Intent.KILL,
-            MESSAGE_KEY: text,
+            MESSAGE_TEXT_KEY: text,
             FORCE_KILL_KEY: force_kill,
         }
 
@@ -77,7 +77,7 @@ def status(cls, text: str | None = None) -> MessageType:
         """The status message send over communicator."""
         return {
             INTENT_KEY: Intent.STATUS,
-            MESSAGE_KEY: text,
+            MESSAGE_TEXT_KEY: text,
         }
 
 

diff --git a/src/plumpy/processes.py b/src/plumpy/processes.py
@@ -54,7 +54,7 @@
 from .base.state_machine import StateEntryFailed, StateMachine, TransitionFailed, event
 from .base.utils import call_with_super_check, super_check
 from .event_helper import EventHelper
-from .process_comms import MESSAGE_KEY, MessageBuilder, MessageType
+from .process_comms import MESSAGE_TEXT_KEY, MessageBuilder, MessageType
 from .process_listener import ProcessListener
 from .process_spec import ProcessSpec
 from .utils import PID_TYPE, SAVED_STATE_TYPE, protected
@@ -902,7 +902,7 @@ def on_kill(self, msg: Optional[MessageType]) -> None:
         if msg is None:
             msg_txt = ''
         else:
-            msg_txt = msg[MESSAGE_KEY] or ''
+            msg_txt = msg[MESSAGE_TEXT_KEY] or ''
 
         self.set_status(msg_txt)
         self.future().set_exception(exceptions.KilledError(msg_txt))
@@ -963,9 +963,9 @@ def message_receive(self, _comm: kiwipy.Communicator, msg: MessageType) -> Any:
         if intent == process_comms.Intent.PLAY:
             return self._schedule_rpc(self.play)
         if intent == process_comms.Intent.PAUSE:
-            return self._schedule_rpc(self.pause, msg_text=msg.get(process_comms.MESSAGE_KEY, None))
+            return self._schedule_rpc(self.pause, msg_text=msg.get(process_comms.MESSAGE_TEXT_KEY, None))
         if intent == process_comms.Intent.KILL:
-            return self._schedule_rpc(self.kill, msg_text=msg.get(process_comms.MESSAGE_KEY, None))
+            return self._schedule_rpc(self.kill, msg_text=msg.get(process_comms.MESSAGE_TEXT_KEY, None))
         if intent == process_comms.Intent.STATUS:
             status_info: Dict[str, Any] = {}
             self.get_status_info(status_info)
@@ -996,9 +996,9 @@ def broadcast_receive(
         if subject == process_comms.Intent.PLAY:
             return self._schedule_rpc(self.play)
         if subject == process_comms.Intent.PAUSE:
-            return self._schedule_rpc(self.pause, msg_text=msg.get(process_comms.MESSAGE_KEY, None))
+            return self._schedule_rpc(self.pause, msg_text=msg.get(process_comms.MESSAGE_TEXT_KEY, None))
         if subject == process_comms.Intent.KILL:
-            return self._schedule_rpc(self.kill, msg_text=msg.get(process_comms.MESSAGE_KEY, None))
+            return self._schedule_rpc(self.kill, msg_text=msg.get(process_comms.MESSAGE_TEXT_KEY, None))
         return None
 
     def _schedule_rpc(self, callback: Callable[..., Any], *args: Any, **kwargs: Any) -> kiwipy.Future:
@@ -1113,7 +1113,7 @@ def _do_pause(self, state_msg: Optional[MessageType], next_state: Optional[proce
             if state_msg is None:
                 msg_text = ''
             else:
-                msg_text = state_msg[MESSAGE_KEY]
+                msg_text = state_msg[MESSAGE_TEXT_KEY]
 
             call_with_super_check(self.on_pausing, msg_text)
             call_with_super_check(self.on_paused, msg_text)

diff --git a/tests/test_processes.py b/tests/test_processes.py
@@ -10,7 +10,7 @@
 
 import plumpy
 from plumpy import BundleKeys, Process, ProcessState
-from plumpy.process_comms import MESSAGE_KEY, MessageBuilder
+from plumpy.process_comms import MESSAGE_TEXT_KEY, MessageBuilder
 from plumpy.utils import AttributesFrozendict
 from tests import utils
 
@@ -325,7 +325,7 @@ def test_kill(self):
         msg_text = 'Farewell!'
         proc.kill(msg_text=msg_text)
         self.assertTrue(proc.killed())
-        self.assertEqual(proc.killed_msg()[MESSAGE_KEY], msg_text)
+        self.assertEqual(proc.killed_msg()[MESSAGE_TEXT_KEY], msg_text)
         self.assertEqual(proc.state, ProcessState.KILLED)
 
     def test_wait_continue(self):