metaflow-stubs 2.12.8__py2.py3-none-any.whl → 2.12.10__py2.py3-none-any.whl

metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi

@@ -0,0 +1,292 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.199657                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.runner.subprocess_manager
+    import metaflow.graph
+    import metaflow.runner.deployer
+
+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):
+        ...
+    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):
+        ...
+    ...
+
+class DeployerImpl(object, metaclass=type):
+    def __init__(self, flow_file: str, show_output: bool = True, profile: typing.Optional[str] = None, env: typing.Optional[typing.Dict] = None, cwd: typing.Optional[str] = None, **kwargs):
+        ...
+    def __enter__(self) -> metaflow.runner.deployer.DeployerImpl:
+        ...
+    def create(self, **kwargs) -> metaflow.runner.deployer.DeployedFlow:
+        """
+        Create a deployed flow using the deployer implementation.
+        
+        Parameters
+        ----------
+        **kwargs : Any
+            Additional arguments to pass to `create` corresponding to the
+            command line arguments of `create`
+        
+        Returns
+        -------
+        DeployedFlow
+            DeployedFlow object representing the deployed flow.
+        
+        Raises
+        ------
+        Exception
+            If there is an error during deployment.
+        """
+        ...
+    def __exit__(self, exc_type, exc_value, traceback):
+        """
+        Cleanup resources on exit.
+        """
+        ...
+    def cleanup(self):
+        """
+        Cleanup resources.
+        """
+        ...
+    ...
+
+class DeployedFlow(object, metaclass=type):
+    def __init__(self, deployer: metaflow.runner.deployer.DeployerImpl):
+        ...
+    ...
+
+class TriggeredRun(object, metaclass=type):
+    def __init__(self, deployer: metaflow.runner.deployer.DeployerImpl, content: str):
+        ...
+    @property
+    def run(self):
+        """
+        Retrieve the `Run` object for the triggered run.
+        
+        Note that Metaflow `Run` becomes available only when the `start` task
+        has started executing.
+        
+        Returns
+        -------
+        Run, optional
+            Metaflow Run object if the `start` step has started executing, otherwise None.
+        """
+        ...
+    ...
+
+def get_lower_level_group(api, top_level_kwargs: typing.Dict, _type: typing.Optional[str], deployer_kwargs: typing.Dict):
+    """
+    Retrieve a lower-level group from the API based on the type and provided arguments.
+    
+    Parameters
+    ----------
+    api : MetaflowAPI
+        Metaflow API instance.
+    top_level_kwargs : Dict
+        Top-level keyword arguments to pass to the API.
+    _type : str
+        Type of the deployer implementation to target.
+    deployer_kwargs : Dict
+        Keyword arguments specific to the deployer.
+    
+    Returns
+    -------
+    Any
+        The lower-level group object retrieved from the API.
+    
+    Raises
+    ------
+    ValueError
+        If the `_type` is None.
+    """
+    ...
+
+def handle_timeout(tfp_runner_attribute, command_obj: metaflow.runner.subprocess_manager.CommandManager):
+    """
+    Handle the timeout for a running subprocess command that reads a file
+    and raises an error with appropriate logs if a TimeoutError occurs.
+    
+    Parameters
+    ----------
+    tfp_runner_attribute : NamedTemporaryFile
+        Temporary file that stores runner attribute data.
+    command_obj : CommandManager
+        Command manager object that encapsulates the running command details.
+    
+    Returns
+    -------
+    str
+        Content read from the temporary file.
+    
+    Raises
+    ------
+    RuntimeError
+        If a TimeoutError occurs, it raises a RuntimeError with the command's
+        stdout and stderr logs.
+    """
+    ...
+
+def suspend(instance: metaflow.runner.deployer.TriggeredRun, **kwargs):
+    """
+    Suspend the running workflow.
+    
+    Parameters
+    ----------
+    **kwargs : Any
+        Additional arguments to pass to the suspend command.
+    
+    Returns
+    -------
+    bool
+        True if the command was successful, False otherwise.
+    """
+    ...
+
+def unsuspend(instance: metaflow.runner.deployer.TriggeredRun, **kwargs):
+    """
+    Unsuspend the suspended workflow.
+    
+    Parameters
+    ----------
+    **kwargs : Any
+        Additional arguments to pass to the unsuspend command.
+    
+    Returns
+    -------
+    bool
+        True if the command was successful, False otherwise.
+    """
+    ...
+
+def terminate(instance: metaflow.runner.deployer.TriggeredRun, **kwargs):
+    """
+    Terminate the running workflow.
+    
+    Parameters
+    ----------
+    **kwargs : Any
+        Additional arguments to pass to the terminate command.
+    
+    Returns
+    -------
+    bool
+        True if the command was successful, False otherwise.
+    """
+    ...
+
+def status(instance: metaflow.runner.deployer.TriggeredRun):
+    """
+    Get the status of the triggered run.
+    
+    Returns
+    -------
+    str, optional
+        The status of the workflow considering the run object, or None if the status could not be retrieved.
+    """
+    ...
+
+def production_token(instance: metaflow.runner.deployer.DeployedFlow):
+    """
+    Get the production token for the deployed flow.
+    
+    Returns
+    -------
+    str, optional
+        The production token, None if it cannot be retrieved.
+    """
+    ...
+
+def delete(instance: metaflow.runner.deployer.DeployedFlow, **kwargs):
+    """
+    Delete the deployed flow.
+    
+    Parameters
+    ----------
+    **kwargs : Any
+        Additional arguments to pass to the delete command.
+    
+    Returns
+    -------
+    bool
+        True if the command was successful, False otherwise.
+    """
+    ...
+
+def trigger(instance: metaflow.runner.deployer.DeployedFlow, **kwargs):
+    """
+    Trigger a new run for the deployed flow.
+    
+    Parameters
+    ----------
+    **kwargs : Any
+        Additional arguments to pass to the trigger command, `Parameters` in particular
+    
+    Returns
+    -------
+    ArgoWorkflowsTriggeredRun
+        The triggered run instance.
+    
+    Raises
+    ------
+    Exception
+        If there is an error during the trigger process.
+    """
+    ...
+
+class ArgoWorkflowsDeployer(metaflow.runner.deployer.DeployerImpl, metaclass=type):
+    def __init__(self, deployer_kwargs, **kwargs):
+        """
+        Initialize the ArgoWorkflowsDeployer.
+        
+        Parameters
+        ----------
+        deployer_kwargs : dict
+            The deployer-specific keyword arguments.
+        **kwargs : Any
+            Additional arguments to pass to the superclass constructor.
+        """
+        ...
+    ...
+

