ob-metaflow 2.10.7.3__py2.py3-none-any.whl → 2.10.9.1__py2.py3-none-any.whl

metaflow/plugins/cards/card_modules/card.py

@@ -32,12 +32,40 @@ class MetaflowCard(object):
         JSON-encodable dictionary containing user-definable options for the class.
     """
 
+    # RELOAD_POLICY determines whether UIs should
+    # reload intermediate cards produced by render_runtime
+    # or whether they can just rely on data updates
+
+    # the UI may keep using the same card
+    # until the final card is produced
+    RELOAD_POLICY_NEVER = "never"
+
+    # the UI should reload card every time
+    # render_runtime() has produced a new card
+    RELOAD_POLICY_ALWAYS = "always"
+
+    # derive reload token from data and component
+    # content - force reload only when the content
+    # changes. The actual policy is card-specific,
+    # defined by the method reload_content_token()
+    RELOAD_POLICY_ONCHANGE = "onchange"
+
+    # this token will get replaced in the html with a unique
+    # string that is used to ensure that data updates and the
+    # card content matches
+    RELOAD_POLICY_TOKEN = "[METAFLOW_RELOAD_TOKEN]"
+
     type = None
 
     ALLOW_USER_COMPONENTS = False
+    RUNTIME_UPDATABLE = False
+    RELOAD_POLICY = RELOAD_POLICY_NEVER
 
     scope = "task"  # can be task | run
 
+    # FIXME document runtime_data
+    runtime_data = None
+
     def __init__(self, options={}, components=[], graph=None):
         pass
 
@@ -68,8 +96,45 @@ class MetaflowCard(object):
         """
         return NotImplementedError()
 
+    # FIXME document
+    def render_runtime(self, task, data):
+        raise NotImplementedError()
+
+    # FIXME document
+    def refresh(self, task, data):
+        raise NotImplementedError()
+
+    # FIXME document
+    def reload_content_token(self, task, data):
+        return "content-token"
+
 
 class MetaflowCardComponent(object):
+
+    # Setting REALTIME_UPDATABLE as True will allow metaflow to update the card
+    # during Task runtime.
+    REALTIME_UPDATABLE = False
+
+    _component_id = None
+
+    _logger = None
+
+    @property
+    def component_id(self):
+        return self._component_id
+
+    @component_id.setter
+    def component_id(self, value):
+        if not isinstance(value, str):
+            raise TypeError("Component ID must be a string")
+        self._component_id = value
+
+    def update(self, *args, **kwargs):
+        """
+        #FIXME document
+        """
+        raise NotImplementedError()
+
     def render(self):
         """
         `render` returns a string or dictionary. This class can be called on the client side to dynamically add components to the `MetaflowCard`