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

metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi

@@ -0,0 +1,165 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.954547                                        #
+##################################################################################
+
+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 MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+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):
+    ...
+
+DATASTORE_LOCAL_DIR: str
+
+KUBERNETES_CONTAINER_IMAGE: None
+
+KUBERNETES_CONTAINER_REGISTRY: None
+
+KUBERNETES_FETCH_EC2_METADATA: bool
+
+KUBERNETES_IMAGE_PULL_POLICY: None
+
+KUBERNETES_GPU_VENDOR: str
+
+KUBERNETES_NAMESPACE: str
+
+KUBERNETES_NODE_SELECTOR: str
+
+KUBERNETES_PERSISTENT_VOLUME_CLAIMS: str
+
+KUBERNETES_TOLERATIONS: str
+
+KUBERNETES_SERVICE_ACCOUNT: None
+
+KUBERNETES_PORT: None
+
+KUBERNETES_SHARED_MEMORY: None
+
+class ResourcesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    ...
+
+def get_run_time_limit_for_task(step_decos):
+    ...
+
+UBF_CONTROL: 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 KubernetesException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+def parse_kube_keyvalue_list(items: typing.List[str], requires_both: bool = True):
+    ...
+
+MAX_MEMORY_PER_TASK: None
+
+MAX_CPU_PER_TASK: None
+
+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):
+        ...
+    ...
+

metaflow-stubs/plugins/kubernetes/kubernetes_job.pyi

@@ -0,0 +1,100 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.951085                                        #
+##################################################################################
+
+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):
+        ...
+    ...
+
+KUBERNETES_SECRETS: str
+
+CLIENT_REFRESH_INTERVAL_SECONDS: int
+
+class KubernetesJobException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+def k8s_retry(deadline_seconds = 60, max_backoff = 32):
+    ...
+
+class KubernetesJob(object, metaclass=type):
+    def __init__(self, client, **kwargs):
+        ...
+    def create(self):
+        ...
+    def execute(self):
+        ...
+    def step_name(self, step_name):
+        ...
+    def namespace(self, namespace):
+        ...
+    def name(self, name):
+        ...
+    def command(self, command):
+        ...
+    def image(self, image):
+        ...
+    def cpu(self, cpu):
+        ...
+    def memory(self, mem):
+        ...
+    def environment_variable(self, name, value):
+        ...
+    def label(self, name, value):
+        ...
+    def annotation(self, name, value):
+        ...
+    ...
+
+class RunningJob(object, metaclass=type):
+    def __init__(self, client, name, uid, namespace):
+        ...
+    def __repr__(self):
+        ...
+    def kill(self):
+        ...
+    @property
+    def id(self):
+        ...
+    @property
+    def is_done(self):
+        ...
+    @property
+    def status(self):
+        ...
+    @property
+    def has_succeeded(self):
+        ...
+    @property
+    def has_failed(self):
+        ...
+    @property
+    def _have_containers_succeeded(self):
+        ...
+    @property
+    def _has_any_container_failed(self):
+        ...
+    @property
+    def _are_pod_containers_done(self):
+        ...
+    @property
+    def is_running(self):
+        ...
+    @property
+    def is_waiting(self):
+        ...
+    @property
+    def reason(self):
+        ...
+    ...
+

metaflow-stubs/plugins/package_cli.pyi

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

metaflow-stubs/plugins/parallel_decorator.pyi

@@ -0,0 +1,34 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.929728                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.decorators
+
+UBF_CONTROL: str
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+class ParallelDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    def __init__(self, attributes = None, statically_defined = False):
+        ...
+    def runtime_step_cli(self, cli_args, retry_count, max_user_code_retries, ubf_context):
+        ...
+    def step_init(self, flow, graph, step_name, decorators, environment, flow_datastore, logger):
+        ...
+    def task_decorate(self, step_func, flow, graph, retry_count, max_user_code_retries, ubf_context):
+        ...
+    def setup_distributed_env(self, flow):
+        ...
+    ...
+

metaflow-stubs/plugins/project_decorator.pyi

@@ -0,0 +1,36 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.933532                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
+    import metaflow.decorators
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+current: metaflow.metaflow_current.Current
+
+VALID_NAME_RE: str
+
+VALID_NAME_LEN: int
+
+class ProjectDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    def flow_init(self, flow, graph, environment, flow_datastore, metadata, logger, echo, options):
+        ...
+    def get_top_level_options(self):
+        ...
+    ...
+
+def format_name(flow_name, project_name, deploy_prod, given_branch, user_name):
+    ...
+

metaflow-stubs/plugins/pypi/__init__.pyi

@@ -0,0 +1,18 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.928983                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+MAGIC_FILE: str
+

metaflow-stubs/plugins/pypi/conda_decorator.pyi

