ob-metaflow-stubs 6.0.3.117__py2.py3-none-any.whl → 6.0.3.118__py2.py3-none-any.whl

metaflow-stubs/runner/deployer.pyi

@@ -1,155 +1,34 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.367380                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.935544                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.runner.subprocess_manager
+    import metaflow.plugins.aws.step_functions.step_functions_deployer_objects
+    import metaflow.plugins.aws.step_functions.step_functions_deployer
+    import metaflow.plugins.argo.argo_workflows_deployer_objects
+    import metaflow
     import metaflow.runner.deployer
-    import metaflow.exception
+    import metaflow.plugins.argo.argo_workflows_deployer
 
-class MetaflowNotFound(metaflow.exception.MetaflowException, metaclass=type):
-    ...
+from ..exception import MetaflowNotFound as MetaflowNotFound
 
-class SubprocessManager(object, metaclass=type):
-    """
-    A manager for subprocesses. The subprocess manager manages one or more
-    CommandManager objects, each of which manages an individual subprocess.
-    """
-    def __init__(self):
-        ...
-    def __aenter__(self) -> metaflow.runner.subprocess_manager.SubprocessManager:
-        ...
-    def __aexit__(self, exc_type, exc_value, traceback):
-        ...
-    def run_command(self, command: typing.List[str], env: typing.Optional[typing.Dict[str, str]] = None, cwd: typing.Optional[str] = None, show_output: bool = False) -> int:
-        """
-        Run a command synchronously and return its process ID.
-        
-        Parameters
-        ----------
-        command : List[str]
-            The command to run in List form.
-        env : Optional[Dict[str, str]], default None
-            Environment variables to set for the subprocess; if not specified,
-            the current enviornment variables are used.
-        cwd : Optional[str], default None
-            The directory to run the subprocess in; if not specified, the current
-            directory is used.
-        show_output : bool, default False
-            Suppress the 'stdout' and 'stderr' to the console by default.
-            They can be accessed later by reading the files present in the
-            CommandManager object:
-                - command_obj.log_files["stdout"]
-                - command_obj.log_files["stderr"]
-        Returns
-        -------
-        int
-            The process ID of the subprocess.
-        """
-        ...
-    def async_run_command(self, command: typing.List[str], env: typing.Optional[typing.Dict[str, str]] = None, cwd: typing.Optional[str] = None) -> int:
-        """
-        Run a command asynchronously and return its process ID.
-        
-        Parameters
-        ----------
-        command : List[str]
-            The command to run in List form.
-        env : Optional[Dict[str, str]], default None
-            Environment variables to set for the subprocess; if not specified,
-            the current enviornment variables are used.
-        cwd : Optional[str], default None
-            The directory to run the subprocess in; if not specified, the current
-            directory is used.
-        
-        Returns
-        -------
-        int
-            The process ID of the subprocess.
-        """
-        ...
-    def get(self, pid: int) -> typing.Optional["CommandManager"]:
-        """
-        Get one of the CommandManager managed by this SubprocessManager.
-        
-        Parameters
-        ----------
-        pid : int
-            The process ID of the subprocess (returned by run_command or async_run_command).
-        
-        Returns
-        -------
-        Optional[CommandManager]
-            The CommandManager object for the given process ID, or None if not found.
-        """
-        ...
-    def cleanup(self):
-        """
-        Clean up log files for all running subprocesses.
-        """
-        ...
-    ...
+TYPE_CHECKING: bool
 
-def handle_timeout(tfp_runner_attribute, command_obj: "CommandManager", file_read_timeout: int):
-    """
-    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.
-    file_read_timeout : int
-        Timeout for reading the file.
-    
-    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.
-    """
-    ...
+DEFAULT_FROM_DEPLOYMENT_IMPL: str
 
-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.
-    """
+class DeployerMeta(type, metaclass=type):
+    @staticmethod
+    def __new__(mcs, name, bases, dct):
+        ...
     ...
 
-class Deployer(object, metaclass=type):
+class Deployer(object, metaclass=DeployerMeta):
     """
     Use the `Deployer` class to configure and access one of the production
     orchestrators supported by Metaflow.
@@ -176,40 +55,45 @@ class Deployer(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, file_read_timeout: int = 3600, **kwargs):
         ...
