ob-metaflow-stubs 4.9__py2.py3-none-any.whl → 5.1__py2.py3-none-any.whl

metaflow-stubs/plugins/airflow/airflow.pyi

@@ -1,187 +0,0 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.10.1+ob(v1)                                                   #
-# Generated on 2024-07-31T05:43:21.028106                                        #
-##################################################################################
-
-from __future__ import annotations
-
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow._vendor.click.types
-    import metaflow.exception
-    import metaflow.metaflow_current
-
-current: metaflow.metaflow_current.Current
-
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
-
-class FilePathClass(metaflow._vendor.click.types.ParamType, metaclass=type):
-    def __init__(self, is_text, encoding):
-        ...
-    def convert(self, value, param, ctx):
-        ...
-    def __str__(self):
-        ...
-    def __repr__(self):
-        ...
-    ...
-
-AIRFLOW_KUBERNETES_CONN_ID: None
-
-AIRFLOW_KUBERNETES_KUBECONFIG_CONTEXT: None
-
-AIRFLOW_KUBERNETES_KUBECONFIG_FILE: None
-
-AIRFLOW_KUBERNETES_STARTUP_TIMEOUT_SECONDS: int
-
-AWS_SECRETS_MANAGER_DEFAULT_REGION: None
-
-GCP_SECRET_MANAGER_PREFIX: None
-
-AZURE_STORAGE_BLOB_SERVICE_ENDPOINT: None
-
-CARD_AZUREROOT: None
-
-CARD_GSROOT: None
-
-CARD_S3ROOT: None
-
-DATASTORE_SYSROOT_AZURE: None
-
-DATASTORE_SYSROOT_GS: None
-
-DATASTORE_SYSROOT_S3: None
-
-DATATOOLS_S3ROOT: None
-
-DEFAULT_SECRETS_BACKEND_TYPE: None
-
-KUBERNETES_SECRETS: str
-
-KUBERNETES_SERVICE_ACCOUNT: None
-
-S3_ENDPOINT_URL: None
-
-SERVICE_HEADERS: dict
-
-SERVICE_INTERNAL_URL: None
-
-AZURE_KEY_VAULT_PREFIX: None
-
-class DelayedEvaluationParameter(object, metaclass=type):
-    def __init__(self, name, field, fun):
-        ...
-    def __call__(self, return_str = False):
-        ...
-    ...
-
-class JSONTypeClass(metaflow._vendor.click.types.ParamType, metaclass=type):
-    def convert(self, value, param, ctx):
-        ...
-    def __str__(self):
-        ...
-    def __repr__(self):
-        ...
-    ...
-
-def deploy_time_eval(value):
-    ...
-
-class Kubernetes(object, metaclass=type):
-    def __init__(self, datastore, metadata, environment):
-        ...
-    def launch_job(self, **kwargs):
-        ...
-    def create_jobset(self, flow_name, run_id, step_name, task_id, attempt, user, code_package_sha, code_package_url, code_package_ds, docker_image, docker_image_pull_policy, step_cli = None, service_account = None, secrets = None, node_selector = None, namespace = None, cpu = None, gpu = None, gpu_vendor = None, disk = None, memory = None, use_tmpfs = None, tmpfs_tempdir = None, tmpfs_size = None, tmpfs_path = None, run_time_limit = None, env = None, persistent_volume_claims = None, tolerations = None, labels = None, shared_memory = None, port = None, num_parallel = None):
-        ...
-    def create_job_object(self, flow_name, run_id, step_name, task_id, attempt, user, code_package_sha, code_package_url, code_package_ds, step_cli, docker_image, docker_image_pull_policy, service_account = None, secrets = None, node_selector = None, namespace = None, cpu = None, gpu = None, gpu_vendor = None, disk = None, memory = None, use_tmpfs = None, tmpfs_tempdir = None, tmpfs_size = None, tmpfs_path = None, run_time_limit = None, env = None, persistent_volume_claims = None, tolerations = None, labels = None, shared_memory = None, port = None, name_pattern = None):
-        ...
-    def create_k8sjob(self, job):
-        ...
-    def wait(self, stdout_location, stderr_location, echo = None):
-        ...
-    ...
-
-def get_run_time_limit_for_task(step_decos):
-    ...
-
-class AIRFLOW_MACROS(object, metaclass=type):
-    @classmethod
-    def create_task_id(cls, is_foreach):
-        ...
-    @classmethod
-    def pathspec(cls, flowname, is_foreach = False):
-        ...
-    ...
-
-TASK_ID_XCOM_KEY: str
-
-class AirflowTask(object, metaclass=type):
-    def __init__(self, name, operator_type = "kubernetes", flow_name = None, is_mapper_node = False, flow_contains_foreach = False):
-        ...
-    @property
-    def is_mapper_node(self):
-        ...
-    def set_operator_args(self, **kwargs):
-        ...
-    def to_dict(self):
-        ...
-    @classmethod
-    def from_dict(cls, task_dict, flow_name = None, flow_contains_foreach = False):
-        ...
-    def to_task(self):
-        ...
-    ...
-
-class Workflow(object, metaclass=type):
-    def __init__(self, file_path = None, graph_structure = None, metadata = None, **kwargs):
-        ...
-    def set_parameters(self, params):
-        ...
-    def add_state(self, state):
-        ...
-    def to_dict(self):
-        ...
-    def to_json(self):
-        ...
-    @classmethod
-    def from_dict(cls, data_dict):
-        ...
-    @classmethod
-    def from_json(cls, json_string):
-        ...
-    def compile(self):
-        ...
-    ...
-
-class AirflowException(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, msg):
-        ...
-    ...
-
-SUPPORTED_SENSORS: list
-
-AIRFLOW_DEPLOY_TEMPLATE_FILE: str
-
-class Airflow(object, metaclass=type):
-    def __init__(self, name, graph, flow, code_package_sha, code_package_url, metadata, flow_datastore, environment, event_logger, monitor, production_token, tags = None, namespace = None, username = None, max_workers = None, worker_pool = None, description = None, file_path = None, workflow_timeout = None, is_paused_upon_creation = True):
-        ...
-    @classmethod
-    def get_existing_deployment(cls, name, flow_datastore):
-        ...
-    @classmethod
-    def get_token_path(cls, name):
-        ...
-    @classmethod
-    def save_deployment_token(cls, owner, name, token, flow_datastore):
-        ...
-    def compile(self):
-        ...
-    ...
-

