metaflow-stubs 2.15.21__py2.py3-none-any.whl → 2.16.1__py2.py3-none-any.whl

metaflow-stubs/runner/metaflow_runner.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:13.017240                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.963938                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
 import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.client.core
     import metaflow.runner.subprocess_manager
+    import metaflow.client.core
     import metaflow.runner.metaflow_runner
 
 from ..client.core import Run as Run

metaflow-stubs/runner/nbdeploy.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:13.018302                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.964930                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/runner/nbrun.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:13.017899                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.964531                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/runner/subprocess_manager.pyi

@@ -1,13 +1,14 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:13.025745                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.978070                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 
+from ..packaging_sys import MetaflowCodeContent as MetaflowCodeContent
 from .utils import check_process_exited as check_process_exited
 
 def kill_processes_and_descendants(pids: typing.List[str], termination_timeout: float):

metaflow-stubs/runner/utils.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:13.024407                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.976811                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -9,9 +9,9 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.runner.subprocess_manager
-    import metaflow.runner.click_api
-    import typing
     import types
+    import typing
+    import metaflow.runner.click_api
 
 
 TYPE_CHECKING: bool

metaflow-stubs/system/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:13.018895                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.965482                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/system/system_logger.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:13.044399                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.995610                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/system/system_monitor.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:13.043991                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.995191                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/tagging_util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:12.996089                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.943239                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/tuple_util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:13.001956                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.950767                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/user_configs/__init__.pyi

@@ -1,13 +1,12 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:12.995686                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.942633                                                            #
 ######################################################################################################
 
 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_options.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.15.21                                                                                #
-# Generated on 2025-07-11T15:58:13.021121                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.971376                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -16,11 +16,10 @@ 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.15.21                                                                                #
-# Generated on 2025-07-11T15:58:12.999830                                                            #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.947054                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import metaflow
 import collections
 import typing
+import metaflow
 import abc
 if typing.TYPE_CHECKING:
+    import typing
+    import metaflow.user_configs.config_parameters
     import collections.abc
     import metaflow.parameters
     import abc
-    import metaflow.user_configs.config_parameters
-    import typing
 
 from ..exception import MetaflowException as MetaflowException
 from ..parameters import Parameter as Parameter
@@ -23,8 +23,6 @@ from ..parameters import ParameterContext as ParameterContext
 
 TYPE_CHECKING: bool
 
-CONFIG_FILE: str
-
 UNPACK_KEY: str
 
 def dump_config_values(flow: "FlowSpec"):

metaflow-stubs/user_decorators/__init__.pyi

@@ -0,0 +1,15 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.942870                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+
+from . import mutable_flow as mutable_flow
+from . import common as common
+from . import user_step_decorator as user_step_decorator
+from . import mutable_step as mutable_step
+from . import user_flow_decorator as user_flow_decorator
+

metaflow-stubs/user_decorators/common.pyi

@@ -0,0 +1,38 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.972876                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+
+
+class ClassPath_Trie(object, metaclass=type):
+    def __init__(self):
+        ...
+    def init(self, initial_nodes: typing.Optional[typing.List[typing.Tuple[str, type]]] = None):
+        ...
+    def insert(self, classpath_name: str, value: type):
+        ...
+    def search(self, classpath_name: str) -> typing.Optional[type]:
+        ...
+    def remove(self, classpath_name: str):
+        ...
+    def unique_prefix_value(self, classpath_name: str) -> typing.Optional[type]:
+        ...
+    def unique_prefix_for_type(self, value: type) -> typing.Optional[str]:
+        ...
+    def get_unique_prefixes(self) -> typing.Dict[str, type]:
+        """
+        Get all unique prefixes in the trie.
+        
+        Returns
+        -------
+        List[str]
+            A list of unique prefixes.
+        """
+        ...
+    ...
+

metaflow-stubs/user_decorators/mutable_flow.pyi

