ob-metaflow-stubs 6.0.10.19__py2.py3-none-any.whl → 6.0.10.21__py2.py3-none-any.whl

metaflow-stubs/runner/deployer_impl.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.272946                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.841576                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/runner/metaflow_runner.pyi

@@ -1,19 +1,20 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.245260                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.813761                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import metaflow
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
+    import metaflow.runner.metaflow_runner
     import metaflow.runner.subprocess_manager
     import metaflow.client.core
-    import metaflow.runner.metaflow_runner
 
 from ..client.core import Run as Run
+from ..client.core import Task as Task
 from ..plugins import get_runner_cli as get_runner_cli
 from .utils import temporary_fifo as temporary_fifo
 from .utils import handle_timeout as handle_timeout
@@ -24,27 +25,35 @@ from .subprocess_manager import SubprocessManager as SubprocessManager
 
 CLICK_API_PROCESS_CONFIG: bool
 
-class ExecutingRun(object, metaclass=type):
+class ExecutingProcess(object, metaclass=type):
     """
-    This class contains a reference to a `metaflow.Run` object representing
-    the currently executing or finished run, as well as metadata related
-    to the process.
+    This is a base class for `ExecutingRun` and `ExecutingTask` classes.
+    The `ExecutingRun` and `ExecutingTask` classes are returned by methods
+    in `Runner` and `NBRunner`, and they are subclasses of this class.
     
-    `ExecutingRun` is returned by methods in `Runner` and `NBRunner`. It is not
-    meant to be instantiated directly.
+    The `ExecutingRun` class for instance contains a reference to a `metaflow.Run`
+    object representing the currently executing or finished run, as well as the metadata
+    related to the process.
+    
+    Similarly, the `ExecutingTask` class contains a reference to a `metaflow.Task`
+    object representing the currently executing or finished task, as well as the metadata
+    related to the process.
+    
+    This class or its subclasses are not meant to be instantiated directly. The class
+    works as a context manager, allowing you to use a pattern like:
     
-    This class works as a context manager, allowing you to use a pattern like
     ```python
     with Runner(...).run() as running:
         ...
     ```
-    Note that you should use either this object as the context manager or
-    `Runner`, not both in a nested manner.
+    
+    Note that you should use either this object as the context manager or `Runner`, not both
+    in a nested manner.
     """
-    def __init__(self, runner: Runner, command_obj: metaflow.runner.subprocess_manager.CommandManager, run_obj: metaflow.client.core.Run):
+    def __init__(self, runner: Runner, command_obj: metaflow.runner.subprocess_manager.CommandManager):
         """
         Create a new ExecutingRun -- this should not be done by the user directly but
-        instead user Runner.run()
+        instead use Runner.run()
         
         Parameters
         ----------
@@ -56,11 +65,11 @@ class ExecutingRun(object, metaclass=type):
             Run object corresponding to this run.
         """
         ...
-    def __enter__(self) -> "ExecutingRun":
+    def __enter__(self) -> "ExecutingProcess":
         ...
     def __exit__(self, exc_type, exc_value, traceback):
         ...
-    def wait(self, timeout: typing.Optional[float] = None, stream: typing.Optional[str] = None) -> "ExecutingRun":
+    def wait(self, timeout: typing.Optional[float] = None, stream: typing.Optional[str] = None) -> "ExecutingProcess":
         """
         Wait for this run to finish, optionally with a timeout
         and optionally streaming its output.
@@ -79,7 +88,7 @@ class ExecutingRun(object, metaclass=type):
         
         Returns
         -------
-        ExecutingRun
+        ExecutingProcess
             This object, allowing you to chain calls.
         """
         ...
@@ -164,6 +173,68 @@ class ExecutingRun(object, metaclass=type):
         ...
     ...
 
