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

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

@@ -1,15 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.430822                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.905941                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.decorators
 
+
 class ScheduleDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
     """
     Specifies the times when the flow should be run when running on a

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

@@ -1,21 +1,21 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.433231                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.923951                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
 
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ....exception import MetaflowException as MetaflowException
+from ....parameters import deploy_time_eval as deploy_time_eval
+from ..batch.batch import Batch as Batch
+from .event_bridge_client import EventBridgeClient as EventBridgeClient
+from .step_functions_client import StepFunctionsClient as StepFunctionsClient
 
 EVENTS_SFN_ACCESS_IAM_ROLE: None
 
@@ -29,60 +29,6 @@ SFN_IAM_ROLE: None
 
 SFN_S3_DISTRIBUTED_MAP_OUTPUT_PATH: None
 
-def deploy_time_eval(value):
-    ...
-
-class Batch(object, metaclass=type):
-    def __init__(self, metadata, environment):
-        ...
-    def list_jobs(self, flow_name, run_id, user, echo):
-        ...
-    def kill_jobs(self, flow_name, run_id, user, echo):
-        ...
-    def create_job(self, step_name, step_cli, task_spec, code_package_sha, code_package_url, code_package_ds, image, queue, iam_role = None, execution_role = None, cpu = None, gpu = None, memory = None, run_time_limit = None, shared_memory = None, max_swap = None, swappiness = None, inferentia = None, efa = None, env = {}, attrs = {}, host_volumes = None, efs_volumes = None, use_tmpfs = None, tmpfs_tempdir = None, tmpfs_size = None, tmpfs_path = None, num_parallel = 0, ephemeral_storage = None, log_driver = None, log_options = None):
-        ...
-    def launch_job(self, step_name, step_cli, task_spec, code_package_sha, code_package_url, code_package_ds, image, queue, iam_role = None, execution_role = None, cpu = None, gpu = None, memory = None, run_time_limit = None, shared_memory = None, max_swap = None, swappiness = None, inferentia = None, efa = None, host_volumes = None, efs_volumes = None, use_tmpfs = None, tmpfs_tempdir = None, tmpfs_size = None, tmpfs_path = None, num_parallel = 0, env = {}, attrs = {}, ephemeral_storage = None, log_driver = None, log_options = None):
-        ...
-    def wait(self, stdout_location, stderr_location, echo = None):
-        ...
-    ...
-
-class EventBridgeClient(object, metaclass=type):
-    def __init__(self, name):
-        ...
-    def cron(self, cron):
-        ...
-    def role_arn(self, role_arn):
-        ...
-    def state_machine_arn(self, state_machine_arn):
-        ...
-    def schedule(self):
-        ...
-    def delete(self):
-        ...
-    ...
-
-class StepFunctionsClient(object, metaclass=type):
-    def __init__(self):
-        ...
-    def search(self, name):
-        ...
-    def push(self, name, definition, role_arn, log_execution_history):
-        ...
-    def get(self, name):
-        ...
-    def trigger(self, state_machine_arn, input):
-        ...
-    def list_executions(self, state_machine_arn, states):
-        ...
-    def terminate_execution(self, execution_arn):
-        ...
-    def get_state_machine_arn(self, name):
-        ...
-    def delete(self, name):
-        ...
-    ...
-
 class StepFunctionsException(metaflow.exception.MetaflowException, metaclass=type):
     ...
 

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

@@ -1,12 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.431399                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.924576                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 AWS_SANDBOX_ENABLED: bool
 
 AWS_SANDBOX_REGION: None

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

@@ -1,324 +1,84 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.434505                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.906358                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.runner.deployer
+    import metaflow.plugins.aws.step_functions.step_functions_deployer_objects
+    import typing
+    import metaflow.runner.deployer_impl
 
-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):
-        ...
-    ...
+from ....runner.deployer_impl import DeployerImpl as DeployerImpl
 
-class DeployerImpl(object, metaclass=type):
+TYPE_CHECKING: bool
+
+class StepFunctionsDeployer(metaflow.runner.deployer_impl.DeployerImpl, metaclass=type):
     """
-    Base class for deployer implementations. Each implementation should define a TYPE
-    class variable that matches the name of the CLI group.
+    Deployer implementation for AWS Step Functions.
     
     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.
+    name : str, optional, default None
+        State Machine name. The flow name is used instead if this option is not specified.
     """
-    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) -> metaflow.runner.deployer.DeployerImpl:
-        ...
-    def create(self, **kwargs) -> metaflow.runner.deployer.DeployedFlow:
+    def __init__(self, deployer_kwargs: typing.Dict[str, str], **kwargs):
         """
-        Create a deployed flow using the deployer implementation.
+        Initialize the StepFunctionsDeployer.
         
         Parameters
         ----------
+        deployer_kwargs : Dict[str, str]
+            The deployer-specific keyword arguments.
         **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.
+            Additional arguments to pass to the superclass constructor.
         """
         ...
-    ...
-
-class DeployedFlow(object, metaclass=metaflow.runner.deployer.DeploymentMethodsMeta):
-    """
-    DeployedFlow class represents a flow that has been deployed.
-    
-    Parameters
-    ----------
-    deployer : DeployerImpl
-        Instance of the deployer implementation.
-    """
-    def __init__(self, deployer: metaflow.runner.deployer.DeployerImpl):
+    @property
+    def deployer_kwargs(self) -> typing.Dict[str, typing.Any]:
         ...
     @staticmethod
-    def from_deployment(identifier, metadata = None, impl = None):
-        ...
-    ...
-
-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.
-    """
-    def __init__(self, deployer: metaflow.runner.deployer.DeployerImpl, content: str):
+    def deployed_flow_type() -> typing.Type["metaflow.plugins.aws.step_functions.step_functions_deployer_objects.StepFunctionsDeployedFlow"]:
         ...
