metaflow-stubs 2.12.28__py2.py3-none-any.whl → 2.12.30__py2.py3-none-any.whl

metaflow-stubs/plugins/argo/argo_workflows_cli.pyi

@@ -1,310 +1,32 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.534187                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.358922                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.graph
-    import datetime
-    import metaflow.decorators
-    import metaflow.parameters
-    import metaflow.client.core
-    import metaflow.events
     import metaflow.exception
-    import metaflow.metaflow_current
 
-JSONType: metaflow.parameters.JSONTypeClass
-
-class Run(metaflow.client.core.MetaflowObject, metaclass=type):
-    """
-    A `Run` represents an execution of a `Flow`. It is a container of `Step`s.
-    
-    Attributes
-    ----------
-    data : MetaflowData
-        a shortcut to run['end'].task.data, i.e. data produced by this run.
-    successful : bool
-        True if the run completed successfully.
-    finished : bool
-        True if the run completed.
-    finished_at : datetime
-        Time this run finished.
-    code : MetaflowCode
-        Code package for this run (if present). See `MetaflowCode`.
-    trigger : MetaflowTrigger
-        Information about event(s) that triggered this run (if present). See `MetaflowTrigger`.
-    end_task : Task
-        `Task` for the end step (if it is present already).
-    """
-    def steps(self, *tags: str) -> typing.Iterator[metaflow.client.core.Step]:
-        """
-        [Legacy function - do not use]
-        
-        Returns an iterator over all `Step` objects in the step. This is an alias
-        to iterating the object itself, i.e.
-        ```
-        list(Run(...)) == list(Run(...).steps())
-        ```
-        
-        Parameters
-        ----------
-        tags : str
-            No op (legacy functionality)
-        
-        Yields
-        ------
-        Step
-            `Step` objects in this run.
-        """
-        ...
-    @property
-    def code(self) -> typing.Optional[metaflow.client.core.MetaflowCode]:
-        """
-        Returns the MetaflowCode object for this run, if present.
-        Code is packed if atleast one `Step` runs remotely, else None is returned.
-        
-        Returns
-        -------
-        MetaflowCode, optional
-            Code package for this run
-        """
-        ...
-    @property
-    def data(self) -> typing.Optional[metaflow.client.core.MetaflowData]:
-        """
-        Returns a container of data artifacts produced by this run.
-        
-        You can access data produced by this run as follows:
-        ```
-        print(run.data.my_var)
-        ```
-        This is a shorthand for `run['end'].task.data`. If the 'end' step has not yet
-        executed, returns None.
-        
-        Returns
-        -------
-        MetaflowData, optional
-            Container of all artifacts produced by this task
-        """
-        ...
-    @property
-    def successful(self) -> bool:
-        """
-        Indicates whether or not the run completed successfully.
-        
-        A run is successful if its 'end' step is successful.
-        
-        Returns
-        -------
-        bool
-            True if the run completed successfully and False otherwise
-        """
-        ...
-    @property
-    def finished(self) -> bool:
-        """
-        Indicates whether or not the run completed.
-        
-        A run completed if its 'end' step completed.
-        
-        Returns
-        -------
-        bool
-            True if the run completed and False otherwise
-        """
-        ...
-    @property
-    def finished_at(self) -> typing.Optional[datetime.datetime]:
-        """
-        Returns the datetime object of when the run finished (successfully or not).
-        
-        The completion time of a run is the same as the completion time of its 'end' step.
-        If the 'end' step has not completed, returns None.
-        
-        Returns
-        -------
-        datetime, optional
-            Datetime of when the run finished
-        """
-        ...
-    @property
-    def end_task(self) -> typing.Optional[metaflow.client.core.Task]:
-        """
-        Returns the Task corresponding to the 'end' step.
-        
-        This returns None if the end step does not yet exist.
-        
-        Returns
-        -------
-        Task, optional
-            The 'end' task
-        """
-        ...
-    def add_tag(self, tag: str):
-        """
-        Add a tag to this `Run`.
-        
-        Note that if the tag is already a system tag, it is not added as a user tag,
-        and no error is thrown.
-        
-        Parameters
-        ----------
-        tag : str
-            Tag to add.
-        """
-        ...
-    def add_tags(self, tags: typing.Iterable[str]):
-        """
-        Add one or more tags to this `Run`.
-        
-        Note that if any tag is already a system tag, it is not added as a user tag
-        and no error is thrown.
-        
-        Parameters
-        ----------
-        tags : Iterable[str]
-            Tags to add.
-        """
-        ...
-    def remove_tag(self, tag: str):
-        """
-        Remove one tag from this `Run`.
-        
-        Removing a system tag is an error. Removing a non-existent
-        user tag is a no-op.
-        
-        Parameters
-        ----------
-        tag : str
-            Tag to remove.
-        """
-        ...
-    def remove_tags(self, tags: typing.Iterable[str]):
-        """
-        Remove one or more tags to this `Run`.
-        
-        Removing a system tag will result in an error. Removing a non-existent
-        user tag is a no-op.
-        
-        Parameters
-        ----------
-        tags : Iterable[str]
-            Tags to remove.
-        """
-        ...
-    def replace_tag(self, tag_to_remove: str, tag_to_add: str):
-        """
-        Remove a tag and add a tag atomically. Removal is done first.
-        The rules for `Run.add_tag` and `Run.remove_tag` also apply here.
-        
-        Parameters
-        ----------
-        tag_to_remove : str
-            Tag to remove.
-        tag_to_add : str
-            Tag to add.
-        """
-        ...
-    def replace_tags(self, tags_to_remove: typing.Iterable[str], tags_to_add: typing.Iterable[str]):
-        """
-        Remove and add tags atomically; the removal is done first.
-        The rules for `Run.add_tag` and `Run.remove_tag` also apply here.
-        
-        Parameters
-        ----------
-        tags_to_remove : Iterable[str]
-            Tags to remove.
-        tags_to_add : Iterable[str]
-            Tags to add.
-        """
-        ...
-    def __iter__(self) -> typing.Iterator[metaflow.client.core.Step]:
-        """
-        Iterate over all children Step of this Run
-        
-        Yields
-        ------
-        Step
-            A Step in this Run
-        """
-        ...
-    def __getitem__(self, name: str) -> metaflow.client.core.Step:
-        """
-        Returns the Step object with the step name 'name'
-        
-        Parameters
-        ----------
-        name : str
-            Step name
-        
-        Returns
-        -------
-        Step
-            Step for this step name in this Run
-        
-        Raises
-        ------
-        KeyError
-            If the name does not identify a valid Step object
-        """
-        ...
-    def __getstate__(self):
-        ...
-    def __setstate__(self, state):
-        ...
-    @property
-    def trigger(self) -> typing.Optional[metaflow.events.Trigger]:
-        """
-        Returns a container of events that triggered this run.
-        
-        This returns None if the run was not triggered by any events.
-        
-        Returns
-        -------
-        Trigger, optional
-            Container of triggering events
-        """
-        ...
-    ...
-
-current: metaflow.metaflow_current.Current
-
-def get_metadata() -> str:
-    """
-    Returns the current Metadata provider.
-    
-    If this is not set explicitly using `metadata`, the default value is
-    determined through the Metaflow configuration. You can use this call to
-    check that your configuration is set up properly.
-    
-    If multiple configuration profiles are present, this call returns the one
-    selected through the `METAFLOW_PROFILE` environment variable.
-    
-    Returns
-    -------
-    str
-        Information about the Metadata provider currently selected. This information typically
-        returns provider specific information (like URL for remote providers or local paths for
-        local providers).
-    """
-    ...
-
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
-
-class MetaflowInternalError(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-class MetaflowNotFound(metaflow.exception.MetaflowException, metaclass=type):
-    ...
+from ...parameters import JSONType as JSONType
+from ...client.core import Run as Run
+from ...metaflow_current import current as current
+from ... import parameters as parameters
+from ..._vendor import click as click
+from ...client.core import get_metadata as get_metadata
+from ...exception import MetaflowException as MetaflowException
+from ...exception import MetaflowInternalError as MetaflowInternalError
+from ...exception import MetaflowNotFound as MetaflowNotFound
+from ..aws.step_functions.production_token import load_token as load_token
+from ..aws.step_functions.production_token import new_token as new_token
+from ..aws.step_functions.production_token import store_token as store_token
+from ..environment_decorator import EnvironmentDecorator as EnvironmentDecorator
+from ..kubernetes.kubernetes_decorator import KubernetesDecorator as KubernetesDecorator
+from ...tagging_util import validate_tags as validate_tags
+from .argo_workflows import ArgoWorkflows as ArgoWorkflows
 
 ARGO_WORKFLOWS_UI_URL: None
 
@@ -314,166 +36,6 @@ SERVICE_VERSION_CHECK: bool
 
 UI_URL: None
 
-def load_token(token_prefix):
-    ...
-
-def new_token(token_prefix, prev_token = None):
-    ...
-
-def store_token(token_prefix, token):
-    ...
-
-class EnvironmentDecorator(metaflow.decorators.StepDecorator, metaclass=type):
-    """
-    Specifies environment variables to be set prior to the execution of a step.
-    
-    Parameters
-    ----------
-    vars : Dict[str, str], default {}
-        Dictionary of environment variables to set.
-    """
-    def runtime_step_cli(self, cli_args, retry_count, max_user_code_retries, ubf_context):
-        ...
-    ...
-
-class KubernetesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
-    """
-    Specifies that this step should execute on Kubernetes.
-    
-    Parameters
-    ----------
-    cpu : int, default 1
-        Number of CPUs required for this step. If `@resources` is
-        also present, the maximum value from all decorators is used.
-    memory : int, default 4096
-        Memory size (in MB) required for this step. If
-        `@resources` is also present, the maximum value from all decorators is
-        used.
-    disk : int, default 10240
-        Disk size (in MB) required for this step. If
-        `@resources` is also present, the maximum value from all decorators is
-        used.
-    image : str, optional, default None
-        Docker image to use when launching on Kubernetes. If not specified, and
-        METAFLOW_KUBERNETES_CONTAINER_IMAGE is specified, that image is used. If
-        not, a default Docker image mapping to the current version of Python is used.
-    image_pull_policy: str, default KUBERNETES_IMAGE_PULL_POLICY
-        If given, the imagePullPolicy to be applied to the Docker image of the step.
-    service_account : str, default METAFLOW_KUBERNETES_SERVICE_ACCOUNT
-        Kubernetes service account to use when launching pod in Kubernetes.
-    secrets : List[str], optional, default None
-        Kubernetes secrets to use when launching pod in Kubernetes. These
-        secrets are in addition to the ones defined in `METAFLOW_KUBERNETES_SECRETS`
-        in Metaflow configuration.
-    node_selector: Union[Dict[str,str], str], optional, default None
-        Kubernetes node selector(s) to apply to the pod running the task.
-        Can be passed in as a comma separated string of values e.g. "kubernetes.io/os=linux,kubernetes.io/arch=amd64"
-        or as a dictionary {"kubernetes.io/os": "linux", "kubernetes.io/arch": "amd64"}
-    namespace : str, default METAFLOW_KUBERNETES_NAMESPACE
-        Kubernetes namespace to use when launching pod in Kubernetes.
-    gpu : int, optional, default None
-        Number of GPUs required for this step. A value of zero implies that
-        the scheduled node should not have GPUs.
-    gpu_vendor : str, default KUBERNETES_GPU_VENDOR
-        The vendor of the GPUs to be used for this step.
-    tolerations : List[str], default []
-        The default is extracted from METAFLOW_KUBERNETES_TOLERATIONS.
-        Kubernetes tolerations to use when launching pod in Kubernetes.
-    use_tmpfs : bool, default False
-        This enables an explicit tmpfs mount for this step.
-    tmpfs_tempdir : bool, default True
-        sets METAFLOW_TEMPDIR to tmpfs_path if set for this step.
-    tmpfs_size : int, optional, default: None
-        The value for the size (in MiB) of the tmpfs mount for this step.
-        This parameter maps to the `--tmpfs` option in Docker. Defaults to 50% of the
-        memory allocated for this step.
-    tmpfs_path : str, optional, default /metaflow_temp
-        Path to tmpfs mount for this step.
-    persistent_volume_claims : Dict[str, str], optional, default None
-        A map (dictionary) of persistent volumes to be mounted to the pod for this step. The map is from persistent
-        volumes to the path to which the volume is to be mounted, e.g., `{'pvc-name': '/path/to/mount/on'}`.
-    shared_memory: int, optional
-        Shared memory size (in MiB) required for this step
-    port: int, optional
-        Port number to specify in the Kubernetes job object
-    compute_pool : str, optional, default None
-        Compute pool to be used for for this step.
-        If not specified, any accessible compute pool within the perimeter is used.
-    hostname_resolution_timeout: int, default 10 * 60
-        Timeout in seconds for the workers tasks in the gang scheduled cluster to resolve the hostname of control task.
-        Only applicable when @parallel is used.
-    """
-    def __init__(self, attributes = None, statically_defined = False):
-        ...
-    def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):
-        ...
-    def package_init(self, flow, step_name, environment):
-        ...
-    def runtime_init(self, flow, graph, package, run_id):
-        ...
-    def runtime_task_created(self, task_datastore, task_id, split_index, input_paths, is_cloned, ubf_context):
-        ...
-    def runtime_step_cli(self, cli_args, retry_count, max_user_code_retries, ubf_context):
-        ...
-    def task_pre_step(self, step_name, task_datastore, metadata, run_id, task_id, flow, graph, retry_count, max_retries, ubf_context, inputs):
-        ...
-    def task_finished(self, step_name, flow, graph, is_task_ok, retry_count, max_retries):
-        ...
-    ...
-
-def validate_tags(tags, existing_tags = None):
-    """
-    Raises MetaflowTaggingError if invalid based on these rules:
-    
-    Tag set size is too large. But it's OK if tag set is not larger
-    than an existing tag set (if provided).
-    
-    Then, we validate each tag.  See validate_tag()
-    """
-    ...
-
-class ArgoWorkflows(object, metaclass=type):
-    def __init__(self, name, graph: metaflow.graph.FlowGraph, flow, code_package_sha, code_package_url, production_token, metadata, flow_datastore, environment, event_logger, monitor, tags = None, namespace = None, username = None, max_workers = None, workflow_timeout = None, workflow_priority = None, auto_emit_argo_events = False, notify_on_error = False, notify_on_success = False, notify_slack_webhook_url = None, notify_pager_duty_integration_key = None, enable_heartbeat_daemon = True, enable_error_msg_capture = False):
-        ...
-    def __str__(self):
-        ...
-    def deploy(self):
-        ...
-    @staticmethod
-    def list_templates(flow_name, all = False):
-        ...
-    @staticmethod
-    def delete(name):
-        ...
-    @classmethod
-    def terminate(cls, flow_name, name):
-        ...
-    @staticmethod
-    def get_workflow_status(flow_name, name):
-        ...
-    @staticmethod
-    def suspend(name):
-        ...
-    @staticmethod
-    def unsuspend(name):
-        ...
-    @classmethod
-    def trigger(cls, name, parameters = None):
-        ...
-    def schedule(self):
-        ...
-    def trigger_explanation(self):
-        ...
-    @classmethod
-    def get_existing_deployment(cls, name):
-        ...
-    @classmethod
-    def get_execution(cls, name):
-        ...
-    def list_to_prose(self, items, singular):
-        ...
-    ...
-
 unsupported_decorators: dict
 
 class IncorrectProductionToken(metaflow.exception.MetaflowException, metaclass=type):