From 0cb6ad82dec75f69322970bad01a135a85f1b25c Mon Sep 17 00:00:00 2001
From: Marina Golosova <golosova.marina@gmail.com>
Date: Mon, 17 Feb 2020 13:27:09 +0100
Subject: [PATCH] pyDKB/message: introduce `for_update()` method.

It allows to mark message as "for update"; without this marker it will
be treated as "for insert" by the pre-load stage (e.g. Stage 019).
---
 Utils/Dataflow/pyDKB/VERSION                  |  2 +-
 .../pyDKB/dataflow/communication/messages.py  | 34 +++++++++++++++++++
 2 files changed, 35 insertions(+), 1 deletion(-)

diff --git a/Utils/Dataflow/pyDKB/VERSION b/Utils/Dataflow/pyDKB/VERSION
index 5fdf9f44a..7b3c692a9 100644
--- a/Utils/Dataflow/pyDKB/VERSION
+++ b/Utils/Dataflow/pyDKB/VERSION
@@ -1 +1 @@
-0.3.20200210
+0.3.20200217
diff --git a/Utils/Dataflow/pyDKB/dataflow/communication/messages.py b/Utils/Dataflow/pyDKB/dataflow/communication/messages.py
index bc98bdd33..95e9b78fc 100644
--- a/Utils/Dataflow/pyDKB/dataflow/communication/messages.py
+++ b/Utils/Dataflow/pyDKB/dataflow/communication/messages.py
@@ -55,6 +55,7 @@ class AbstractMessage(object):
     encoded = None
 
     incompl = None
+    update = None
 
     def __init__(self, message=None):
         """ Save initial message. """
@@ -109,6 +110,20 @@ def incomplete(self, status=None):
             self.incompl = bool(status)
         return old
 
+    def for_update(self, status=None):
+        """ Set message for-update marker and/or get previous/current value.
+
+        :param status: new status (if not passed, current status is returned)
+        :type status: bool, NoneType
+
+        :return: for-update marker status (previous value, if reset)
+        :rtype: bool
+        """
+        old = self.update
+        if status is not None:
+            self.update = bool(status)
+        return old
+
 
 class JSONMessage(AbstractMessage):
     """ Message in JSON format. """
@@ -118,6 +133,7 @@ class JSONMessage(AbstractMessage):
     _ext = ".json"
 
     incompl_key = "_incomplete"
+    update_key = "_update"
 
     def decode(self, code=codeType.STRING):
         """ Decode original data as JSON. """
@@ -159,6 +175,24 @@ def incomplete(self, status=None):
             self.encoded = None
         return super(JSONMessage, self).incomplete(status)
 
+    def for_update(self, status=None):
+        """ Set message for-update marker and/or get previous/current value.
+
+        For JSON messages the marker is implemented as additional field:
+        "_update".
+
+        :param status: new status (if not passed, current status is returned)
+        :type status: bool, NoneType
+
+        :return: for-update marker status (previous value, if reset)
+        :rtype: bool
+        """
+        if status is not None:
+            decoded = self.decode()
+            decoded[self.update_key] = status
+            self.encoded = None
+        return super(JSONMessage, self).for_update(status)
+
 
 __message_class[messageType.JSON] = JSONMessage