metaflow-stubs 2.12.25__py2.py3-none-any.whl → 2.12.27__py2.py3-none-any.whl

metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.847630                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.951991                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/logs_cli.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.838207                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.930455                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/package_cli.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.836205                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.928521                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/parallel_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.827064                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.917710                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -73,18 +73,19 @@ class ParallelDecorator(metaflow.decorators.StepDecorator, metaclass=type):
     MF Add To Current
     -----------------
     parallel -> metaflow.metaflow_current.Parallel
+        Returns a namedtuple with relevant information about the parallel task.
     
         @@ Returns
         -------
         Parallel
             `namedtuple` with the following fields:
-                - main_ip : str
+                - main_ip (`str`)
                     The IP address of the control task.
-                - num_nodes : int
+                - num_nodes (`int`)
                     The total number of tasks created by @parallel
-                - node_index : int
+                - node_index (`int`)
                     The index of the current task in all the @parallel tasks.
-                - control_task_id : Optional[str]
+                - control_task_id (`Optional[str]`)
                     The task ID of the control task. Available to all tasks.
     
     is_parallel -> bool

metaflow-stubs/plugins/project_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.830631                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.922622                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/pypi/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.826223                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.917962                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/pypi/conda_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.855993                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.940233                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/pypi/conda_environment.pyi

@@ -1,17 +1,17 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.857749                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.941533                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.exception
-    import abc
     import metaflow.metaflow_environment
+    import metaflow.exception
     import io
+    import abc
 
 class MetaflowException(Exception, metaclass=type):
     def __init__(self, msg = "", lineno = None):

metaflow-stubs/plugins/pypi/pypi_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.856411                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.939511                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/pypi/pypi_environment.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.858349                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.941997                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.plugins.pypi.conda_environment
     import metaflow.metaflow_environment
+    import metaflow.plugins.pypi.conda_environment
 
 class CondaEnvironment(metaflow.metaflow_environment.MetaflowEnvironment, metaclass=type):
     def __init__(self, flow):

metaflow-stubs/plugins/pypi/utils.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.856769                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.940590                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/resources_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.825852                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.918390                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -32,7 +32,7 @@ class ResourcesDecorator(metaflow.decorators.StepDecorator, metaclass=type):
     ----------
     cpu : int, default 1
         Number of CPUs required for this step.
-    gpu : int, default 0
+    gpu : int, optional, default None
         Number of GPUs required for this step.
     disk : int, optional, default None
         Disk size (in MB) required for this step. Only applies on Kubernetes.

metaflow-stubs/plugins/retry_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.827905                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.919658                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/secrets/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.827337                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.921577                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.859945                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.981371                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/secrets/secrets_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.859673                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.981096                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/storage_executor.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.831151                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.923648                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/tag_cli.pyi

@@ -1,18 +1,18 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.837674                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.929920                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.metaflow_current
     import metaflow.client.core
-    import metaflow.exception
     import datetime
     import metaflow.events
+    import metaflow.exception
+    import metaflow.metaflow_current
 
 def namespace(ns: typing.Optional[str]) -> typing.Optional[str]:
     """

metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.824455                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.916876                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/plugins/timeout_decorator.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.825560                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.918857                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/procpoll.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.817065                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.909694                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/pylint_wrapper.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.816585                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.909209                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/runner/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.793607                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.886875                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/runner/deployer.pyi

@@ -1,16 +1,16 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.814682                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.907372                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
+    import metaflow.runner.subprocess_manager
     import metaflow.exception
     import metaflow.runner.deployer
-    import metaflow.runner.subprocess_manager
 
 class MetaflowNotFound(metaflow.exception.MetaflowException, metaclass=type):
     ...

metaflow-stubs/runner/metaflow_runner.pyi

@@ -1,18 +1,18 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.812044                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.904810                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.client.core
     import metaflow.runner.subprocess_manager
+    import metaflow.client.core
+    import metaflow.runner.metaflow_runner
     import datetime
     import metaflow.events
-    import metaflow.runner.metaflow_runner
 
 class Run(metaflow.client.core.MetaflowObject, metaclass=type):
     """
@@ -266,34 +266,6 @@ class Run(metaflow.client.core.MetaflowObject, metaclass=type):
         ...
     ...
 
-def metadata(ms: str) -> str:
-    """
-    Switch Metadata provider.
-    
-    This call has a global effect. Selecting the local metadata will,
-    for example, not allow access to information stored in remote
-    metadata providers.
-    
-    Note that you don't typically have to call this function directly. Usually
-    the metadata provider is set through the Metaflow configuration file. If you
-    need to switch between multiple providers, you can use the `METAFLOW_PROFILE`
-    environment variable to switch between configurations.
-    
-    Parameters
-    ----------
-    ms : str
-        Can be a path (selects local metadata), a URL starting with http (selects
-        the service metadata) or an explicit specification <metadata_type>@<info>; as an
-        example, you can specify local@<path> or service@<url>.
-    
-    Returns
-    -------
-    str
-        The description of the metadata selected (equivalent to the result of
-        get_metadata()).
-    """
-    ...
-
 def handle_timeout(tfp_runner_attribute, command_obj: "CommandManager", file_read_timeout: int):
     """
     Handle the timeout for a running subprocess command that reads a file
@@ -321,9 +293,6 @@ def handle_timeout(tfp_runner_attribute, command_obj: "CommandManager", file_rea
     """
     ...
 
