ob-metaflow-stubs 6.0.3.117__py2.py3-none-any.whl → 6.0.3.118__py2.py3-none-any.whl

metaflow-stubs/plugins/cards/card_datastore.pyi

@@ -1,14 +1,14 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.396367                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.872732                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.exception
+
+from ... import metaflow_config as metaflow_config
+from .exception import CardNotPresentException as CardNotPresentException
 
 CARD_S3ROOT: None
 
@@ -24,14 +24,6 @@ CARD_GSROOT: None
 
 SKIP_CARD_DUALWRITE: bool
 
-class CardNotPresentException(metaflow.exception.MetaflowException, metaclass=type):
-    """
-    This exception is raised with a card is not present in the datastore.
-    """
-    def __init__(self, pathspec, card_type = None, card_hash = None, card_id = None):
-        ...
-    ...
-
 TEMP_DIR_NAME: str
 
 NUM_SHORT_HASH_CHARS: int
@@ -77,10 +69,10 @@ class CardDatastore(object, metaclass=type):
     def __init__(self, flow_datastore, pathspec = None):
         ...
     @classmethod
-    def get_card_location(cls, base_path, card_name, uuid, card_id = None, suffix = "html"):
+    def get_card_location(cls, base_path, card_name, uuid, card_id = None, suffix = 'html'):
         ...
     @staticmethod
