ob-metaflow-stubs 6.0.4.4__py2.py3-none-any.whl → 6.0.4.5__py2.py3-none-any.whl

metaflow-stubs/runner/utils.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.2.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-16T08:15:48.008783                                                            #
+# MF version: 2.15.21.2+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-16T21:13:36.374195                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/system/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.2.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-16T08:15:47.990231                                                            #
+# MF version: 2.15.21.2+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-16T21:13:36.360998                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/system/system_logger.pyi

@@ -1,15 +1,15 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.2.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-16T08:15:48.029038                                                            #
+# MF version: 2.15.21.2+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-16T21:13:36.394008                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import typing
     import metaflow.event_logger
+    import typing
 
 
 class SystemLogger(object, metaclass=type):

metaflow-stubs/system/system_monitor.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.2.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-16T08:15:48.028713                                                            #
+# MF version: 2.15.21.2+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-16T21:13:36.393666                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/tagging_util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.2.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-16T08:15:47.967621                                                            #
+# MF version: 2.15.21.2+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-16T21:13:36.339646                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/tuple_util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.2.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-16T08:15:47.973360                                                            #
+# MF version: 2.15.21.2+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-16T21:13:36.344436                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/user_configs/__init__.pyi

@@ -1,12 +1,13 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.2.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-16T08:15:47.967027                                                            #
+# MF version: 2.15.21.2+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-16T21:13:36.339322                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 
 from . import config_parameters as config_parameters
+from . import config_decorators as config_decorators
 from . import config_options as config_options
 

metaflow-stubs/user_configs/config_decorators.pyi