-    def _Deployer__make_function(self, deployer_class):
+    def argo_workflows(self, *, name: typing.Optional[str] = None) -> "metaflow.plugins.argo.argo_workflows_deployer.ArgoWorkflowsDeployer":
         """
-        Create a function for the given deployer class.
+        Deployer implementation for Argo Workflows.
         
         Parameters
         ----------
-        deployer_class : Type[DeployerImpl]
-            Deployer implementation class.
+        name : str, optional, default None
+            Argo workflow name. The flow name is used instead if this option is not specified.
+        """
+        ...
+    def step_functions(self, *, name: typing.Optional[str] = None) -> "metaflow.plugins.aws.step_functions.step_functions_deployer.StepFunctionsDeployer":
+        """
+        Deployer implementation for AWS Step Functions.
         
-        Returns
-        -------
-        Callable
-            Function that initializes and returns an instance of the deployer class.
+        Parameters
+        ----------
+        name : str, optional, default None
+            State Machine name. The flow name is used instead if this option is not specified.
         """
         ...
     ...
 
 class TriggeredRun(object, metaclass=type):
     """
-    TriggeredRun class represents a run that has been triggered on a production orchestrator.
-    
-    Only when the `start` task starts running, the `run` object corresponding to the run
-    becomes available.
+    TriggeredRun class represents a run that has been triggered on a
+    production orchestrator.
     """
-    def __init__(self, deployer: DeployerImpl, content: str):
-        ...
-    def wait_for_run(self, timeout = None):
+    def wait_for_run(self, timeout: typing.Optional[int] = None):
         """
         Wait for the `run` property to become available.
         
+        The `run` property becomes available only after the `start` task of the triggered
+        flow starts running.
+        
         Parameters
         ----------
-        timeout : int, optional
-            Maximum time to wait for the `run` to become available, in seconds. If None, wait indefinitely.
+        timeout : int, optional, default None
+            Maximum time to wait for the `run` to become available, in seconds. If
+            None, wait indefinitely.
         
         Raises
         ------
@@ -218,7 +102,7 @@ class TriggeredRun(object, metaclass=type):
         """
         ...
     @property
-    def run(self):
+    def run(self) -> typing.Optional["metaflow.Run"]:
         """
         Retrieve the `Run` object for the triggered run.
         
@@ -233,93 +117,85 @@ class TriggeredRun(object, metaclass=type):
         ...
     ...
 
-class LazyDeploymentMethod(object, metaclass=type):
-    def __init__(self, module_path, func_name):
-        ...
-    def __call__(self, *args, **kwargs):
-        ...
-    ...
-
-class DeploymentMethodsMeta(type, metaclass=type):
+class DeployedFlowMeta(type, metaclass=type):
     @staticmethod
     def __new__(mcs, name, bases, dct):
         ...
     ...
 
-class DeployedFlow(object, metaclass=DeploymentMethodsMeta):
+class DeployedFlow(object, metaclass=DeployedFlowMeta):
     """
     DeployedFlow class represents a flow that has been deployed.
     
-    Parameters
-    ----------
-    deployer : DeployerImpl
-        Instance of the deployer implementation.
-    """
-    def __init__(self, deployer: DeployerImpl):
-        ...
-    @staticmethod
-    def from_deployment(identifier, metadata = None, impl = None):
-        ...
-    ...
-
-class DeployerImpl(object, metaclass=type):
+    This class is not meant to be instantiated directly. Instead, it is returned from
+    methods of `Deployer`.
     """
-    Base class for deployer implementations. Each implementation should define a TYPE
-    class variable that matches the name of the CLI group.
-    
-    Parameters
-    ----------
-    flow_file : str
-        Path to the flow file to deploy.
-    show_output : bool, default True
-        Show the 'stdout' and 'stderr' to the console by default.
-    profile : Optional[str], default None
-        Metaflow profile to use for the deployment. If not specified, the default
-        profile is used.
-    env : Optional[Dict], default None
-        Additional environment variables to set for the deployment.
-    cwd : Optional[str], default None
-        The directory to run the subprocess in; if not specified, the current
-        directory is used.
-    file_read_timeout : int, default 3600
-        The timeout until which we try to read the deployer attribute file.
-    **kwargs : Any
-        Additional arguments that you would pass to `python myflow.py` before
-        the deployment command.
-    """
-    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, file_read_timeout: int = 3600, **kwargs):
-        ...
-    def __enter__(self) -> DeployerImpl:
-        ...
-    def create(self, **kwargs) -> DeployedFlow:
+    @classmethod
+    def from_deployment(cls, *, identifier: str, metadata: typing.Optional[str] = None, impl: typing.Optional[str] = 'given by METAFLOW_DEFAULT_FROM_DEPLOYMENT_IMPL') -> typing.Union["metaflow.plugins.argo.argo_workflows_deployer_objects.ArgoWorkflowsDeployedFlow", "metaflow.plugins.aws.step_functions.step_functions_deployer_objects.StepFunctionsDeployedFlow"]:
         """
