metaflow-stubs 2.12.22__py2.py3-none-any.whl → 2.12.24__py2.py3-none-any.whl

metaflow-stubs/plugins/pypi/conda_environment.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.674603                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:47.048296                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,9 +9,9 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.metaflow_environment
-    import metaflow.exception
-    import abc
     import io
+    import abc
+    import metaflow.exception
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):

metaflow-stubs/plugins/pypi/pypi_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.672564                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:47.046210                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -11,6 +11,23 @@ if typing.TYPE_CHECKING:
     import metaflow.decorators
 
 class PyPIStepDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies the PyPI packages for the step.
+    
+    Information in this decorator will augment any
+    attributes set in the `@pyi_base` flow-level decorator. Hence,
+    you can use `@pypi_base` to set packages required by all
+    steps and use `@pypi` to specify step-specific overrides.
+    
+    Parameters
+    ----------
+    packages : Dict[str, str], default: {}
+        Packages to use for this step. The key is the name of the package
+        and the value is the version to use.
+    python : str, optional, default: None
+        Version of Python to use, e.g. '3.7.4'. A default value of None implies
+        that the version used will correspond to the version of the Python interpreter used to start the run.
+    """
     def __init__(self, attributes = None, statically_defined = False):
         ...
     def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):
@@ -20,6 +37,20 @@ class PyPIStepDecorator(metaflow.decorators.StepDecorator, metaclass=type):
     ...
 
 class PyPIFlowDecorator(metaflow.decorators.FlowDecorator, metaclass=type):
+    """
+    Specifies the PyPI packages for all steps of the flow.
+    
+    Use `@pypi_base` to set common packages required by all
+    steps and use `@pypi` to specify step-specific overrides.
+    Parameters
+    ----------
+    packages : Dict[str, str], default: {}
+        Packages to use for this flow. The key is the name of the package
+        and the value is the version to use.
+    python : str, optional, default: None
+        Version of Python to use, e.g. '3.7.4'. A default value of None implies
+        that the version used will correspond to the version of the Python interpreter used to start the run.
+    """
     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/pypi_environment.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.675093                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:47.048870                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.metaflow_environment
     import metaflow.plugins.pypi.conda_environment
+    import metaflow.metaflow_environment
 
 class CondaEnvironment(metaflow.metaflow_environment.MetaflowEnvironment, metaclass=type):
     def __init__(self, flow):

metaflow-stubs/plugins/pypi/utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.673635                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:47.047323                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/resources_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.630318                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:46.995864                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -11,5 +11,36 @@ if typing.TYPE_CHECKING:
     import metaflow.decorators
 
 class ResourcesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies the resources needed when executing this step.
+    
+    Use `@resources` to specify the resource requirements
+    independently of the specific compute layer (`@batch`, `@kubernetes`).
+    
+    You can choose the compute layer on the command line by executing e.g.
+    ```
+    python myflow.py run --with batch
+    ```
+    or
+    ```
+    python myflow.py run --with kubernetes
+    ```
+    which executes the flow on the desired system using the
+    requirements specified in `@resources`.
+    
+    Parameters
+    ----------
+    cpu : int, default 1
+        Number of CPUs required for this step.
+    gpu : int, default 0
+        Number of GPUs required for this step.
+    disk : int, optional, default None
+        Disk size (in MB) required for this step. Only applies on Kubernetes.
+    memory : int, default 4096
+        Memory size (in MB) required for this step.
+    shared_memory : int, optional, default None
+        The value for the size (in MiB) of the /dev/shm volume for this step.
+        This parameter maps to the `--shm-size` option in Docker.
+    """
     ...
 

metaflow-stubs/plugins/retry_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.631361                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:47.001136                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -20,6 +20,25 @@ class MetaflowException(Exception, metaclass=type):
 MAX_ATTEMPTS: int
 
 class RetryDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies the number of times the task corresponding
+    to a step needs to be retried.
+    
+    This decorator is useful for handling transient errors, such as networking issues.
+    If your task contains operations that can't be retried safely, e.g. database updates,
+    it is advisable to annotate it with `@retry(times=0)`.
+    
+    This can be used in conjunction with the `@catch` decorator. The `@catch`
+    decorator will execute a no-op task after all retries have been exhausted,
+    ensuring that the flow execution can continue.
+    
+    Parameters
+    ----------
+    times : int, default 3
+        Number of times to retry this task.
+    minutes_between_retries : int, default 2
+        Number of minutes between retries.
+    """
     def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):
         ...
     def step_task_retry_count(self):

metaflow-stubs/plugins/secrets/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.631726                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:47.000690                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.666608                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:47.054141                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import abc
     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]:

metaflow-stubs/plugins/secrets/secrets_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.666331                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:47.053865                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -69,6 +69,15 @@ def get_secrets_backend_provider(secrets_backend_type):
     ...
 
 class SecretsDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies secrets to be retrieved and injected as environment variables prior to
+    the execution of a step.
+    
+    Parameters
+    ----------
+    sources : List[Union[str, Dict[str, Any]]], default: []
+        List of secret specs, defining how the secrets are to be retrieved
+    """
     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

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.636554                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:47.002694                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -15,6 +15,10 @@ class MetaflowException(Exception, metaclass=type):
     ...
 
 class StorageExecutor(object, metaclass=type):