@@ -0,0 +1,251 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.15.21.2+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-16T21:13:36.344024                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.parameters
+    import metaflow.user_configs.config_decorators
+    import functools
+    import metaflow.decorators
+    import typing
+    import metaflow.flowspec
+    import metaflow.user_configs.config_parameters
+
+from ..exception import MetaflowException as MetaflowException
+from .config_parameters import ConfigValue as ConfigValue
+from .config_parameters import resolve_delayed_evaluator as resolve_delayed_evaluator
+
+TYPE_CHECKING: bool
+
+class MutableStep(object, metaclass=type):
+    """
+    A MutableStep is a wrapper passed to the `CustomStepDecorator`'s `evaluate` method
+    to allow the decorator to interact with the step and providing easy methods to
+    modify the behavior of the step.
+    """
+    def __init__(self, flow_spec: "metaflow.flowspec.FlowSpec", step: typing.Union[typing.Callable[["metaflow.decorators.FlowSpecDerived"], None], typing.Callable[["metaflow.decorators.FlowSpecDerived", typing.Any], None]]):
+        ...
+    @property
+    def flow(self) -> MutableFlow:
+        """
+        The flow that contains this step
+        
+        Returns
+        -------
+        MutableFlow
+            The flow that contains this step
+        """
+        ...
+    @property
+    def decorators(self) -> typing.Generator["metaflow.decorators.StepDecorator", None, None]:
+        """
+        Iterate over all the decorators of this step. Note that the same type of decorator
+        may be present multiple times and no order is guaranteed.
+        
+        Yields
+        ------
+        metaflow.decorators.StepDecorator
+            A decorator of the step
+        """
+        ...
+    def add_decorator(self, deco_type: functools.partial, **kwargs):
+        """
+        Add a Metaflow decorator to a step.
+        
+        Parameters
+        ----------
+        deco_type : partial
+            The decorator class to add to this step
+        """
+        ...
+    def remove_decorator(self, deco_name: str, all: bool = True, **kwargs) -> bool:
+        """
+        Remove one or more Metaflow decorators from a step.
+        
+        Some decorators can be applied multiple times to a step. This method allows you
+        to choose which decorator to remove or just remove all of them or one of them.
+        
+        Parameters
+        ----------
+        deco_name : str
+            Name of the decorator to remove
+        all : bool, default True
+            If True, remove all instances of the decorator that match the filters
+            passed using kwargs (or all the instances of the decorator if no filters are
+            passed). If False, removes only the first found instance of the decorator.
+        
+        Returns
+        -------
+        bool
+            Returns True if at least one decorator was removed.
+        """
+        ...
+    ...
+
+class MutableFlow(object, metaclass=type):
+    def __init__(self, flow_spec: "metaflow.flowspec.FlowSpec"):
+        ...
+    @property
+    def decorators(self) -> typing.Generator["metaflow.decorators.FlowDecorator", None, None]:
+        """
+        Iterate over all the decorators of this flow. Note that the same type of decorator
+        may be present multiple times and no order is guaranteed.
+        
+        Yields
+        ------
+        metaflow.decorators.FlowDecorator
+            A decorator of the flow
+        """
+        ...
+    @property
+    def configs(self) -> typing.Generator[typing.Tuple[str, metaflow.user_configs.config_parameters.ConfigValue], None, None]:
+        """
+        Iterate over all user configurations in this flow
+        
+        Use this to parameterize your flow based on configuration. As an example, the
+        `evaluate` method of your `CustomFlowDecorator` can use this to add an
+        environment decorator.
+        ```
+        class MyDecorator(CustomFlowDecorator):
+            def evaluate(flow: MutableFlow):
+                val = next(flow.configs)[1].steps.start.cpu
+                flow.start.add_decorator(environment, vars={'mycpu': val})
+                return flow
+        
+        @MyDecorator()
+        class TestFlow(FlowSpec):
+            config = Config('myconfig.json')
+        
+            @step
+            def start(self):
+                pass
+        ```
+        can be used to add an environment decorator to the `start` step.
+        
+        Yields
+        ------
+        Tuple[str, ConfigValue]
+            Iterates over the configurations of the flow
+        """
+        ...
+    @property
+    def parameters(self) -> typing.Generator[typing.Tuple[str, typing.Any], None, None]:
+        ...
+    @property
+    def steps(self) -> typing.Generator[typing.Tuple[str, metaflow.user_configs.config_decorators.MutableStep], None, None]:
+        """
+        Iterate over all the steps in this flow. The order of the steps
+        returned is not guaranteed.
+        
+        Yields
+        ------
+        Tuple[str, MutableStep]
+            A tuple with the step name and the step proxy
+        """
+        ...
+    def add_parameter(self, name: str, value: "metaflow.parameters.Parameter", overwrite: bool = False):
+        ...
+    def remove_parameter(self, parameter_name: str) -> bool:
+        """
+        Remove a parameter from the flow.
+        
+        The name given should match the name of the parameter (can be different
+        from the name of the parameter in the flow. You can not remove config parameters.
+        
+        Parameters
+        ----------
+        parameter_name : str
+            Name of the parameter
+        
+        Returns
+        -------
+        bool
+            Returns True if the parameter was removed
+        """
+        ...
+    def add_decorator(self, deco_type: functools.partial, **kwargs):
+        """
+        Add a Metaflow decorator to a flow.
+        
+        Parameters
+        ----------
+        deco_type : partial
+            The decorator class to add to this flow
+        """
+        ...
+    def remove_decorator(self, deco_name: str, all: bool = True, **kwargs) -> bool:
+        """
+        Remove one or more Metaflow decorators from a flow.
+        
+        Some decorators can be applied multiple times to a flow. This method allows you
+        to choose which decorator to remove or just remove all of them or one of them.
+        
+        Parameters
+        ----------
+        deco_name : str
+            Name of the decorator to remove
+        all : bool, default True
+            If True, remove all instances of the decorator that match the filters
+            passed using kwargs (or all the instances of the decorator if no filters are
+            passed). If False, removes only the first found instance of the decorator.
+        
+        Returns
+        -------
+        bool
+            Returns True if at least one decorator was removed.
+        """
+        ...
+    def __getattr__(self, name):
+        ...
+    ...
+
+class CustomFlowDecorator(object, metaclass=type):
+    def __init__(self, *args, **kwargs):
+        ...
+    def __call__(self, flow_spec: typing.Optional["metaflow.flowspec.FlowSpecMeta"] = None) -> "metaflow.flowspec.FlowSpecMeta":
+        ...
+    def init(self, *args, **kwargs):
+        """
+        This method is intended to be optionally overridden if you need to
+        have an initializer.
+        """
+        ...
+    def evaluate(self, mutable_flow: MutableFlow):
+        """
+        Implement this method to act on the flow and modify it as needed.
+        
+        Parameters
+        ----------
+        mutable_flow : MutableFlow
+            Flow
+        
+        Raises
+        ------
+        NotImplementedError
+            _description_
+        """
+        ...
+    ...
+
+class CustomStepDecorator(object, metaclass=type):
+    def __init__(self, *args, **kwargs):
+        ...
+    def __get__(self, instance, owner):
+        ...
+    def __call__(self, step: typing.Union[typing.Callable[["metaflow.decorators.FlowSpecDerived"], None], typing.Callable[["metaflow.decorators.FlowSpecDerived", typing.Any], None], None] = None) -> typing.Union[typing.Callable[["metaflow.decorators.FlowSpecDerived"], None], typing.Callable[["metaflow.decorators.FlowSpecDerived", typing.Any], None]]:
+        ...
+    def init(self, *args, **kwargs):
+        """
+        This method is intended to be optionally overridden if you need to
+        have an initializer.
+        """
+        ...
+    def evaluate(self, mutable_step: MutableStep):
+        ...
+    ...
+