-def clear_and_set_os_environ(env: typing.Dict):
-    ...
-
 class CommandManager(object, metaclass=type):
     """
     A manager for an individual subprocess.

metaflow-stubs/runner/nbdeploy.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.815315                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.907960                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -61,8 +61,6 @@ def format_flowfile(cell):
     """
     ...
 
-DEFAULT_DIR: str
-
 class NBDeployerInitializationError(Exception, metaclass=type):
     """
     Custom exception for errors during NBDeployer initialization.
@@ -101,13 +99,13 @@ class NBDeployer(object, metaclass=type):
         Additional environment variables to set. This overrides the
         environment set for this process.
     base_dir : Optional[str], default None
-        The directory to run the subprocess in; if not specified, a temporary
-        directory is used.
+        The directory to run the subprocess in; if not specified, the current
+        working directory is used.
     **kwargs : Any
         Additional arguments that you would pass to `python myflow.py` i.e. options
         listed in `python myflow.py --help`
     """
-    def __init__(self, flow, show_output: bool = True, profile: typing.Optional[str] = None, env: typing.Optional[typing.Dict] = None, base_dir: str = "/tmp", file_read_timeout: int = 3600, **kwargs):
+    def __init__(self, flow, show_output: bool = True, profile: typing.Optional[str] = None, env: typing.Optional[typing.Dict] = None, base_dir: typing.Optional[str] = None, file_read_timeout: int = 3600, **kwargs):
         ...
     def cleanup(self):
         """

metaflow-stubs/runner/nbrun.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.813230                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.905910                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -149,8 +149,6 @@ def format_flowfile(cell):
     """
     ...
 
-DEFAULT_DIR: str
-
 class NBRunnerInitializationError(Exception, metaclass=type):
     """
     Custom exception for errors during NBRunner initialization.
@@ -186,15 +184,15 @@ class NBRunner(object, metaclass=type):
         Additional environment variables to set for the Run. This overrides the
         environment set for this process.
     base_dir : Optional[str], default None
-        The directory to run the subprocess in; if not specified, a temporary
-        directory is used.
+        The directory to run the subprocess in; if not specified, the current
+        working 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, show_output: bool = True, profile: typing.Optional[str] = None, env: typing.Optional[typing.Dict] = None, base_dir: str = "/tmp", file_read_timeout: int = 3600, **kwargs):
+    def __init__(self, flow, show_output: bool = True, profile: typing.Optional[str] = None, env: typing.Optional[typing.Dict] = None, base_dir: typing.Optional[str] = None, file_read_timeout: int = 3600, **kwargs):
         ...
     def nbrun(self, **kwargs):
         """

metaflow-stubs/runner/subprocess_manager.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.821318                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.913841                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/runner/utils.pyi

@@ -1,12 +1,11 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.821818                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.914302                                        #
 ##################################################################################
 
 from __future__ import annotations
 
-import typing
 
 TYPE_CHECKING: bool
 
@@ -19,9 +18,6 @@ def format_flowfile(cell):
     """
     ...
 
-def clear_and_set_os_environ(env: typing.Dict):
-    ...
-
 def check_process_status(command_obj: "CommandManager"):
     ...
 

metaflow-stubs/system/__init__.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.816227                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.908859                                        #
 ##################################################################################
 
 from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.event_logger
-    import typing
     import metaflow.monitor
+    import typing
 
 class SystemMonitor(object, metaclass=type):
     def __init__(self):

metaflow-stubs/system/system_logger.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.844108                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.936175                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/system/system_monitor.pyi

@@ -1,15 +1,15 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.843664                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.935737                                        #
 ##################################################################################
 
 from __future__ import annotations
 
 import typing
 if typing.TYPE_CHECKING:
-    import typing
     import metaflow.monitor
+    import typing
 
 class SystemMonitor(object, metaclass=type):
     def __init__(self):

metaflow-stubs/tagging_util.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.784730                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.878193                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/tuple_util.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.793480                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.886741                                        #
 ##################################################################################
 
 from __future__ import annotations

metaflow-stubs/version.pyi

@@ -1,7 +1,7 @@
 ##################################################################################
 #                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.25                                                            #
-# Generated on 2024-10-07T19:08:03.815433                                        #
+# MF version: 2.12.27                                                            #
+# Generated on 2024-10-24T19:27:17.908084                                        #
 ##################################################################################
 
 from __future__ import annotations

{metaflow_stubs-2.12.25.dist-info → metaflow_stubs-2.12.27.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: metaflow-stubs
-Version: 2.12.25
+Version: 2.12.27
 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.25
+Requires-Dist: metaflow==2.12.27
 
 # Metaflow Stubs