metaflow-stubs 2.12.27__py2.py3-none-any.whl → 2.12.29__py2.py3-none-any.whl

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

@@ -1,51 +1,29 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.992778                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.639271                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.parameters
     import metaflow.exception
-    import metaflow.metaflow_current
-    import metaflow.decorators
 
-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):
-        ...
-    def __str__(self):
-        ...
-    ...
-
-class MetaflowInternalError(metaflow.exception.MetaflowException, metaclass=type):
-    ...
+from ....parameters import JSONType as JSONType
+from ....metaflow_current import current as current
+from .... import parameters as parameters
+from ....client.core import get_metadata as get_metadata
+from ...._vendor import click as click
+from ....exception import MetaflowException as MetaflowException
+from ....exception import MetaflowInternalError as MetaflowInternalError
+from ..batch.batch_decorator import BatchDecorator as BatchDecorator
+from ....tagging_util import validate_tags as validate_tags
+from .production_token import load_token as load_token
+from .production_token import new_token as new_token
+from .production_token import store_token as store_token
+from .step_functions import StepFunctions as StepFunctions
 
 SERVICE_VERSION_CHECK: bool
 
@@ -53,140 +31,6 @@ SFN_STATE_MACHINE_PREFIX: None
 
 UI_URL: None
 
-class BatchDecorator(metaflow.decorators.StepDecorator, metaclass=type):
-    """
-    Specifies that this step should execute on [AWS Batch](https://aws.amazon.com/batch/).
-    
-    Parameters
-    ----------
-    cpu : int, default 1
-        Number of CPUs required for this step. If `@resources` is
-        also present, the maximum value from all decorators is used.
-    gpu : int, default 0
-        Number of GPUs required for this step. If `@resources` is
-        also present, the maximum value from all decorators is used.
-    memory : int, default 4096
-        Memory size (in MB) required for this step. If
-        `@resources` is also present, the maximum value from all decorators is
-        used.
-    image : str, optional, default None
-        Docker image to use when launching on AWS Batch. If not specified, and
-        METAFLOW_BATCH_CONTAINER_IMAGE is specified, that image is used. If
-        not, a default Docker image mapping to the current version of Python is used.
-    queue : str, default METAFLOW_BATCH_JOB_QUEUE
-        AWS Batch Job Queue to submit the job to.
-    iam_role : str, default METAFLOW_ECS_S3_ACCESS_IAM_ROLE
-        AWS IAM role that AWS Batch container uses to access AWS cloud resources.
-    execution_role : str, default METAFLOW_ECS_FARGATE_EXECUTION_ROLE
-        AWS IAM role that AWS Batch can use [to trigger AWS Fargate tasks]
-        (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html).
-    shared_memory : int, optional, default None
-        The value for the size (in MiB) of the /dev/shm volume for this step.
-        This parameter maps to the `--shm-size` option in Docker.
-    max_swap : int, optional, default None
-        The total amount of swap memory (in MiB) a container can use for this
-        step. This parameter is translated to the `--memory-swap` option in
-        Docker where the value is the sum of the container memory plus the
-        `max_swap` value.
-    swappiness : int, optional, default None
-        This allows you to tune memory swappiness behavior for this step.
-        A swappiness value of 0 causes swapping not to happen unless absolutely
-        necessary. A swappiness value of 100 causes pages to be swapped very
-        aggressively. Accepted values are whole numbers between 0 and 100.
-    use_tmpfs : bool, default False
-        This enables an explicit tmpfs mount for this step. Note that tmpfs is
-        not available on Fargate compute environments
-    tmpfs_tempdir : bool, default True
-        sets METAFLOW_TEMPDIR to tmpfs_path if set for this step.
-    tmpfs_size : int, optional, default None
-        The value for the size (in MiB) of the tmpfs mount for this step.
-        This parameter maps to the `--tmpfs` option in Docker. Defaults to 50% of the
-        memory allocated for this step.
-    tmpfs_path : str, optional, default None
-        Path to tmpfs mount for this step. Defaults to /metaflow_temp.
-    inferentia : int, default 0
-        Number of Inferentia chips required for this step.
-    trainium : int, default None
-        Alias for inferentia. Use only one of the two.
-    efa : int, default 0
-        Number of elastic fabric adapter network devices to attach to container
-    ephemeral_storage : int, default None
-        The total amount, in GiB, of ephemeral storage to set for the task, 21-200GiB.
-        This is only relevant for Fargate compute environments
-    log_driver: str, optional, default None
-        The log driver to use for the Amazon ECS container.
-    log_options: List[str], optional, default None
-        List of strings containing options for the chosen log driver. The configurable values
-        depend on the `log driver` chosen. Validation of these options is not supported yet.
-        Example: [`awslogs-group:aws/batch/job`]
-    """
-    def __init__(self, attributes = None, statically_defined = False):
-        ...
-    def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):
-        ...
-    def runtime_init(self, flow, graph, package, run_id):
-        ...
-    def runtime_task_created(self, task_datastore, task_id, split_index, input_paths, is_cloned, ubf_context):
-        ...
-    def runtime_step_cli(self, cli_args, retry_count, max_user_code_retries, ubf_context):
-        ...
-    def task_pre_step(self, step_name, task_datastore, metadata, run_id, task_id, flow, graph, retry_count, max_retries, ubf_context, inputs):
-        ...
-    def task_finished(self, step_name, flow, graph, is_task_ok, retry_count, max_retries):
-        ...
-    ...
-
-def validate_tags(tags, existing_tags = None):
-    """
-    Raises MetaflowTaggingError if invalid based on these rules:
-    
-    Tag set size is too large. But it's OK if tag set is not larger
-    than an existing tag set (if provided).
-    
-    Then, we validate each tag.  See validate_tag()
-    """
-    ...
-
-def load_token(token_prefix):
-    ...
-
-def new_token(token_prefix, prev_token = None):
-    ...
-
-def store_token(token_prefix, token):
-    ...
-
-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 IncorrectProductionToken(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                                                            #
-# Generated on 2024-10-24T19:27:17.987023                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.636995                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 AWS_SANDBOX_ENABLED: bool
 
 AWS_SANDBOX_REGION: None

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

@@ -1,47 +1,18 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.986103                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.635556                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.decorators
 
-class MetaDatum(tuple, metaclass=type):
-    """
-    MetaDatum(field, value, type, tags)
-    """
-    @staticmethod
-    def __new__(_cls, field, value, type, tags):
-        """
-        Create new instance of MetaDatum(field, value, type, tags)
-        """
-        ...
-    def __repr__(self):
-        """
-        Return a nicely formatted representation string
-        """
-        ...
-    def __getnewargs__(self):
-        """
-        Return self as a plain tuple.  Used by copy and pickle.
-        """
-        ...
-    ...
-
-class DynamoDbClient(object, metaclass=type):
-    def __init__(self):
-        ...
-    def save_foreach_cardinality(self, foreach_split_task_id, foreach_cardinality, ttl):
-        ...
-    def save_parent_task_id_for_foreach_join(self, foreach_split_task_id, foreach_join_parent_task_id):
-        ...
-    def get_parent_task_ids_for_foreach_join(self, foreach_split_task_id):
-        ...
-    ...
+from ....metadata_provider.metadata import MetaDatum as MetaDatum
+from .dynamo_db_client import DynamoDbClient as DynamoDbClient
 
 class StepFunctionsInternalDecorator(metaflow.decorators.StepDecorator, metaclass=type):
     def task_pre_step(self, step_name, task_datastore, metadata, run_id, task_id, flow, graph, retry_count, max_user_code_retries, ubf_context, inputs):

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

@@ -1,321 +1,84 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.27                                                            #
-# Generated on 2024-10-24T19:27:17.990879                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.636274                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
-    import metaflow.runner.deployer
+    import metaflow.runner.deployer_impl
+    import metaflow.plugins.aws.step_functions.step_functions_deployer_objects
+    import typing
 
-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=type):
-    """
-    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]:
         ...
-    ...
-
-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):
+    @staticmethod
+    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.
         """
         ...
     ...