metaflow-stubs 2.12.28__py2.py3-none-any.whl → 2.12.29__py2.py3-none-any.whl

metaflow-stubs/runner/nbrun.pyi

@@ -1,153 +1,16 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.466910                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.574733                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 import typing
-if typing.TYPE_CHECKING:
-    import metaflow.runner.metaflow_runner
 
-class Runner(object, metaclass=type):
-    """
-    Metaflow's Runner API that presents a programmatic interface
-    to run flows and perform other operations either synchronously or asynchronously.
-    The class expects a path to the flow file along with optional arguments
-    that match top-level options on the command-line.
-    
-    This class works as a context manager, calling `cleanup()` to remove
-    temporary files at exit.
-    
-    Example:
-    ```python
-    with Runner('slowflow.py', pylint=False) as runner:
-        result = runner.run(alpha=5, tags=["abc", "def"], max_workers=5)
-        print(result.run.finished)
-    ```
-    
-    Parameters
-    ----------
-    flow_file : str
-        Path to the flow file to run
-    show_output : bool, default True
-        Show the 'stdout' and 'stderr' to the console by default,
-        Only applicable for synchronous 'run' and 'resume' functions.
-    profile : Optional[str], default None
-        Metaflow profile to use to run this run. If not specified, the default
-        profile is used (or the one already set using `METAFLOW_PROFILE`)
-    env : Optional[Dict], default None
-        Additional environment variables to set for the Run. This overrides the
-        environment set for this process.
-    cwd : Optional[str], default None
-        The directory to run the subprocess in; if not specified, the current
-        directory is used.
-    file_read_timeout : int, default 3600
-        The timeout until which we try to read the runner attribute file.
-    **kwargs : Any
-        Additional arguments that you would pass to `python myflow.py` before
-        the `run` command.
-    """
-    def __init__(self, flow_file: str, show_output: bool = True, profile: typing.Optional[str] = None, env: typing.Optional[typing.Dict] = None, cwd: typing.Optional[str] = None, file_read_timeout: int = 3600, **kwargs):
-        ...
-    def __enter__(self) -> metaflow.runner.metaflow_runner.Runner:
-        ...
-    def __aenter__(self) -> metaflow.runner.metaflow_runner.Runner:
-        ...
-    def _Runner__get_executing_run(self, tfp_runner_attribute, command_obj):
-        ...
-    def run(self, **kwargs) -> metaflow.runner.metaflow_runner.ExecutingRun:
-        """
-        Blocking execution of the run. This method will wait until
-        the run has completed execution.
-        
-        Parameters
-        ----------
-        **kwargs : Any
-            Additional arguments that you would pass to `python myflow.py` after
-            the `run` command, in particular, any parameters accepted by the flow.
-        
-        Returns
-        -------
-        ExecutingRun
-            ExecutingRun containing the results of the run.
-        """
-        ...
-    def resume(self, **kwargs):
-        """
-        Blocking resume execution of the run.
-        This method will wait until the resumed run has completed execution.
-        
-        Parameters
-        ----------
-        **kwargs : Any
-            Additional arguments that you would pass to `python ./myflow.py` after
-            the `resume` command.
-        
-        Returns
-        -------
-        ExecutingRun
-            ExecutingRun containing the results of the resumed run.
-        """
-        ...
-    def async_run(self, **kwargs) -> metaflow.runner.metaflow_runner.ExecutingRun:
-        """
-        Non-blocking execution of the run. This method will return as soon as the
-        run has launched.
-        
-        Note that this method is asynchronous and needs to be `await`ed.
-        
-        Parameters
-        ----------
-        **kwargs : Any
-            Additional arguments that you would pass to `python myflow.py` after
-            the `run` command, in particular, any parameters accepted by the flow.
-        
-        Returns
-        -------
-        ExecutingRun
-            ExecutingRun representing the run that was started.
-        """
-        ...
-    def async_resume(self, **kwargs):
-        """
-        Non-blocking resume execution of the run.
-        This method will return as soon as the resume has launched.
-        
-        Note that this method is asynchronous and needs to be `await`ed.
-        
-        Parameters
-        ----------
-        **kwargs : Any
-            Additional arguments that you would pass to `python myflow.py` after
-            the `resume` command.
-        
-        Returns
-        -------
-        ExecutingRun
-            ExecutingRun representing the resumed run that was started.
-        """
-        ...
-    def __exit__(self, exc_type, exc_value, traceback):
-        ...
-    def __aexit__(self, exc_type, exc_value, traceback):
-        ...
-    def cleanup(self):
-        """
-        Delete any temporary files created during execution.
-        """
-        ...
-    ...
-
-def get_current_cell(ipython):
-    ...
-
-def format_flowfile(cell):
-    """
-    Formats the given cell content to create a valid Python script that can be executed as a Metaflow flow.
-    """
-    ...
+from .metaflow_runner import Runner as Runner
+from .utils import get_current_cell as get_current_cell
+from .utils import format_flowfile as format_flowfile
 
 class NBRunnerInitializationError(Exception, metaclass=type):
     """
@@ -177,13 +40,13 @@ class NBRunner(object, metaclass=type):
     show_output : bool, default True
         Show the 'stdout' and 'stderr' to the console by default,
         Only applicable for synchronous 'run' and 'resume' functions.
-    profile : Optional[str], default None
+    profile : str, optional, default None
         Metaflow profile to use to run this run. If not specified, the default
         profile is used (or the one already set using `METAFLOW_PROFILE`)
-    env : Optional[Dict], default None
+    env : Dict[str, str], optional, default None
         Additional environment variables to set for the Run. This overrides the
         environment set for this process.
-    base_dir : Optional[str], default None
+    base_dir : str, optional, default None
         The directory to run the subprocess in; if not specified, the current
         working directory is used.
     file_read_timeout : int, default 3600

metaflow-stubs/runner/subprocess_manager.pyi

@@ -1,14 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.474626                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.581545                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 import typing
-if typing.TYPE_CHECKING:
-    import metaflow.runner.subprocess_manager
+
 
 def kill_process_and_descendants(pid, termination_timeout):
     ...
@@ -26,7 +25,7 @@ class SubprocessManager(object, metaclass=type):
     """
     def __init__(self):
         ...
