[card/components] internal MetaflowCard classes support realtime behavior

- Markdown and Artifact Component made realtime.
- default/blank cards made realtime

Author: valayDave

metaflow/plugins/cards/card_modules/basic.py

@@ -146,6 +146,8 @@ def render(self):
             label=self._label,
         )
         datadict.update(img_dict)
+        if self.id is not None:
+            datadict["id"] = self.id
         return datadict
 
 
@@ -194,6 +196,8 @@ def render(self):
         datadict["columns"] = self._headers
         datadict["data"] = self._data
         datadict["vertical"] = self._vertical
+        if self.id is not None:
+            datadict["id"] = self.id
         return datadict
 
 
@@ -295,6 +299,8 @@ def __init__(self, title=None, subtitle=None, data={}):
     def render(self):
         datadict = super().render()
         datadict["data"] = self._data
+        if self.id is not None:
+            datadict["id"] = self.id
         return datadict
 
 
@@ -308,6 +314,8 @@ def __init__(self, text=None):
     def render(self):
         datadict = super().render()
         datadict["source"] = self._text
+        if self.id is not None:
+            datadict["id"] = self.id
         return datadict
 
 
@@ -319,7 +327,13 @@ class TaskInfoComponent(MetaflowCardComponent):
     """
 
     def __init__(
-        self, task, page_title="Task Info", only_repr=True, graph=None, components=[]
+        self,
+        task,
+        page_title="Task Info",
+        only_repr=True,
+        graph=None,
+        components=[],
+        runtime=False,
     ):
         self._task = task
         self._only_repr = only_repr
@@ -328,6 +342,7 @@ def __init__(
         self._page_title = page_title
         self.final_component = None
         self.page_component = None
+        self.runtime = runtime
 
     def render(self):
         """
@@ -340,7 +355,8 @@ def render(self):
             self._task, graph=self._graph
         )
         # ignore the name as an artifact
-        del task_data_dict["data"]["name"]
+        if "name" in task_data_dict["data"]:
+            del task_data_dict["data"]["name"]
 
         _metadata = dict(version=1, template="defaultCardTemplate")
         # try to parse out metaflow version from tags, but let it go if unset
@@ -370,11 +386,12 @@ def render(self):
             "Task Created On": task_data_dict["created_at"],
             "Task Finished On": task_data_dict["finished_at"],
             # Remove Microseconds from timedelta
-            "Task Duration": str(self._task.finished_at - self._task.created_at).split(
-                "."
-            )[0],
             "Tags": ", ".join(tags),
         }
+        if not self.runtime:
+            task_metadata_dict["Task Duration"] = str(
+                self._task.finished_at - self._task.created_at
+            ).split(".")[0]
         if len(user_info) > 0:
             task_metadata_dict["User"] = user_info[0].split("user:")[1]
 
@@ -580,6 +597,10 @@ class DefaultCard(MetaflowCard):
 
     ALLOW_USER_COMPONENTS = True
 
+    IS_RUNTIME_CARD = True
+
+    RELOAD_POLICY = MetaflowCard.RELOAD_POLICY_ONCHANGE
+
     type = "default"
 
     def __init__(self, options=dict(only_repr=True), components=[], graph=None):
@@ -589,7 +610,7 @@ def __init__(self, options=dict(only_repr=True), components=[], graph=None):
             self._only_repr = options["only_repr"]
         self._components = components
 
-    def render(self, task):
+    def render(self, task, runtime=False):
         RENDER_TEMPLATE = read_file(RENDER_TEMPLATE_PATH)
         JS_DATA = read_file(JS_PATH)
         CSS_DATA = read_file(CSS_PATH)
@@ -598,6 +619,7 @@ def render(self, task):
             only_repr=self._only_repr,
             graph=self._graph,
             components=self._components,
+            runtime=runtime,
         ).render()
         pt = self._get_mustache()
         data_dict = dict(
@@ -611,11 +633,27 @@ def render(self, task):
         )
         return pt.render(RENDER_TEMPLATE, data_dict)
 
+    def render_runtime(self, task, data):
+        return self.render(task, runtime=True)
+
+    def refresh(self, task, data):
+        return data["components"]
+
+    def reload_content_token(self, task, data):
+        if task.finished:
+            return "final"
+        else:
+            return "runtime"
+
 
 class BlankCard(MetaflowCard):
 
     ALLOW_USER_COMPONENTS = True
 
+    IS_RUNTIME_CARD = True
+
+    RELOAD_POLICY = MetaflowCard.RELOAD_POLICY_ONCHANGE
+
     type = "blank"
 
     def __init__(self, options=dict(title=""), components=[], graph=None):
@@ -653,6 +691,18 @@ def render(self, task, components=[]):
         )
         return pt.render(RENDER_TEMPLATE, data_dict)
 
+    def render_runtime(self, task, data):
+        return self.render(task)
+
+    def refresh(self, task, data):
+        return data["components"]
+
+    def reload_content_token(self, task, data):
+        if task.finished:
+            return "final"
+        else:
+            return "runtime"
+
 
 class TaskSpecCard(MetaflowCard):
     type = "taskspec_card"

metaflow/plugins/cards/card_modules/components.py

@@ -39,6 +39,11 @@ class Artifact(UserComponent):
         Use a truncated representation.
     """
 
+    REALTIME_UPDATABLE = True
+
+    def update(self, artifact):
+        self._artifact = artifact
+
     def __init__(
         self, artifact: Any, name: Optional[str] = None, compressed: bool = True
     ):
@@ -52,7 +57,9 @@ def render(self):
         artifact["name"] = None
         if self._name is not None:
             artifact["name"] = str(self._name)
-        return ArtifactsComponent(data=[artifact]).render()
+        af_component = ArtifactsComponent(data=[artifact])
+        af_component.id = self.id
+        return af_component.render()
 
 
 class Table(UserComponent):
@@ -434,9 +441,16 @@ class Markdown(UserComponent):
         Text formatted in Markdown.
     """
 
+    REALTIME_UPDATABLE = True
+
+    def update(self, text=None):
+        self._text = text
+
     def __init__(self, text=None):
         self._text = text
 
     @render_safely
     def render(self):
-        return MarkdownComponent(self._text).render()
+        comp = MarkdownComponent(self._text)
+        comp.id = self.id
+        return comp.render()

metaflow/plugins/cards/card_modules/convert_to_native_type.py

@@ -44,7 +44,7 @@ def _full_classname(obj):
 
 
 class TaskToDict:
-    def __init__(self, only_repr=False):
+    def __init__(self, only_repr=False, runtime=False):
         # this dictionary holds all the supported functions
         import reprlib
         import pprint
@@ -59,6 +59,7 @@ def __init__(self, only_repr=False):
         r.maxlist = 100
         r.maxlevel = 3
         self._repr = r
+        self._runtime = runtime
         self._only_repr = only_repr
         self._supported_types = {
             "tuple": self._parse_tuple,
@@ -90,11 +91,16 @@ def __call__(self, task, graph=None):
             stderr=task.stderr,
             stdout=task.stdout,
             created_at=task.created_at.strftime(TIME_FORMAT),
-            finished_at=task.finished_at.strftime(TIME_FORMAT),
+            finished_at=None,
             pathspec=task.pathspec,
             graph=graph,
             data={},
         )
+        if not self._runtime:
+            if task.finished_at is not None:
+                task_dict.update(
+                    dict(finished_at=task.finished_at.strftime(TIME_FORMAT))
+                )
         task_dict["data"], type_infered_objects = self._create_task_data_dict(task)
         task_dict.update(type_infered_objects)
         return task_dict