+    """
+    Thin wrapper around a ProcessPoolExecutor, or a ThreadPoolExecutor where
+    the former may be unsafe.
+    """
     def __init__(self, use_processes = False):
         ...
     def warm_up(self):

metaflow-stubs/plugins/tag_cli.pyi

@@ -1,18 +1,18 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.642906                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:47.008997                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.events
-    import metaflow.client.core
-    import metaflow.exception
     import metaflow.metaflow_current
+    import metaflow.client.core
     import datetime
+    import metaflow.exception
+    import metaflow.events
 
 def namespace(ns: typing.Optional[str]) -> typing.Optional[str]:
     """
@@ -35,6 +35,17 @@ def namespace(ns: typing.Optional[str]) -> typing.Optional[str]:
     ...
 
 class Flow(metaflow.client.core.MetaflowObject, metaclass=type):
+    """
+    A Flow represents all existing flows with a certain name, in other words,
+    classes derived from `FlowSpec`. A container of `Run` objects.
+    
+    Attributes
+    ----------
+    latest_run : Run
+        Latest `Run` (in progress or completed, successfully or not) of this flow.
+    latest_successful_run : Run
+        Latest successfully completed `Run` of this flow.
+    """
     def __init__(self, *args, **kwargs):
         ...
     @property
@@ -121,6 +132,26 @@ class Flow(metaflow.client.core.MetaflowObject, metaclass=type):
     ...
 
 class Run(metaflow.client.core.MetaflowObject, metaclass=type):
+    """
+    A `Run` represents an execution of a `Flow`. It is a container of `Step`s.
+    
+    Attributes
+    ----------
+    data : MetaflowData
+        a shortcut to run['end'].task.data, i.e. data produced by this run.
+    successful : bool
+        True if the run completed successfully.
+    finished : bool
+        True if the run completed.
+    finished_at : datetime
+        Time this run finished.
+    code : MetaflowCode
+        Code package for this run (if present). See `MetaflowCode`.
+    trigger : MetaflowTrigger
+        Information about event(s) that triggered this run (if present). See `MetaflowTrigger`.
+    end_task : Task
+        `Task` for the end step (if it is present already).
+    """
     def steps(self, *tags: str) -> typing.Iterator[metaflow.client.core.Step]:
         """
         [Legacy function - do not use]

metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.630172                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:46.995687                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.unbounded_foreach
     import metaflow.decorators
+    import metaflow.unbounded_foreach
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):
@@ -25,6 +25,9 @@ UBF_TASK: str
 CONTROL_TASK_TAG: str
 
 class MetaDatum(tuple, metaclass=type):
+    """
+    MetaDatum(field, value, type, tags)
+    """
     @staticmethod
     def __new__(_cls, field, value, type, tags):
         """
@@ -44,6 +47,10 @@ class MetaDatum(tuple, metaclass=type):
     ...
 
 class InternalTestUnboundedForeachInput(metaflow.unbounded_foreach.UnboundedForeachInput, metaclass=type):
+    """
+    Test class that wraps around values (any iterator) and simulates an
+    unbounded-foreach instead of a bounded foreach.
+    """
     def __init__(self, iterable):
         ...
     def __iter__(self):

metaflow-stubs/plugins/timeout_decorator.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.632549                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:46.996348                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.exception
     import metaflow.decorators
+    import metaflow.exception
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):
@@ -26,6 +26,27 @@ class TimeoutException(metaflow.exception.MetaflowException, metaclass=type):
     ...
 
 class TimeoutDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    """
+    Specifies a timeout for your step.
+    
+    This decorator is useful if this step may hang indefinitely.
+    
+    This can be used in conjunction with the `@retry` decorator as well as the `@catch` decorator.
+    A timeout is considered to be an exception thrown by the step. It will cause the step to be
+    retried if needed and the exception will be caught by the `@catch` decorator, if present.
+    
+    Note that all the values specified in parameters are added together so if you specify
+    60 seconds and 1 hour, the decorator will have an effective timeout of 1 hour and 1 minute.
+    
+    Parameters
+    ----------
+    seconds : int, default 0
+        Number of seconds to wait prior to timing out.
+    minutes : int, default 0
+        Number of minutes to wait prior to timing out.
+    hours : int, default 0
+        Number of hours to wait prior to timing out.
+    """
     def __init__(self, *args, **kwargs):
         ...
     def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):

metaflow-stubs/procpoll.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.623089                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:46.988338                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/pylint_wrapper.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.622590                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:46.987833                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/runner/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.22                                                            #
-# Generated on 2024-09-20T00:45:49.603201                                        #
+# MF version: 2.12.24                                                            #
+# Generated on 2024-10-04T11:37:46.967807                                        #
 ##################################################################################
 
 from __future__ import annotations