ob-metaflow-stubs 2.11.4.1__py2.py3-none-any.whl

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

@@ -0,0 +1,159 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.000374                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.exception
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+AWS_SANDBOX_ENABLED: bool
+
+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):
+        ...
+    ...
+
+class BatchJobException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class BatchJob(object, metaclass=type):
+    def __init__(self, client):
+        ...
+    def execute(self):
+        ...
+    def job_def(self, image, iam_role, job_queue, execution_role, shared_memory, max_swap, swappiness, inferentia, efa, memory, host_volumes, efs_volumes, use_tmpfs, tmpfs_tempdir, tmpfs_size, tmpfs_path, num_parallel):
+        ...
+    def job_name(self, job_name):
+        ...
+    def job_queue(self, job_queue):
+        ...
+    def image(self, image):
+        ...
+    def task_id(self, task_id):
+        ...
+    def iam_role(self, iam_role):
+        ...
+    def execution_role(self, execution_role):
+        ...
+    def shared_memory(self, shared_memory):
+        ...
+    def max_swap(self, max_swap):
+        ...
+    def swappiness(self, swappiness):
+        ...
+    def inferentia(self, inferentia):
+        ...
+    def efa(self, efa):
+        ...
+    def command(self, command):
+        ...
+    def cpu(self, cpu):
+        ...
+    def memory(self, mem):
+        ...
+    def gpu(self, gpu):
+        ...
+    def environment_variable(self, name, value):
+        ...
+    def timeout_in_secs(self, timeout_in_secs):
+        ...
+    def tag(self, key, value):
+        ...
+    def parameter(self, key, value):
+        ...
+    def attempts(self, attempts):
+        ...
+    ...
+
+class Throttle(object, metaclass=type):
+    def __init__(self, delta_in_secs = 1, num_tries = 20):
+        ...
+    def __call__(self, func):
+        ...
+    ...
+
+class TriableException(Exception, metaclass=type):
+    def __init__(self, ex):
+        ...
+    ...
+
+class RunningJob(object, metaclass=type):
+    def __init__(self, id, client):
+        ...
+    def __repr__(self):
+        ...
+    def _update(*args, **kwargs):
+        ...
+    def update(self):
+        ...
+    @property
+    def id(self):
+        ...
+    @property
+    def info(self):
+        ...
+    @property
+    def job_name(self):
+        ...
+    @property
+    def job_queue(self):
+        ...
+    @property
+    def status(self):
+        ...
+    @property
+    def status_reason(self):
+        ...
+    @property
+    def created_at(self):
+        ...
+    @property
+    def stopped_at(self):
+        ...
+    @property
+    def is_done(self):
+        ...
+    @property
+    def is_running(self):
+        ...
+    @property
+    def is_successful(self):
+        ...
+    @property
+    def is_crashed(self):
+        ...
+    @property
+    def reason(self):
+        ...
+    @property
+    def status_code(self):
+        ...
+    def kill(self):
+        ...
+    ...
+

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

@@ -0,0 +1,145 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.003125                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
+    import metaflow.decorators
+    import metaflow.exception
+
+current: metaflow.metaflow_current.Current
+
+class ResourcesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    ...
+
+def get_run_time_limit_for_task(step_decos):
+    ...
+
+class MetaDatum(tuple, metaclass=type):
+    @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):
+    ...
+
+ECS_S3_ACCESS_IAM_ROLE: None
+
+BATCH_JOB_QUEUE: None
+
+BATCH_CONTAINER_IMAGE: None
+
+BATCH_CONTAINER_REGISTRY: None
+
+ECS_FARGATE_EXECUTION_ROLE: None
+
+DATASTORE_LOCAL_DIR: str
+
+UBF_CONTROL: str
+
+class BatchException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+def compute_resource_attributes(decos, compute_deco, step_name, 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):
+    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):
+        ...
+    ...
+

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

@@ -0,0 +1,9 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.956943                                        #
+##################################################################################
+
+from __future__ import annotations
+
+

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

@@ -0,0 +1,73 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.011320                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.secrets
+    import abc
+    import metaflow.exception
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+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):
+    ...
+
+class MetaflowAWSSecretsManagerDuplicateKey(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class MetaflowAWSSecretsManagerJSONParseError(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class MetaflowAWSSecretsManagerNotJSONObject(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class AwsSecretsManagerSecretsProvider(metaflow.plugins.secrets.SecretsProvider, metaclass=abc.ABCMeta):
+    def get_secret_as_dict(self, secret_id, options = {}, role = None):
+        """
+        Reads a secret from AWS Secrets Manager and returns it as a dictionary of environment variables.
+        
+        The secret payload from AWS is EITHER a string OR a binary blob.
+        
+        If the secret contains a string payload ("SecretString"):
+        - if the `parse_secret_string_as_json` option is True (default):
+            {SecretString} will be parsed as a JSON. If successfully parsed, AND the JSON contains a
+            top-level object, each entry K/V in the object will also be converted to an entry in the result. V will
+            always be casted to a string (if not already a string).
+        - If `parse_secret_string_as_json` option is False:
+            {SecretString} will be returned as a single entry in the result, with the key being the secret_id.
+        
+        Otherwise, the secret contains a binary blob payload ("SecretBinary"). In this case
+        - The result dic contains '{SecretName}': '{SecretBinary}', where {SecretBinary} is a base64-encoded string
+        
+        All keys in the result are sanitized to be more valid environment variable names. This is done on a best effort
+        basis. Further validation is expected to be done by the invoking @secrets decorator itself.
+        
+        :param secret_id: ARN or friendly name of the secret
+        :param options: unused
+        :param role: AWS IAM Role ARN to assume before reading the secret
+        :return: dict of environment variables. All keys and values are strings.
+        """
+        ...
+    ...
+

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

@@ -0,0 +1,9 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.956417                                        #
+##################################################################################
+
+from __future__ import annotations
+
+

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

@@ -0,0 +1,22 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.004206                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+SFN_DYNAMO_DB_TABLE: None
+
+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):
+        ...
+    ...
+

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

@@ -0,0 +1,27 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.005604                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+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):
+        ...
+    ...
+
+def format(name):
+    ...
+

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

@@ -0,0 +1,18 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.005230                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+def new_token(token_prefix, prev_token = None):
+    ...
+
+def load_token(token_prefix):
+    ...
+
+def store_token(token_prefix, token):
+    ...
+

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

@@ -0,0 +1,17 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.004936                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.decorators
+
+class ScheduleDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    def flow_init(self, flow, graph, environment, flow_datastore, metadata, logger, echo, options):
+        ...
+    ...
+