+class ExecutingTask(ExecutingProcess, metaclass=type):
+    """
+    This class contains a reference to a `metaflow.Task` object representing
+    the currently executing or finished task, as well as metadata related
+    to the process.
+    `ExecutingTask` is returned by methods in `Runner` and `NBRunner`. It is not
+    meant to be instantiated directly.
+    This class works as a context manager, allowing you to use a pattern like
+    ```python
+    with Runner(...).spin() as running:
+        ...
+    ```
+    Note that you should use either this object as the context manager or
+    `Runner`, not both in a nested manner.
+    """
+    def __init__(self, runner: Runner, command_obj: metaflow.runner.subprocess_manager.CommandManager, task_obj: metaflow.client.core.Task):
+        """
+        Create a new ExecutingTask -- this should not be done by the user directly but
+        instead use Runner.spin()
+        Parameters
+        ----------
+        runner : Runner
+            Parent runner for this task.
+        command_obj : CommandManager
+            CommandManager containing the subprocess executing this task.
+        task_obj : Task
+            Task object corresponding to this task.
+        """
+        ...
+    ...
+
+class ExecutingRun(ExecutingProcess, metaclass=type):
+    """
+    This class contains a reference to a `metaflow.Run` object representing
+    the currently executing or finished run, as well as metadata related
+    to the process.
+    `ExecutingRun` is returned by methods in `Runner` and `NBRunner`. It is not
+    meant to be instantiated directly.
+    This class works as a context manager, allowing you to use a pattern like
+    ```python
+    with Runner(...).run() as running:
+        ...
+    ```
+    Note that you should use either this object as the context manager or
+    `Runner`, not both in a nested manner.
+    """
+    def __init__(self, runner: Runner, command_obj: metaflow.runner.subprocess_manager.CommandManager, run_obj: metaflow.client.core.Run):
+        """
+        Create a new ExecutingRun -- this should not be done by the user directly but
+        instead use Runner.run()
+        Parameters
+        ----------
+        runner : Runner
+            Parent runner for this run.
+        command_obj : CommandManager
+            CommandManager containing the subprocess executing this run.
+        run_obj : Run
+            Run object corresponding to this run.
+        """
+        ...
+    ...
+
 class RunnerMeta(type, metaclass=type):
     @staticmethod
     def __new__(mcs, name, bases, dct):
@@ -236,6 +307,27 @@ class Runner(object, metaclass=RunnerMeta):
             ExecutingRun containing the results of the run.
         """
         ...
+    def _Runner__get_executing_task(self, attribute_file_fd, command_obj):
+        ...
+    def _Runner__async_get_executing_task(self, attribute_file_fd, command_obj):
+        ...
+    def spin(self, pathspec, **kwargs) -> ExecutingTask:
+        """
+        Blocking spin execution of the run.
+        This method will wait until the spun run has completed execution.
+        Parameters
+        ----------
+        pathspec : str
+            The pathspec of the step/task to spin.
+        **kwargs : Any
+            Additional arguments that you would pass to `python ./myflow.py` after
+            the `spin` command.
+        Returns
+        -------
+        ExecutingTask
+            ExecutingTask containing the results of the spun task.
+        """
+        ...
     def resume(self, **kwargs) -> ExecutingRun:
         """
         Blocking resume execution of the run.