-    def __aenter__(self) -> SubprocessManager:
+    def __aenter__(self) -> "SubprocessManager":
         ...
     def __aexit__(self, exc_type, exc_value, traceback):
         ...
@@ -120,7 +119,7 @@ class CommandManager(object, metaclass=type):
             directory is used.
         """
         ...
-    def __aenter__(self) -> CommandManager:
+    def __aenter__(self) -> "CommandManager":
         ...
     def __aexit__(self, exc_type, exc_value, traceback):
         ...
@@ -195,7 +194,7 @@ class CommandManager(object, metaclass=type):
             for example.
         """
         ...
-    def emit_logs(self, stream: str = "stdout", custom_logger: typing.Callable[..., None] = print):
+    def emit_logs(self, stream: str = 'stdout', custom_logger: typing.Callable[..., None] = print):
         """
         Helper function that can easily emit all the logs for a given stream.
         

metaflow-stubs/runner/utils.pyi

@@ -1,11 +1,18 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.475083                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.582314                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.runner.click_api
+    import metaflow.runner.subprocess_manager
+    import tempfile
+    import typing
+
 
 TYPE_CHECKING: bool
 
@@ -14,17 +21,18 @@ def get_current_cell(ipython):
 
 def format_flowfile(cell):
     """
-    Formats the given cell content to create a valid Python script that can be executed as a Metaflow flow.
+    Formats the given cell content to create a valid Python script that can be
+    executed as a Metaflow flow.
     """
     ...
 
-def check_process_status(command_obj: "CommandManager"):
+def check_process_status(command_obj: "metaflow.runner.subprocess_manager.CommandManager"):
     ...
 
-def read_from_file_when_ready(file_path: str, command_obj: "CommandManager", timeout: float = 5):
+def read_from_file_when_ready(file_path: str, command_obj: "metaflow.runner.subprocess_manager.CommandManager", timeout: float = 5):
     ...
 
-def handle_timeout(tfp_runner_attribute, command_obj: "CommandManager", file_read_timeout: int):
+def handle_timeout(tfp_runner_attribute: "tempfile._TemporaryFileWrapper[str]", command_obj: "metaflow.runner.subprocess_manager.CommandManager", file_read_timeout: int):
     """
     Handle the timeout for a running subprocess command that reads a file
     and raises an error with appropriate logs if a TimeoutError occurs.