-    def info_from_path(path, suffix = "html"):
+    def info_from_path(path, suffix = 'html'):
         """
         Args:
             path (str): The path to the card

metaflow-stubs/plugins/cards/card_decorator.pyi

@@ -1,136 +1,20 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.403991                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.882882                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.decorators
-    import metaflow.metaflow_current
 
-current: metaflow.metaflow_current.Current
-
-class CardComponentCollector(object, metaclass=type):
-    """
-    This class helps collect `MetaflowCardComponent`s during runtime execution
-    
-    ### Usage with `current`
-    `current.card` is of type `CardComponentCollector`
-    
-    ### Main Usage TLDR
-    - [x] `current.card.append` customizes the default editable card.
-    - [x] Only one card can be default editable in a step.
-    - [x] The card class must have `ALLOW_USER_COMPONENTS=True` to be considered default editable.
-        - [x] Classes with `ALLOW_USER_COMPONENTS=False` are never default editable.
-    - [x] The user can specify an `id` argument to a card, in which case the card is editable through `current.card[id].append`.
-        - [x] A card with an id can be also default editable, if there are no other cards that are eligible to be default editable.
-    - [x] If multiple default-editable cards exist but only one card doesn't have an id, the card without an id is considered to be default editable.
-    - [x] If we can't resolve a single default editable card through the above rules, `current.card`.append calls show a warning but the call doesn't fail.
-    - [x] A card that is not default editable can be still edited through:
-        - [x] its `current.card['myid']`
-        - [x] by looking it up by its type, e.g. `current.card.get(type='pytorch')`.
-    """
-    def __init__(self, logger = None, card_creator = None):
-        ...
-    @staticmethod
-    def create_uuid():
-        ...
-    def get(self, type = None):
-        """
-        `get`
-        gets all the components arrays for a card `type`.
-        Since one `@step` can have many `@card` decorators, many decorators can have the same type. That is why this function returns a list of lists.
-        
-        Args:
-            type ([str], optional): `type` of MetaflowCard. Defaults to None.
-        
-        Returns: will return empty `list` if `type` is None or not found
-            List[List[MetaflowCardComponent]]
-        """
-        ...
-    def __getitem__(self, key):
-        """
-        Choose a specific card for manipulation.
-        
-        When multiple @card decorators are present, you can add an
-        `ID` to distinguish between them, `@card(id=ID)`. This allows you
-        to add components to a specific card like this:
-        ```
-        current.card[ID].append(component)
-        ```
-        
-        Parameters
-        ----------
-        key : str
-            Card ID.
-        
-        Returns
-        -------
-        CardComponentManager
-            An object with `append` and `extend` calls which allow you to
-            add components to the chosen card.
-        """
-        ...
-    def __setitem__(self, key, value):
-        """
-        Specify components of the chosen card.
-        
-        Instead of adding components to a card individually with `current.card[ID].append(component)`,
-        use this method to assign a list of components to a card, replacing the existing components:
-        ```
-        current.card[ID] = [FirstComponent, SecondComponent]
-        ```
-        
-        Parameters
-        ----------
-        key: str
-            Card ID.
-        
-        value: List[MetaflowCardComponent]
-            List of card components to assign to this card.
-        """
-        ...
-    def append(self, component, id = None):
-        """
-        Appends a component to the current card.
-        
-        Parameters
-        ----------
-        component : MetaflowCardComponent
-            Card component to add to this card.
-        """
-        ...
-    def extend(self, components):
-        """
-        Appends many components to the current card.
-        
-        Parameters
-        ----------
-        component : Iterator[MetaflowCardComponent]
-            Card components to add to this card.
-        """
-        ...
-    @property
-    def components(self):
-        ...
-    def clear(self):
-        ...
-    def refresh(self, *args, **kwargs):
-        ...
-    ...
-
-def get_card_class(card_type):
-    ...
-
-class CardCreator(object, metaclass=type):
-    def __init__(self, top_level_options):
-        ...
-    def create(self, card_uuid = None, user_set_card_id = None, runtime_card = False, decorator_attributes = None, card_options = None, logger = None, mode = "render", final = False, sync = False):
-        ...
-    ...
+from ...metaflow_current import current as current
+from .component_serializer import CardComponentCollector as CardComponentCollector
+from .component_serializer import get_card_class as get_card_class
+from .card_creator import CardCreator as CardCreator
 
 TYPE_CHECK_REGEX: str
 

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

@@ -1,88 +1,20 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.401623                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.880985                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow
 
-class MetaflowCard(object, metaclass=type):
-    """
-    Metaflow cards derive from this base class.
-    
-    Subclasses of this class are called *card types*. The desired card
-    type `T` is defined in the `@card` decorator as `@card(type=T)`.
-    
-    After a task with `@card(type=T, options=S)` finishes executing, Metaflow instantiates
-    a subclass `C` of `MetaflowCard` that has its `type` attribute set to `T`, i.e. `C.type=T`.
-    The constructor is given the options dictionary `S` that contains arbitrary
-    JSON-encodable data that is passed to the instance, parametrizing the card. The subclass
-    may override the constructor to capture and process the options.
-    
-    The subclass needs to implement a `render(task)` method that produces the card
-    contents in HTML, given the finished task that is represented by a `Task` object.
-    
-    Attributes
-    ----------
-    type : str
-        Card type string. Note that this should be a globally unique name, similar to a
-        Python package name, to avoid name clashes between different custom cards.
-    
-    Parameters
-    ----------
-    options : Dict
-        JSON-encodable dictionary containing user-definable options for the class.
-    """
-    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`
-        """
-        ...
-    ...
+from . import card as card
+from .card import MetaflowCard as MetaflowCard
+from .card import MetaflowCardComponent as MetaflowCardComponent
+from . import convert_to_native_type as convert_to_native_type
+from . import basic as basic
+from . import renderer_tools as renderer_tools
+from . import components as components
+from . import test_cards as test_cards
 
 EXT_PKG: str
 

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

@@ -1,103 +1,20 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.376889                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.856767                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.plugins.cards.card_modules.card
     import metaflow.plugins.cards.card_modules.basic
-    import metaflow
 