@@ -0,0 +1,59 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.958051                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.decorators
+
+EXT_PKG: str
+
+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.
+        """
+        ...
+    ...
+
+INFO_FILE: str
+
+class CondaStepDecorator(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 task_pre_step(self, step_name, task_datastore, meta, run_id, task_id, flow, graph, retry_count, max_retries, ubf_context, inputs):
+        ...
+    def runtime_step_cli(self, cli_args, retry_count, max_user_code_retries, ubf_context):
+        ...
+    def runtime_finished(self, exception):
+        ...
+    ...
+
+class CondaFlowDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    def __init__(self, attributes = None, statically_defined = False):
+        ...
+    def flow_init(self, flow, graph, environment, flow_datastore, metadata, logger, echo, options):
+        ...
+    ...
+

metaflow-stubs/plugins/pypi/conda_environment.pyi

@@ -0,0 +1,86 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.959635                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import io
+    import metaflow.metaflow_environment
+    import abc
+    import metaflow.exception
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+def get_pinned_conda_libs(python_version, datastore_type):
+    ...
+
+MAGIC_FILE: str
+
+def conda_platform():
+    ...
+
+class CondaEnvironmentException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, msg):
+        ...
+    ...
+
+class CondaEnvironment(metaflow.metaflow_environment.MetaflowEnvironment, metaclass=type):
+    def __init__(self, flow):
+        ...
+    def set_local_root(self, local_root):
+        ...
+    def decospecs(self):
+        ...
+    def validate_environment(self, echo, datastore_type):
+        ...
+    def init_environment(self, echo):
+        ...
+    def executable(self, step_name, default = None):
+        ...
+    def interpreter(self, step_name):
+        ...
+    def is_disabled(self, step):
+        ...
+    def pylint_config(self):
+        ...
+    @classmethod
+    def get_client_info(cls, flow_name, metadata):
+        ...
+    def add_to_package(self):
+        ...
+    def bootstrap_commands(self, step_name, datastore_type):
+        ...
+    def get_environment_manifest_path(self):
+        ...
+    def read_from_environment_manifest(self, keys):
+        ...
+    def write_to_environment_manifest(self, keys, value):
+        ...
+    ...
+
+class LazyOpen(io.BufferedIOBase, metaclass=abc.ABCMeta):
+    def __init__(self, filename, mode = "rb", url = None):
+        ...
+    def readable(self):
+        ...
+    def seekable(self):
+        ...
+    def read(self, size = -1):
+        ...
+    def seek(self, offset, whence = 0):
+        ...
+    def tell(self):
+        ...
+    def close(self):
+        ...
+    ...
+

metaflow-stubs/plugins/pypi/pypi_decorator.pyi

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

metaflow-stubs/plugins/pypi/pypi_environment.pyi

@@ -0,0 +1,50 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.960176                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.pypi.conda_environment
+    import metaflow.metaflow_environment
+
+class CondaEnvironment(metaflow.metaflow_environment.MetaflowEnvironment, metaclass=type):
+    def __init__(self, flow):
+        ...
+    def set_local_root(self, local_root):
+        ...
+    def decospecs(self):
+        ...
+    def validate_environment(self, echo, datastore_type):
+        ...
+    def init_environment(self, echo):
+        ...
+    def executable(self, step_name, default = None):
+        ...
+    def interpreter(self, step_name):
+        ...
+    def is_disabled(self, step):
+        ...
+    def pylint_config(self):
+        ...
+    @classmethod
+    def get_client_info(cls, flow_name, metadata):
+        ...
+    def add_to_package(self):
+        ...
+    def bootstrap_commands(self, step_name, datastore_type):
+        ...
+    def get_environment_manifest_path(self):
+        ...
+    def read_from_environment_manifest(self, keys):
+        ...
+    def write_to_environment_manifest(self, keys, value):
+        ...
+    ...
+
+class PyPIEnvironment(metaflow.plugins.pypi.conda_environment.CondaEnvironment, metaclass=type):
+    ...
+

metaflow-stubs/plugins/pypi/utils.pyi

@@ -0,0 +1,28 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.958470                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+def conda_platform():
+    ...
+
+def wheel_tags(wheel):
+    ...
+
+def pip_tags(python_version, mamba_platform):
+    ...
+
+def parse_filename_from_url(url):
+    ...
+

metaflow-stubs/plugins/resources_decorator.pyi

@@ -0,0 +1,15 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.927805                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.decorators
+
+class ResourcesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    ...
+

metaflow-stubs/plugins/retry_decorator.pyi

@@ -0,0 +1,28 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.928750                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.decorators
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+MAX_ATTEMPTS: int
+
+class RetryDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):
+        ...
+    def step_task_retry_count(self):
+        ...
+    ...
+

metaflow-stubs/plugins/secrets/__init__.pyi

@@ -0,0 +1,21 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.932618                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import abc
+
+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.
+        """
+        ...
+    ...
+