@@ -51,3 +59,30 @@ def handle_timeout(tfp_runner_attribute, command_obj: "CommandManager", file_rea
     """
     ...
 
+def get_lower_level_group(api: "metaflow.runner.click_api.MetaflowAPI", top_level_kwargs: typing.Dict[str, typing.Any], sub_command: str, sub_command_kwargs: typing.Dict[str, typing.Any]) -> "metaflow.runner.click_api.MetaflowAPI":
+    """
+    Retrieve a lower-level group from the API based on the type and provided arguments.
+    
+    Parameters
+    ----------
+    api : MetaflowAPI
+        Metaflow API instance.
+    top_level_kwargs : Dict[str, Any]
+        Top-level keyword arguments to pass to the API.
+    sub_command : str
+        Sub-command of API to get the API for
+    sub_command_kwargs : Dict[str, Any]
+        Sub-command arguments
+    
+    Returns
+    -------
+    MetaflowAPI
+        The lower-level group object retrieved from the API.
+    
+    Raises
+    ------
+    ValueError
+        If the `_type` is None.
+    """
+    ...
+

metaflow-stubs/system/__init__.pyi

@@ -1,92 +1,14 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.469832                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.575565                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.monitor
-    import typing
-    import metaflow.event_logger
 
-class SystemMonitor(object, metaclass=type):
-    def __init__(self):
-        ...
-    def __del__(self):
-        ...
-    def init_system_monitor(self, flow_name: str, monitor: "metaflow.monitor.NullMonitor"):
-        ...
-    @property
-    def monitor(self) -> typing.Optional["metaflow.monitor.NullMonitor"]:
-        ...
-    def measure(self, name: str):
-        """
-        Context manager to measure the execution duration and counter of a block of code.
-        
-        Parameters
-        ----------
-        name : str
-            The name to associate with the timer and counter.
-        
-        Yields
-        ------
-        None
-        """
-        ...
-    def count(self, name: str):
-        """
-        Context manager to increment a counter.
-        
-        Parameters
-        ----------
-        name : str
-            The name of the counter.
-        
-        Yields
-        ------
-        None
-        """
-        ...
-    def gauge(self, gauge: "metaflow.monitor.Gauge"):
-        """
-        Log a gauge.
-        
-        Parameters
-        ----------
-        gauge : metaflow.monitor.Gauge
-            The gauge to log.
-        """
-        ...
-    ...
-
-class SystemLogger(object, metaclass=type):
-    def __init__(self):
-        ...
-    def __del__(self):
-        ...
-    def init_system_logger(self, flow_name: str, logger: "metaflow.event_logger.NullEventLogger"):
-        ...
-    @property
-    def logger(self) -> typing.Optional["metaflow.event_logger.NullEventLogger"]:
-        ...
-    def log_event(self, level: str, module: str, name: str, payload: typing.Optional[typing.Any] = None):
-        """
-        Log an event to the event logger.
-        
-        Parameters
-        ----------
-        level : str
-            Log level of the event. Can be one of "info", "warning", "error", "critical", "debug".
-        module : str
-            Module of the event. Usually the name of the class, function, or module that the event is being logged from.
-        name : str
-            Name of the event. Used to qualify the event type.
-        payload : Optional[Any], default None
-            Payload of the event. Contains the event data.
-        """
-        ...
-    ...
+from . import system_monitor as system_monitor
+from .system_monitor import SystemMonitor as SystemMonitor
+from . import system_logger as system_logger
+from .system_logger import SystemLogger as SystemLogger
 

metaflow-stubs/system/system_logger.pyi

@@ -1,15 +1,16 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.497194                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.600323                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import typing
     import metaflow.event_logger
+    import typing
+
 
 class SystemLogger(object, metaclass=type):
     def __init__(self):

metaflow-stubs/system/system_monitor.pyi

@@ -1,8 +1,8 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.496798                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.599913                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
@@ -10,6 +10,7 @@ import typing
 if typing.TYPE_CHECKING:
     import metaflow.monitor
 
+
 class SystemMonitor(object, metaclass=type):
     def __init__(self):
         ...

metaflow-stubs/tagging_util.pyi

@@ -1,17 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.439514                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.558598                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
-import typing
-if typing.TYPE_CHECKING:
-    import metaflow.exception
 
-class MetaflowTaggingError(metaflow.exception.MetaflowException, metaclass=type):
-    ...
+from .exception import MetaflowTaggingError as MetaflowTaggingError
 
 def is_utf8_encodable(x):
     """

metaflow-stubs/tuple_util.pyi

@@ -1,12 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.447296                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.561013                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 def namedtuple_with_defaults(typename, field_descr, defaults = ()):
     ...
 

metaflow-stubs/version.pyi

@@ -1,11 +1,12 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.469041                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.575284                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
+
 metaflow_version: str
 

{metaflow_stubs-2.12.28.dist-info → metaflow_stubs-2.12.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: metaflow-stubs
-Version: 2.12.28
+Version: 2.12.29
 Summary: Metaflow Stubs: Stubs for the metaflow package
 Author: Metaflow Developers
 Author-email: help@metaflow.org
@@ -21,7 +21,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.7.0
 Description-Content-Type: text/markdown
-Requires-Dist: metaflow==2.12.28
+Requires-Dist: metaflow==2.12.29
 
 # Metaflow Stubs