-class MetaflowCard(object, metaclass=type):
-    """
-    Metaflow cards derive from this base class.
-    
-    Subclasses of this class are called *card types*. The desired card
-    type `T` is defined in the `@card` decorator as `@card(type=T)`.
-    
-    After a task with `@card(type=T, options=S)` finishes executing, Metaflow instantiates
-    a subclass `C` of `MetaflowCard` that has its `type` attribute set to `T`, i.e. `C.type=T`.
-    The constructor is given the options dictionary `S` that contains arbitrary
-    JSON-encodable data that is passed to the instance, parametrizing the card. The subclass
-    may override the constructor to capture and process the options.
-    
-    The subclass needs to implement a `render(task)` method that produces the card
-    contents in HTML, given the finished task that is represented by a `Task` object.
-    
-    Attributes
-    ----------
-    type : str
-        Card type string. Note that this should be a globally unique name, similar to a
-        Python package name, to avoid name clashes between different custom cards.
-    
-    Parameters
-    ----------
-    options : Dict
-        JSON-encodable dictionary containing user-definable options for the class.
-    """
-    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`
-        """
-        ...
-    ...
-
-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):
-        ...
-    ...
+from .card import MetaflowCard as MetaflowCard
+from .card import MetaflowCardComponent as MetaflowCardComponent
+from .convert_to_native_type import TaskToDict as TaskToDict
 
 ABS_DIR_PATH: str
 
@@ -236,7 +153,7 @@ class TaskInfoComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardCom
         page_content : a list of MetaflowCardComponents going as task info
         final_component: the dictionary returned by the `render` function of this class.
     """
-    def __init__(self, task, page_title = "Task Info", only_repr = True, graph = None, components = [], runtime = False):
+    def __init__(self, task, page_title = 'Task Info', only_repr = True, graph = None, components = [], runtime = False):
         ...
     def render(self):
         """
@@ -261,14 +178,14 @@ class ErrorCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass
     ...
 
 class DefaultCardJSON(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
-    def __init__(self, options = {"only_repr": True}, components = [], graph = None):
+    def __init__(self, options = {'only_repr': True}, components = [], graph = None):
         ...
     def render(self, task):
         ...
     ...
 
 class DefaultCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
-    def __init__(self, options = {"only_repr": True}, components = [], graph = None):
+    def __init__(self, options = {'only_repr': True}, components = [], graph = None):
         ...
     def render(self, task, runtime = False):
         ...
@@ -285,7 +202,7 @@ class DefaultCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metacla
     ...
 
 class BlankCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
-    def __init__(self, options = {"title": ""}, components = [], graph = None):
+    def __init__(self, options = {'title': ''}, components = [], graph = None):
         ...
     def render(self, task, components = [], runtime = False):
         ...

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

@@ -1,8 +1,8 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.373070                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.853317                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
@@ -10,6 +10,7 @@ import typing
 if typing.TYPE_CHECKING:
     import metaflow
 
+
 TYPE_CHECKING: bool
 
 class MetaflowCard(object, metaclass=type):

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

@@ -1,111 +1,28 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.374954                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.854831                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.cards.card_modules.card
-    import metaflow.plugins.cards.card_modules.basic
     import metaflow.plugins.cards.card_modules.components
+    import metaflow.plugins.cards.card_modules.card
     import typing
 
-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.
-    """
-    ...
+from .basic import LogComponent as LogComponent
+from .basic import ErrorComponent as ErrorComponent
+from .basic import ArtifactsComponent as ArtifactsComponent
+from .basic import TableComponent as TableComponent
+from .basic import ImageComponent as ImageComponent
+from .basic import SectionComponent as SectionComponent
+from .basic import MarkdownComponent as MarkdownComponent
+from .card import MetaflowCardComponent as MetaflowCardComponent
+from .convert_to_native_type import TaskToDict as TaskToDict
+from .renderer_tools import render_safely as render_safely
 
 def create_component_id(component):
     ...
@@ -390,20 +307,20 @@ class ProgressBar(UserComponent, metaclass=type):
     
     Parameters
     ----------
-    max : int
+    max : int, default 100
         The maximum value of the progress bar.
-    label : str, optional
+    label : str, optional, default None
         Optional label for the progress bar.
-    value : int, optional
+    value : int, default 0
         Optional initial value of the progress bar.
-    unit : str, optional
+    unit : str, optional, default None
         Optional unit for the progress bar.
-    metadata : str, optional
+    metadata : str, optional, default None
         Optional additional information to show on the progress bar.
     """
-    def __init__(self, max: int = 100, label: str = None, value: int = 0, unit: str = None, metadata: str = None):
+    def __init__(self, max: int = 100, label: typing.Optional[str] = None, value: int = 0, unit: typing.Optional[str] = None, metadata: typing.Optional[str] = None):
         ...
-    def update(self, new_value: int, metadata: str = None):
+    def update(self, new_value: int, metadata: typing.Optional[str] = None):
         ...
     def render(self, *args, **kwargs):
         ...

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

@@ -1,12 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.397294                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.873635                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 class TypeResolvedObject(tuple, metaclass=type):
     """
     TypeResolvedObject(data, is_image, is_table)

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

@@ -1,19 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.397477                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.873796                                                            #
+######################################################################################################
 
 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):
-        ...
-    ...
+from .basic import SerializationErrorComponent as SerializationErrorComponent
 
 def render_safely(func):
     """