metaflow-stubs 2.12.28__py2.py3-none-any.whl → 2.12.30__py2.py3-none-any.whl

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

@@ -1,46 +1,20 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.556232                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.370444                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
 
-class S3Tail(object, metaclass=type):
-    def __init__(self, s3url):
-        ...
-    def reset_client(self, hard_reset = False):
-        ...
-    def clone(self, s3url):
-        ...
-    @property
-    def bytes_read(self):
-        ...
-    @property
-    def tail(self):
-        ...
-    def __iter__(self):
-        ...
-    def _make_range_request(self, *args, **kwargs):
-        ...
-    ...
-
-def sanitize_batch_tag(key, value):
-    """
-    Sanitize a key and value for use as a Batch tag.
-    """
-    ...
-
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ...datatools.s3.s3tail import S3Tail as S3Tail
+from ..aws_utils import sanitize_batch_tag as sanitize_batch_tag
+from ....exception import MetaflowException as MetaflowException
+from .batch_client import BatchClient as BatchClient
 
 OTEL_ENDPOINT: None
 
@@ -68,25 +42,6 @@ S3_SERVER_SIDE_ENCRYPTION: None
 
 BASH_SAVE_LOGS: str
 
-class BatchClient(object, metaclass=type):
-    def __init__(self):
-        ...
-    def active_job_queues(self):
-        ...
-    def unfinished_jobs(self):
-        ...
-    def describe_jobs(self, job_ids):
-        ...
-    def describe_job_queue(self, job_queue):
-        ...
-    def job(self):
-        ...
-    def attach_job(self, job_id):
-        ...
-    def region(self):
-        ...
-    ...
-
 LOGS_DIR: str
 
 STDOUT_FILE: str

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

@@ -1,23 +1,20 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.557921                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.371434                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.exception
 
-class CommandException(metaflow.exception.MetaflowException, metaclass=type):
-    ...
+from ...._vendor import click as click
+from ....exception import CommandException as CommandException
+from ....metadata_provider.util import sync_local_metadata_from_datastore as sync_local_metadata_from_datastore
+from .batch import Batch as Batch
+from .batch import BatchKilledException as BatchKilledException
 
 METAFLOW_EXIT_DISALLOW_RETRY: int
 
-def sync_local_metadata_from_datastore(metadata_local_dir, task_ds):
-    ...
-
 DATASTORE_LOCAL_DIR: str
 
 TASK_LOG_SOURCE: str
@@ -26,21 +23,3 @@ UBF_CONTROL: str
 
 UBF_TASK: str
 
