metaflow-stubs 2.12.7__py2.py3-none-any.whl → 2.12.9__py2.py3-none-any.whl

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

@@ -0,0 +1,260 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.345765                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.runner.subprocess_manager
+    import metaflow.runner.deployer
+
+class StepFunctions(object, metaclass=type):
+    def __init__(self, name, graph, 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, is_project = False, use_distributed_map = False):
+        ...
+    def to_json(self):
+        ...
+    def trigger_explanation(self):
+        ...
+    def deploy(self, log_execution_history):
+        ...
+    def schedule(self):
+        ...
+    @classmethod
+    def delete(cls, name):
+        ...
+    @classmethod
+    def terminate(cls, flow_name, name):
+        ...
+    @classmethod
+    def trigger(cls, name, parameters):
+        ...
+    @classmethod
+    def list(cls, name, states):
+        ...
+    @classmethod
+    def get_existing_deployment(cls, name):
+        ...
+    @classmethod
+    def get_execution(cls, state_machine_name, name):
+        ...
+    ...
+
+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 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 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 list_runs(instance: metaflow.runner.deployer.DeployedFlow, states: typing.Optional[typing.List[str]] = None):
+    """
+    List runs of the deployed flow.
+    
+    Parameters
+    ----------
+    states : Optional[List[str]], optional
+        A list of states to filter the runs by. Allowed values are:
+        RUNNING, SUCCEEDED, FAILED, TIMED_OUT, ABORTED.
+        If not provided, all states will be considered.
+    
+    Returns
+    -------
+    List[TriggeredRun]
+        A list of TriggeredRun objects representing the runs of the deployed flow.
+    
+    Raises
+    ------
+    ValueError
+        If any of the provided states are invalid or if there are duplicate states.
+    """
+    ...
+
+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
+    -------
+    StepFunctionsTriggeredRun
+        The triggered run instance.
+    
+    Raises
+    ------
+    Exception
+        If there is an error during the trigger process.
+    """
+    ...
+
+class StepFunctionsDeployer(metaflow.runner.deployer.DeployerImpl, metaclass=type):
+    def __init__(self, deployer_kwargs, **kwargs):
+        """
+        Initialize the StepFunctionsDeployer.
+        
+        Parameters
+        ----------
+        deployer_kwargs : dict
+            The deployer-specific keyword arguments.
+        **kwargs : Any
+            Additional arguments to pass to the superclass constructor.
+        """
+        ...
+    ...
+

metaflow-stubs/plugins/azure/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.616895                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.275034                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/azure/azure_credential.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.673898                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.331791                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/azure/azure_exceptions.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.674158                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.332047                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.675605                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.333483                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import abc
-    import metaflow.exception
     import metaflow.plugins.secrets
+    import metaflow.exception
+    import abc
 
 class SecretsProvider(abc.ABC, metaclass=abc.ABCMeta):
     def get_secret_as_dict(self, secret_id, options = {}, role = None) -> typing.Dict[str, str]:

metaflow-stubs/plugins/azure/azure_utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.674656                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.332563                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/azure/blob_service_client_factory.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.675065                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.332967                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/azure/includefile_support.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.626084                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.267438                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/cards/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.609302                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.269812                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/cards/card_cli.pyi

@@ -1,18 +1,18 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.656919                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.306572                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import datetime
+    import typing
     import metaflow.client.core
     import metaflow.parameters
     import metaflow.exception
-    import typing
-    import datetime
 
 class Task(metaflow.client.core.MetaflowObject, metaclass=type):
     def __init__(self, *args, **kwargs):

metaflow-stubs/plugins/cards/card_client.pyi

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.628111                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.284038                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow
     import metaflow.plugins.cards.card_client
     import metaflow.exception
-    import metaflow
 
 TYPE_CHECKING: bool
 

metaflow-stubs/plugins/cards/card_creator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.651728                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.301575                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/cards/card_datastore.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.653584                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.303352                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/cards/card_decorator.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.652658                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.302436                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.decorators
     import metaflow.metaflow_current
+    import metaflow.decorators
 
 current: metaflow.metaflow_current.Current
 

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.648777                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.298581                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.620730                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.278590                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.cards.card_modules.basic
-    import metaflow.plugins.cards.card_modules.card
     import metaflow
+    import metaflow.plugins.cards.card_modules.card
+    import metaflow.plugins.cards.card_modules.basic
 
 class MetaflowCard(object, metaclass=type):
     def __init__(self, options = {}, components = [], graph = None):

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.628606                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.284559                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.678463                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.348639                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.692631                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.351976                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.692302                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.351646                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.692174                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.351524                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.691680                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.351071                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,17 +1,17 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.630831                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.286735                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.plugins.cards.card_modules.components
     import metaflow.plugins.cards.card_modules.basic
-    import metaflow.plugins.cards.card_modules.card
     import typing
-    import metaflow.plugins.cards.card_modules.components
+    import metaflow.plugins.cards.card_modules.card
 
 class LogComponent(metaflow.plugins.cards.card_modules.basic.DefaultComponent, metaclass=type):
     def __init__(self, data = None):

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.677456                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.335275                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.677685                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.335502                                        #
 ##################################################################################
 
 from __future__ import annotations

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

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.622175                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.279996                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.cards.card_modules.card
     import metaflow
+    import metaflow.plugins.cards.card_modules.card
 
 class MetaflowCard(object, metaclass=type):
     def __init__(self, options = {}, components = [], graph = None):

metaflow-stubs/plugins/cards/card_resolver.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.654171                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.303942                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/cards/component_serializer.pyi

@@ -1,17 +1,17 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.7                                                             #
-# Generated on 2024-07-03T19:20:47.651424                                        #
+# MF version: 2.12.9                                                             #
+# Generated on 2024-07-25T18:20:16.301278                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.plugins.cards.card_modules.components
     import metaflow.plugins.cards.card_modules.basic
-    import metaflow.plugins.cards.card_modules.card
     import metaflow.exception
-    import metaflow.plugins.cards.card_modules.components
+    import metaflow.plugins.cards.card_modules.card
 
 class MetaflowCardComponent(object, metaclass=type):
     @property