-        Create a deployed flow using the deployer implementation.
+        Retrieves a `DeployedFlow` object from an identifier and optional
+        metadata. The `impl` parameter specifies the deployer implementation
+        to use (like `argo-workflows`).
+        
+        
         
         Parameters
         ----------
-        **kwargs : Any
-            Additional arguments to pass to `create` corresponding to the
-            command line arguments of `create`
+        identifier : str
+            Deployer specific identifier for the workflow to retrieve
+        metadata : str, optional, default None
+            Optional deployer specific metadata.
+        impl : str, optional, default given by METAFLOW_DEFAULT_FROM_DEPLOYMENT_IMPL
+            The default implementation to use if not specified
+        
+        
         
         Returns
         -------
-        DeployedFlow
-            DeployedFlow object representing the deployed flow.
-        
-        Raises
-        ------
-        Exception
-            If there is an error during deployment.
+        typing.Union[ForwardRef('metaflow.plugins.argo.argo_workflows_deployer_objects.ArgoWorkflowsDeployedFlow'), ForwardRef('metaflow.plugins.aws.step_functions.step_functions_deployer_objects.StepFunctionsDeployedFlow')]
+        A `DeployedFlow` object
         """
         ...
-    def __exit__(self, exc_type, exc_value, traceback):
+    @classmethod
+    def from_argo_workflows(cls, *, identifier: str, metadata: typing.Optional[str] = None) -> "metaflow.plugins.argo.argo_workflows_deployer_objects.ArgoWorkflowsDeployedFlow":
         """
-        Cleanup resources on exit.
+        Retrieves a `ArgoWorkflowsDeployedFlow` object from an identifier and optional
+        metadata.
+        
+        
+        
+        Parameters
+        ----------
+        identifier : str
+            Deployer specific identifier for the workflow to retrieve
+        metadata : str, optional, default None
+            Optional deployer specific metadata.
+        
+        
+        
+        Returns
+        -------
+        ArgoWorkflowsDeployedFlow
+            A `ArgoWorkflowsDeployedFlow` object representing the
+            deployed flow on argo workflows.
         """
         ...
-    def cleanup(self):
+    @classmethod
+    def from_step_functions(cls) -> "metaflow.plugins.aws.step_functions.step_functions_deployer_objects.StepFunctionsDeployedFlow":
         """
-        Cleanup resources.
+        This method is not currently implemented for Step Functions.
+        
+        Raises
+        ------
+        NotImplementedError
+            This method is not implemented for Step Functions.
+        
+        Parameters
+        ----------
+        
+        
+        Returns
+        -------
         """
         ...
     ...

metaflow-stubs/runner/deployer_impl.pyi

@@ -0,0 +1,87 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.858861                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.runner.deployer
+    import typing
+
+from .subprocess_manager import SubprocessManager as SubprocessManager
+from .utils import get_lower_level_group as get_lower_level_group
+from .utils import handle_timeout as handle_timeout
+
+TYPE_CHECKING: bool
+
+class DeployerImpl(object, metaclass=type):
+    """
+    Base class for deployer implementations. Each implementation should define a TYPE
+    class variable that matches the name of the CLI group.
+    
+    Parameters
+    ----------
+    flow_file : str
+        Path to the flow file to deploy.
+    show_output : bool, default True
+        Show the 'stdout' and 'stderr' to the console by default.
+    profile : Optional[str], default None
+        Metaflow profile to use for the deployment. If not specified, the default
+        profile is used.
+    env : Optional[Dict], default None
+        Additional environment variables to set for the deployment.
+    cwd : Optional[str], default None
+        The directory to run the subprocess in; if not specified, the current
+        directory is used.
+    file_read_timeout : int, default 3600
+        The timeout until which we try to read the deployer attribute file.
+    **kwargs : Any
+        Additional arguments that you would pass to `python myflow.py` before
+        the deployment command.
+    """
+    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, file_read_timeout: int = 3600, **kwargs):
+        ...
+    @property
+    def deployer_kwargs(self) -> typing.Dict[str, typing.Any]:
+        ...
+    @staticmethod
+    def deployed_flow_type() -> typing.Type["metaflow.runner.deployer.DeployedFlow"]:
+        ...
+    def __enter__(self) -> "DeployerImpl":
+        ...
+    def create(self, **kwargs) -> "metaflow.runner.deployer.DeployedFlow":
+        """
+        Create a sub-class of a `DeployedFlow` depending on 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.
+        """
+        ...
+    ...
+