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

metaflow-stubs/plugins/cards/card_cli.pyi

@@ -1,499 +1,30 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.950300                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.619251                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.client.core
-    import typing
-    import datetime
-    import metaflow.parameters
-    import metaflow.exception
 
-class Task(metaflow.client.core.MetaflowObject, metaclass=type):
-    """
-    A `Task` represents an execution of a `Step`.
-    
-    It contains all `DataArtifact` objects produced by the task as
-    well as metadata related to execution.
-    
-    Note that the `@retry` decorator may cause multiple attempts of
-    the task to be present. Usually you want the latest attempt, which
-    is what instantiating a `Task` object returns by default. If
-    you need to e.g. retrieve logs from a failed attempt, you can
-    explicitly get information about a specific attempt by using the
-    following syntax when creating a task:
-    
-    `Task('flow/run/step/task', attempt=<attempt>)`
-    
-    where `attempt=0` corresponds to the first attempt etc.
-    
-    Attributes
-    ----------
-    metadata : List[Metadata]
-        List of all metadata events associated with the task.
-    metadata_dict : Dict[str, str]
-        A condensed version of `metadata`: A dictionary where keys
-        are names of metadata events and values the latest corresponding event.
-    data : MetaflowData
-        Container of all data artifacts produced by this task. Note that this
-        call downloads all data locally, so it can be slower than accessing
-        artifacts individually. See `MetaflowData` for more information.
-    artifacts : MetaflowArtifacts
-        Container of `DataArtifact` objects produced by this task.
-    successful : bool
-        True if the task completed successfully.
-    finished : bool
-        True if the task completed.
-    exception : object
-        Exception raised by this task if there was one.
-    finished_at : datetime
-        Time this task finished.
-    runtime_name : str
-        Runtime this task was executed on.
-    stdout : str
-        Standard output for the task execution.
-    stderr : str
-        Standard error output for the task execution.
-    code : MetaflowCode
-        Code package for this task (if present). See `MetaflowCode`.
-    environment_info : Dict[str, str]
-        Information about the execution environment.
-    """
-    def __init__(self, *args, **kwargs):
-        ...
-    @property
-    def metadata(self) -> typing.List[metaflow.client.core.Metadata]:
-        """
-        Metadata events produced by this task across all attempts of the task
-        *except* if you selected a specific task attempt.
-        
-        Note that Metadata is different from tags.
-        
-        Returns
-        -------
-        List[Metadata]
-            Metadata produced by this task
-        """
-        ...
-    @property
-    def metadata_dict(self) -> typing.Dict[str, str]:
-        """
-        Dictionary mapping metadata names (keys) and their associated values.
-        
-        Note that unlike the metadata() method, this call will only return the latest
-        metadata for a given name. For example, if a task executes multiple times (retries),
-        the same metadata name will be generated multiple times (one for each execution of the
-        task). The metadata() method returns all those metadata elements whereas this call will
-        return the metadata associated with the latest execution of the task.
-        
-        Returns
-        -------
-        Dict[str, str]
-            Dictionary mapping metadata name with value
-        """
-        ...
-    @property
-    def index(self) -> typing.Optional[int]:
-        """
-        Returns the index of the innermost foreach loop if this task is run inside at least
-        one foreach.
-        
-        The index is what distinguishes the various tasks inside a given step.
-        This call returns None if this task was not run in a foreach loop.
-        
-        Returns
-        -------
-        int, optional
-            Index in the innermost loop for this task
-        """
-        ...
-    @property
-    def data(self) -> metaflow.client.core.MetaflowData:
-        """
-        Returns a container of data artifacts produced by this task.
-        
-        You can access data produced by this task as follows:
-        ```
-        print(task.data.my_var)
-        ```
-        
-        Returns
-        -------
-        MetaflowData
-            Container of all artifacts produced by this task
-        """
-        ...
-    @property
-    def artifacts(self) -> typing.NamedTuple:
-        """
-        Returns a container of DataArtifacts produced by this task.
-        
-        You can access each DataArtifact by name like so:
-        ```
-        print(task.artifacts.my_var)
-        ```
-        This method differs from data() because it returns DataArtifact objects
-        (which contain additional metadata) as opposed to just the data.
-        
-        Returns
-        -------
-        MetaflowArtifacts
-            Container of all DataArtifacts produced by this task
-        """
-        ...
-    @property
-    def successful(self) -> bool:
-        """
-        Indicates whether or not the task completed successfully.
-        
-        This information is always about the latest task to have completed (in case
-        of retries).
-        
-        Returns
-        -------
-        bool
-            True if the task completed successfully and False otherwise
-        """
-        ...
-    @property
-    def finished(self) -> bool:
-        """
-        Indicates whether or not the task completed.
-        
-        This information is always about the latest task to have completed (in case
-        of retries).
-        
-        Returns
-        -------
-        bool
-            True if the task completed and False otherwise
-        """
-        ...
-    @property
-    def exception(self) -> typing.Optional[typing.Any]:
-        """
-        Returns the exception that caused the task to fail, if any.
-        
-        This information is always about the latest task to have completed (in case
-        of retries). If successful() returns False and finished() returns True,
-        this method can help determine what went wrong.
-        
-        Returns
-        -------
-        object
-            Exception raised by the task or None if not applicable
-        """
-        ...
-    @property
-    def finished_at(self) -> typing.Optional[datetime.datetime]:
-        """
-        Returns the datetime object of when the task finished (successfully or not).
-        
-        This information is always about the latest task to have completed (in case
-        of retries). This call will return None if the task is not finished.
-        
-        Returns
-        -------
-        datetime
-            Datetime of when the task finished
-        """
-        ...
-    @property
-    def runtime_name(self) -> typing.Optional[str]:
-        """
-        Returns the name of the runtime this task executed on.
-        
-        
-        Returns
-        -------
-        str
-            Name of the runtime this task executed on
-        """
-        ...
-    @property
-    def stdout(self) -> str:
-        """
-        Returns the full standard out of this task.
-        
-        If you specify a specific attempt for this task, it will return the
-        standard out for that attempt. If you do not specify an attempt,
-        this will return the current standard out for the latest *started*
-        attempt of the task. In both cases, multiple calls to this
-        method will return the most up-to-date log (so if an attempt is not
-        done, each call will fetch the latest log).
-        
-        Returns
-        -------
-        str
-            Standard output of this task
-        """
-        ...
-    @property
-    def stdout_size(self) -> int:
-        """
-        Returns the size of the stdout log of this task.
-        
-        Similar to `stdout`, the size returned is the latest size of the log
-        (so for a running attempt, this value will increase as the task produces
-        more output).
-        
-        Returns
-        -------
-        int
-            Size of the stdout log content (in bytes)
-        """
-        ...
-    @property
-    def stderr(self) -> str:
-        """
-        Returns the full standard error of this task.
-        
-        If you specify a specific attempt for this task, it will return the
-        standard error for that attempt. If you do not specify an attempt,
-        this will return the current standard error for the latest *started*
-        attempt. In both cases, multiple calls to this
-        method will return the most up-to-date log (so if an attempt is not
-        done, each call will fetch the latest log).
-        
-        Returns
-        -------
-        str
-            Standard error of this task
-        """
-        ...
-    @property
-    def stderr_size(self) -> int:
-        """
-        Returns the size of the stderr log of this task.
-        
-        Similar to `stderr`, the size returned is the latest size of the log
-        (so for a running attempt, this value will increase as the task produces
-        more output).
-        
-        Returns
-        -------
-        int
-            Size of the stderr log content (in bytes)
-        """
-        ...
-    @property
-    def current_attempt(self) -> int:
-        """
-        Get the relevant attempt for this Task.
-        
-        Returns the specific attempt used when
-        initializing the instance, or the latest *started* attempt for the Task.
-        
-        Returns
-        -------
-        int
-            attempt id for this task object
-        """
-        ...
-    @property
-    def code(self) -> typing.Optional[metaflow.client.core.MetaflowCode]:
-        """
-        Returns the MetaflowCode object for this task, if present.
-        
-        Not all tasks save their code so this call may return None in those cases.
-        
-        Returns
-        -------
-        MetaflowCode
-            Code package for this task
-        """
-        ...
-    @property
-    def environment_info(self) -> typing.Dict[str, typing.Any]:
-        """
-        Returns information about the environment that was used to execute this task. As an
-        example, if the Conda environment is selected, this will return information about the
-        dependencies that were used in the environment.
-        
-        This environment information is only available for tasks that have a code package.
-        
-        Returns
-        -------
-        Dict
-            Dictionary describing the environment
-        """
-        ...
-    def loglines(self, stream: str, as_unicode: bool = True, meta_dict: typing.Optional[typing.Dict[str, typing.Any]] = None) -> typing.Iterator[typing.Tuple[datetime.datetime, str]]:
-        """
-        Return an iterator over (utc_timestamp, logline) tuples.
-        
-        Parameters
-        ----------
-        stream : str
-            Either 'stdout' or 'stderr'.
-        as_unicode : bool, default: True
-            If as_unicode=False, each logline is returned as a byte object. Otherwise,
-            it is returned as a (unicode) string.
-        
-        Yields
-        ------
-        Tuple[datetime, str]
-            Tuple of timestamp, logline pairs.
-        """
-        ...
-    def __iter__(self) -> typing.Iterator[metaflow.client.core.DataArtifact]:
-        """
-        Iterate over all children DataArtifact of this Task
-        
-        Yields
-        ------
-        DataArtifact
-            A DataArtifact in this Step
-        """
-        ...
-    def __getitem__(self, name: str) -> metaflow.client.core.DataArtifact:
-        """
-        Returns the DataArtifact object with the artifact name 'name'
-        
-        Parameters
-        ----------
-        name : str
-            Data artifact name
-        
-        Returns
-        -------
-        DataArtifact
-            DataArtifact for this artifact name in this task
-        
-        Raises
-        ------
-        KeyError
-            If the name does not identify a valid DataArtifact object
-        """
-        ...
-    def __getstate__(self):
-        ...
-    def __setstate__(self, state):
-        ...
-    ...
-
-JSONType: metaflow.parameters.JSONTypeClass
-
-def namespace(ns: typing.Optional[str]) -> typing.Optional[str]:
-    """
-    Switch namespace to the one provided.
-    
-    This call has a global effect. No objects outside this namespace
-    will be accessible. To access all objects regardless of namespaces,
-    pass None to this call.
-    
-    Parameters
-    ----------
-    ns : str, optional
-        Namespace to switch to or None to ignore namespaces.
-    
-    Returns
-    -------
-    str, optional
-        Namespace set (result of get_namespace()).
-    """
-    ...
-
-class CommandException(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-class MetaflowNotFound(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-class MetaflowNamespaceMismatch(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, namespace):
-        ...
-    ...
-
-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 ...client.core import Task as Task
+from ...parameters import JSONTypeClass as JSONTypeClass
+from ...client.core import namespace as namespace
+from ...exception import CommandException as CommandException
+from ...exception import MetaflowNotFound as MetaflowNotFound
+from ...exception import MetaflowNamespaceMismatch as MetaflowNamespaceMismatch
+from ..._vendor import click as click
+from .card_datastore import CardDatastore as CardDatastore
+from .exception import CardClassFoundException as CardClassFoundException
+from .exception import IncorrectCardArgsException as IncorrectCardArgsException
+from .exception import UnrenderableCardException as UnrenderableCardException
+from .exception import CardNotPresentException as CardNotPresentException
+from .exception import TaskNotFoundException as TaskNotFoundException
+from .card_resolver import resolve_paths_from_task as resolve_paths_from_task
+from .card_resolver import resumed_info as resumed_info
 
 NUM_SHORT_HASH_CHARS: int
 
-class CardClassFoundException(metaflow.exception.MetaflowException, metaclass=type):
-    """
-    This exception is raised with MetaflowCard class is not present for a particular card type.
-    """
-    def __init__(self, card_name):
-        ...
-    ...
-
-class IncorrectCardArgsException(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, card_type, args):
-        ...
-    ...
-
-class UnrenderableCardException(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, card_type, args):
-        ...
-    ...
-
-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):
-        ...
-    ...
-
-class TaskNotFoundException(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, pathspec_query, resolved_from, run_id = None):
-        ...
-    ...
-
-def resolve_paths_from_task(flow_datastore, pathspec = None, type = None, hash = None, card_id = None):
-    ...
-
-def resumed_info(task):
-    ...
-
 class CardRenderInfo(tuple, metaclass=type):
     """
     CardRenderInfo(mode, is_implemented, data, timed_out, timeout_stack_trace)
@@ -556,10 +87,10 @@ def timeout(time):
 def raise_timeout(signum, frame):
     ...
 
-def list_available_cards(ctx, pathspec, card_paths, card_datastore, command = "view", show_list_as_json = False, list_many = False, file = None):
+def list_available_cards(ctx, pathspec, card_paths, card_datastore, command = 'view', show_list_as_json = False, list_many = False, file = None):
     ...
 
-def make_command(script_name, taskspec, command = "get", hash = None):
+def make_command(script_name, taskspec, command = 'get', hash = None):
     ...
 
 def list_many_cards(ctx, type = None, hash = None, card_id = None, follow_resumed = None, as_json = None, file = None):

metaflow-stubs/plugins/cards/card_client.pyi

@@ -1,90 +1,28 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.932224                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.596012                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow
-    import metaflow.exception
     import metaflow.plugins.cards.card_client
+    import metaflow
+
+from .card_resolver import resolve_paths_from_task as resolve_paths_from_task
+from .card_resolver import resumed_info as resumed_info
+from .card_datastore import CardDatastore as CardDatastore
+from .card_datastore import CardNameSuffix as CardNameSuffix
+from .exception import UnresolvableDatastoreException as UnresolvableDatastoreException
+from .exception import IncorrectArgumentException as IncorrectArgumentException
+from .exception import IncorrectPathspecException as IncorrectPathspecException
 
 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):
     """
     `Card` represents an individual Metaflow Card, a single HTML file, produced by

metaflow-stubs/plugins/cards/card_creator.pyi

@@ -1,16 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.945317                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.616659                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.metaflow_current
 
-current: metaflow.metaflow_current.Current
+from ...metaflow_current import current as current
 
 ASYNC_TIMEOUT: int
 
@@ -23,7 +20,7 @@ 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):
+    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):
         ...
     ...