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

metaflow-stubs/plugins/datatools/s3/s3tail.pyi

@@ -0,0 +1,34 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.014274                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+def aws_retry(f):
+    ...
+
+def get_s3_client(s3_role_arn = None, s3_session_vars = None, s3_client_params = None):
+    ...
+
+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):
+        ...
+    ...
+

metaflow-stubs/plugins/datatools/s3/s3util.pyi

@@ -0,0 +1,45 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.942308                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+DATATOOLS_CLIENT_PARAMS: dict
+
+DATATOOLS_SESSION_VARS: dict
+
+S3_RETRY_COUNT: int
+
+RETRY_WARNING_THRESHOLD: int
+
+TEST_S3_RETRY: bool
+
+TRANSIENT_RETRY_LINE_CONTENT: str
+
+TRANSIENT_RETRY_START_LINE: str
+
+def get_s3_client(s3_role_arn = None, s3_session_vars = None, s3_client_params = None):
+    ...
+
+def aws_retry(f):
+    ...
+
+def read_in_chunks(dst, src, src_sz, max_chunk_size):
+    ...
+
+def get_timestamp(dt):
+    """
+    Python2 compatible way to compute the timestamp (seconds since 1/1/1970)
+    """
+    ...
+

metaflow-stubs/plugins/debug_logger.pyi

@@ -0,0 +1,25 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.934516                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.event_logger
+
+class DebugEventLogger(metaflow.event_logger.NullEventLogger, metaclass=type):
+    @classmethod
+    def get_worker(cls):
+        ...
+    ...
+
+class DebugEventLoggerSidecar(object, metaclass=type):
+    def __init__(self):
+        ...
+    def process_message(self, msg):
+        ...
+    ...
+

metaflow-stubs/plugins/debug_monitor.pyi

@@ -0,0 +1,25 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.934974                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.monitor
+
+class DebugMonitor(metaflow.monitor.NullMonitor, metaclass=type):
+    @classmethod
+    def get_worker(cls):
+        ...
+    ...
+
+class DebugMonitorSidecar(object, metaclass=type):
+    def __init__(self):
+        ...
+    def process_message(self, msg):
+        ...
+    ...
+

metaflow-stubs/plugins/environment_decorator.pyi

@@ -0,0 +1,17 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.927550                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.decorators
+
+class EnvironmentDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    def runtime_step_cli(self, cli_args, retry_count, max_user_code_retries, ubf_context):
+        ...
+    ...
+

metaflow-stubs/plugins/events_decorator.pyi

@@ -0,0 +1,34 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.933081                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
+    import metaflow.decorators
+
+current: metaflow.metaflow_current.Current
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+class TriggerDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    def flow_init(self, flow_name, graph, environment, flow_datastore, metadata, logger, echo, options):
+        ...
+    ...
+
+class TriggerOnFinishDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    def flow_init(self, flow_name, graph, environment, flow_datastore, metadata, logger, echo, options):
+        ...
+    def get_top_level_options(self):
+        ...
+    ...
+

metaflow-stubs/plugins/frameworks/__init__.pyi

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

metaflow-stubs/plugins/frameworks/pytorch.pyi

@@ -0,0 +1,42 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.982403                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
+    import metaflow.plugins.parallel_decorator
+    import metaflow.decorators
+
+current: metaflow.metaflow_current.Current
+
+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):
+        ...
+    ...
+
+class PytorchParallelDecorator(metaflow.plugins.parallel_decorator.ParallelDecorator, metaclass=type):
+    def task_decorate(self, step_func, flow, graph, retry_count, max_user_code_retries, ubf_context):
+        ...
+    def setup_distributed_env(self, flow):
+        ...
+    ...
+
+def setup_torch_distributed(master_port = None):
+    """
+    Set up environment variables for PyTorch's distributed (DDP).
+    """
+    ...
+

metaflow-stubs/plugins/gcp/__init__.pyi

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

metaflow-stubs/plugins/gcp/gs_exceptions.pyi