-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 BatchKilledException(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-

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

@@ -1,21 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.555029                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.369456                                                            #
+######################################################################################################
 
 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
 
 AWS_SANDBOX_ENABLED: bool
 

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

@@ -1,80 +1,25 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.557217                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.371146                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.decorators
-    import metaflow.metaflow_current
-    import metaflow.exception
 
-current: metaflow.metaflow_current.Current
-
-class ResourcesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
-    """
-    Specifies the resources needed when executing this step.
-    
-    Use `@resources` to specify the resource requirements
-    independently of the specific compute layer (`@batch`, `@kubernetes`).
-    
-    You can choose the compute layer on the command line by executing e.g.
-    ```
-    python myflow.py run --with batch
-    ```
-    or
-    ```
-    python myflow.py run --with kubernetes
-    ```
-    which executes the flow on the desired system using the
-    requirements specified in `@resources`.
-    
-    Parameters
-    ----------
-    cpu : int, default 1
-        Number of CPUs required for this step.
-    gpu : int, optional, default None
-        Number of GPUs required for this step.
-    disk : int, optional, default None
-        Disk size (in MB) required for this step. Only applies on Kubernetes.
-    memory : int, default 4096
-        Memory size (in MB) required for this step.
-    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.
-    """
-    ...
-
-def get_run_time_limit_for_task(step_decos):
-    ...
-
-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.
-        """
-        ...
-    ...
-
-def sync_local_metadata_to_datastore(metadata_local_dir, task_ds):
-    ...
+from ....metaflow_current import current as current
+from ...resources_decorator import ResourcesDecorator as ResourcesDecorator
+from ...timeout_decorator import get_run_time_limit_for_task as get_run_time_limit_for_task
+from ....metadata_provider.metadata import MetaDatum as MetaDatum
+from ....metadata_provider.util import sync_local_metadata_to_datastore as sync_local_metadata_to_datastore
+from .batch import BatchException as BatchException
+from ..aws_utils import compute_resource_attributes as compute_resource_attributes
+from ..aws_utils import get_docker_registry as get_docker_registry
+from ..aws_utils import get_ec2_instance_metadata as get_ec2_instance_metadata
 
 ECS_S3_ACCESS_IAM_ROLE: None
 
@@ -90,76 +35,6 @@ DATASTORE_LOCAL_DIR: str
 
 UBF_CONTROL: str
 
-class BatchException(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-def compute_resource_attributes(decos, compute_deco, resource_defaults):
-    """
-    Compute resource values taking into account defaults, the values specified
-    in the compute decorator (like @batch or @kubernetes) directly, and
-    resources specified via @resources decorator.
-    
-    Returns a dictionary of resource attr -> value (str).
-    """
-    ...
-
-def get_docker_registry(image_uri):
-    """
-    Explanation:
-        (.+?(?:[:.].+?)\/)? - [GROUP 0] REGISTRY
-            .+?                  - A registry must start with at least one character
-            (?:[:.].+?)\/       - A registry must have ":" or "." and end with "/"
-            ?                    - Make a registry optional
-        (.*?)                - [GROUP 1] REPOSITORY
-            .*?                  - Get repository name until separator
-        (?:[@:])?            - SEPARATOR
-            ?:                   - Don't capture separator
-            [@:]                 - The separator must be either "@" or ":"
-            ?                    - The separator is optional
-        ((?<=[@:]).*)?       - [GROUP 2] TAG / DIGEST
-            (?<=[@:])            - A tag / digest must be preceded by "@" or ":"
-            .*                   - Capture rest of tag / digest
-            ?                    - A tag / digest is optional
-    Examples:
-        image
-            - None
-            - image
-            - None
-        example/image
-            - None
-            - example/image
-            - None
-        example/image:tag
-            - None
-            - example/image
-            - tag
-        example.domain.com/example/image:tag
-            - example.domain.com/
-            - example/image
-            - tag
-        123.123.123.123:123/example/image:tag
-            - 123.123.123.123:123/
-            - example/image
-            - tag
-        example.domain.com/example/image@sha256:45b23dee0
-            - example.domain.com/
-            - example/image
-            - sha256:45b23dee0
-    """
-    ...
-
-def get_ec2_instance_metadata():
-    """
-    Fetches the EC2 instance metadata through AWS instance metadata service
-    
-    Returns either an empty dictionary, or one with the keys
-        - ec2-instance-id
-        - ec2-instance-type
-        - ec2-region
-        - ec2-availability-zone
-    """
-    ...
-
 class BatchDecorator(metaflow.decorators.StepDecorator, metaclass=type):
     """
     Specifies that this step should execute on [AWS Batch](https://aws.amazon.com/batch/).

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

@@ -1,9 +1,11 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.500583                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.337385                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+from . import aws_secrets_manager_secrets_provider as aws_secrets_manager_secrets_provider
+

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

@@ -1,35 +1,24 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.558402                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.371787                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import abc
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.secrets
     import abc
     import metaflow.exception
+    import metaflow.plugins.secrets
 
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ....exception import MetaflowException as MetaflowException
+from ...secrets import SecretsProvider as SecretsProvider
 
 AWS_SECRETS_MANAGER_DEFAULT_REGION: None
 
-class SecretsProvider(abc.ABC, metaclass=abc.ABCMeta):
-    def get_secret_as_dict(self, secret_id, options = {}, role = None) -> typing.Dict[str, str]:
-        """
-        Retrieve the secret from secrets backend, and return a dictionary of
-        environment variables.
-        """
-        ...
-    ...
-
 class MetaflowAWSSecretsManagerBadResponse(metaflow.exception.MetaflowException, metaclass=type):
     """
     Raised when the response from AWS Secrets Manager is not valid in some way

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

@@ -1,9 +1,19 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.499671                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.335653                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+from . import dynamo_db_client as dynamo_db_client
+from . import step_functions_decorator as step_functions_decorator
+from . import schedule_decorator as schedule_decorator
+from . import step_functions_deployer as step_functions_deployer
+from . import production_token as production_token
+from . import event_bridge_client as event_bridge_client
+from . import step_functions_client as step_functions_client
+from . import step_functions as step_functions
+from . import step_functions_cli as step_functions_cli
+

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

@@ -1,12 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.546418                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.363729                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 SFN_DYNAMO_DB_TABLE: None
 
 class DynamoDbClient(object, metaclass=type):

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

@@ -1,12 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.547399                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.365320                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 class EventBridgeClient(object, metaclass=type):
     def __init__(self, name):
         ...

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

@@ -1,12 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.551943                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.364969                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 def new_token(token_prefix, prev_token = None):
     ...
 

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

@@ -1,15 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.547078                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.364245                                                            #
+######################################################################################################
 
 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.28                                                            #
-# Generated on 2024-11-01T10:21:04.550150                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.30                                                                                #
+# Generated on 2024-11-13T13:50:31.367351                                                            #
+######################################################################################################
 
 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):
     ...