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

metaflow-stubs/plugins/cards/card_client.pyi

@@ -0,0 +1,178 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.946200                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow
+    import metaflow.plugins.cards.card_client
+    import metaflow.exception
+
+TYPE_CHECKING: bool
+
+CARD_SUFFIX: str
+
+def resolve_paths_from_task(flow_datastore, pathspec = None, type = None, hash = None, card_id = None):
+    ...
+
+def resumed_info(task):
+    ...
+
+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):
+        ...
+    ...
+
+class CardNameSuffix(object, metaclass=type):
+    ...
+
+class UnresolvableDatastoreException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, task):
+        ...
+    ...
+
+class IncorrectArgumentException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, obj_type):
+        ...
+    ...
+
+class IncorrectPathspecException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, pthspec):
+        ...
+    ...
+
+class Card(object, metaclass=type):
+    def __init__(self, card_ds, type, path, hash, id = None, html = None, created_on = None, from_resumed = False, origin_pathspec = None):
+        ...
+    def get_data(self) -> typing.Optional[dict]:
+        ...
+    def get(self) -> str:
+        """
+        Retrieves the HTML contents of the card from the
+        Metaflow datastore.
+        
+        Returns
+        -------
+        str
+            HTML contents of the card.
+        """
+        ...
+    @property
+    def path(self) -> str:
+        """
+        The path of the card in the datastore which uniquely
+        identifies the card.
+        
+        Returns
+        -------
+        str
+            Path to the card
+        """
+        ...
+    @property
+    def id(self) -> typing.Optional[str]:
+        """
+        The ID of the card, if specified with `@card(id=ID)`.
+        
+        Returns
+        -------
+        Optional[str]
+            ID of the card
+        """
+        ...
+    def __str__(self):
+        ...
+    def view(self):
+        """
+        Opens the card in a local web browser.
+        
+        This call uses Python's built-in [`webbrowser`](https://docs.python.org/3/library/webbrowser.html)
+        module to open the card.
+        """
+        ...
+    ...
+
+class CardContainer(object, metaclass=type):
+    def __init__(self, card_paths, card_ds, origin_pathspec = None):
+        ...
+    def __len__(self):
+        ...
+    def __iter__(self):
+        ...
+    def __getitem__(self, index):
+        ...
+    ...
+
+def get_cards(task: typing.Union[str, "metaflow.Task"], id: typing.Optional[str] = None, type: typing.Optional[str] = None, follow_resumed: bool = True) -> CardContainer:
+    """
+    Get cards related to a `Task`.
+    
+    Note that `get_cards` resolves the cards contained by the task, but it doesn't actually
+    retrieve them from the datastore. Actual card contents are retrieved lazily either when
+    the card is rendered in a notebook to when you call `Card.get`. This means that
+    `get_cards` is a fast call even when individual cards contain a lot of data.
+    
+    Parameters
+    ----------
+    task : Union[str, `Task`]
+        A `Task` object or pathspec `{flow_name}/{run_id}/{step_name}/{task_id}` that
+        uniquely identifies a task.
+    id : str, optional, default None
+        The ID of card to retrieve if multiple cards are present.
+    type : str, optional, default None
+        The type of card to retrieve if multiple cards are present.
+    follow_resumed : bool, default True
+        If the task has been resumed, then setting this flag will resolve the card for
+        the origin task.
+    
+    Returns
+    -------
+    CardContainer
+        A list-like object that holds `Card` objects.
+    """
+    ...
+

metaflow-stubs/plugins/cards/card_creator.pyi

@@ -0,0 +1,26 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.975441                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
+
+current: metaflow.metaflow_current.Current
+
+ASYNC_TIMEOUT: int
+
+class CardProcessManager(object, metaclass=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):
+        ...
+    ...
+

metaflow-stubs/plugins/cards/card_datastore.pyi

@@ -0,0 +1,111 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.977592                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.exception
+
+CARD_S3ROOT: None
+
+CARD_LOCALROOT: None
+
+DATASTORE_LOCAL_DIR: str
+
+CARD_SUFFIX: str
+
+CARD_AZUREROOT: None
+
+CARD_GSROOT: None
+
+SKIP_CARD_DUALWRITE: bool
+
+class CardNotPresentException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, pathspec, card_type = None, card_hash = None, card_id = None):
+        ...
+    ...
+
+TEMP_DIR_NAME: str
+
+NUM_SHORT_HASH_CHARS: int
+
+class CardInfo(tuple, metaclass=type):
+    @staticmethod
+    def __new__(_cls, type, hash, id, filename):
+        """
+        Create new instance of CardInfo(type, hash, id, filename)
+        """
+        ...
+    def __repr__(self):
+        """
+        Return a nicely formatted representation string
+        """
+        ...
+    def __getnewargs__(self):
+        """
+        Return self as a plain tuple.  Used by copy and pickle.
+        """
+        ...
+    ...
+
+class CardNameSuffix(object, metaclass=type):
+    ...
+
+class CardPathSuffix(object, metaclass=type):
+    ...
+
+def path_spec_resolver(pathspec):
+    ...
+
+def is_file_present(path):
+    ...
+
+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):
+        ...
+    ...
+

metaflow-stubs/plugins/cards/card_decorator.pyi

@@ -0,0 +1,133 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.976477                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
+    import metaflow.decorators
+
+current: metaflow.metaflow_current.Current
+
+class CardComponentCollector(object, metaclass=type):
+    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):
+        ...
+    ...
+
+TYPE_CHECK_REGEX: str
+
+ASYNC_TIMEOUT: int
+
+def warning_message(message, logger = None, ts = False):
+    ...
+
+class CardDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    def __init__(self, *args, **kwargs):
+        ...
+    def step_init(self, flow, graph, step_name, decorators, environment, flow_datastore, logger):
+        ...
+    def task_pre_step(self, step_name, task_datastore, metadata, run_id, task_id, flow, graph, retry_count, max_user_code_retries, ubf_context, inputs):
+        ...
+    def task_finished(self, step_name, flow, graph, is_task_ok, retry_count, max_user_code_retries):
+        ...
+    ...
+

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

@@ -0,0 +1,67 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.972275                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow
+
+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`
+        """
+        ...
+    ...
+
+EXT_PKG: str
+
+def iter_namespace(ns_pkg):
+    ...
+
+MF_EXTERNAL_CARDS: list
+