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

metaflow/plugins/cards/card_modules/components.py

@@ -11,10 +11,53 @@ from .basic import (
 from .card import MetaflowCardComponent
 from .convert_to_native_type import TaskToDict, _full_classname
 from .renderer_tools import render_safely
+import uuid
+
+
+def create_component_id(component):
+    uuid_bit = "".join(uuid.uuid4().hex.split("-"))[:6]
+    return type(component).__name__.lower() + "_" + uuid_bit
+
+
+def with_default_component_id(func):
+    def ret_func(self, *args, **kwargs):
+        if self.component_id is None:
+            self.component_id = create_component_id(self)
+        return func(self, *args, **kwargs)
+
+    return ret_func
+
+
+def _warning_with_component(component, msg):
+    if component._logger is None:
+        return None
+    if component._warned_once:
+        return None
+    log_msg = "[@card-component WARNING] %s" % msg
+    component._logger(log_msg, timestamp=False, bad=True)
+    component._warned_once = True
 
 
 class UserComponent(MetaflowCardComponent):
-    pass
+
+    _warned_once = False
+
+    def update(self, *args, **kwargs):
+        cls_name = self.__class__.__name__
+        msg = (
+            "MetaflowCardComponent doesn't have an `update` method implemented "
+            "and is not compatible with realtime updates."
+        ) % cls_name
+        _warning_with_component(self, msg)
+
+
+class StubComponent(UserComponent):
+    def __init__(self, component_id):
+        self._non_existing_comp_id = component_id
+
+    def update(self, *args, **kwargs):
+        msg = "Component with id %s doesn't exist. No updates will be made at anytime during runtime."
+        _warning_with_component(self, msg % self._non_existing_comp_id)
 
 
 class Artifact(UserComponent):
@@ -39,6 +82,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
     ):
@@ -46,13 +94,16 @@ class Artifact(UserComponent):
         self._name = name
         self._task_to_dict = TaskToDict(only_repr=compressed)
 
+    @with_default_component_id
     @render_safely
     def render(self):
         artifact = self._task_to_dict.infer_object(self._artifact)
         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.component_id = self.component_id
+        return af_component.render()
 
 
 class Table(UserComponent):
@@ -96,10 +147,21 @@ class Table(UserComponent):
         Optional header row for the table.
     """
 
+    REALTIME_UPDATABLE = True
+
+    def update(self, *args, **kwargs):
+        msg = (
+            "`Table` doesn't have an `update` method implemented. "
+            "Components within a table can be updated individually "
+            "but the table itself cannot be updated."
+        )
+        _warning_with_component(self, msg)
+
     def __init__(
         self,
         data: Optional[List[List[Union[str, MetaflowCardComponent]]]] = None,
         headers: Optional[List[str]] = None,
+        disable_updates: bool = False,
     ):
         data = data or [[]]
         headers = headers or []
@@ -111,8 +173,15 @@ class Table(UserComponent):
         if data_bool:
             self._data = data
 
+        if disable_updates:
+            self.REALTIME_UPDATABLE = False
+
     @classmethod
-    def from_dataframe(cls, dataframe=None, truncate: bool = True):
+    def from_dataframe(
+        cls,
+        dataframe=None,
+        truncate: bool = True,
+    ):
         """
         Create a `Table` based on a Pandas dataframe.
 
@@ -129,14 +198,24 @@ class Table(UserComponent):
             table_data = task_to_dict._parse_pandas_dataframe(
                 dataframe, truncate=truncate
             )
-            return_val = cls(data=table_data["data"], headers=table_data["headers"])
+            return_val = cls(
+                data=table_data["data"],
+                headers=table_data["headers"],
+                disable_updates=True,
+            )
             return return_val
         else:
             return cls(
                 headers=["Object type %s not supported" % object_type],
+                disable_updates=True,
             )
 
     def _render_subcomponents(self):