@@ -291,6 +383,27 @@ class Runner(object, metaclass=RunnerMeta):
             ExecutingRun representing the resumed run that was started.
         """
         ...
+    def async_spin(self, pathspec, **kwargs) -> ExecutingTask:
+        """
+        Non-blocking spin execution of the run.
+        This method will return as soon as the spun task has launched.
+        
+        Note that this method is asynchronous and needs to be `await`ed.
+        
+        Parameters
+        ----------
+        pathspec : str
+            The pathspec of the step/task to spin.
+        **kwargs : Any
+            Additional arguments that you would pass to `python ./myflow.py` after
+            the `spin` command.
+        
+        Returns
+        -------
+        ExecutingTask
+            ExecutingTask representing the spun task that was started.
+        """
+        ...
     def __exit__(self, exc_type, exc_value, traceback):
         ...
     def __aexit__(self, exc_type, exc_value, traceback):

metaflow-stubs/runner/nbdeploy.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.246119                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.814642                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/runner/nbrun.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.245764                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.814300                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/runner/subprocess_manager.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.272378                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.841020                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/runner/utils.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.271349                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.839983                                                            #
 ######################################################################################################
 
 from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import typing
-    import metaflow.runner.click_api
     import metaflow.runner.subprocess_manager
+    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.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.252442                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.821243                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/system/system_logger.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.291199                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.860529                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/system/system_monitor.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.290861                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.860204                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/tagging_util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.229781                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.797684                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/tuple_util.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.236288                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.803206                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/user_configs/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.229212                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.797097                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/user_configs/config_options.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.261785                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.830371                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/user_configs/config_parameters.pyi

@@ -1,21 +1,21 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.232854                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.800846                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
+import typing
 import metaflow
 import collections
-import typing
 import abc
 if typing.TYPE_CHECKING:
-    import collections.abc
+    import metaflow.user_configs.config_parameters
+    import metaflow.parameters
     import typing
+    import collections.abc
     import abc
-    import metaflow.parameters
-    import metaflow.user_configs.config_parameters
 
 from ..exception import MetaflowException as MetaflowException
 from ..parameters import Parameter as Parameter

metaflow-stubs/user_decorators/__init__.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.229461                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.797353                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/user_decorators/common.pyi

@@ -1,7 +1,7 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.262999                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.831583                                                            #
 ######################################################################################################
 
 from __future__ import annotations

metaflow-stubs/user_decorators/mutable_flow.pyi

@@ -1,19 +1,19 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.262600                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.831201                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import functools
     import metaflow.user_decorators.mutable_step
+    import functools
     import metaflow.flowspec
-    import typing
-    import metaflow.parameters
     import metaflow.user_configs.config_parameters
+    import metaflow.parameters
+    import typing
 
 from ..exception import MetaflowException as MetaflowException
 from ..user_configs.config_parameters import ConfigValue as ConfigValue

metaflow-stubs/user_decorators/mutable_step.pyi

@@ -1,19 +1,19 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.263618                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.832239                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import functools
     import metaflow.user_decorator.mutable_flow
-    import metaflow.user_decorators.user_step_decorator
+    import functools
+    import metaflow.flowspec
     import metaflow.decorators
+    import metaflow.user_decorators.user_step_decorator
     import typing
-    import metaflow.flowspec
 
 from ..exception import MetaflowException as MetaflowException
 from .user_step_decorator import StepMutator as StepMutator

metaflow-stubs/user_decorators/user_flow_decorator.pyi

@@ -1,18 +1,18 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.235073                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.803045                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import metaflow
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
-    import metaflow.user_decorators.mutable_flow
-    import metaflow.user_decorators.user_flow_decorator
     import metaflow.decorators
     import metaflow.flowspec
+    import metaflow.user_decorators.mutable_flow
+    import metaflow.user_decorators.user_flow_decorator
 
 from ..exception import MetaflowException as MetaflowException
 from ..user_configs.config_parameters import resolve_delayed_evaluator as resolve_delayed_evaluator

metaflow-stubs/user_decorators/user_step_decorator.pyi

@@ -1,20 +1,20 @@
 ######################################################################################################
 #                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.18.13.1+obcheckpoint(0.2.8);ob(v1)                                                   #
-# Generated on 2025-10-21T09:01:27.234354                                                            #
+# MF version: 2.19.4.1+obcheckpoint(0.2.8);ob(v1)                                                    #
+# Generated on 2025-10-29T20:50:15.802322                                                            #
 ######################################################################################################
 
 from __future__ import annotations
 
-import metaflow
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
     import metaflow.user_decorators.mutable_step
-    import metaflow.user_decorators.user_step_decorator
+    import metaflow.datastore.inputs
     import metaflow.decorators
-    import typing
     import metaflow.flowspec
-    import metaflow.datastore.inputs
+    import metaflow.user_decorators.user_step_decorator
+    import typing
 
 from ..exception import MetaflowException as MetaflowException
 from ..user_configs.config_parameters import resolve_delayed_evaluator as resolve_delayed_evaluator
@@ -237,7 +237,7 @@ def user_step_decorator(*args, **kwargs):
     
     ```
     @user_step_decorator
-    def timing(step_name, flow, inputs):
+    def timing(step_name, flow, inputs, attributes):
         start_time = time.time()
         yield
         end_time = time.time()
@@ -254,6 +254,15 @@ def user_step_decorator(*args, **kwargs):
     ```
     
     Your generator should:
+      - take 3 or 4 arguments: step_name, flow, inputs, and attributes (optional)
+        - step_name: the name of the step
+        - flow: the flow object
+        - inputs: the inputs to the step
+        - attributes: the kwargs passed in when initializing the decorator. In the
+          example above, something like `@timing(arg1="foo", arg2=42)` would make
+          `attributes = {"arg1": "foo", "arg2": 42}`. If you choose to pass arguments
+          to the decorator when you apply it to the step, your function *must* take
+          4 arguments (step_name, flow, inputs, attributes).
       - yield at most once -- if you do not yield, the step will not execute.
       - yield:
           - None

{ob_metaflow_stubs-6.0.10.19.dist-info → ob_metaflow_stubs-6.0.10.21.dist-info}/METADATA

@@ -1,12 +1,19 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: ob-metaflow-stubs
-Version: 6.0.10.19
+Version: 6.0.10.21
 Summary: Metaflow Stubs: Stubs for the metaflow package
 Author: Netflix, Outerbounds & the Metaflow Community
 Author-email: help@outerbounds.co
 License: Apache License 2.0
 Requires-Python: >=3.7.0
 Description-Content-Type: text/markdown
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: requires-python
+Dynamic: summary
 
 # Metaflow Stubs