metaflow-stubs 2.12.27__py2.py3-none-any.whl → 2.12.29__py2.py3-none-any.whl

metaflow-stubs/plugins/cards/card_modules/chevron/renderer.pyi

@@ -1,52 +1,15 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:18.001290                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.646632                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
-linesep: str
+from .tokenizer import tokenize as tokenize
 
-def tokenize(template, def_ldel = "{{", def_rdel = "}}"):
-    """
-    Tokenize a mustache template
-    
-    Tokenizes a mustache template in a generator fashion,
-    using file-like objects. It also accepts a string containing
-    the template.
-    
-    
-    Arguments:
-    
-    template -- a file-like object, or a string of a mustache template
-    
-    def_ldel -- The default left delimiter
-                ("{{" by default, as in spec compliant mustache)
-    
-    def_rdel -- The default right delimiter
-                ("}}" by default, as in spec compliant mustache)
-    
-    
-    Returns:
-    
-    A generator of mustache tags in the form of a tuple
-    
-    -- (tag_type, tag_key)
-    
-    Where tag_type is one of:
-     * literal
-     * section
-     * inverted section
-     * end
-     * partial
-     * no escape
-    
-    And tag_key is either the key or in the case of a literal tag,
-    the literal itself.
-    """
-    ...
+linesep: str
 
 python3: bool
 
@@ -55,7 +18,7 @@ def unicode(x, y):
 
 g_token_cache: dict
 
-def render(template = "", data = {}, partials_path = ".", partials_ext = "mustache", partials_dict = {}, padding = "", def_ldel = "{{", def_rdel = "}}", scopes = None, warn = False, keep = False):
+def render(template = '', data = {}, partials_path = '.', partials_ext = 'mustache', partials_dict = {}, padding = '', def_ldel = '{{', def_rdel = '}}', scopes = None, warn = False, keep = False):
     """
     Render a mustache template.
     

metaflow-stubs/plugins/cards/card_modules/chevron/tokenizer.pyi

@@ -1,12 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:18.000840                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.646226                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 class ChevronError(SyntaxError, metaclass=type):
     ...
 
@@ -34,7 +35,7 @@ def parse_tag(template, l_del, r_del):
     """
     ...
 
-def tokenize(template, def_ldel = "{{", def_rdel = "}}"):
+def tokenize(template, def_ldel = '{{', def_rdel = '}}'):
     """
     Tokenize a mustache template
     

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

@@ -1,111 +1,28 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.935145                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.598355                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
     import metaflow.plugins.cards.card_modules.card
-    import metaflow.plugins.cards.card_modules.basic
-    import typing
     import metaflow.plugins.cards.card_modules.components
+    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                                                            #
-# Generated on 2024-10-24T19:27:17.985110                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.633226                                                            #
+######################################################################################################
 
 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                                                            #
-# Generated on 2024-10-24T19:27:17.985331                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.633410                                                            #
+######################################################################################################
 
 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):
     """

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

@@ -1,96 +1,19 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.928319                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.593789                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow
     import metaflow.plugins.cards.card_modules.card
 
-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`
-        """
-        ...
-    ...
-
-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 .card import MetaflowCard as MetaflowCard
+from .card import MetaflowCardComponent as MetaflowCardComponent
+from .renderer_tools import render_safely as render_safely
 
 class TestStringComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
     def __init__(self, text):
@@ -128,7 +51,7 @@ class TestNonEditableCard(metaflow.plugins.cards.card_modules.card.MetaflowCard,
     ...
 
 class TestMockCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
-    def __init__(self, options = {"key": "dummy_key"}, **kwargs):
+    def __init__(self, options = {'key': 'dummy_key'}, **kwargs):
         ...
     def render(self, task):
         ...
@@ -140,7 +63,7 @@ class TestErrorCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metac
     ...
 
 class TestTimeoutCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
-    def __init__(self, options = {"timeout": 50}, **kwargs):
+    def __init__(self, options = {'timeout': 50}, **kwargs):
         ...
     def render(self, task):
         ...

metaflow-stubs/plugins/cards/card_resolver.pyi

@@ -1,56 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.947721                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.618259                                                            #
+######################################################################################################
 
 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):
-        ...
-    ...
+from .card_datastore import CardDatastore as CardDatastore
 
 def resumed_info(task):
     ...

metaflow-stubs/plugins/cards/component_serializer.pyi

@@ -1,73 +1,23 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.944992                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.616315                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.cards.card_modules.card
-    import metaflow.exception
     import metaflow.plugins.cards.card_modules.basic
-    import metaflow.plugins.cards.card_modules.components
 
-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 ErrorComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
-    def __init__(self, headline, error_message):
-        ...
-    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 UserComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
-    def update(self, *args, **kwargs):
-        ...
-    ...
-
-def create_component_id(component):
-    ...
-
-class StubComponent(metaflow.plugins.cards.card_modules.components.UserComponent, metaclass=type):
-    def __init__(self, component_id):
-        ...
-    def update(self, *args, **kwargs):
-        ...
-    ...
-
-class ComponentOverwriteNotSupportedException(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, component_id, card_id, card_type):
-        ...
-    ...
+from .card_modules.card import MetaflowCardComponent as MetaflowCardComponent
+from .card_modules.basic import ErrorComponent as ErrorComponent
+from .card_modules.basic import SectionComponent as SectionComponent
+from .card_modules.components import UserComponent as UserComponent
+from .card_modules.components import create_component_id as create_component_id
+from .card_modules.components import StubComponent as StubComponent
+from .exception import ComponentOverwriteNotSupportedException as ComponentOverwriteNotSupportedException
 
 RUNTIME_CARD_RENDER_INTERVAL: int
 

metaflow-stubs/plugins/cards/exception.pyi

@@ -1,21 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.943282                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.614796                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
 
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ...exception import MetaflowException as MetaflowException
 
 TYPE_CHECK_REGEX: str
 

metaflow-stubs/plugins/catch_decorator.pyi

@@ -1,40 +1,20 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.922195                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.585583                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
-    import metaflow.metaflow_current
     import metaflow.decorators
 
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
-
-class MetaflowExceptionWrapper(Exception, metaclass=type):
-    def __init__(self, exc = None):
-        ...
-    def __reduce__(self):
-        ...
-    def __getstate__(self):
-        ...
-    def __setstate__(self, state):
-        ...
-    def __repr__(self):
-        ...
-    def __str__(self):
-        ...
-    ...
-
-current: metaflow.metaflow_current.Current
+from ..exception import MetaflowException as MetaflowException
+from ..exception import MetaflowExceptionWrapper as MetaflowExceptionWrapper
+from ..metaflow_current import current as current
 
 NUM_FALLBACK_RETRIES: int