Add a frozen checking decorator

Since quite a few of the types check for being
frozen and disallow mutations on there instances
we can take advantage of a common decorator that
checks the frozen attribute and raises instead
of duplicating the same logic at the start of
the mutating methods.

Change-Id: I8c81a26d2d39bb9da4f68d64e07f67ac26ee0b08

1 files changed, 17 insertions, 0 deletions

diff --git a/taskflow/utils/misc.py b/taskflow/utils/misc.py
index 6c5c9de..ec9eda8 100644
--- a/taskflow/utils/misc.py
+++ b/taskflow/utils/misc.py
@@ -227,6 +227,23 @@ def look_for(haystack, needles, extractor=None):
         return [needles[i] for (_hay_i, i) in sorted(matches)]
 
 
+def disallow_when_frozen(excp_cls):
+    """Frozen checking/raising method decorator."""
+
+    def decorator(f):
+
+        @six.wraps(f)
+        def wrapper(self, *args, **kwargs):
+            if self.frozen:
+                raise excp_cls()
+            else:
+                return f(self, *args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
 def clamp(value, minimum, maximum, on_clamped=None):
     """Clamps a value to ensure its >= minimum and <= maximum."""
     if minimum > maximum: