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

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

@@ -0,0 +1,263 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.937993                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow
+    import metaflow.plugins.cards.card_modules.basic
+    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`
+        """
+        ...
+    ...
+
+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):
+        ...
+    ...
+
+ABS_DIR_PATH: str
+
+RENDER_TEMPLATE_PATH: str
+
+JS_PATH: str
+
+CSS_PATH: str
+
+def transform_flow_graph(step_info):
+    ...
+
+def read_file(path):
+    ...
+
+class DefaultComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def __init__(self, title = None, subtitle = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class TitleComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def __init__(self, text = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class SubTitleComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def __init__(self, text = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class SectionComponent(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 ImageComponent(DefaultComponent, metaclass=type):
+    def __init__(self, src = None, label = None, title = None, subtitle = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class TableComponent(DefaultComponent, metaclass=type):
+    def __init__(self, title = None, subtitle = None, headers = [], data = [[]], vertical = False):
+        ...
+    @classmethod
+    def validate(cls, headers, data):
+        ...
+    def render(self):
+        ...
+    ...
+
+class DagComponent(DefaultComponent, metaclass=type):
+    def __init__(self, title = None, subtitle = None, data = {}):
+        ...
+    def render(self):
+        ...
+    ...
+
+class TextComponent(DefaultComponent, metaclass=type):
+    def __init__(self, text = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class LogComponent(DefaultComponent, metaclass=type):
+    def __init__(self, data = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class HTMLComponent(DefaultComponent, metaclass=type):
+    def __init__(self, data = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class PageComponent(DefaultComponent, metaclass=type):
+    def __init__(self, title = None, subtitle = None, contents = []):
+        ...
+    def render(self):
+        ...
+    ...
+
+class ErrorComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def __init__(self, headline, error_message):
+        ...
+    def render(self):
+        ...
+    ...
+
+class SerializationErrorComponent(ErrorComponent, metaclass=type):
+    def __init__(self, component_name, error_message):
+        ...
+    ...
+
+class ArtifactsComponent(DefaultComponent, metaclass=type):
+    def __init__(self, title = None, subtitle = None, data = {}):
+        ...
+    def render(self):
+        ...
+    ...
+
+class MarkdownComponent(DefaultComponent, metaclass=type):
+    def __init__(self, text = None):
+        ...
+    def render(self):
+        ...
+    ...
+
+class TaskInfoComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def __init__(self, task, page_title = "Task Info", only_repr = True, graph = None, components = [], runtime = False):
+        ...
+    def render(self):
+        """
+        Returns:
+            a dictionary of form:
+                dict(metadata = {},components= [])
+        """
+        ...
+    ...
+
+class ErrorCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def __init__(self, options = {}, components = [], graph = None):
+        ...
+    def render(self, task, stack_trace = None):
+        ...
+    ...
+
+class DefaultCardJSON(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    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 render(self, task, runtime = False):
+        ...
+    def render_runtime(self, task, data):
+        ...
+    def refresh(self, task, data):
+        ...
+    def reload_content_token(self, task, data):
+        """
+        The reload token will change when the component array has changed in the Metaflow card.
+        The change in the component array is signified by the change in the component_update_ts.
+        """
+        ...
+    ...
+
+class BlankCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def __init__(self, options = {"title": ""}, components = [], graph = None):
+        ...
+    def render(self, task, components = [], runtime = False):
+        ...
+    def render_runtime(self, task, data):
+        ...
+    def refresh(self, task, data):
+        ...
+    def reload_content_token(self, task, data):
+        """
+        The reload token will change when the component array has changed in the Metaflow card.
+        The change in the component array is signified by the change in the component_update_ts.
+        """
+        ...
+    ...
+
+class TaskSpecCard(metaflow.plugins.cards.card_modules.card.MetaflowCard, metaclass=type):
+    def render(self, task):
+        ...
+    ...
+

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

@@ -0,0 +1,62 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.946774                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow
+
+TYPE_CHECKING: bool
+
+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`
+        """
+        ...
+    ...
+

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

@@ -0,0 +1,78 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.011975                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+def main(template, data = None, **kwargs):
+    ...
+
+def cli_main():
+    """
+    Render mustache templates using json files
+    """
+    ...
+
+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.
+    
+    Renders a mustache template with a data scope and partial capability.
+    Given the file structure...
+    ╷
+    ├─╼ main.py
+    ├─╼ main.ms
+    └─┮ partials
+      └── part.ms
+    
+    then main.py would make the following call:
+    
+    render(open('main.ms', 'r'), {...}, 'partials', 'ms')
+    
+    
+    Arguments:
+    
+    template      -- A file-like object or a string containing the template
+    
+    data          -- A python dictionary with your data scope
+    
+    partials_path -- The path to where your partials are stored
+                     If set to None, then partials won't be loaded from the file system
+                     (defaults to '.')
+    
+    partials_ext  -- The extension that you want the parser to look for
+                     (defaults to 'mustache')
+    
+    partials_dict -- A python dictionary which will be search for partials
+                     before the filesystem is. {'include': 'foo'} is the same
+                     as a file called include.mustache
+                     (defaults to {})
+    
+    padding       -- This is for padding partials, and shouldn't be used
+                     (but can be if you really want to)
+    
+    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)
+    
+    scopes        -- The list of scopes that get_key will look through
+    
+    warn          -- Issue a warning to stderr when a template substitution isn't found in the data
+    
+    keep          -- Keep unreplaced tags when a template substitution isn't found in the data
+    
+    
+    Returns:
+    
+    A string containing the rendered template.
+    """
+    ...
+
+class ChevronError(SyntaxError, metaclass=type):
+    ...
+

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

@@ -0,0 +1,77 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.015794                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+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.
+    
+    Renders a mustache template with a data scope and partial capability.
+    Given the file structure...
+    ╷
+    ├─╼ main.py
+    ├─╼ main.ms
+    └─┮ partials
+      └── part.ms
+    
+    then main.py would make the following call:
+    
+    render(open('main.ms', 'r'), {...}, 'partials', 'ms')
+    
+    
+    Arguments:
+    
+    template      -- A file-like object or a string containing the template
+    
+    data          -- A python dictionary with your data scope
+    
+    partials_path -- The path to where your partials are stored
+                     If set to None, then partials won't be loaded from the file system
+                     (defaults to '.')
+    
+    partials_ext  -- The extension that you want the parser to look for
+                     (defaults to 'mustache')
+    
+    partials_dict -- A python dictionary which will be search for partials
+                     before the filesystem is. {'include': 'foo'} is the same
+                     as a file called include.mustache
+                     (defaults to {})
+    
+    padding       -- This is for padding partials, and shouldn't be used
+                     (but can be if you really want to)
+    
+    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)
+    
+    scopes        -- The list of scopes that get_key will look through
+    
+    warn          -- Issue a warning to stderr when a template substitution isn't found in the data
+    
+    keep          -- Keep unreplaced tags when a template substitution isn't found in the data
+    
+    
+    Returns:
+    
+    A string containing the rendered template.
+    """
+    ...
+
+version: str
+
+def main(template, data = None, **kwargs):
+    ...
+
+def cli_main():
+    """
+    Render mustache templates using json files
+    """
+    ...
+

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

@@ -0,0 +1,11 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.015425                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+version: str
+

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

@@ -0,0 +1,114 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.015309                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+linesep: str
+
+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.
+    """
+    ...
+
+python3: bool
+
+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):
+    """
+    Render a mustache template.
+    
+    Renders a mustache template with a data scope and partial capability.
+    Given the file structure...
+    ╷
+    ├─╼ main.py
+    ├─╼ main.ms
+    └─┮ partials
+      └── part.ms
+    
+    then main.py would make the following call:
+    
+    render(open('main.ms', 'r'), {...}, 'partials', 'ms')
+    
+    
+    Arguments:
+    
+    template      -- A file-like object or a string containing the template
+    
+    data          -- A python dictionary with your data scope
+    
+    partials_path -- The path to where your partials are stored
+                     If set to None, then partials won't be loaded from the file system
+                     (defaults to '.')
+    
+    partials_ext  -- The extension that you want the parser to look for
+                     (defaults to 'mustache')
+    
+    partials_dict -- A python dictionary which will be search for partials
+                     before the filesystem is. {'include': 'foo'} is the same
+                     as a file called include.mustache
+                     (defaults to {})
+    
+    padding       -- This is for padding partials, and shouldn't be used
+                     (but can be if you really want to)
+    
+    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)
+    
+    scopes        -- The list of scopes that get_key will look through
+    
+    warn          -- Issue a warning to stderr when a template substitution isn't found in the data
+    
+    keep          -- Keep unreplaced tags when a template substitution isn't found in the data
+    
+    
+    Returns:
+    
+    A string containing the rendered template.
+    """
+    ...
+

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

@@ -0,0 +1,75 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.014781                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+class ChevronError(SyntaxError, metaclass=type):
+    ...
+
+def grab_literal(template, l_del):
+    """
+    Parse a literal from the template
+    """
+    ...
+
+def l_sa_check(template, literal, is_standalone):
+    """
+    Do a preliminary check to see if a tag could be a standalone
+    """
+    ...
+
+def r_sa_check(template, tag_type, is_standalone):
+    """
+    Do a final checkto see if a tag could be a standalone
+    """
+    ...
+
+def parse_tag(template, l_del, r_del):
+    """
+    Parse a tag from a template
+    """
+    ...
+
+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.
+    """
+    ...
+