@@ -0,0 +1,223 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.972408                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import typing
+    import metaflow.user_configs.config_parameters
+    import metaflow.flowspec
+    import functools
+    import metaflow.parameters
+    import metaflow.user_decorators.mutable_step
+
+from ..exception import MetaflowException as MetaflowException
+from ..user_configs.config_parameters import ConfigValue as ConfigValue
+
+TYPE_CHECKING: bool
+
+class MutableFlow(object, metaclass=type):
+    def __init__(self, flow_spec: "metaflow.flowspec.FlowSpec", pre_mutate: bool = False, statically_defined: bool = False, inserted_by: typing.Optional[str] = None):
+        ...
+    @property
+    def decorator_specs(self) -> typing.Generator[typing.Tuple[str, str, typing.List[typing.Any], typing.Dict[str, typing.Any]], None, None]:
+        """
+        Iterate over all the decorator specifications of this flow. Note that the same
+        type of decorator may be present multiple times and no order is guaranteed.
+        
+        The returned tuple contains:
+        - The decorator's name (shortest possible)
+        - The decorator's fully qualified name (in the case of Metaflow decorators, this
+          will indicate which extension the decorator comes from)
+        - A list of positional arguments
+        - A dictionary of keyword arguments
+        
+        You can use the decorator specification to remove a decorator from the flow
+        for example.
+        
+        Yields
+        ------
+        str, str, List[Any], Dict[str, Any]
+            A tuple containing the decorator name, it's fully qualified name,
+            a list of positional arguments, and a dictionary of keyword arguments.
+        """
+        ...
+    @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
+        `pre_mutate`/`mutate` methods can add decorators to steps in the flow that
+        depend on values in the configuration.
+        
+        ```
+        class MyDecorator(FlowMutator):
+            def mutate(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, "metaflow.parameters.Parameter"], None, None]:
+        """
+        Iterate over all the parameters in this flow.
+        
+        Yields
+        ------
+        Tuple[str, Parameter]
+            Name of the parameter and parameter in the flow
+        """
+        ...
+    @property
+    def steps(self) -> typing.Generator[typing.Tuple[str, "metaflow.user_decorators.mutable_step.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):
+        """
+        Add a parameter to the flow. You can only add parameters in the `pre_mutate`
+        method.
+        
+        Parameters
+        ----------
+        name : str
+            Name of the parameter
+        value : Parameter
+            Parameter to add to the flow
+        overwrite : bool, default False
+            If True, overwrite the parameter if it already exists
+        """
+        ...
+    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.
+        You can only remove parameters in the `pre_mutate` method.
+        
+        Parameters
+        ----------
+        parameter_name : str
+            Name of the parameter
+        
+        Returns
+        -------
+        bool
+            Returns True if the parameter was removed
+        """
+        ...
+    def add_decorator(self, deco_type: typing.Union[functools.partial, str], deco_args: typing.Optional[typing.List[typing.Any]] = None, deco_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None, duplicates: int = 1):
+        """
+        Add a Metaflow flow-decorator to a flow. You can only add decorators in the
+        `pre_mutate` method.
+        
+        You can either add the decorator itself or its decorator specification for it
+        (the same you would get back from decorator_specs). You can also mix and match
+        but you cannot provide arguments both through the string and the
+        deco_args/deco_kwargs.
+        
+        As an example:
+        ```
+        from metaflow import project
+        
+        ...
+        my_flow.add_decorator(project, deco_kwargs={"name":"my_project"})
+        ```
+        
+        is equivalent to:
+        ```
+        my_flow.add_decorator("project:name=my_project")
+        ```
+        
+        Note in the later case, there is no need to import the flow decorator.
+        
+        The latter syntax is useful to, for example, allow decorators to be stored as
+        strings in a configuration file.
+        
+        In terms of precedence for decorators:
+          - if a decorator can be applied multiple times all decorators
+            added are kept (this is rare for flow-decorators).
+          - if `duplicates` is set to `MutableFlow.IGNORE`, then the decorator
+            being added is ignored (in other words, the existing decorator has precedence).
+          - if `duplicates` is set to `MutableFlow.OVERRIDE`, then the *existing*
+            decorator is removed and this newly added one replaces it (in other
+            words, the newly added decorator has precedence).
+          - if `duplicates` is set to `MutableFlow.ERROR`, then an error is raised but only
+            if the newly added decorator is *static* (ie: defined directly in the code).
+            If not, it is ignored.
+        
+        Parameters
+        ----------
+        deco_type : Union[partial, str]
+            The decorator class to add to this flow. If using a string, you cannot specify
+            additional arguments as all argument will be parsed from the decorator
+            specification.
+        deco_args : List[Any], optional, default None
+            Positional arguments to pass to the decorator.
+        deco_kwargs : Dict[str, Any], optional, default None
+            Keyword arguments to pass to the decorator.
+        duplicates : int, default MutableFlow.IGNORE
+            Instruction on how to handle duplicates. It can be one of:
+            - `MutableFlow.IGNORE`: Ignore the decorator if it already exists.
+            - `MutableFlow.ERROR`: Raise an error if the decorator already exists.
+            - `MutableFlow.OVERRIDE`: Remove the existing decorator and add this one.
+        """
+        ...
+    def remove_decorator(self, deco_name: str, deco_args: typing.Optional[typing.List[typing.Any]] = None, deco_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None) -> bool:
+        """
+        Remove a flow-level decorator. To remove a decorator, you can pass the decorator
+        specification (obtained from `decorator_specs` for example).
+        Note that if multiple decorators share the same decorator specification
+        (very rare), they will all be removed.
+        
+        You can only remove decorators in the `pre_mutate` method.
+        
+        Parameters
+        ----------
+        deco_name : str
+            Decorator specification of the decorator to remove. If nothing else is
+            specified, all decorators matching that name will be removed.
+        deco_args : List[Any], optional, default None
+            Positional arguments to match the decorator specification.
+        deco_kwargs : Dict[str, Any], optional, default None
+            Keyword arguments to match the decorator specification.
+        
+        Returns
+        -------
+        bool
+            Returns True if a decorator was removed.
+        """
+        ...
+    def __getattr__(self, name):
+        ...
+    ...
+

metaflow-stubs/user_decorators/mutable_step.pyi

@@ -0,0 +1,152 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.16.1                                                                                 #
+# Generated on 2025-07-15T19:29:42.973641                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.decorators
+    import typing
+    import metaflow.flowspec
+    import functools
+    import metaflow.user_decorator.mutable_flow
+    import metaflow.user_decorators.user_step_decorator
+
+from ..exception import MetaflowException as MetaflowException
+from .user_step_decorator import StepMutator as StepMutator
+from .user_step_decorator import UserStepDecoratorBase as UserStepDecoratorBase
+
+TYPE_CHECKING: bool
+
+class MutableStep(object, metaclass=type):
+    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]], pre_mutate: bool = False, statically_defined: bool = False, inserted_by: typing.Optional[str] = None):
+        ...
+    @property
+    def flow(self) -> "metaflow.user_decorator.mutable_flow.MutableFlow":
+        """
+        The flow that contains this step
+        
+        Returns
+        -------
+        MutableFlow
+            The flow that contains this step
+        """
+        ...
+    @property
+    def decorator_specs(self) -> typing.Generator[typing.Tuple[str, str, typing.List[typing.Any], typing.Dict[str, typing.Any]], None, None]:
+        """
+        Iterate over all the decorator specifications of this step. Note that the same
+        type of decorator may be present multiple times and no order is guaranteed.
+        
+        The returned tuple contains:
+        - The decorator's name (shortest possible)
+        - The decorator's fully qualified name (in the case of Metaflow decorators, this
+          will indicate which extension the decorator comes from)
+        - A list of positional arguments
+        - A dictionary of keyword arguments
+        
+        You can use the resulting tuple to remove a decorator for example
+        
+        Yields
+        ------
+        str, str, List[Any], Dict[str, Any]
+            A tuple containing the decorator name, it's fully qualified name,
+            a list of positional arguments, and a dictionary of keyword arguments.
+        """
+        ...
+    def add_decorator(self, deco_type: typing.Union[functools.partial, metaflow.user_decorators.user_step_decorator.UserStepDecoratorBase, str], deco_args: typing.Optional[typing.List[typing.Any]] = None, deco_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None, duplicates: int = 1):
+        """
+        Add a Metaflow step-decorator or a user step-decorator to a step.
+        
+        You can either add the decorator itself or its decorator specification for it
+        (the same you would get back from decorator_specs). You can also mix and match
+        but you cannot provide arguments both through the string and the
+        deco_args/deco_kwargs.
+        
+        As an example:
+        ```
+        from metaflow import environment
+        ...
+        my_step.add_decorator(environment, deco_kwargs={"vars": {"foo": 42})}
+        ```
+        
+        is equivalent to:
+        ```
+        my_step.add_decorator('environment:vars={"foo": 42}')
+        ```
+        
+        is equivalent to:
+        ```
+        my_step.add_decorator('environment', deco_kwargs={"vars":{"foo": 42}})
+        ```
+        
+        but this is not allowed:
+        ```
+        my_step.add_decorator('environment:vars={"bar" 43}', deco_kwargs={"vars":{"foo": 42}})
+        ```
+        
+        Note in the case where you specify a
+        string for the decorator, there is no need to import the decorator.
+        
+        The string syntax is useful to, for example, allow decorators to be stored as
+        strings in a configuration file.
+        
+        You can only add StepMutators in the pre_mutate stage.
+        
+        In terms of precedence for decorators:
+          - if a decorator can be applied multiple times (like `@card`) all decorators
+            added are kept.
+          - if `duplicates` is set to `MutableStep.IGNORE`, then the decorator
+            being added is ignored (in other words, the existing decorator has precedence).
+          - if `duplicates` is set to `MutableStep.OVERRIDE`, then the *existing*
+            decorator is removed and this newly added one replaces it (in other
+            words, the newly added decorator has precedence).
+          - if `duplicates` is set to `MutableStep.ERROR`, then an error is raised but only
+            if the newly added decorator is *static* (ie: defined directly in the code).
+            If not, it is ignored.
+        
+        Parameters
+        ----------
+        deco_type : Union[partial, UserStepDecoratorBase, str]
+            The decorator class to add to this step.
+        deco_args : List[Any], optional, default None
+            Positional arguments to pass to the decorator.
+        deco_kwargs : Dict[str, Any], optional, default None
+            Keyword arguments to pass to the decorator.
+        duplicates : int, default MutableStep.IGNORE
+            Instruction on how to handle duplicates. It can be one of:
+            - `MutableStep.IGNORE`: Ignore the decorator if it already exists.
+            - `MutableStep.ERROR`: Raise an error if the decorator already exists.
+            - `MutableStep.OVERRIDE`: Remove the existing decorator and add this one.
+        """
+        ...
+    def remove_decorator(self, deco_name: str, deco_args: typing.Optional[typing.List[typing.Any]] = None, deco_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None) -> bool:
+        """
+        Remove a step-level decorator. To remove a decorator, you can pass the decorator
+        specification (obtained from `decorator_specs` for example).
+        Note that if multiple decorators share the same decorator specification
+        (very rare), they will all be removed.
+        
+        You can only remove StepMutators in the `pre_mutate` method.
+        
+        Parameters
+        ----------
+        deco_name : str
+            Decorator specification of the decorator to remove. If nothing else is
+            specified, all decorators matching that name will be removed.
+        deco_args : List[Any], optional, default None
+            Positional arguments to match the decorator specification.
+        deco_kwargs : Dict[str, Any], optional, default None
+            Keyword arguments to match the decorator specification.
+        
+        Returns
+        -------
+        bool
+            Returns True if a decorator was removed.
+        """
+        ...
+    ...
+