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

metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi

@@ -0,0 +1,30 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.993136                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.secrets
+    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.
+        """
+        ...
+    ...
+
+class InlineSecretsProvider(metaflow.plugins.secrets.SecretsProvider, metaclass=abc.ABCMeta):
+    def get_secret_as_dict(self, secret_id, options = {}, role = None):
+        """
+        Intended to be used for testing purposes only.
+        """
+        ...
+    ...
+

metaflow-stubs/plugins/secrets/secrets_decorator.pyi

@@ -0,0 +1,75 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.992829                                        #
+##################################################################################
+
+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):
+        ...
+    ...
+
+DEFAULT_SECRETS_ROLE: None
+
+UBF_CONTROL: str
+
+DISALLOWED_SECRETS_ENV_VAR_PREFIXES: list
+
+def get_default_secrets_backend_type():
+    ...
+
+class SecretSpec(object, metaclass=type):
+    def __init__(self, secrets_backend_type, secret_id, options = {}, role = None):
+        ...
+    @property
+    def secrets_backend_type(self):
+        ...
+    @property
+    def secret_id(self):
+        ...
+    @property
+    def options(self):
+        ...
+    @property
+    def role(self):
+        ...
+    def to_json(self):
+        """
+        Mainly used for testing... not the same as the input dict in secret_spec_from_dict()!
+        """
+        ...
+    def __str__(self):
+        ...
+    @staticmethod
+    def secret_spec_from_str(secret_spec_str, role):
+        ...
+    @staticmethod
+    def secret_spec_from_dict(secret_spec_dict, role):
+        ...
+    ...
+
+def validate_env_vars_across_secrets(all_secrets_env_vars):
+    ...
+
+def validate_env_vars_vs_existing_env(all_secrets_env_vars):
+    ...
+
+def validate_env_vars(env_vars):
+    ...
+
+def get_secrets_backend_provider(secrets_backend_type):
+    ...
+
+class SecretsDecorator(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):
+        ...
+    ...
+

metaflow-stubs/plugins/storage_executor.pyi

@@ -0,0 +1,33 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.934105                                        #
+##################################################################################
+
+from __future__ import annotations
+
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+class StorageExecutor(object, metaclass=type):
+    def __init__(self, use_processes = False):
+        ...
+    def warm_up(self):
+        ...
+    def submit(self, *args, **kwargs):
+        ...
+    ...
+
+def handle_executor_exceptions(func):
+    """
+    Decorator for handling errors that come from an Executor. This decorator should
+    only be used on functions where executor errors are possible. I.e. the function
+    uses StorageExecutor.
+    """
+    ...
+

metaflow-stubs/plugins/tag_cli.pyi

@@ -0,0 +1,370 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.941509                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.exception
+    import metaflow.client.core
+    import metaflow.metaflow_current
+    import datetime
+    import metaflow.events
+
+def namespace(ns: typing.Optional[str]) -> typing.Optional[str]:
+    """
+    Switch namespace to the one provided.
+    
+    This call has a global effect. No objects outside this namespace
+    will be accessible. To access all objects regardless of namespaces,
+    pass None to this call.
+    
+    Parameters
+    ----------
+    ns : str, optional
+        Namespace to switch to or None to ignore namespaces.
+    
+    Returns
+    -------
+    str, optional
+        Namespace set (result of get_namespace()).
+    """
+    ...
+
+class Flow(metaflow.client.core.MetaflowObject, metaclass=type):
+    def __init__(self, *args, **kwargs):
+        ...
+    @property
+    def latest_run(self) -> typing.Optional[metaflow.client.core.Run]:
+        """
+        Returns the latest run (either in progress or completed) of this flow.
+        
+        Note that an in-progress run may be returned by this call. Use latest_successful_run
+        to get an object representing a completed successful run.
+        
+        Returns
+        -------
+        Run, optional
+            Latest run of this flow
+        """
+        ...
+    @property
+    def latest_successful_run(self) -> typing.Optional[metaflow.client.core.Run]:
+        """
+        Returns the latest successful run of this flow.
+        
+        Returns
+        -------
+        Run, optional
+            Latest successful run of this flow
+        """
+        ...
+    def runs(self, *tags: str) -> typing.Iterator[metaflow.client.core.Run]:
+        """
+        Returns an iterator over all `Run`s of this flow.
+        
+        An optional filter is available that allows you to filter on tags.
+        If multiple tags are specified, only runs that have all the
+        specified tags are returned.
+        
+        Parameters
+        ----------
+        tags : str
+            Tags to match.
+        
+        Yields
+        ------
+        Run
+            `Run` objects in this flow.
+        """
+        ...
+    def __iter__(self) -> typing.Iterator[metaflow.client.core.Task]:
+        """
+        Iterate over all children Run of this Flow.
+        
+        Note that only runs in the current namespace are returned unless
+        _namespace_check is False
+        
+        Yields
+        ------
+        Run
+            A Run in this Flow
+        """
+        ...
+    def __getitem__(self, run_id: str) -> metaflow.client.core.Run:
+        """
+        Returns the Run object with the run ID 'run_id'
+        
+        Parameters
+        ----------
+        run_id : str
+            Run OD
+        
+        Returns
+        -------
+        Run
+            Run for this run ID in this Flow
+        
+        Raises
+        ------
+        KeyError
+            If the run_id does not identify a valid Run object
+        """
+        ...
+    def __getstate__(self):
+        ...
+    def __setstate__(self, state):
+        ...
+    ...
+
+class Run(metaflow.client.core.MetaflowObject, metaclass=type):
+    def steps(self, *tags: str) -> typing.Iterator[metaflow.client.core.Step]:
+        """
+        [Legacy function - do not use]
+        
+        Returns an iterator over all `Step` objects in the step. This is an alias
+        to iterating the object itself, i.e.
+        ```
+        list(Run(...)) == list(Run(...).steps())
+        ```
+        
+        Parameters
+        ----------
+        tags : str
+            No op (legacy functionality)
+        
+        Yields
+        ------
+        Step
+            `Step` objects in this run.
+        """
+        ...
+    @property
+    def code(self) -> typing.Optional[metaflow.client.core.MetaflowCode]:
+        """
+        Returns the MetaflowCode object for this run, if present.
+        Code is packed if atleast one `Step` runs remotely, else None is returned.
+        
+        Returns
+        -------
+        MetaflowCode, optional
+            Code package for this run
+        """
+        ...
+    @property
+    def data(self) -> typing.Optional[metaflow.client.core.MetaflowData]:
+        """
+        Returns a container of data artifacts produced by this run.
+        
+        You can access data produced by this run as follows:
+        ```
+        print(run.data.my_var)
+        ```
+        This is a shorthand for `run['end'].task.data`. If the 'end' step has not yet
+        executed, returns None.
+        
+        Returns
+        -------
+        MetaflowData, optional
+            Container of all artifacts produced by this task
+        """
+        ...
+    @property
+    def successful(self) -> bool:
+        """
+        Indicates whether or not the run completed successfully.
+        
+        A run is successful if its 'end' step is successful.
+        
+        Returns
+        -------
+        bool
+            True if the run completed successfully and False otherwise
+        """
+        ...
+    @property
+    def finished(self) -> bool:
+        """
+        Indicates whether or not the run completed.
+        
+        A run completed if its 'end' step completed.
+        
+        Returns
+        -------
+        bool
+            True if the run completed and False otherwise
+        """
+        ...
+    @property
+    def finished_at(self) -> typing.Optional[datetime.datetime]:
+        """
+        Returns the datetime object of when the run finished (successfully or not).
+        
+        The completion time of a run is the same as the completion time of its 'end' step.
+        If the 'end' step has not completed, returns None.
+        
+        Returns
+        -------
+        datetime, optional
+            Datetime of when the run finished
+        """
+        ...
+    @property
+    def end_task(self) -> typing.Optional[metaflow.client.core.Task]:
+        """
+        Returns the Task corresponding to the 'end' step.
+        
+        This returns None if the end step does not yet exist.
+        
+        Returns
+        -------
+        Task, optional
+            The 'end' task
+        """
+        ...
+    def add_tag(self, tag: str):
+        """
+        Add a tag to this `Run`.
+        
+        Note that if the tag is already a system tag, it is not added as a user tag,
+        and no error is thrown.
+        
+        Parameters
+        ----------
+        tag : str
+            Tag to add.
+        """
+        ...
+    def add_tags(self, tags: typing.Iterable[str]):
+        """
+        Add one or more tags to this `Run`.
+        
+        Note that if any tag is already a system tag, it is not added as a user tag
+        and no error is thrown.
+        
+        Parameters
+        ----------
+        tags : Iterable[str]
+            Tags to add.
+        """
+        ...
+    def remove_tag(self, tag: str):
+        """
+        Remove one tag from this `Run`.
+        
+        Removing a system tag is an error. Removing a non-existent
+        user tag is a no-op.
+        
+        Parameters
+        ----------
+        tag : str
+            Tag to remove.
+        """
+        ...
+    def remove_tags(self, tags: typing.Iterable[str]):
+        """
+        Remove one or more tags to this `Run`.
+        
+        Removing a system tag will result in an error. Removing a non-existent
+        user tag is a no-op.
+        
+        Parameters
+        ----------
+        tags : Iterable[str]
+            Tags to remove.
+        """
+        ...
+    def replace_tag(self, tag_to_remove: str, tag_to_add: str):
+        """
+        Remove a tag and add a tag atomically. Removal is done first.
+        The rules for `Run.add_tag` and `Run.remove_tag` also apply here.
+        
+        Parameters
+        ----------
+        tag_to_remove : str
+            Tag to remove.
+        tag_to_add : str
+            Tag to add.
+        """
+        ...
+    def replace_tags(self, tags_to_remove: typing.Iterable[str], tags_to_add: typing.Iterable[str]):
+        """
+        Remove and add tags atomically; the removal is done first.
+        The rules for `Run.add_tag` and `Run.remove_tag` also apply here.
+        
+        Parameters
+        ----------
+        tags_to_remove : Iterable[str]
+            Tags to remove.
+        tags_to_add : Iterable[str]
+            Tags to add.
+        """
+        ...
+    def __iter__(self) -> typing.Iterator[metaflow.client.core.Step]:
+        """
+        Iterate over all children Step of this Run
+        
+        Yields
+        ------
+        Step
+            A Step in this Run
+        """
+        ...
+    def __getitem__(self, name: str) -> metaflow.client.core.Step:
+        """
+        Returns the Step object with the step name 'name'
+        
+        Parameters
+        ----------
+        name : str
+            Step name
+        
+        Returns
+        -------
+        Step
+            Step for this step name in this Run
+        
+        Raises
+        ------
+        KeyError
+            If the name does not identify a valid Step object
+        """
+        ...
+    def __getstate__(self):
+        ...
+    def __setstate__(self, state):
+        ...
+    @property
+    def trigger(self) -> typing.Optional[metaflow.events.Trigger]:
+        """
+        Returns a container of events that triggered this run.
+        
+        This returns None if the run was not triggered by any events.
+        
+        Returns
+        -------
+        Trigger, optional
+            Container of triggering events
+        """
+        ...
+    ...
+
+current: metaflow.metaflow_current.Current
+
+class CommandException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class MetaflowNotFound(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class MetaflowInternalError(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class MetaflowNamespaceMismatch(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, namespace):
+        ...
+    ...
+

metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi

@@ -0,0 +1,54 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.927357                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.unbounded_foreach
+    import metaflow.decorators
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+UBF_CONTROL: str
+
+UBF_TASK: str
+
+class InternalTestUnboundedForeachInput(metaflow.unbounded_foreach.UnboundedForeachInput, metaclass=type):
+    def __init__(self, iterable):
+        ...
+    def __iter__(self):
+        ...
+    def __next__(self):
+        ...
+    def __getitem__(self, key):
+        ...
+    def __len__(self):
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+class InternalTestUnboundedForeachDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    def __init__(self, attributes = None, statically_defined = False):
+        ...
+    def step_init(self, flow, graph, step_name, decorators, environment, flow_datastore, logger):
+        ...
+    def control_task_step_func(self, flow, graph, retry_count):
+        ...
+    def task_decorate(self, step_func, flow, graph, retry_count, max_user_code_retries, ubf_context):
+        ...
+    def step_task_retry_count(self):
+        ...
+    ...
+

metaflow-stubs/plugins/timeout_decorator.pyi

@@ -0,0 +1,39 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.928315                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.decorators
+    import metaflow.exception
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+UBF_CONTROL: str
+
+class TimeoutException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class TimeoutDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    def __init__(self, *args, **kwargs):
+        ...
+    def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):
+        ...
+    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_post_step(self, step_name, flow, graph, retry_count, max_user_code_retries):
+        ...
+    ...
+
+def get_run_time_limit_for_task(step_decos):
+    ...
+

metaflow-stubs/procpoll.pyi

@@ -0,0 +1,51 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.923244                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.procpoll
+
+class ProcPollEvent(object, metaclass=type):
+    def __init__(self, fd, can_read = False, is_terminated = False):
+        ...
+    ...
+
+class ProcPoll(object, metaclass=type):
+    def poll(self):
+        ...
+    def add(self, fd):
+        ...
+    def remove(self, fd):
+        ...
+    ...
+
+class LinuxProcPoll(ProcPoll, metaclass=type):
+    def __init__(self):
+        ...
+    def add(self, fd):
+        ...
+    def remove(self, fd):
+        ...
+    def poll(self, timeout):
+        ...
+    ...
+
+class DarwinProcPoll(ProcPoll, metaclass=type):
+    def __init__(self):
+        ...
+    def add(self, fd):
+        ...
+    def remove(self, fd):
+        ...
+    def poll(self, timeout):
+        ...
+    ...
+
+def make_poll():
+    ...
+

metaflow-stubs/pylint_wrapper.pyi

@@ -0,0 +1,31 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.923640                                        #
+##################################################################################
+
+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 PyLintWarn(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class PyLint(object, metaclass=type):
+    def __init__(self, fname):
+        ...
+    def has_pylint(self):
+        ...
+    def run(self, logger = None, warnings = False, pylint_config = []):
+        ...
+    ...
+