metaflow-stubs/plugins/aws/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.385056                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.142440                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/aws_client.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.407917                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.174165                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/aws_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.407531                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.173778                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/batch/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.407149                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.173916                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/batch/batch.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.450800                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.217986                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/batch/batch_cli.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.452446                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.219553                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/batch/batch_client.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.449581                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.216566                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/batch/batch_decorator.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.451735                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.218851                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.decorators
     import metaflow.metaflow_current
+    import metaflow.decorators
     import metaflow.exception
 
 current: metaflow.metaflow_current.Current

metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.408035                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.174280                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.458861                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.220021                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.plugins.secrets
     import abc
     import metaflow.exception
-    import metaflow.plugins.secrets
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):

metaflow-stubs/plugins/aws/step_functions/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.407664                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.173395                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/dynamo_db_client.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.452705                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.208176                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.453966                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.209151                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/production_token.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.453635                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.213605                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.453364                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.208828                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/step_functions.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.456787                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.211931                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/step_functions_cli.pyi

@@ -1,22 +1,42 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.458347                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.215140                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.decorators
     import metaflow.parameters
-    import metaflow.exception
     import metaflow.metaflow_current
+    import metaflow.decorators
+    import metaflow.exception
 
 JSONType: metaflow.parameters.JSONTypeClass
 
 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):
         ...

metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.454450                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.209547                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/aws/step_functions/step_functions_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.8                                                             #
-# Generated on 2024-07-16T15:51:55.453163                                        #
+# MF version: 2.12.10                                                            #
+# Generated on 2024-07-30T23:31:35.208636                                        #
 ##################################################################################
 
 from __future__ import annotations