@@ -0,0 +1,22 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.993713                                        #
+##################################################################################
+
+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):
+        ...
+    ...
+
+class MetaflowGSPackageError(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+

metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi

@@ -0,0 +1,26 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.993487                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+class GcpDefaultClientProvider(object, metaclass=type):
+    @staticmethod
+    def get_gs_storage_client(*args, **kwargs):
+        ...
+    @staticmethod
+    def get_credentials(scopes, *args, **kwargs):
+        ...
+    ...
+
+cached_provider_class: None
+
+def get_gs_storage_client():
+    ...
+
+def get_credentials(scopes, *args, **kwargs):
+    ...
+

metaflow-stubs/plugins/gcp/gs_utils.pyi

@@ -0,0 +1,38 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.994131                                        #
+##################################################################################
+
+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):
+        ...
+    ...
+
+class MetaflowInternalError(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class MetaflowGSPackageError(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+def parse_gs_full_path(gs_uri):
+    ...
+
+def check_gs_deps(func):
+    """
+    The decorated function checks GS dependencies (as needed for Google Cloud storage backend). This includes
+    various GCP SDK packages, as well as a Python version of >=3.7
+    """
+    ...
+
+def process_gs_exception(*args, **kwargs):
+    ...
+

metaflow-stubs/plugins/gcp/includefile_support.pyi

@@ -0,0 +1,63 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.944384                                        #
+##################################################################################
+
+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):
+        ...
+    ...
+
+class MetaflowInternalError(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class GS(object, metaclass=type):
+    @classmethod
+    def get_root_from_config(cls, echo, create_on_absent = True):
+        ...
+    def __init__(self):
+        ...
+    def __enter__(self):
+        ...
+    def __exit__(self, *args):
+        ...
+    def get(self, key = None, return_missing = False):
+        """
+        Key MUST be a fully qualified path.  gs://<bucket_name>/b/l/o/b/n/a/m/e
+        """
+        ...
+    def put(self, key, obj, overwrite = True):
+        """
+        Key MUST be a fully qualified path.  gs://<bucket_name>/b/l/o/b/n/a/m/e
+        """
+        ...
+    def info(self, key = None, return_missing = False):
+        ...
+    ...
+
+class GSObject(object, metaclass=type):
+    def __init__(self, url, path, exists, size):
+        ...
+    @property
+    def path(self):
+        ...
+    @property
+    def url(self):
+        ...
+    @property
+    def exists(self):
+        ...
+    @property
+    def size(self):
+        ...
+    ...
+

metaflow-stubs/plugins/kubernetes/__init__.pyi

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

metaflow-stubs/plugins/kubernetes/kubernetes.pyi

@@ -0,0 +1,127 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.953160                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
+    import metaflow.exception
+
+current: metaflow.metaflow_current.Current
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+ARGO_EVENTS_EVENT: None
+
+ARGO_EVENTS_EVENT_BUS: str
+
+ARGO_EVENTS_EVENT_SOURCE: None
+
+ARGO_EVENTS_SERVICE_ACCOUNT: None
+
+ARGO_EVENTS_INTERNAL_WEBHOOK_URL: None
+
+AWS_SECRETS_MANAGER_DEFAULT_REGION: None
+
+ARGO_EVENTS_WEBHOOK_AUTH: str
+
+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_AWS_CLIENT_PROVIDER: str
+
+DEFAULT_METADATA: str
+
+DEFAULT_SECRETS_BACKEND_TYPE: None
+
+KUBERNETES_FETCH_EC2_METADATA: bool
+
+KUBERNETES_LABELS: str
+
+KUBERNETES_SANDBOX_INIT_SCRIPT: None
+
+S3_ENDPOINT_URL: None
+
+SERVICE_HEADERS: dict
+
+SERVICE_INTERNAL_URL: None
+
+S3_SERVER_SIDE_ENCRYPTION: None
+
+OTEL_ENDPOINT: None
+
+BASH_SAVE_LOGS: str
+
+class KubernetesClient(object, metaclass=type):
+    def __init__(self):
+        ...
+    def get(self):
+        ...
+    def job(self, **kwargs):
+        ...
+    ...
+
+LOGS_DIR: str
+
+STDOUT_FILE: str
+
+STDERR_FILE: str
+
+STDOUT_PATH: str
+
+STDERR_PATH: str
+
+class KubernetesException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class KubernetesKilledException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class Kubernetes(object, metaclass=type):
+    def __init__(self, datastore, metadata, environment):
+        ...
+    def launch_job(self, **kwargs):
+        ...
+    def create_job(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, annotations = None, num_parallel = 0, attrs = {}, port = None, shared_memory = None):
+        ...
+    def wait(self, stdout_location, stderr_location, echo = None):
+        ...
+    ...
+
+def validate_kube_labels(labels: typing.Optional[typing.Dict[str, typing.Optional[str]]]) -> bool:
+    """
+    Validate label values.
+    
+    This validates the kubernetes label values.  It does not validate the keys.
+    Ideally, keys should be static and also the validation rules for keys are
+    more complex than those for values.  For full validation rules, see:
+    
+    https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set
+    """
+    ...
+
+def parse_kube_keyvalue_list(items: typing.List[str], requires_both: bool = True):
+    ...
+

metaflow-stubs/plugins/kubernetes/kubernetes_cli.pyi

@@ -0,0 +1,73 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.955710                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow._vendor.click.types
+    import metaflow.decorators
+    import metaflow.exception
+
+class JSONTypeClass(metaflow._vendor.click.types.ParamType, metaclass=type):
+    def convert(self, value, param, ctx):
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+METAFLOW_EXIT_DISALLOW_RETRY: int
+
+class CommandException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+def sync_local_metadata_from_datastore(metadata_local_dir, task_ds):
+    ...
+
+DATASTORE_LOCAL_DIR: str
+
+KUBERNETES_LABELS: str
+
+TASK_LOG_SOURCE: str
+
+class Kubernetes(object, metaclass=type):
+    def __init__(self, datastore, metadata, environment):
+        ...
+    def launch_job(self, **kwargs):
+        ...
+    def create_job(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, annotations = None, num_parallel = 0, attrs = {}, port = None, shared_memory = None):
+        ...
+    def wait(self, stdout_location, stderr_location, echo = None):
+        ...
+    ...
+
+class KubernetesKilledException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+def parse_kube_keyvalue_list(items: typing.List[str], requires_both: bool = True):
+    ...
+
+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_client.pyi

@@ -0,0 +1,62 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.951784                                        #
+##################################################################################
+
+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):
+        ...
+    ...
+
+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):
+        ...
+    ...
+
+CLIENT_REFRESH_INTERVAL_SECONDS: int
+
+class KubernetesClientException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class KubernetesClient(object, metaclass=type):
+    def __init__(self):
+        ...
+    def get(self):
+        ...
+    def job(self, **kwargs):
+        ...
+    ...
+