ob-metaflow-stubs 2.11.4.1__py2.py3-none-any.whl

metaflow-stubs/plugins/cards/card_modules/components.pyi

@@ -0,0 +1,251 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.949578                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import typing
+    import metaflow.plugins.cards.card_modules.basic
+    import metaflow.plugins.cards.card_modules.card
+    import metaflow.plugins.cards.card_modules.components
+
+class LogComponent(metaflow.plugins.cards.card_modules.basic.DefaultComponent, metaclass=type):
+    def __init__(self, data = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class ErrorComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def __init__(self, headline, error_message):
+        ...
+    def render(self):
+        ...
+    ...
+
+class ArtifactsComponent(metaflow.plugins.cards.card_modules.basic.DefaultComponent, metaclass=type):
+    def __init__(self, title = None, subtitle = None, data = {}):
+        ...
+    def render(self):
+        ...
+    ...
+
+class TableComponent(metaflow.plugins.cards.card_modules.basic.DefaultComponent, metaclass=type):
+    def __init__(self, title = None, subtitle = None, headers = [], data = [[]], vertical = False):
+        ...
+    @classmethod
+    def validate(cls, headers, data):
+        ...
+    def render(self):
+        ...
+    ...
+
+class ImageComponent(metaflow.plugins.cards.card_modules.basic.DefaultComponent, metaclass=type):
+    def __init__(self, src = None, label = None, title = None, subtitle = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class SectionComponent(metaflow.plugins.cards.card_modules.basic.DefaultComponent, metaclass=type):
+    def __init__(self, title = None, subtitle = None, columns = None, contents = []):
+        ...
+    @classmethod
+    def render_subcomponents(cls, component_array, additional_allowed_types = [str, dict], allow_unknowns = False):
+        ...
+    def render(self):
+        ...
+    ...
+
+class MarkdownComponent(metaflow.plugins.cards.card_modules.basic.DefaultComponent, metaclass=type):
+    def __init__(self, text = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class MetaflowCardComponent(object, metaclass=type):
+    @property
+    def component_id(self):
+        ...
+    @component_id.setter
+    def component_id(self, value):
+        ...
+    def update(self, *args, **kwargs):
+        """
+        #FIXME document
+        """
+        ...
+    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`
+        """
+        ...
+    ...
+
+class TaskToDict(object, metaclass=type):
+    def __init__(self, only_repr = False, runtime = False):
+        ...
+    def __call__(self, task, graph = None):
+        ...
+    def object_type(self, object):
+        ...
+    def parse_image(self, data_object):
+        ...
+    def infer_object(self, artifact_object):
+        ...
+    ...
+
+def render_safely(func):
+    """
+    This is a decorator that can be added to any `MetaflowCardComponent.render`
+    The goal is to render subcomponents safely and ensure that they are JSON serializable.
+    """
+    ...
+
+def create_component_id(component):
+    ...
+
+def with_default_component_id(func):
+    ...
+
+class UserComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def update(self, *args, **kwargs):
+        ...
+    ...
+
+class StubComponent(UserComponent, metaclass=type):
+    def __init__(self, component_id):
+        ...
+    def update(self, *args, **kwargs):
+        ...
+    ...
+
+class Artifact(UserComponent, metaclass=type):
+    def update(self, artifact):
+        ...
+    def __init__(self, artifact: typing.Any, name: typing.Optional[str] = None, compressed: bool = True):
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    ...
+
+class Table(UserComponent, metaclass=type):
+    def update(self, *args, **kwargs):
+        ...
+    def __init__(self, data: typing.Optional[typing.List[typing.List[typing.Union[str, metaflow.plugins.cards.card_modules.card.MetaflowCardComponent]]]] = None, headers: typing.Optional[typing.List[str]] = None, disable_updates: bool = False):
+        ...
+    @classmethod
+    def from_dataframe(cls, dataframe = None, truncate: bool = True):
+        """
+        Create a `Table` based on a Pandas dataframe.
+        
+        Parameters
+        ----------
+        dataframe : Optional[pandas.DataFrame]
+            Pandas dataframe.
+        truncate : bool, default: True
+            Truncate large dataframe instead of showing all rows (default: True).
+        """
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    ...
+
+class Image(UserComponent, metaclass=type):
+    @staticmethod
+    def render_fail_headline(msg):
+        ...
+    def __init__(self, src = None, label = None, disable_updates: bool = True):
+        ...
+    @classmethod
+    def from_pil_image(cls, pilimage, label: typing.Optional[str] = None, disable_updates: bool = False):
+        """
+        Create an `Image` from a PIL image.
+        
+        Parameters
+        ----------
+        pilimage : PIL.Image
+            a PIL image object.
+        label : str, optional
+            Optional label for the image.
+        """
+        ...
+    @classmethod
+    def from_matplotlib(cls, plot, label: typing.Optional[str] = None, disable_updates: bool = False):
+        """
+        Create an `Image` from a Matplotlib plot.
+        
+        Parameters
+        ----------
+        plot :  matplotlib.figure.Figure or matplotlib.axes.Axes or matplotlib.axes._subplots.AxesSubplot
+            a PIL axes (plot) object.
+        label : str, optional
+            Optional label for the image.
+        """
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    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.
+        """
+        ...
+    ...
+
+class Error(UserComponent, metaclass=type):
+    def __init__(self, exception, title = None):
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    ...
+
+class Markdown(UserComponent, metaclass=type):
+    def update(self, text = None):
+        ...
+    def __init__(self, text = None):
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    ...
+
+class ProgressBar(UserComponent, metaclass=type):
+    def __init__(self, max: int = 100, label: str = None, value: int = 0, unit: str = None, metadata: str = None):
+        ...
+    def update(self, new_value: int, metadata: str = None):
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    ...
+
+class VegaChart(UserComponent, metaclass=type):
+    def __init__(self, spec: dict, show_controls: bool = False):
+        ...
+    def update(self, spec = None):
+        """
+        Update the chart.
+        
+        Parameters
+        ----------
+        spec : dict or altair.Chart
+            The updated chart spec or an altair Chart Object.
+        """
+        ...
+    @classmethod
+    def from_altair_chart(cls, altair_chart):
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    ...
+

metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi

@@ -0,0 +1,45 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.996202                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+class TypeResolvedObject(tuple, metaclass=type):
+    @staticmethod
+    def __new__(_cls, data, is_image, is_table):
+        """
+        Create new instance of TypeResolvedObject(data, is_image, is_table)
+        """
+        ...
+    def __repr__(self):
+        """
+        Return a nicely formatted representation string
+        """
+        ...
+    def __getnewargs__(self):
+        """
+        Return self as a plain tuple.  Used by copy and pickle.
+        """
+        ...
+    ...
+
+TIME_FORMAT: str
+
+MAX_ARTIFACT_SIZE: int
+
+class TaskToDict(object, metaclass=type):
+    def __init__(self, only_repr = False, runtime = False):
+        ...
+    def __call__(self, task, graph = None):
+        ...
+    def object_type(self, object):
+        ...
+    def parse_image(self, data_object):
+        ...
+    def infer_object(self, artifact_object):
+        ...
+    ...
+

metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi

@@ -0,0 +1,24 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.996432                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.cards.card_modules.basic
+
+class SerializationErrorComponent(metaflow.plugins.cards.card_modules.basic.ErrorComponent, metaclass=type):
+    def __init__(self, component_name, error_message):
+        ...
+    ...
+
+def render_safely(func):
+    """
+    This is a decorator that can be added to any `MetaflowCardComponent.render`
+    The goal is to render subcomponents safely and ensure that they are JSON serializable.
+    """
+    ...
+

metaflow-stubs/plugins/cards/card_modules/test_cards.pyi

@@ -0,0 +1,155 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.939715                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow
+    import metaflow.plugins.cards.card_modules.card
+
+class MetaflowCard(object, metaclass=type):
+    def __init__(self, options = {}, components = [], graph = None):
+        ...
+    def render(self, task: "metaflow.Task") -> str:
+        """
+        Produce custom card contents in HTML.
+        
+        Subclasses override this method to customize the card contents.
+        
+        Parameters
+        ----------
+        task : Task
+            A `Task` object that allows you to access data from the finished task and tasks
+            preceding it.
+        
+        Returns
+        -------
+        str
+            Card contents as an HTML string.
+        """
+        ...
+    def render_runtime(self, task, data):
+        ...
+    def refresh(self, task, data):
+        ...
+    def reload_content_token(self, task, data):
+        ...
+    ...
+
+class MetaflowCardComponent(object, metaclass=type):
+    @property
+    def component_id(self):
+        ...
+    @component_id.setter
+    def component_id(self, value):
+        ...
+    def update(self, *args, **kwargs):
+        """
+        #FIXME document
+        """
+        ...
+    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`
+        """
+        ...
+    ...
+
+def render_safely(func):
+    """
+    This is a decorator that can be added to any `MetaflowCardComponent.render`
+    The goal is to render subcomponents safely and ensure that they are JSON serializable.
+    """
+    ...
+
+class TestStringComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def __init__(self, text):
+        ...
+    def render(self):
+        ...
+    def update(self, text):
+        ...
+    ...
+
+class TestPathSpecCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def render(self, task):
+        ...
+    ...
+
+class TestEditableCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def __init__(self, options = {}, components = [], graph = None):
+        ...
+    def render(self, task):
+        ...
+    ...
+
+class TestEditableCard2(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def __init__(self, options = {}, components = [], graph = None):
+        ...
+    def render(self, task):
+        ...
+    ...
+
+class TestNonEditableCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def __init__(self, options = {}, components = [], graph = None):
+        ...
+    def render(self, task):
+        ...
+    ...
+
+class TestMockCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def __init__(self, options = {"key": "dummy_key"}, **kwargs):
+        ...
+    def render(self, task):
+        ...
+    ...
+
+class TestErrorCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def render(self, task):
+        ...
+    ...
+
+class TestTimeoutCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def __init__(self, options = {"timeout": 50}, **kwargs):
+        ...
+    def render(self, task):
+        ...
+    ...
+
+REFRESHABLE_HTML_TEMPLATE: str
+
+class TestJSONComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def __init__(self, data):
+        ...
+    def render(self, *args, **kwargs):
+        ...
+    def update(self, data):
+        ...
+    ...
+
+class TestRefreshCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def render(self, task) -> str:
+        ...
+    def render_runtime(self, task, data):
+        ...
+    def refresh(self, task, data):
+        ...
+    ...
+
+class TestRefreshComponentCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def __init__(self, options = {}, components = [], graph = None):
+        ...
+    def render(self, task) -> str:
+        ...
+    def render_runtime(self, task, data):
+        ...
+    def refresh(self, task, data):
+        ...
+    def reload_content_token(self, task, data):
+        ...
+    ...
+

metaflow-stubs/plugins/cards/card_resolver.pyi

@@ -0,0 +1,60 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.978312                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+class CardDatastore(object, metaclass=type):
+    @classmethod
+    def get_storage_root(cls, storage_type):
+        ...
+    def __init__(self, flow_datastore, pathspec = None):
+        ...
+    @classmethod
+    def get_card_location(cls, base_path, card_name, uuid, card_id = None, suffix = "html"):
+        ...
+    @staticmethod
+    def info_from_path(path, suffix = "html"):
+        """
+        Args:
+            path (str): The path to the card
+        
+        Raises:
+            Exception: When the card_path is invalid
+        
+        Returns:
+            CardInfo
+        """
+        ...
+    def save_data(self, uuid, card_type, json_data, card_id = None):
+        ...
+    def save_card(self, uuid, card_type, card_html, card_id = None, overwrite = True):
+        ...
+    def create_full_path(self, card_path):
+        ...
+    def get_card_names(self, card_paths):
+        ...
+    def get_card_html(self, path):
+        ...
+    def get_card_data(self, path):
+        ...
+    def cache_locally(self, path, save_path = None):
+        """
+        Saves the data present in the `path` the `metaflow_card_cache` directory or to the `save_path`.
+        """
+        ...
+    def extract_data_paths(self, card_type = None, card_hash = None, card_id = None):
+        ...
+    def extract_card_paths(self, card_type = None, card_hash = None, card_id = None):
+        ...
+    ...
+
+def resumed_info(task):
+    ...
+
+def resolve_paths_from_task(flow_datastore, pathspec = None, type = None, hash = None, card_id = None):
+    ...
+