-    def wait_for_run(self, timeout = None):
+    def create(self, **kwargs) -> "metaflow.plugins.aws.step_functions.step_functions_deployer_objects.StepFunctionsDeployedFlow":
         """
-        Wait for the `run` property to become available.
+        Create a new AWS Step Functions State Machine deployment.
         
         Parameters
         ----------
-        timeout : int, optional
-            Maximum time to wait for the `run` to become available, in seconds. If None, wait indefinitely.
-        
-        Raises
-        ------
-        TimeoutError
-            If the `run` is not available within the specified timeout.
-        """
-        ...
-    @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.
+        authorize : str, optional, default None
+            Authorize using this production token. Required when re-deploying an existing flow
+            for the first time. The token is cached in METAFLOW_HOME.
+        generate_new_token : bool, optional, default False
+            Generate a new production token for this flow. Moves the production flow to a new namespace.
+        given_token : str, optional, default None
+            Use the given production token for this flow. Moves the production flow to the given namespace.
+        tags : List[str], optional, default None
+            Annotate all objects produced by AWS Step Functions runs with these tags.
+        user_namespace : str, optional, default None
+            Change the namespace from the default (production token) to the given tag.
+        only_json : bool, optional, default False
+            Only print out JSON sent to AWS Step Functions without deploying anything.
+        max_workers : int, optional, default 100
+            Maximum number of parallel processes.
+        workflow_timeout : int, optional, default None
+            Workflow timeout in seconds.
+        log_execution_history : bool, optional, default False
+            Log AWS Step Functions execution history to AWS CloudWatch Logs log group.
+        use_distributed_map : bool, optional, default False
+            Use AWS Step Functions Distributed Map instead of Inline Map for defining foreach
+            tasks in Amazon State Language.
+        deployer_attribute_file : str, optional, default None
+            Write the workflow name to the specified file. Used internally for Metaflow's Deployer API.
         
         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: "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.
-    """
-    ...
-
-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):
-    """
-    Deployer implementation for AWS Step Functions.
-    
-    Attributes
-    ----------
-    TYPE : ClassVar[Optional[str]]
-        The type of the deployer, which is "step-functions".
-    """
-    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.
+        StepFunctionsDeployedFlow
+            The Flow deployed to AWS Step Functions.
         """
         ...
     ...

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

@@ -0,0 +1,127 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.921542                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import metaflow
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.aws.step_functions.step_functions_deployer_objects
+    import metaflow.runner.deployer
+
+from .step_functions import StepFunctions as StepFunctions
+from ....runner.deployer import DeployedFlow as DeployedFlow
+from ....runner.deployer import TriggeredRun as TriggeredRun
+from ....runner.utils import get_lower_level_group as get_lower_level_group
+from ....runner.utils import handle_timeout as handle_timeout
+
+class StepFunctionsTriggeredRun(metaflow.runner.deployer.TriggeredRun, metaclass=type):
+    """
+    A class representing a triggered AWS Step Functions state machine execution.
+    """
+    def terminate(self, **kwargs) -> bool:
+        """
+        Terminate the running state machine execution.
+        
+        Parameters
+        ----------
+        authorize : str, optional, default None
+            Authorize the termination with a production token.
+        
+        Returns
+        -------
+        bool
+            True if the command was successful, False otherwise.
+        """
+        ...
+    ...
+
+class StepFunctionsDeployedFlow(metaflow.runner.deployer.DeployedFlow, metaclass=metaflow.runner.deployer.DeployedFlowMeta):
+    """
+    A class representing a deployed AWS Step Functions state machine.
+    """
+    @classmethod
+    def from_deployment(cls, identifier: str, metadata: typing.Optional[str] = None):
+        """
+        This method is not currently implemented for Step Functions.
+        
+        Raises
+        ------
+        NotImplementedError
+            This method is not implemented for Step Functions.
+        """
+        ...
+    @property
+    def production_token(self: metaflow.runner.deployer.DeployedFlow) -> typing.Optional[str]:
+        """
+        Get the production token for the deployed flow.
+        
+        Returns
+        -------
+        str, optional
+            The production token, None if it cannot be retrieved.
+        """
+        ...
+    def list_runs(self, states: typing.Optional[typing.List[str]] = None) -> typing.List[StepFunctionsTriggeredRun]:
+        """
+        List runs of the deployed flow.
+        
+        Parameters
+        ----------
+        states : List[str], optional, default None
+            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[StepFunctionsTriggeredRun]
+            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(self, **kwargs) -> bool:
+        """
+        Delete the deployed state machine.
+        
+        Parameters
+        ----------
+        authorize : str, optional, default None
+            Authorize the deletion with a production token.
+        
+        Returns
+        -------
+        bool
+            True if the command was successful, False otherwise.
+        """
+        ...
+    def trigger(self, **kwargs) -> StepFunctionsTriggeredRun:
+        """
+        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.
+        """
+        ...
+    ...
+

metaflow-stubs/plugins/azure/__init__.pyi

@@ -1,12 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27.1+obcheckpoint(0.1.2);ob(v1)                               #
-# Generated on 2024-11-13T19:05:29.389319                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-11-13T23:34:52.866228                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
-def create_azure_credential():
-    ...
+from . import azure_credential as azure_credential
+from .azure_credential import create_cacheable_azure_credential as create_azure_credential
+from . import azure_exceptions as azure_exceptions
+from . import azure_utils as azure_utils
+from . import blob_service_client_factory as blob_service_client_factory
+from . import includefile_support as includefile_support
+from . import azure_secret_manager_secrets_provider as azure_secret_manager_secrets_provider