metaflow-stubs/plugins/airflow/airflow_cli.pyi

@@ -1,90 +0,0 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.10.1+ob(v1)                                                   #
-# Generated on 2024-07-31T05:43:21.029019                                        #
-##################################################################################
-
-from __future__ import annotations
-
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.decorators
-    import metaflow.exception
-    import metaflow.metaflow_current
-
-current: metaflow.metaflow_current.Current
-
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
-
-class MetaflowInternalError(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-def load_token(token_prefix):
-    ...
-
-def new_token(token_prefix, prev_token = None):
-    ...
-
-def store_token(token_prefix, token):
-    ...
-
-class KubernetesDecorator(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 package_init(self, flow, step_name, environment):
-        ...
-    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):
-        ...
-    ...
-
-class Airflow(object, metaclass=type):
-    def __init__(self, name, graph, flow, code_package_sha, code_package_url, metadata, flow_datastore, environment, event_logger, monitor, production_token, tags = None, namespace = None, username = None, max_workers = None, worker_pool = None, description = None, file_path = None, workflow_timeout = None, is_paused_upon_creation = True):
-        ...
-    @classmethod
-    def get_existing_deployment(cls, name, flow_datastore):
-        ...
-    @classmethod
-    def get_token_path(cls, name):
-        ...
-    @classmethod
-    def save_deployment_token(cls, owner, name, token, flow_datastore):
-        ...
-    def compile(self):
-        ...
-    ...
-
-class AirflowException(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, msg):
-        ...
-    ...
-
-class NotSupportedException(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-class IncorrectProductionToken(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-def resolve_token(name, token_prefix, obj, authorize, given_token, generate_new_token, is_project):
-    ...
-
-def make_flow(obj, dag_name, production_token, tags, is_paused_upon_creation, namespace, max_workers, workflow_timeout, worker_pool, file):
-    ...
-
-def resolve_dag_name(name):
-    ...
-

metaflow-stubs/plugins/airflow/airflow_decorator.pyi

@@ -1,50 +0,0 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.10.1+ob(v1)                                                   #
-# Generated on 2024-07-31T05:43:21.026122                                        #
-##################################################################################
-
-from __future__ import annotations
-
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.decorators
-
-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.
-        """
-        ...
-    ...
-
-TASK_ID_XCOM_KEY: str
-
-FOREACH_CARDINALITY_XCOM_KEY: str
-
-K8S_XCOM_DIR_PATH: str
-
-def safe_mkdir(dir):
-    ...
-
-def push_xcom_values(xcom_dict):
-    ...
-
-class AirflowInternalDecorator(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):
-        ...
-    def task_finished(self, step_name, flow, graph, is_task_ok, retry_count, max_user_code_retries):
-        ...
-    ...
-

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

@@ -1,46 +0,0 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.10.1+ob(v1)                                                   #
-# Generated on 2024-07-31T05:43:21.060159                                        #
-##################################################################################
-
-from __future__ import annotations
-
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.exception
-
-class CommandException(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-METAFLOW_EXIT_DISALLOW_RETRY: int
-
-def sync_local_metadata_from_datastore(metadata_local_dir, task_ds):
-    ...
-
-DATASTORE_LOCAL_DIR: str
-
-TASK_LOG_SOURCE: str
-
-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_decorator.pyi

@@ -1,145 +0,0 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.10.1+ob(v1)                                                   #
-# Generated on 2024-07-31T05:43:21.059594                                        #
-##################################################################################
-
-from __future__ import annotations
-
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.decorators
-    import metaflow.exception
-    import metaflow.metaflow_current
-
-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/step_functions/dynamo_db_client.pyi

@@ -1,22 +0,0 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.10.1+ob(v1)                                                   #
-# Generated on 2024-07-31T05:43:21.051337                                        #
-##################################################################################
-
-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/step_functions_cli.pyi

@@ -1,159 +0,0 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.10.1+ob(v1)                                                   #
-# Generated on 2024-07-31T05:43:21.056756                                        #
-##################################################################################
-
-from __future__ import annotations
-
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.decorators
-    import metaflow.exception
-    import metaflow.metaflow_current
-    import metaflow.parameters
-
-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):
-    ...
-
-SERVICE_VERSION_CHECK: bool
-
-SFN_STATE_MACHINE_PREFIX: None
-
-UI_URL: None
-
-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):
-        ...
-    ...
-
-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):
-    ...
-
-class RunIdMismatch(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-class IncorrectMetadataServiceVersion(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-class StepFunctionsStateMachineNameTooLong(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-def check_metadata_service_version(obj):
-    ...
-
-def resolve_state_machine_name(obj, name):
-    ...
-
-def make_flow(obj, token, name, tags, namespace, max_workers, workflow_timeout, is_project, use_distributed_map):
-    ...
-
-def resolve_token(name, token_prefix, obj, authorize, given_token, generate_new_token, is_project):
-    ...
-
-def validate_run_id(state_machine_name, token_prefix, authorize, run_id, instructions_fn = None):
-    ...
-
-def validate_token(name, token_prefix, authorize, instruction_fn = None):
-    """
-    Validate that the production token matches that of the deployed flow.
-    
-    In case both the user and token do not match, raises an error.
-    Optionally outputs instructions on token usage via the provided instruction_fn(flow_name, prev_user)
-    """
-    ...
-