metaflow-stubs/user_configs/config_options.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.2.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-16T08:15:47.999235                                                            #
+# MF version: 2.15.21.2+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-16T21:13:36.367037                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -9,17 +9,18 @@ from __future__ import annotations
 import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import typing
     import metaflow._vendor.click.types
+    import typing
 
 from .._vendor import click as click
 from .config_parameters import ConfigValue as ConfigValue
 from ..exception import MetaflowException as MetaflowException
 from ..exception import MetaflowInternalError as MetaflowInternalError
-from ..packaging_sys import MetaflowCodeContent as MetaflowCodeContent
 from ..parameters import DeployTimeField as DeployTimeField
 from ..parameters import ParameterContext as ParameterContext
 
+CONFIG_FILE: str
+
 class ConvertPath(metaflow._vendor.click.types.Path, metaclass=type):
     def convert(self, value, param, ctx):
         ...

metaflow-stubs/user_configs/config_parameters.pyi

@@ -1,21 +1,21 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.2.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-16T08:15:47.970874                                                            #
+# MF version: 2.15.21.2+obcheckpoint(0.2.4);ob(v1)                                                   #
+# Generated on 2025-07-16T21:13:36.342666                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import abc
+import metaflow
 import collections
+import abc
 import typing
-import metaflow
 if typing.TYPE_CHECKING:
-    import collections.abc
-    import metaflow.user_configs.config_parameters
-    import abc
     import metaflow.parameters
     import typing
+    import abc
+    import metaflow.user_configs.config_parameters
+    import collections.abc
 
 from ..exception import MetaflowException as MetaflowException
 from ..parameters import Parameter as Parameter
@@ -23,6 +23,8 @@ from ..parameters import ParameterContext as ParameterContext
 
 TYPE_CHECKING: bool
 
+CONFIG_FILE: str
+
 UNPACK_KEY: str
 
 def dump_config_values(flow: "FlowSpec"):

{ob_metaflow_stubs-6.0.4.4.dist-info → ob_metaflow_stubs-6.0.4.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ob-metaflow-stubs
-Version: 6.0.4.4
+Version: 6.0.4.5
 Summary: Metaflow Stubs: Stubs for the metaflow package
 Author: Netflix, Outerbounds & the Metaflow Community
 Author-email: help@outerbounds.co