metaflow-stubs 2.18.12__py2.py3-none-any.whl → 2.19.0__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of metaflow-stubs might be problematic. Click here for more details.
- metaflow-stubs/__init__.pyi +503 -502
- metaflow-stubs/cards.pyi +2 -2
- metaflow-stubs/cli.pyi +2 -2
- metaflow-stubs/cli_components/__init__.pyi +2 -2
- metaflow-stubs/cli_components/utils.pyi +2 -2
- metaflow-stubs/client/__init__.pyi +3 -2
- metaflow-stubs/client/core.pyi +62 -31
- metaflow-stubs/client/filecache.pyi +20 -4
- metaflow-stubs/events.pyi +7 -8
- metaflow-stubs/exception.pyi +2 -2
- metaflow-stubs/flowspec.pyi +7 -8
- metaflow-stubs/generated_for.txt +1 -1
- metaflow-stubs/includefile.pyi +4 -4
- metaflow-stubs/meta_files.pyi +2 -2
- metaflow-stubs/metadata_provider/__init__.pyi +2 -2
- metaflow-stubs/metadata_provider/heartbeat.pyi +2 -2
- metaflow-stubs/metadata_provider/metadata.pyi +2 -2
- metaflow-stubs/metadata_provider/util.pyi +2 -2
- metaflow-stubs/metaflow_config.pyi +16 -2
- metaflow-stubs/metaflow_current.pyi +32 -34
- metaflow-stubs/metaflow_git.pyi +3 -5
- metaflow-stubs/multicore_utils.pyi +4 -4
- metaflow-stubs/packaging_sys/__init__.pyi +39 -40
- metaflow-stubs/packaging_sys/backend.pyi +13 -13
- metaflow-stubs/packaging_sys/distribution_support.pyi +6 -7
- metaflow-stubs/packaging_sys/tar_backend.pyi +11 -11
- metaflow-stubs/packaging_sys/utils.pyi +3 -6
- metaflow-stubs/packaging_sys/v1.pyi +4 -4
- metaflow-stubs/parameters.pyi +6 -9
- metaflow-stubs/plugins/__init__.pyi +11 -11
- metaflow-stubs/plugins/airflow/__init__.pyi +2 -2
- metaflow-stubs/plugins/airflow/airflow_decorator.pyi +2 -2
- metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
- metaflow-stubs/plugins/airflow/exception.pyi +2 -2
- metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
- metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
- metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
- metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
- metaflow-stubs/plugins/argo/__init__.pyi +2 -2
- metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
- metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
- metaflow-stubs/plugins/argo/argo_workflows.pyi +3 -3
- metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +4 -4
- metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +5 -3
- metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +11 -9
- metaflow-stubs/plugins/argo/exit_hooks.pyi +4 -7
- metaflow-stubs/plugins/aws/__init__.pyi +3 -3
- metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
- metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
- metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -2
- metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
- metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
- metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +2 -2
- metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
- metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +3 -3
- metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/dynamo_db_client.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/step_functions_decorator.pyi +2 -2
- metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +5 -3
- metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +9 -7
- metaflow-stubs/plugins/azure/__init__.pyi +2 -2
- metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
- metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
- metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +3 -3
- metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
- metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
- metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
- metaflow-stubs/plugins/cards/__init__.pyi +2 -2
- metaflow-stubs/plugins/cards/card_client.pyi +5 -6
- metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
- metaflow-stubs/plugins/cards/card_datastore.pyi +4 -2
- metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/basic.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/components.pyi +14 -14
- metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/json_viewer.pyi +4 -4
- metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
- metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
- metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
- metaflow-stubs/plugins/cards/component_serializer.pyi +2 -2
- metaflow-stubs/plugins/cards/exception.pyi +2 -2
- metaflow-stubs/plugins/catch_decorator.pyi +3 -3
- metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
- metaflow-stubs/plugins/datatools/local.pyi +2 -2
- metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
- metaflow-stubs/plugins/datatools/s3/s3.pyi +27 -35
- metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
- metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
- metaflow-stubs/plugins/debug_logger.pyi +2 -2
- metaflow-stubs/plugins/debug_monitor.pyi +2 -2
- metaflow-stubs/plugins/environment_decorator.pyi +2 -2
- metaflow-stubs/plugins/events_decorator.pyi +2 -2
- metaflow-stubs/plugins/exit_hook/__init__.pyi +2 -2
- metaflow-stubs/plugins/exit_hook/exit_hook_decorator.pyi +2 -2
- metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
- metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
- metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
- metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +3 -3
- metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
- metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
- metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
- metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/__init__.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kube_utils.pyi +3 -3
- metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes_job.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
- metaflow-stubs/plugins/kubernetes/spot_monitor_sidecar.pyi +2 -2
- metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
- metaflow-stubs/plugins/parsers.pyi +2 -2
- metaflow-stubs/plugins/project_decorator.pyi +2 -2
- metaflow-stubs/plugins/pypi/__init__.pyi +2 -2
- metaflow-stubs/plugins/pypi/conda_decorator.pyi +2 -2
- metaflow-stubs/plugins/pypi/conda_environment.pyi +3 -3
- metaflow-stubs/plugins/pypi/parsers.pyi +2 -2
- metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
- metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
- metaflow-stubs/plugins/pypi/utils.pyi +2 -2
- metaflow-stubs/plugins/resources_decorator.pyi +2 -2
- metaflow-stubs/plugins/retry_decorator.pyi +2 -2
- metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
- metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +3 -3
- metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
- metaflow-stubs/plugins/secrets/secrets_func.pyi +3 -5
- metaflow-stubs/plugins/secrets/secrets_spec.pyi +2 -2
- metaflow-stubs/plugins/secrets/utils.pyi +2 -2
- metaflow-stubs/plugins/storage_executor.pyi +2 -2
- metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +3 -3
- metaflow-stubs/plugins/timeout_decorator.pyi +3 -3
- metaflow-stubs/plugins/uv/__init__.pyi +2 -2
- metaflow-stubs/plugins/uv/uv_environment.pyi +3 -3
- metaflow-stubs/pylint_wrapper.pyi +2 -2
- metaflow-stubs/runner/__init__.pyi +2 -2
- metaflow-stubs/runner/deployer.pyi +20 -19
- metaflow-stubs/runner/deployer_impl.pyi +6 -4
- metaflow-stubs/runner/metaflow_runner.pyi +134 -21
- metaflow-stubs/runner/nbdeploy.pyi +3 -3
- metaflow-stubs/runner/nbrun.pyi +3 -3
- metaflow-stubs/runner/subprocess_manager.pyi +8 -8
- metaflow-stubs/runner/utils.pyi +4 -5
- metaflow-stubs/system/__init__.pyi +2 -2
- metaflow-stubs/system/system_logger.pyi +4 -5
- metaflow-stubs/system/system_monitor.pyi +3 -3
- metaflow-stubs/tagging_util.pyi +2 -2
- metaflow-stubs/tuple_util.pyi +2 -2
- metaflow-stubs/user_configs/__init__.pyi +2 -2
- metaflow-stubs/user_configs/config_options.pyi +5 -6
- metaflow-stubs/user_configs/config_parameters.pyi +9 -9
- metaflow-stubs/user_decorators/__init__.pyi +2 -2
- metaflow-stubs/user_decorators/common.pyi +6 -6
- metaflow-stubs/user_decorators/mutable_flow.pyi +6 -7
- metaflow-stubs/user_decorators/mutable_step.pyi +6 -9
- metaflow-stubs/user_decorators/user_flow_decorator.pyi +6 -7
- metaflow-stubs/user_decorators/user_step_decorator.pyi +22 -15
- metaflow-stubs/version.pyi +2 -2
- {metaflow_stubs-2.18.12.dist-info → metaflow_stubs-2.19.0.dist-info}/METADATA +2 -2
- metaflow_stubs-2.19.0.dist-info/RECORD +168 -0
- metaflow_stubs-2.18.12.dist-info/RECORD +0 -168
- {metaflow_stubs-2.18.12.dist-info → metaflow_stubs-2.19.0.dist-info}/WHEEL +0 -0
- {metaflow_stubs-2.18.12.dist-info → metaflow_stubs-2.19.0.dist-info}/top_level.txt +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.739260 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -9,11 +9,12 @@ from __future__ import annotations
|
|
|
9
9
|
import typing
|
|
10
10
|
import metaflow
|
|
11
11
|
if typing.TYPE_CHECKING:
|
|
12
|
-
import metaflow.client.core
|
|
13
|
-
import metaflow.runner.subprocess_manager
|
|
14
12
|
import metaflow.runner.metaflow_runner
|
|
13
|
+
import metaflow.runner.subprocess_manager
|
|
14
|
+
import metaflow.client.core
|
|
15
15
|
|
|
16
16
|
from ..client.core import Run as Run
|
|
17
|
+
from ..client.core import Task as Task
|
|
17
18
|
from ..plugins import get_runner_cli as get_runner_cli
|
|
18
19
|
from .utils import temporary_fifo as temporary_fifo
|
|
19
20
|
from .utils import handle_timeout as handle_timeout
|
|
@@ -24,27 +25,35 @@ from .subprocess_manager import SubprocessManager as SubprocessManager
|
|
|
24
25
|
|
|
25
26
|
CLICK_API_PROCESS_CONFIG: bool
|
|
26
27
|
|
|
27
|
-
class
|
|
28
|
+
class ExecutingProcess(object, metaclass=type):
|
|
28
29
|
"""
|
|
29
|
-
This
|
|
30
|
-
|
|
31
|
-
|
|
30
|
+
This is a base class for `ExecutingRun` and `ExecutingTask` classes.
|
|
31
|
+
The `ExecutingRun` and `ExecutingTask` classes are returned by methods
|
|
32
|
+
in `Runner` and `NBRunner`, and they are subclasses of this class.
|
|
32
33
|
|
|
33
|
-
`ExecutingRun`
|
|
34
|
-
|
|
34
|
+
The `ExecutingRun` class for instance contains a reference to a `metaflow.Run`
|
|
35
|
+
object representing the currently executing or finished run, as well as the metadata
|
|
36
|
+
related to the process.
|
|
37
|
+
|
|
38
|
+
Similarly, the `ExecutingTask` class contains a reference to a `metaflow.Task`
|
|
39
|
+
object representing the currently executing or finished task, as well as the metadata
|
|
40
|
+
related to the process.
|
|
41
|
+
|
|
42
|
+
This class or its subclasses are not meant to be instantiated directly. The class
|
|
43
|
+
works as a context manager, allowing you to use a pattern like:
|
|
35
44
|
|
|
36
|
-
This class works as a context manager, allowing you to use a pattern like
|
|
37
45
|
```python
|
|
38
46
|
with Runner(...).run() as running:
|
|
39
47
|
...
|
|
40
48
|
```
|
|
41
|
-
|
|
42
|
-
`Runner`, not both
|
|
49
|
+
|
|
50
|
+
Note that you should use either this object as the context manager or `Runner`, not both
|
|
51
|
+
in a nested manner.
|
|
43
52
|
"""
|
|
44
|
-
def __init__(self, runner: Runner, command_obj: metaflow.runner.subprocess_manager.CommandManager
|
|
53
|
+
def __init__(self, runner: Runner, command_obj: metaflow.runner.subprocess_manager.CommandManager):
|
|
45
54
|
"""
|
|
46
55
|
Create a new ExecutingRun -- this should not be done by the user directly but
|
|
47
|
-
instead
|
|
56
|
+
instead use Runner.run()
|
|
48
57
|
|
|
49
58
|
Parameters
|
|
50
59
|
----------
|
|
@@ -56,11 +65,11 @@ class ExecutingRun(object, metaclass=type):
|
|
|
56
65
|
Run object corresponding to this run.
|
|
57
66
|
"""
|
|
58
67
|
...
|
|
59
|
-
def __enter__(self) -> "
|
|
68
|
+
def __enter__(self) -> "ExecutingProcess":
|
|
60
69
|
...
|
|
61
70
|
def __exit__(self, exc_type, exc_value, traceback):
|
|
62
71
|
...
|
|
63
|
-
def wait(self, timeout:
|
|
72
|
+
def wait(self, timeout: float | None = None, stream: str | None = None) -> "ExecutingProcess":
|
|
64
73
|
"""
|
|
65
74
|
Wait for this run to finish, optionally with a timeout
|
|
66
75
|
and optionally streaming its output.
|
|
@@ -79,12 +88,12 @@ class ExecutingRun(object, metaclass=type):
|
|
|
79
88
|
|
|
80
89
|
Returns
|
|
81
90
|
-------
|
|
82
|
-
|
|
91
|
+
ExecutingProcess
|
|
83
92
|
This object, allowing you to chain calls.
|
|
84
93
|
"""
|
|
85
94
|
...
|
|
86
95
|
@property
|
|
87
|
-
def returncode(self) ->
|
|
96
|
+
def returncode(self) -> int | None:
|
|
88
97
|
"""
|
|
89
98
|
Gets the return code of the underlying subprocess. A non-zero
|
|
90
99
|
code indicates a failure, `None` a currently executing run.
|
|
@@ -139,7 +148,7 @@ class ExecutingRun(object, metaclass=type):
|
|
|
139
148
|
The current snapshot of stderr.
|
|
140
149
|
"""
|
|
141
150
|
...
|
|
142
|
-
def stream_log(self, stream: str, position:
|
|
151
|
+
def stream_log(self, stream: str, position: int | None = None) -> typing.Iterator[typing.Tuple[int, str]]:
|
|
143
152
|
"""
|
|
144
153
|
Asynchronous iterator to stream logs from the subprocess line by line.
|
|
145
154
|
|
|
@@ -164,6 +173,68 @@ class ExecutingRun(object, metaclass=type):
|
|
|
164
173
|
...
|
|
165
174
|
...
|
|
166
175
|
|
|
176
|
+
class ExecutingTask(ExecutingProcess, metaclass=type):
|
|
177
|
+
"""
|
|
178
|
+
This class contains a reference to a `metaflow.Task` object representing
|
|
179
|
+
the currently executing or finished task, as well as metadata related
|
|
180
|
+
to the process.
|
|
181
|
+
`ExecutingTask` is returned by methods in `Runner` and `NBRunner`. It is not
|
|
182
|
+
meant to be instantiated directly.
|
|
183
|
+
This class works as a context manager, allowing you to use a pattern like
|
|
184
|
+
```python
|
|
185
|
+
with Runner(...).spin() as running:
|
|
186
|
+
...
|
|
187
|
+
```
|
|
188
|
+
Note that you should use either this object as the context manager or
|
|
189
|
+
`Runner`, not both in a nested manner.
|
|
190
|
+
"""
|
|
191
|
+
def __init__(self, runner: Runner, command_obj: metaflow.runner.subprocess_manager.CommandManager, task_obj: metaflow.client.core.Task):
|
|
192
|
+
"""
|
|
193
|
+
Create a new ExecutingTask -- this should not be done by the user directly but
|
|
194
|
+
instead use Runner.spin()
|
|
195
|
+
Parameters
|
|
196
|
+
----------
|
|
197
|
+
runner : Runner
|
|
198
|
+
Parent runner for this task.
|
|
199
|
+
command_obj : CommandManager
|
|
200
|
+
CommandManager containing the subprocess executing this task.
|
|
201
|
+
task_obj : Task
|
|
202
|
+
Task object corresponding to this task.
|
|
203
|
+
"""
|
|
204
|
+
...
|
|
205
|
+
...
|
|
206
|
+
|
|
207
|
+
class ExecutingRun(ExecutingProcess, metaclass=type):
|
|
208
|
+
"""
|
|
209
|
+
This class contains a reference to a `metaflow.Run` object representing
|
|
210
|
+
the currently executing or finished run, as well as metadata related
|
|
211
|
+
to the process.
|
|
212
|
+
`ExecutingRun` is returned by methods in `Runner` and `NBRunner`. It is not
|
|
213
|
+
meant to be instantiated directly.
|
|
214
|
+
This class works as a context manager, allowing you to use a pattern like
|
|
215
|
+
```python
|
|
216
|
+
with Runner(...).run() as running:
|
|
217
|
+
...
|
|
218
|
+
```
|
|
219
|
+
Note that you should use either this object as the context manager or
|
|
220
|
+
`Runner`, not both in a nested manner.
|
|
221
|
+
"""
|
|
222
|
+
def __init__(self, runner: Runner, command_obj: metaflow.runner.subprocess_manager.CommandManager, run_obj: metaflow.client.core.Run):
|
|
223
|
+
"""
|
|
224
|
+
Create a new ExecutingRun -- this should not be done by the user directly but
|
|
225
|
+
instead use Runner.run()
|
|
226
|
+
Parameters
|
|
227
|
+
----------
|
|
228
|
+
runner : Runner
|
|
229
|
+
Parent runner for this run.
|
|
230
|
+
command_obj : CommandManager
|
|
231
|
+
CommandManager containing the subprocess executing this run.
|
|
232
|
+
run_obj : Run
|
|
233
|
+
Run object corresponding to this run.
|
|
234
|
+
"""
|
|
235
|
+
...
|
|
236
|
+
...
|
|
237
|
+
|
|
167
238
|
class RunnerMeta(type, metaclass=type):
|
|
168
239
|
@staticmethod
|
|
169
240
|
def __new__(mcs, name, bases, dct):
|
|
@@ -209,7 +280,7 @@ class Runner(object, metaclass=RunnerMeta):
|
|
|
209
280
|
Additional arguments that you would pass to `python myflow.py` before
|
|
210
281
|
the `run` command.
|
|
211
282
|
"""
|
|
212
|
-
def __init__(self, flow_file: str, show_output: bool = True, profile:
|
|
283
|
+
def __init__(self, flow_file: str, show_output: bool = True, profile: str | None = None, env: typing.Dict[str, str] | None = None, cwd: str | None = None, file_read_timeout: int = 3600, **kwargs):
|
|
213
284
|
...
|
|
214
285
|
def __enter__(self) -> "Runner":
|
|
215
286
|
...
|
|
@@ -236,6 +307,27 @@ class Runner(object, metaclass=RunnerMeta):
|
|
|
236
307
|
ExecutingRun containing the results of the run.
|
|
237
308
|
"""
|
|
238
309
|
...
|
|
310
|
+
def _Runner__get_executing_task(self, attribute_file_fd, command_obj):
|
|
311
|
+
...
|
|
312
|
+
def _Runner__async_get_executing_task(self, attribute_file_fd, command_obj):
|
|
313
|
+
...
|
|
314
|
+
def spin(self, pathspec, **kwargs) -> ExecutingTask:
|
|
315
|
+
"""
|
|
316
|
+
Blocking spin execution of the run.
|
|
317
|
+
This method will wait until the spun run has completed execution.
|
|
318
|
+
Parameters
|
|
319
|
+
----------
|
|
320
|
+
pathspec : str
|
|
321
|
+
The pathspec of the step/task to spin.
|
|
322
|
+
**kwargs : Any
|
|
323
|
+
Additional arguments that you would pass to `python ./myflow.py` after
|
|
324
|
+
the `spin` command.
|
|
325
|
+
Returns
|
|
326
|
+
-------
|
|
327
|
+
ExecutingTask
|
|
328
|
+
ExecutingTask containing the results of the spun task.
|
|
329
|
+
"""
|
|
330
|
+
...
|
|
239
331
|
def resume(self, **kwargs) -> ExecutingRun:
|
|
240
332
|
"""
|
|
241
333
|
Blocking resume execution of the run.
|
|
@@ -291,6 +383,27 @@ class Runner(object, metaclass=RunnerMeta):
|
|
|
291
383
|
ExecutingRun representing the resumed run that was started.
|
|
292
384
|
"""
|
|
293
385
|
...
|
|
386
|
+
def async_spin(self, pathspec, **kwargs) -> ExecutingTask:
|
|
387
|
+
"""
|
|
388
|
+
Non-blocking spin execution of the run.
|
|
389
|
+
This method will return as soon as the spun task has launched.
|
|
390
|
+
|
|
391
|
+
Note that this method is asynchronous and needs to be `await`ed.
|
|
392
|
+
|
|
393
|
+
Parameters
|
|
394
|
+
----------
|
|
395
|
+
pathspec : str
|
|
396
|
+
The pathspec of the step/task to spin.
|
|
397
|
+
**kwargs : Any
|
|
398
|
+
Additional arguments that you would pass to `python ./myflow.py` after
|
|
399
|
+
the `spin` command.
|
|
400
|
+
|
|
401
|
+
Returns
|
|
402
|
+
-------
|
|
403
|
+
ExecutingTask
|
|
404
|
+
ExecutingTask representing the spun task that was started.
|
|
405
|
+
"""
|
|
406
|
+
...
|
|
294
407
|
def __exit__(self, exc_type, exc_value, traceback):
|
|
295
408
|
...
|
|
296
409
|
def __aexit__(self, exc_type, exc_value, traceback):
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.740266 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -58,7 +58,7 @@ class NBDeployer(object, metaclass=type):
|
|
|
58
58
|
Additional arguments that you would pass to `python myflow.py` i.e. options
|
|
59
59
|
listed in `python myflow.py --help`
|
|
60
60
|
"""
|
|
61
|
-
def __init__(self, flow, show_output: bool = True, profile:
|
|
61
|
+
def __init__(self, flow, show_output: bool = True, profile: str | None = None, env: typing.Dict | None = None, base_dir: str | None = None, file_read_timeout: int = 3600, **kwargs):
|
|
62
62
|
...
|
|
63
63
|
def __getattr__(self, name):
|
|
64
64
|
"""
|
metaflow-stubs/runner/nbrun.pyi
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.739867 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -55,7 +55,7 @@ class NBRunner(object, metaclass=type):
|
|
|
55
55
|
Additional arguments that you would pass to `python myflow.py` before
|
|
56
56
|
the `run` command.
|
|
57
57
|
"""
|
|
58
|
-
def __init__(self, flow, show_output: bool = True, profile:
|
|
58
|
+
def __init__(self, flow, show_output: bool = True, profile: str | None = None, env: typing.Dict | None = None, base_dir: str | None = None, file_read_timeout: int = 3600, **kwargs):
|
|
59
59
|
...
|
|
60
60
|
def nbrun(self, **kwargs):
|
|
61
61
|
"""
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.753684 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -34,7 +34,7 @@ class SubprocessManager(object, metaclass=type):
|
|
|
34
34
|
...
|
|
35
35
|
def __aexit__(self, exc_type, exc_value, traceback):
|
|
36
36
|
...
|
|
37
|
-
def run_command(self, command: typing.List[str], env: typing.
|
|
37
|
+
def run_command(self, command: typing.List[str], env: typing.Dict[str, str] | None = None, cwd: str | None = None, show_output: bool = False) -> int:
|
|
38
38
|
"""
|
|
39
39
|
Run a command synchronously and return its process ID.
|
|
40
40
|
|
|
@@ -63,7 +63,7 @@ class SubprocessManager(object, metaclass=type):
|
|
|
63
63
|
The process ID of the subprocess.
|
|
64
64
|
"""
|
|
65
65
|
...
|
|
66
|
-
def async_run_command(self, command: typing.List[str], env: typing.
|
|
66
|
+
def async_run_command(self, command: typing.List[str], env: typing.Dict[str, str] | None = None, cwd: str | None = None) -> int:
|
|
67
67
|
"""
|
|
68
68
|
Run a command asynchronously and return its process ID.
|
|
69
69
|
|
|
@@ -84,7 +84,7 @@ class SubprocessManager(object, metaclass=type):
|
|
|
84
84
|
The process ID of the subprocess.
|
|
85
85
|
"""
|
|
86
86
|
...
|
|
87
|
-
def get(self, pid: int) ->
|
|
87
|
+
def get(self, pid: int) -> ForwardRef('CommandManager') | None:
|
|
88
88
|
"""
|
|
89
89
|
Get one of the CommandManager managed by this SubprocessManager.
|
|
90
90
|
|
|
@@ -110,7 +110,7 @@ class CommandManager(object, metaclass=type):
|
|
|
110
110
|
"""
|
|
111
111
|
A manager for an individual subprocess.
|
|
112
112
|
"""
|
|
113
|
-
def __init__(self, command: typing.List[str], env: typing.
|
|
113
|
+
def __init__(self, command: typing.List[str], env: typing.Dict[str, str] | None = None, cwd: str | None = None):
|
|
114
114
|
"""
|
|
115
115
|
Create a new CommandManager object.
|
|
116
116
|
This does not run the process itself but sets it up.
|
|
@@ -131,7 +131,7 @@ class CommandManager(object, metaclass=type):
|
|
|
131
131
|
...
|
|
132
132
|
def __aexit__(self, exc_type, exc_value, traceback):
|
|
133
133
|
...
|
|
134
|
-
def wait(self, timeout:
|
|
134
|
+
def wait(self, timeout: float | None = None, stream: str | None = None):
|
|
135
135
|
"""
|
|
136
136
|
Wait for the subprocess to finish, optionally with a timeout
|
|
137
137
|
and optionally streaming its output.
|
|
@@ -173,7 +173,7 @@ class CommandManager(object, metaclass=type):
|
|
|
173
173
|
logs (using `stream_logs`) or kill it (using `kill`).
|
|
174
174
|
"""
|
|
175
175
|
...
|
|
176
|
-
def stream_log(self, stream: str, position:
|
|
176
|
+
def stream_log(self, stream: str, position: int | None = None, timeout_per_line: float | None = None, log_write_delay: float = 0.01) -> typing.Iterator[typing.Tuple[int, str]]:
|
|
177
177
|
"""
|
|
178
178
|
Stream logs from the subprocess line by line.
|
|
179
179
|
|
metaflow-stubs/runner/utils.pyi
CHANGED
|
@@ -1,17 +1,16 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.752369 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
8
8
|
|
|
9
9
|
import typing
|
|
10
10
|
if typing.TYPE_CHECKING:
|
|
11
|
-
import metaflow.runner.click_api
|
|
12
11
|
import metaflow.runner.subprocess_manager
|
|
13
|
-
import types
|
|
14
12
|
import typing
|
|
13
|
+
import metaflow.runner.click_api
|
|
15
14
|
|
|
16
15
|
|
|
17
16
|
TYPE_CHECKING: bool
|
|
@@ -29,7 +28,7 @@ def format_flowfile(cell):
|
|
|
29
28
|
def check_process_exited(command_obj: "metaflow.runner.subprocess_manager.CommandManager") -> bool:
|
|
30
29
|
...
|
|
31
30
|
|
|
32
|
-
def temporary_fifo() -> typing.ContextManager[typing.Tuple[str, int],
|
|
31
|
+
def temporary_fifo() -> typing.ContextManager[typing.Tuple[str, int], bool | None]:
|
|
33
32
|
"""
|
|
34
33
|
Create and open the read side of a temporary FIFO in a non-blocking mode.
|
|
35
34
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.740822 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.772577 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -9,7 +9,6 @@ from __future__ import annotations
|
|
|
9
9
|
import typing
|
|
10
10
|
if typing.TYPE_CHECKING:
|
|
11
11
|
import metaflow.event_logger
|
|
12
|
-
import typing
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
class SystemLogger(object, metaclass=type):
|
|
@@ -20,9 +19,9 @@ class SystemLogger(object, metaclass=type):
|
|
|
20
19
|
def init_system_logger(self, flow_name: str, logger: "metaflow.event_logger.NullEventLogger"):
|
|
21
20
|
...
|
|
22
21
|
@property
|
|
23
|
-
def logger(self) ->
|
|
22
|
+
def logger(self) -> ForwardRef('metaflow.event_logger.NullEventLogger') | None:
|
|
24
23
|
...
|
|
25
|
-
def log_event(self, level: str, module: str, name: str, payload: typing.
|
|
24
|
+
def log_event(self, level: str, module: str, name: str, payload: typing.Any | None = None):
|
|
26
25
|
"""
|
|
27
26
|
Log an event to the event logger.
|
|
28
27
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.772109 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -19,7 +19,7 @@ class SystemMonitor(object, metaclass=type):
|
|
|
19
19
|
def init_system_monitor(self, flow_name: str, monitor: "metaflow.monitor.NullMonitor"):
|
|
20
20
|
...
|
|
21
21
|
@property
|
|
22
|
-
def monitor(self) ->
|
|
22
|
+
def monitor(self) -> ForwardRef('metaflow.monitor.NullMonitor') | None:
|
|
23
23
|
...
|
|
24
24
|
def measure(self, name: str):
|
|
25
25
|
"""
|
metaflow-stubs/tagging_util.pyi
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.715621 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
metaflow-stubs/tuple_util.pyi
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.723556 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.714992 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.746732 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -10,7 +10,6 @@ import typing
|
|
|
10
10
|
import metaflow
|
|
11
11
|
if typing.TYPE_CHECKING:
|
|
12
12
|
import metaflow._vendor.click.types
|
|
13
|
-
import typing
|
|
14
13
|
|
|
15
14
|
from .._vendor import click as click
|
|
16
15
|
from .config_parameters import ConfigValue as ConfigValue
|
|
@@ -48,7 +47,7 @@ class MultipleTuple(metaflow._vendor.click.types.Tuple, metaclass=type):
|
|
|
48
47
|
...
|
|
49
48
|
|
|
50
49
|
class ConfigInput(object, metaclass=type):
|
|
51
|
-
def __init__(self, req_configs: typing.List[str], defaults: typing.Dict[str, typing.Tuple[
|
|
50
|
+
def __init__(self, req_configs: typing.List[str], defaults: typing.Dict[str, typing.Tuple[str | typing.Dict[typing.Any, typing.Any], bool]], parsers: typing.Dict[str, str | typing.Callable[[str], typing.Dict[typing.Any, typing.Any]]]):
|
|
52
51
|
...
|
|
53
52
|
@staticmethod
|
|
54
53
|
def make_key_name(name: str) -> str:
|
|
@@ -57,9 +56,9 @@ class ConfigInput(object, metaclass=type):
|
|
|
57
56
|
def set_config_file(cls, config_file: str):
|
|
58
57
|
...
|
|
59
58
|
@classmethod
|
|
60
|
-
def get_config(cls, config_name: str) -> typing.
|
|
59
|
+
def get_config(cls, config_name: str) -> typing.Dict[typing.Any, typing.Any] | None:
|
|
61
60
|
...
|
|
62
|
-
def process_configs(self, flow_name: str, param_name: str, param_value: typing.Dict[str,
|
|
61
|
+
def process_configs(self, flow_name: str, param_name: str, param_value: typing.Dict[str, str | None], quiet: bool, datastore: str, click_obj: typing.Any | None = None):
|
|
63
62
|
...
|
|
64
63
|
def process_configs_click(self, ctx, param, value):
|
|
65
64
|
...
|
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.719500 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
8
8
|
|
|
9
|
+
import typing
|
|
10
|
+
import abc
|
|
9
11
|
import metaflow
|
|
10
12
|
import collections
|
|
11
|
-
import abc
|
|
12
|
-
import typing
|
|
13
13
|
if typing.TYPE_CHECKING:
|
|
14
|
+
import metaflow.user_configs.config_parameters
|
|
14
15
|
import metaflow.parameters
|
|
16
|
+
import typing
|
|
15
17
|
import abc
|
|
16
18
|
import collections.abc
|
|
17
|
-
import metaflow.user_configs.config_parameters
|
|
18
|
-
import typing
|
|
19
19
|
|
|
20
20
|
from ..exception import MetaflowException as MetaflowException
|
|
21
21
|
from ..parameters import Parameter as Parameter
|
|
@@ -39,7 +39,7 @@ class ConfigValue(collections.abc.Mapping, dict, metaclass=abc.ABCMeta):
|
|
|
39
39
|
|
|
40
40
|
All "keys"" need to be valid Python identifiers
|
|
41
41
|
"""
|
|
42
|
-
def __init__(self, data:
|
|
42
|
+
def __init__(self, data: ForwardRef('ConfigValue') | typing.Dict[str, typing.Any]):
|
|
43
43
|
...
|
|
44
44
|
@classmethod
|
|
45
45
|
def fromkeys(cls, iterable: typing.Iterable, value: typing.Any = None) -> "ConfigValue":
|
|
@@ -163,7 +163,7 @@ class DelayEvaluator(collections.abc.Mapping, metaclass=abc.ABCMeta):
|
|
|
163
163
|
special handling in whatever this is being unpacked into, specifically the handling
|
|
164
164
|
of _unpacked_delayed_*
|
|
165
165
|
"""
|
|
166
|
-
def __init__(self, ex: str, saved_globals: typing.
|
|
166
|
+
def __init__(self, ex: str, saved_globals: typing.Dict[str, typing.Any] | None = None):
|
|
167
167
|
...
|
|
168
168
|
def __copy__(self):
|
|
169
169
|
...
|
|
@@ -255,7 +255,7 @@ class Config(metaflow.parameters.Parameter, collections.abc.Mapping, metaclass=a
|
|
|
255
255
|
show_default : bool, default True
|
|
256
256
|
If True, show the default value in the help text.
|
|
257
257
|
"""
|
|
258
|
-
def __init__(self, name: str, default:
|
|
258
|
+
def __init__(self, name: str, default: str | typing.Callable[[metaflow.parameters.ParameterContext], str] | None = None, default_value: str | typing.Dict[str, typing.Any] | typing.Callable[[metaflow.parameters.ParameterContext], str | typing.Dict[str, typing.Any]] | None = None, help: str | None = None, required: bool | None = None, parser: str | typing.Callable[[str], typing.Dict[typing.Any, typing.Any]] | None = None, **kwargs: typing.Dict[str, str]):
|
|
259
259
|
...
|
|
260
260
|
def load_parameter(self, v):
|
|
261
261
|
...
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.715264 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
######################################################################################################
|
|
2
2
|
# Auto-generated Metaflow stub file #
|
|
3
|
-
# MF version: 2.
|
|
4
|
-
# Generated on 2025-10-
|
|
3
|
+
# MF version: 2.19.0 #
|
|
4
|
+
# Generated on 2025-10-26T02:29:29.748520 #
|
|
5
5
|
######################################################################################################
|
|
6
6
|
|
|
7
7
|
from __future__ import annotations
|
|
@@ -12,17 +12,17 @@ import typing
|
|
|
12
12
|
class ClassPath_Trie(object, metaclass=type):
|
|
13
13
|
def __init__(self):
|
|
14
14
|
...
|
|
15
|
-
def init(self, initial_nodes: typing.
|
|
15
|
+
def init(self, initial_nodes: typing.List[typing.Tuple[str, type]] | None = None):
|
|
16
16
|
...
|
|
17
17
|
def insert(self, classpath_name: str, value: type):
|
|
18
18
|
...
|
|
19
|
-
def search(self, classpath_name: str) ->
|
|
19
|
+
def search(self, classpath_name: str) -> type | None:
|
|
20
20
|
...
|
|
21
21
|
def remove(self, classpath_name: str):
|
|
22
22
|
...
|
|
23
|
-
def unique_prefix_value(self, classpath_name: str) ->
|
|
23
|
+
def unique_prefix_value(self, classpath_name: str) -> type | None:
|
|
24
24
|
...
|
|
25
|
-
def unique_prefix_for_type(self, value: type) ->
|
|
25
|
+
def unique_prefix_for_type(self, value: type) -> str | None:
|
|
26
26
|
...
|
|
27
27
|
def get_unique_prefixes(self) -> typing.Dict[str, type]:
|
|
28
28
|
"""
|