ob-metaflow-stubs 6.0.3.125__py2.py3-none-any.whl → 6.0.3.127__py2.py3-none-any.whl

metaflow-stubs/runner/utils.pyi

@@ -1,16 +1,16 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.36.3+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-10T22:06:22.121510                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-12-17T21:56:50.939702                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.runner.subprocess_manager
     import metaflow.runner.click_api
     import typing
+    import metaflow.runner.subprocess_manager
 
 
 TYPE_CHECKING: bool
@@ -54,7 +54,7 @@ def read_from_fifo_when_ready(fifo_fd: int, command_obj: "metaflow.runner.subpro
     encoding : str, optional
         Encoding to use while reading the file, by default "utf-8".
     timeout : int, optional
-        Timeout for reading the file in milliseconds, by default 3600.
+        Timeout for reading the file in seconds, by default 3600.
     
     Returns
     -------
@@ -84,7 +84,7 @@ def async_read_from_fifo_when_ready(fifo_fd: int, command_obj: "metaflow.runner.
     encoding : str, optional
         Encoding to use while reading the file, by default "utf-8".
     timeout : int, optional
-        Timeout for reading the file in milliseconds, by default 3600.
+        Timeout for reading the file in seconds, by default 3600.
     
     Returns
     -------
@@ -116,7 +116,7 @@ def handle_timeout(attribute_file_fd: int, command_obj: "metaflow.runner.subproc
     command_obj : CommandManager
         Command manager object that encapsulates the running command details.
     file_read_timeout : int
-        Timeout for reading the file.
+        Timeout for reading the file, in seconds
     
     Returns
     -------
@@ -143,7 +143,7 @@ def async_handle_timeout(attribute_file_fd: int, command_obj: "metaflow.runner.s
     command_obj : CommandManager
         Command manager object that encapsulates the running command details.
     file_read_timeout : int
-        Timeout for reading the file.
+        Timeout for reading the file, in seconds
     
     Returns
     -------

metaflow-stubs/system/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.36.3+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-10T22:06:22.110648                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-12-17T21:56:50.929406                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/system/system_logger.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.36.3+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-10T22:06:22.134883                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-12-17T21:56:50.952740                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/system/system_monitor.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.36.3+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-10T22:06:22.134544                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-12-17T21:56:50.952395                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/tagging_util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.36.3+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-10T22:06:22.095403                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-12-17T21:56:50.911891                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/tuple_util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.36.3+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-10T22:06:22.096807                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-12-17T21:56:50.916095                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/{plugins/aws/step_functions/production_token.pyi → user_configs/__init__.pyi}

@@ -1,19 +1,13 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.12.36.3+obcheckpoint(0.1.4);ob(v1)                                                   #
-# Generated on 2024-12-10T22:06:22.166738                                                            #
+# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-12-17T21:56:50.911528                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 
-
-def new_token(token_prefix, prev_token = None):
-    ...
-
-def load_token(token_prefix):
-    ...
-
-def store_token(token_prefix, token):
-    ...
+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,253 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-12-17T21:56:50.915919                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.user_configs.config_parameters
+    import metaflow.user_configs.config_decorators
+    import metaflow.decorators
+    import functools
+    import typing
+    import metaflow.flowspec
+    import metaflow.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, 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 __get__(self, instance, owner):
+        ...
+    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

@@ -0,0 +1,82 @@
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.39.1+obcheckpoint(0.1.4);ob(v1)                                                   #
+# Generated on 2024-12-17T21:56:50.932287                                                            #
+######################################################################################################
+
+from __future__ import annotations
+
+import metaflow
+import typing
+if typing.TYPE_CHECKING:
+    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 ..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):
+        ...
+    @staticmethod
+    def mark_as_default(value):
+        ...
+    @staticmethod
+    def convert_value(value, is_default):
+        ...
+    ...
+
+class ConvertDictOrStr(metaflow._vendor.click.types.ParamType, metaclass=type):
+    def convert(self, value, param, ctx):
+        ...
+    @staticmethod
+    def convert_value(value, is_default):
+        ...
+    @staticmethod
+    def mark_as_default(value):
+        ...
+    ...
+
+class MultipleTuple(metaflow._vendor.click.types.Tuple, metaclass=type):
+    def split_envvar_value(self, rv):
+        ...
+    ...
+
+class ConfigInput(object, metaclass=type):
+    def __init__(self, req_configs: typing.List[str], defaults: typing.Dict[str, typing.Tuple[typing.Union[str, typing.Dict[typing.Any, typing.Any]], bool]], parsers: typing.Dict[str, typing.Union[str, typing.Callable[[str], typing.Dict[typing.Any, typing.Any]]]]):
+        ...
+    @staticmethod
+    def make_key_name(name: str) -> str:
+        ...
+    @classmethod
+    def set_config_file(cls, config_file: str):
+        ...
+    @classmethod
+    def get_config(cls, config_name: str) -> typing.Optional[typing.Dict[typing.Any, typing.Any]]:
+        ...
+    def process_configs(self, ctx, param, value):
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+class LocalFileInput(metaflow._vendor.click.types.Path, metaclass=type):
+    def convert(self, value, param, ctx):
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+def config_options(cmd):
+    ...
+