+        for row in self._data:
+            for col in row:
+                if isinstance(col, VegaChart):
+                    col._chart_inside_table = True
+
         return [
             SectionComponent.render_subcomponents(
                 row,
@@ -155,11 +234,14 @@ class Table(UserComponent):
             for row in self._data
         ]
 
+    @with_default_component_id
     @render_safely
     def render(self):
-        return TableComponent(
+        table_component = TableComponent(
             headers=self._headers, data=self._render_subcomponents()
-        ).render()
+        )
+        table_component.component_id = self.component_id
+        return table_component.render()
 
 
 class Image(UserComponent):
@@ -213,21 +295,62 @@ class Image(UserComponent):
         Optional label for the image.
     """
 
+    REALTIME_UPDATABLE = True
+
+    _PIL_IMAGE_MODULE_PATH = "PIL.Image.Image"
+
+    _MATPLOTLIB_FIGURE_MODULE_PATH = "matplotlib.figure.Figure"
+
+    _PLT_MODULE = None
+
+    _PIL_MODULE = None
+
+    @classmethod
+    def _get_pil_module(cls):
+        if cls._PIL_MODULE == "NOT_PRESENT":
+            return None
+        if cls._PIL_MODULE is None:
+            try:
+                import PIL
+            except ImportError:
+                cls._PIL_MODULE = "NOT_PRESENT"
+                return None
+            cls._PIL_MODULE = PIL
+        return cls._PIL_MODULE
+
+    @classmethod
+    def _get_plt_module(cls):
+        if cls._PLT_MODULE == "NOT_PRESENT":
+            return None
+        if cls._PLT_MODULE is None:
+            try:
+                import matplotlib.pyplot as pyplt
+            except ImportError:
+                cls._PLT_MODULE = "NOT_PRESENT"
+                return None
+            cls._PLT_MODULE = pyplt
+        return cls._PLT_MODULE
+
     @staticmethod
     def render_fail_headline(msg):
         return "[IMAGE_RENDER FAIL]: %s" % msg
 
-    def __init__(self, src=None, label=None):
-        self._error_comp = None
+    def _set_image_src(self, src, label=None):
         self._label = label
-
-        if type(src) is not str:
+        self._src = None
+        self._error_comp = None
+        if src is None:
+            self._error_comp = ErrorComponent(
+                self.render_fail_headline("`Image` Component `src` cannot be `None`"),
+                "",
+            )
+        elif type(src) is not str:
             try:
                 self._src = self._bytes_to_base64(src)
             except TypeError:
                 self._error_comp = ErrorComponent(
                     self.render_fail_headline(
-                        "first argument should be of type `bytes` or valid image base64 string"
+                        "The `Image` `src` argument should be of type `bytes` or valid image base64 string"
                     ),
                     "Type of %s is invalid" % (str(type(src))),
                 )
@@ -248,11 +371,141 @@ class Image(UserComponent):
             else:
                 self._error_comp = ErrorComponent(
                     self.render_fail_headline(
-                        "first argument should be of type `bytes` or valid image base64 string"
+                        "The `Image` `src` argument should be of type `bytes` or valid image base64 string"
                     ),
                     "String %s is invalid base64 string" % src,
                 )
 
+    def __init__(self, src=None, label=None, disable_updates: bool = True):
+        if disable_updates:
+            self.REALTIME_UPDATABLE = False
+        self._set_image_src(src, label=label)
+
+    def _update_image(self, img_obj, label=None):
+        task_to_dict = TaskToDict()
+        parsed_image, err_comp = None, None
+
+        # First set image for bytes/string type
+        if task_to_dict.object_type(img_obj) in ["bytes", "str"]:
+            self._set_image_src(img_obj, label=label)
+            return
+
+        if task_to_dict.object_type(img_obj).startswith("PIL"):
+            parsed_image, err_comp = self._parse_pil_image(img_obj)
+        elif _full_classname(img_obj) == self._MATPLOTLIB_FIGURE_MODULE_PATH:
+            parsed_image, err_comp = self._parse_matplotlib(img_obj)
+        else:
+            parsed_image, err_comp = None, ErrorComponent(
+                self.render_fail_headline(
+                    "Invalid Type. Object %s is not supported. Supported types: %s"
+                    % (
+                        type(img_obj),
+                        ", ".join(
+                            [
+                                "str",
+                                "bytes",
+                                self._PIL_IMAGE_MODULE_PATH,
+                                self._MATPLOTLIB_FIGURE_MODULE_PATH,
+                            ]
+                        ),
+                    )
+                ),
+                "",
+            )
+
+        if parsed_image is not None:
+            self._set_image_src(parsed_image, label=label)
+        else:
+            self._set_image_src(None, label=label)
+            self._error_comp = err_comp
+
+    @classmethod
+    def _pil_parsing_error(cls, error_type):
+        return None, ErrorComponent(
+            cls.render_fail_headline(
+                "first argument for `Image` should be of type %s"
+                % cls._PIL_IMAGE_MODULE_PATH
+            ),
+            "Type of %s is invalid. Type of %s required"
+            % (error_type, cls._PIL_IMAGE_MODULE_PATH),
+        )
+
+    @classmethod
+    def _parse_pil_image(cls, pilimage):
+        parsed_value = None
+        error_component = None
+        import io
+
+        task_to_dict = TaskToDict()
+        _img_type = task_to_dict.object_type(pilimage)
+
+        if not _img_type.startswith("PIL"):
+            return cls._pil_parsing_error(_img_type)
+
+        # Set the module as a part of the class so that
+        # we don't keep reloading the module everytime
+        pil_module = cls._get_pil_module()
+
+        if pil_module is None:
+            return parsed_value, ErrorComponent(
+                cls.render_fail_headline("PIL cannot be imported"), ""
+            )
+        if not isinstance(pilimage, pil_module.Image.Image):
+            return cls._pil_parsing_error(_img_type)
+
+        img_byte_arr = io.BytesIO()
+        try:
+            pilimage.save(img_byte_arr, format="PNG")
+        except OSError as e:
+            return parsed_value, ErrorComponent(
+                cls.render_fail_headline("PIL Image Not Parsable"), "%s" % repr(e)
+            )
+        img_byte_arr = img_byte_arr.getvalue()
+        parsed_value = task_to_dict.parse_image(img_byte_arr)
+        return parsed_value, error_component
+
+    @classmethod
+    def _parse_matplotlib(cls, plot):
+        import io
+        import traceback
+
+        parsed_value = None
+        error_component = None
+        pyplt = cls._get_plt_module()
+        if pyplt is None:
+            return parsed_value, ErrorComponent(
+                cls.render_fail_headline("Matplotlib cannot be imported"),
+                "%s" % traceback.format_exc(),
+            )
+        # First check if it is a valid Matplotlib figure.
+        figure = None
+        if _full_classname(plot) == cls._MATPLOTLIB_FIGURE_MODULE_PATH:
+            figure = plot
+
+        # If it is not valid figure then check if it is matplotlib.axes.Axes or a matplotlib.axes._subplots.AxesSubplot
+        # These contain the `get_figure` function to get the main figure object.
+        if figure is None:
+            if getattr(plot, "get_figure", None) is None:
+                return parsed_value, ErrorComponent(
+                    cls.render_fail_headline(
+                        "Invalid Type. Object %s is not from `matplotlib`" % type(plot)
+                    ),
+                    "",
+                )
+            else:
+                figure = plot.get_figure()
+
+        task_to_dict = TaskToDict()
+        img_bytes_arr = io.BytesIO()
+        figure.savefig(img_bytes_arr, format="PNG")
+        parsed_value = task_to_dict.parse_image(img_bytes_arr.getvalue())
+        pyplt.close(figure)
+        if parsed_value is not None:
+            return parsed_value, error_component
+        return parsed_value, ErrorComponent(
+            cls.render_fail_headline("Matplotlib plot's image is not parsable"), ""
+        )
+
     @staticmethod
     def _bytes_to_base64(bytes_arr):
         task_to_dict = TaskToDict()
@@ -264,7 +517,9 @@ class Image(UserComponent):
         return parsed_image
 
     @classmethod
-    def from_pil_image(cls, pilimage, label: Optional[str] = None):
+    def from_pil_image(
+        cls, pilimage, label: Optional[str] = None, disable_updates: bool = False
+    ):
         """
         Create an `Image` from a PIL image.
 
@@ -276,43 +531,29 @@ class Image(UserComponent):
             Optional label for the image.
         """
         try:
-            import io
-
-            PIL_IMAGE_PATH = "PIL.Image.Image"
-            task_to_dict = TaskToDict()
-            if task_to_dict.object_type(pilimage) != PIL_IMAGE_PATH:
-                return ErrorComponent(
-                    cls.render_fail_headline(
-                        "first argument for `Image` should be of type %s"
-                        % PIL_IMAGE_PATH
-                    ),
-                    "Type of %s is invalid. Type of %s required"
-                    % (task_to_dict.object_type(pilimage), PIL_IMAGE_PATH),
-                )
-            img_byte_arr = io.BytesIO()
-            try:
-                pilimage.save(img_byte_arr, format="PNG")
-            except OSError as e:
-                return ErrorComponent(
-                    cls.render_fail_headline("PIL Image Not Parsable"), "%s" % repr(e)
-                )
-            img_byte_arr = img_byte_arr.getvalue()
-            parsed_image = task_to_dict.parse_image(img_byte_arr)
+            parsed_image, error_comp = cls._parse_pil_image(pilimage)
             if parsed_image is not None:
-                return cls(src=parsed_image, label=label)
-            return ErrorComponent(
-                cls.render_fail_headline("PIL Image Not Parsable"), ""
-            )
+                img = cls(
+                    src=parsed_image, label=label, disable_updates=disable_updates
+                )
+            else:
+                img = cls(src=None, label=label, disable_updates=disable_updates)
+                img._error_comp = error_comp
+            return img
         except:
             import traceback
 
-            return ErrorComponent(
+            img = cls(src=None, label=label, disable_updates=disable_updates)
+            img._error_comp = ErrorComponent(
                 cls.render_fail_headline("PIL Image Not Parsable"),
                 "%s" % traceback.format_exc(),
             )
+            return img
 
     @classmethod
-    def from_matplotlib(cls, plot, label: Optional[str] = None):
+    def from_matplotlib(
+        cls, plot, label: Optional[str] = None, disable_updates: bool = False
+    ):
         """
         Create an `Image` from a Matplotlib plot.
 
@@ -323,64 +564,62 @@ class Image(UserComponent):
         label : str, optional
             Optional label for the image.
         """
-        import io
-
         try:
-            try:
-                import matplotlib.pyplot as pyplt
-            except ImportError:
-                return ErrorComponent(
-                    cls.render_fail_headline("Matplotlib cannot be imported"),
-                    "%s" % traceback.format_exc(),
-                )
-            # First check if it is a valid Matplotlib figure.
-            figure = None
-            if _full_classname(plot) == "matplotlib.figure.Figure":
-                figure = plot
-
-            # If it is not valid figure then check if it is matplotlib.axes.Axes or a matplotlib.axes._subplots.AxesSubplot
-            # These contain the `get_figure` function to get the main figure object.
-            if figure is None:
-                if getattr(plot, "get_figure", None) is None:
-                    return ErrorComponent(
-                        cls.render_fail_headline(
-                            "Invalid Type. Object %s is not from `matplotlib`"
-                            % type(plot)
-                        ),
-                        "",
-                    )
-                else:
-                    figure = plot.get_figure()
-
-            task_to_dict = TaskToDict()
-            img_bytes_arr = io.BytesIO()
-            figure.savefig(img_bytes_arr, format="PNG")
-            parsed_image = task_to_dict.parse_image(img_bytes_arr.getvalue())
-            pyplt.close(figure)
+            parsed_image, error_comp = cls._parse_matplotlib(plot)
             if parsed_image is not None:
-                return cls(src=parsed_image, label=label)
-            return ErrorComponent(
-                cls.render_fail_headline("Matplotlib plot's image is not parsable"), ""
-            )
+                img = cls(
+                    src=parsed_image, label=label, disable_updates=disable_updates
+                )
+            else:
+                img = cls(src=None, label=label, disable_updates=disable_updates)
+                img._error_comp = error_comp
+            return img
         except:
             import traceback
 
-            return ErrorComponent(
+            img = cls(src=None, label=label, disable_updates=disable_updates)
+            img._error_comp = ErrorComponent(
                 cls.render_fail_headline("Matplotlib plot's image is not parsable"),
                 "%s" % traceback.format_exc(),
             )
+            return img
 
+    @with_default_component_id
     @render_safely
     def render(self):
         if self._error_comp is not None:
             return self._error_comp.render()
 
         if self._src is not None:
-            return ImageComponent(src=self._src, label=self._label).render()
+            img_comp = ImageComponent(src=self._src, label=self._label)
+            img_comp.component_id = self.component_id
+            return img_comp.render()
         return ErrorComponent(
             self.render_fail_headline("`Image` Component `src` argument is `None`"), ""
         ).render()
 
+    def update(self, image, label=None):
+        """
+        Update the image.
+
+        Parameters
+        ----------
+        image : PIL.Image or matplotlib.figure.Figure or matplotlib.axes.Axes or matplotlib.axes._subplots.AxesSubplot or bytes or str
+            The updated image object
+        label : str, optional
+            Optional label for the image.
+        """
+        if not self.REALTIME_UPDATABLE:
+            msg = (
+                "The `Image` component is disabled for realtime updates. "
+                "Please set `disable_updates` to `False` while creating the `Image` object."
+            )
+            _warning_with_component(self, msg)
+            return
+
+        _label = label if label is not None else self._label
+        self._update_image(image, label=_label)
+
 
 class Error(UserComponent):
     """
@@ -434,9 +673,135 @@ 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
 
+    @with_default_component_id
+    @render_safely
+    def render(self):
+        comp = MarkdownComponent(self._text)
+        comp.component_id = self.component_id
+        return comp.render()
+
+
+class ProgressBar(UserComponent):
+    """
+    A Progress bar for tracking progress of any task.
+
+    Example:
+    ```
+    progress_bar = ProgressBar(
+        max=100,
+        label="Progress Bar",
+        value=0,
+        unit="%",
+        metadata="0.1 items/s"
+    )
+    current.card.append(
+        progress_bar
+    )
+    for i in range(100):
+        progress_bar.update(i, metadata="%s items/s" % i)
+
+    ```
+
+    Parameters
+    ----------
+    text : str
+        Text formatted in Markdown.
+    """
+
+    type = "progressBar"
+
+    REALTIME_UPDATABLE = True
+
+    def __init__(
+        self,
+        max: int = 100,
+        label: str = None,
+        value: int = 0,
+        unit: str = None,
+        metadata: str = None,
+    ):
+        self._label = label
+        self._max = max
+        self._value = value
+        self._unit = unit
+        self._metadata = metadata
+
+    def update(self, new_value: int, metadata: str = None):
+        self._value = new_value
+        if metadata is not None:
+            self._metadata = metadata
+
+    @with_default_component_id
+    @render_safely
+    def render(self):
+        data = {
+            "type": self.type,
+            "id": self.component_id,
+            "max": self._max,
+            "value": self._value,
+        }
+        if self._label:
+            data["label"] = self._label
+        if self._unit:
+            data["unit"] = self._unit
+        if self._metadata:
+            data["details"] = self._metadata
+        return data
+
+
+class VegaChart(UserComponent):
+    type = "vegaChart"
+
+    REALTIME_UPDATABLE = True
+
+    def __init__(self, spec: dict, show_controls=False):
+        self._spec = spec
+        self._show_controls = show_controls
+        self._chart_inside_table = False
+
+    def update(self, spec=None):
+        if spec is not None:
+            self._spec = spec
+
+    @classmethod
+    def from_altair_chart(cls, altair_chart):
+        from metaflow.plugins.cards.card_modules.convert_to_native_type import (
+            _full_classname,
+        )
+
+        # This will feel slightly hacky but I am unable to find a natural way of determining the class
+        # name of the Altair chart. The only way I can think of is to use the full class name and then
+        # match with heuristics
+
+        fulclsname = _full_classname(altair_chart)
+        if not all([x in fulclsname for x in ["altair", "vegalite", "Chart"]]):
+            raise ValueError(fulclsname + " is not an altair chart")
+
+        altair_chart_dict = altair_chart.to_dict()
+
+        cht = cls(spec=altair_chart_dict)
+        return cht
+
+    @with_default_component_id
     @render_safely
     def render(self):
-        return MarkdownComponent(self._text).render()
+        data = {
+            "type": self.type,
+            "id": self.component_id,
+            "spec": self._spec,
+        }
+        if not self._show_controls:
+            data["options"] = {"actions": False}
+        if "width" not in self._spec and not self._chart_inside_table:
+            data["spec"]["width"] = "container"
+        if self._chart_inside_table and "autosize" not in self._spec:
+            data["spec"]["autosize"] = "fit-x"
+        return data