metaflow-stubs 2.12.36__py2.py3-none-any.whl → 2.12.38__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.
Files changed (162) hide show
  1. metaflow-stubs/__init__.pyi +185 -181
  2. metaflow-stubs/cards.pyi +2 -2
  3. metaflow-stubs/cli.pyi +9 -21
  4. metaflow-stubs/{plugins/cards/card_modules/chevron/metadata.pyi → cli_components/__init__.pyi} +3 -4
  5. metaflow-stubs/cli_components/utils.pyi +35 -0
  6. metaflow-stubs/client/__init__.pyi +2 -2
  7. metaflow-stubs/client/core.pyi +5 -5
  8. metaflow-stubs/client/filecache.pyi +3 -3
  9. metaflow-stubs/events.pyi +2 -2
  10. metaflow-stubs/exception.pyi +2 -2
  11. metaflow-stubs/flowspec.pyi +11 -4
  12. metaflow-stubs/generated_for.txt +1 -1
  13. metaflow-stubs/includefile.pyi +18 -11
  14. metaflow-stubs/info_file.pyi +2 -2
  15. metaflow-stubs/metadata_provider/__init__.pyi +2 -2
  16. metaflow-stubs/metadata_provider/heartbeat.pyi +2 -2
  17. metaflow-stubs/metadata_provider/metadata.pyi +2 -2
  18. metaflow-stubs/metadata_provider/util.pyi +2 -2
  19. metaflow-stubs/metaflow_config.pyi +4 -2
  20. metaflow-stubs/metaflow_current.pyi +23 -23
  21. metaflow-stubs/multicore_utils.pyi +2 -2
  22. metaflow-stubs/parameters.pyi +33 -16
  23. metaflow-stubs/plugins/__init__.pyi +11 -11
  24. metaflow-stubs/plugins/airflow/__init__.pyi +2 -4
  25. metaflow-stubs/plugins/airflow/airflow_decorator.pyi +2 -2
  26. metaflow-stubs/plugins/airflow/airflow_utils.pyi +2 -2
  27. metaflow-stubs/plugins/airflow/exception.pyi +2 -2
  28. metaflow-stubs/plugins/airflow/sensors/__init__.pyi +2 -2
  29. metaflow-stubs/plugins/airflow/sensors/base_sensor.pyi +2 -2
  30. metaflow-stubs/plugins/airflow/sensors/external_task_sensor.pyi +2 -2
  31. metaflow-stubs/plugins/airflow/sensors/s3_sensor.pyi +2 -2
  32. metaflow-stubs/plugins/argo/__init__.pyi +2 -5
  33. metaflow-stubs/plugins/argo/argo_client.pyi +2 -2
  34. metaflow-stubs/plugins/argo/argo_events.pyi +2 -2
  35. metaflow-stubs/plugins/argo/argo_workflows.pyi +3 -2
  36. metaflow-stubs/plugins/argo/argo_workflows_decorator.pyi +3 -3
  37. metaflow-stubs/plugins/argo/argo_workflows_deployer.pyi +3 -3
  38. metaflow-stubs/plugins/argo/argo_workflows_deployer_objects.pyi +2 -2
  39. metaflow-stubs/plugins/aws/__init__.pyi +2 -2
  40. metaflow-stubs/plugins/aws/aws_client.pyi +2 -2
  41. metaflow-stubs/plugins/aws/aws_utils.pyi +2 -2
  42. metaflow-stubs/plugins/aws/batch/__init__.pyi +2 -3
  43. metaflow-stubs/plugins/aws/batch/batch.pyi +2 -2
  44. metaflow-stubs/plugins/aws/batch/batch_client.pyi +2 -2
  45. metaflow-stubs/plugins/aws/batch/batch_decorator.pyi +3 -3
  46. metaflow-stubs/plugins/aws/secrets_manager/__init__.pyi +2 -2
  47. metaflow-stubs/plugins/aws/secrets_manager/aws_secrets_manager_secrets_provider.pyi +4 -4
  48. metaflow-stubs/plugins/aws/step_functions/__init__.pyi +2 -7
  49. metaflow-stubs/plugins/aws/step_functions/dynamo_db_client.pyi +2 -2
  50. metaflow-stubs/plugins/aws/step_functions/event_bridge_client.pyi +2 -2
  51. metaflow-stubs/plugins/aws/step_functions/schedule_decorator.pyi +2 -2
  52. metaflow-stubs/plugins/aws/step_functions/step_functions.pyi +3 -2
  53. metaflow-stubs/plugins/aws/step_functions/step_functions_client.pyi +2 -2
  54. metaflow-stubs/plugins/aws/step_functions/step_functions_decorator.pyi +2 -2
  55. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer.pyi +2 -2
  56. metaflow-stubs/plugins/aws/step_functions/step_functions_deployer_objects.pyi +2 -2
  57. metaflow-stubs/plugins/azure/__init__.pyi +2 -2
  58. metaflow-stubs/plugins/azure/azure_credential.pyi +2 -2
  59. metaflow-stubs/plugins/azure/azure_exceptions.pyi +2 -2
  60. metaflow-stubs/plugins/azure/azure_secret_manager_secrets_provider.pyi +4 -4
  61. metaflow-stubs/plugins/azure/azure_utils.pyi +2 -2
  62. metaflow-stubs/plugins/azure/blob_service_client_factory.pyi +2 -2
  63. metaflow-stubs/plugins/azure/includefile_support.pyi +2 -2
  64. metaflow-stubs/plugins/cards/__init__.pyi +2 -3
  65. metaflow-stubs/plugins/cards/card_client.pyi +3 -3
  66. metaflow-stubs/plugins/cards/card_creator.pyi +2 -2
  67. metaflow-stubs/plugins/cards/card_datastore.pyi +2 -2
  68. metaflow-stubs/plugins/cards/card_decorator.pyi +2 -2
  69. metaflow-stubs/plugins/cards/card_modules/__init__.pyi +2 -3
  70. metaflow-stubs/plugins/cards/card_modules/basic.pyi +3 -3
  71. metaflow-stubs/plugins/cards/card_modules/card.pyi +2 -2
  72. metaflow-stubs/plugins/cards/card_modules/components.pyi +3 -3
  73. metaflow-stubs/plugins/cards/card_modules/convert_to_native_type.pyi +2 -2
  74. metaflow-stubs/plugins/cards/card_modules/renderer_tools.pyi +2 -2
  75. metaflow-stubs/plugins/cards/card_modules/test_cards.pyi +2 -2
  76. metaflow-stubs/plugins/cards/card_resolver.pyi +2 -2
  77. metaflow-stubs/plugins/cards/component_serializer.pyi +2 -2
  78. metaflow-stubs/plugins/cards/exception.pyi +2 -2
  79. metaflow-stubs/plugins/catch_decorator.pyi +3 -3
  80. metaflow-stubs/plugins/datatools/__init__.pyi +2 -2
  81. metaflow-stubs/plugins/datatools/local.pyi +2 -2
  82. metaflow-stubs/plugins/datatools/s3/__init__.pyi +2 -2
  83. metaflow-stubs/plugins/datatools/s3/s3.pyi +3 -3
  84. metaflow-stubs/plugins/datatools/s3/s3tail.pyi +2 -2
  85. metaflow-stubs/plugins/datatools/s3/s3util.pyi +2 -2
  86. metaflow-stubs/plugins/debug_logger.pyi +2 -2
  87. metaflow-stubs/plugins/debug_monitor.pyi +2 -2
  88. metaflow-stubs/plugins/environment_decorator.pyi +2 -2
  89. metaflow-stubs/plugins/events_decorator.pyi +2 -2
  90. metaflow-stubs/plugins/frameworks/__init__.pyi +2 -2
  91. metaflow-stubs/plugins/frameworks/pytorch.pyi +2 -2
  92. metaflow-stubs/plugins/gcp/__init__.pyi +2 -2
  93. metaflow-stubs/plugins/gcp/gcp_secret_manager_secrets_provider.pyi +4 -4
  94. metaflow-stubs/plugins/gcp/gs_exceptions.pyi +2 -2
  95. metaflow-stubs/plugins/gcp/gs_storage_client_factory.pyi +2 -2
  96. metaflow-stubs/plugins/gcp/gs_utils.pyi +2 -2
  97. metaflow-stubs/plugins/gcp/includefile_support.pyi +2 -2
  98. metaflow-stubs/plugins/kubernetes/__init__.pyi +2 -3
  99. metaflow-stubs/plugins/kubernetes/kube_utils.pyi +2 -2
  100. metaflow-stubs/plugins/kubernetes/kubernetes.pyi +2 -2
  101. metaflow-stubs/plugins/kubernetes/kubernetes_client.pyi +2 -2
  102. metaflow-stubs/plugins/kubernetes/kubernetes_decorator.pyi +3 -3
  103. metaflow-stubs/plugins/kubernetes/kubernetes_job.pyi +2 -2
  104. metaflow-stubs/plugins/kubernetes/kubernetes_jobsets.pyi +2 -2
  105. metaflow-stubs/plugins/parallel_decorator.pyi +2 -2
  106. metaflow-stubs/plugins/project_decorator.pyi +2 -2
  107. metaflow-stubs/plugins/pypi/__init__.pyi +3 -3
  108. metaflow-stubs/plugins/pypi/conda_decorator.pyi +6 -2
  109. metaflow-stubs/plugins/pypi/conda_environment.pyi +5 -5
  110. metaflow-stubs/plugins/pypi/pypi_decorator.pyi +2 -2
  111. metaflow-stubs/plugins/pypi/pypi_environment.pyi +2 -2
  112. metaflow-stubs/plugins/pypi/utils.pyi +2 -2
  113. metaflow-stubs/plugins/resources_decorator.pyi +2 -2
  114. metaflow-stubs/plugins/retry_decorator.pyi +2 -2
  115. metaflow-stubs/plugins/secrets/__init__.pyi +2 -2
  116. metaflow-stubs/plugins/secrets/inline_secrets_provider.pyi +3 -3
  117. metaflow-stubs/plugins/secrets/secrets_decorator.pyi +2 -2
  118. metaflow-stubs/plugins/storage_executor.pyi +2 -2
  119. metaflow-stubs/plugins/test_unbounded_foreach_decorator.pyi +3 -3
  120. metaflow-stubs/plugins/timeout_decorator.pyi +4 -4
  121. metaflow-stubs/pylint_wrapper.pyi +2 -2
  122. metaflow-stubs/runner/__init__.pyi +2 -2
  123. metaflow-stubs/runner/deployer.pyi +5 -5
  124. metaflow-stubs/runner/deployer_impl.pyi +2 -2
  125. metaflow-stubs/runner/metaflow_runner.pyi +4 -4
  126. metaflow-stubs/runner/nbdeploy.pyi +2 -2
  127. metaflow-stubs/runner/nbrun.pyi +2 -2
  128. metaflow-stubs/runner/subprocess_manager.pyi +2 -2
  129. metaflow-stubs/runner/utils.pyi +3 -3
  130. metaflow-stubs/system/__init__.pyi +2 -2
  131. metaflow-stubs/system/system_logger.pyi +3 -3
  132. metaflow-stubs/system/system_monitor.pyi +2 -2
  133. metaflow-stubs/tagging_util.pyi +2 -2
  134. metaflow-stubs/tuple_util.pyi +2 -2
  135. metaflow-stubs/{plugins/package_cli.pyi → user_configs/__init__.pyi} +5 -3
  136. metaflow-stubs/user_configs/config_decorators.pyi +253 -0
  137. metaflow-stubs/user_configs/config_options.pyi +82 -0
  138. metaflow-stubs/user_configs/config_parameters.pyi +217 -0
  139. metaflow-stubs/version.pyi +2 -2
  140. {metaflow_stubs-2.12.36.dist-info → metaflow_stubs-2.12.38.dist-info}/METADATA +2 -2
  141. metaflow_stubs-2.12.38.dist-info/RECORD +144 -0
  142. metaflow-stubs/clone_util.pyi +0 -14
  143. metaflow-stubs/mflog/__init__.pyi +0 -6
  144. metaflow-stubs/mflog/mflog.pyi +0 -69
  145. metaflow-stubs/plugins/airflow/airflow.pyi +0 -89
  146. metaflow-stubs/plugins/airflow/airflow_cli.pyi +0 -37
  147. metaflow-stubs/plugins/argo/argo_workflows_cli.pyi +0 -103
  148. metaflow-stubs/plugins/aws/batch/batch_cli.pyi +0 -25
  149. metaflow-stubs/plugins/aws/step_functions/production_token.pyi +0 -19
  150. metaflow-stubs/plugins/aws/step_functions/step_functions_cli.pyi +0 -69
  151. metaflow-stubs/plugins/cards/card_cli.pyi +0 -146
  152. metaflow-stubs/plugins/cards/card_modules/chevron/__init__.pyi +0 -17
  153. metaflow-stubs/plugins/cards/card_modules/chevron/main.pyi +0 -22
  154. metaflow-stubs/plugins/cards/card_modules/chevron/renderer.pyi +0 -77
  155. metaflow-stubs/plugins/cards/card_modules/chevron/tokenizer.pyi +0 -76
  156. metaflow-stubs/plugins/kubernetes/kubernetes_cli.pyi +0 -33
  157. metaflow-stubs/plugins/logs_cli.pyi +0 -46
  158. metaflow-stubs/plugins/tag_cli.pyi +0 -19
  159. metaflow-stubs/procpoll.pyi +0 -53
  160. metaflow_stubs-2.12.36.dist-info/RECORD +0 -158
  161. {metaflow_stubs-2.12.36.dist-info → metaflow_stubs-2.12.38.dist-info}/WHEEL +0 -0
  162. {metaflow_stubs-2.12.36.dist-info → metaflow_stubs-2.12.38.dist-info}/top_level.txt +0 -0
metaflow-stubs/cli.pyi CHANGED
@@ -1,23 +1,26 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.36 #
4
- # Generated on 2024-12-07T00:02:15.840452 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.928635 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
 
10
10
  from ._vendor import click as click
11
- from .client.core import get_metadata as get_metadata
12
- from .client.core import namespace as namespace
13
11
  from . import parameters as parameters
14
12
  from . import plugins as plugins
13
+ from .cli_components.utils import LazyGroup as LazyGroup
14
+ from .cli_components.utils import LazyPluginCommandCollection as LazyPluginCommandCollection
15
15
  from .exception import CommandException as CommandException
16
16
  from .exception import MetaflowException as MetaflowException
17
17
  from .metaflow_current import current as current
18
- from .mflog import mflog as mflog
19
18
  from .pylint_wrapper import PyLint as PyLint
20
- from .tagging_util import validate_tags as validate_tags
19
+ from .user_configs.config_options import LocalFileInput as LocalFileInput
20
+ from .user_configs.config_options import config_options as config_options
21
+ from .user_configs.config_parameters import ConfigValue as ConfigValue
22
+ from .cli_components.utils import cli as cli
23
+ from .cli_components.utils import start as start
21
24
 
22
25
  DECOSPECS: str
23
26
 
@@ -33,8 +36,6 @@ DEFAULT_MONITOR: str
33
36
 
34
37
  DEFAULT_PACKAGE_SUFFIXES: str
35
38
 
36
- LOG_SOURCES: list
37
-
38
39
  DATASTORES: list
39
40
 
40
41
  ENVIRONMENTS: list
@@ -45,10 +46,6 @@ METADATA_PROVIDERS: list
45
46
 
46
47
  MONITOR_SIDECARS: dict
47
48
 
48
- UBF_CONTROL: str
49
-
50
- UBF_TASK: str
51
-
52
49
  ERASE_TO_EOL: str
53
50
 
54
51
  HIGHLIGHT: str
@@ -73,15 +70,6 @@ def logger(body = '', system_msg = False, head = '', bad = False, timestamp = Tr
73
70
  def config_merge_cb(ctx, param, value):
74
71
  ...
75
72
 
76
- def common_run_options(func):
77
- ...
78
-
79
- def write_file(file_path, content):
80
- ...
81
-
82
- def before_run(obj, tags, decospecs):
83
- ...
84
-
85
73
  def print_metaflow_exception(ex):
86
74
  ...
87
75
 
@@ -1,12 +1,11 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.36 #
4
- # Generated on 2024-12-07T00:02:15.909760 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.927260 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
 
10
-
11
- version: str
10
+ from . import utils as utils
12
11
 
@@ -0,0 +1,35 @@
1
+ ######################################################################################################
2
+ # Auto-generated Metaflow stub file #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.951261 #
5
+ ######################################################################################################
6
+
7
+ from __future__ import annotations
8
+
9
+ import metaflow
10
+ import typing
11
+ if typing.TYPE_CHECKING:
12
+ import metaflow._vendor.click.core
13
+
14
+ from .._vendor import click as click
15
+
16
+ class LazyPluginCommandCollection(metaflow._vendor.click.core.CommandCollection, metaclass=type):
17
+ def __init__(self, *args, lazy_sources = None, **kwargs):
18
+ ...
19
+ def invoke(self, ctx):
20
+ ...
21
+ def list_commands(self, ctx):
22
+ ...
23
+ def get_command(self, ctx, cmd_name):
24
+ ...
25
+ ...
26
+
27
+ class LazyGroup(metaflow._vendor.click.core.Group, metaclass=type):
28
+ def __init__(self, *args, lazy_subcommands = None, **kwargs):
29
+ ...
30
+ def list_commands(self, ctx):
31
+ ...
32
+ def get_command(self, ctx, cmd_name):
33
+ ...
34
+ ...
35
+
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.36 #
4
- # Generated on 2024-12-07T00:02:15.830486 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.918396 #
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.12.36 #
4
- # Generated on 2024-12-07T00:02:15.835581 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.924493 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,11 +9,11 @@ from __future__ import annotations
9
9
  import typing
10
10
  import metaflow
11
11
  if typing.TYPE_CHECKING:
12
- import typing
13
- import metaflow.events
14
- import datetime
15
12
  import metaflow.client.core
13
+ import datetime
16
14
  import tarfile
15
+ import metaflow.events
16
+ import typing
17
17
 
18
18
  from ..metaflow_current import current as current
19
19
  from ..events import Trigger as Trigger
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.36 #
4
- # Generated on 2024-12-07T00:02:15.862376 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.950865 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
9
9
  import metaflow
10
10
  import typing
11
11
  if typing.TYPE_CHECKING:
12
- import metaflow.datastore.content_addressed_store
13
12
  import metaflow.exception
13
+ import metaflow.datastore.content_addressed_store
14
14
 
15
15
  from ..exception import MetaflowException as MetaflowException
16
16
 
metaflow-stubs/events.pyi CHANGED
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.36 #
4
- # Generated on 2024-12-07T00:02:15.823726 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.911947 #
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.12.36 #
4
- # Generated on 2024-12-07T00:02:15.817941 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.902348 #
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.12.36 #
4
- # Generated on 2024-12-07T00:02:15.823014 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.907881 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,18 +9,25 @@ from __future__ import annotations
9
9
  import typing
10
10
  import metaflow
11
11
  if typing.TYPE_CHECKING:
12
- import typing
13
- import metaflow.flowspec
14
12
  import metaflow.unbounded_foreach
15
13
  import metaflow.datastore.inputs
16
14
  import metaflow.exception
15
+ import metaflow.flowspec
16
+ import typing
17
17
 
18
18
  from . import parameters as parameters
19
19
  from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter
20
20
  from .parameters import Parameter as Parameter
21
21
  from .exception import MetaflowException as MetaflowException
22
22
  from .exception import MissingInMergeArtifactsException as MissingInMergeArtifactsException
23
+ from .exception import MetaflowInternalError as MetaflowInternalError
23
24
  from .exception import UnhandledInMergeArtifactsException as UnhandledInMergeArtifactsException
25
+ from .user_configs.config_decorators import CustomFlowDecorator as CustomFlowDecorator
26
+ from .user_configs.config_decorators import CustomStepDecorator as CustomStepDecorator
27
+ from .user_configs.config_decorators import MutableFlow as MutableFlow
28
+ from .user_configs.config_decorators import MutableStep as MutableStep
29
+
30
+ TYPE_CHECKING: bool
24
31
 
25
32
  INCLUDE_FOREACH_STACK: bool
26
33
 
@@ -1 +1 @@
1
- 2.12.36 2024-12-07T00:02:15.815899
1
+ 2.12.38 2024-12-08T03:54:57.900526
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.36 #
4
- # Generated on 2024-12-07T00:02:15.829829 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.917780 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
9
9
  import typing
10
10
  import metaflow
11
11
  if typing.TYPE_CHECKING:
12
- import typing
13
12
  import metaflow.parameters
13
+ import typing
14
14
  import metaflow._vendor.click.types
15
15
 
16
16
  from ._vendor import click as click
@@ -19,6 +19,7 @@ from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter
19
19
  from .parameters import DeployTimeField as DeployTimeField
20
20
  from .parameters import Parameter as Parameter
21
21
  from .parameters import ParameterContext as ParameterContext
22
+ from .user_configs.config_parameters import ConfigValue as ConfigValue
22
23
 
23
24
  DATACLIENTS: list
24
25
 
@@ -61,20 +62,26 @@ class IncludeFile(metaflow.parameters.Parameter, metaclass=type):
61
62
  default : Union[str, Callable[ParameterContext, str]]
62
63
  Default path to a local file. A function
63
64
  implies that the parameter corresponds to a *deploy-time parameter*.
64
- is_text : bool, default True
65
+ is_text : bool, optional, default None
65
66
  Convert the file contents to a string using the provided `encoding`.
66
- If False, the artifact is stored in `bytes`.
67
- encoding : str, optional, default 'utf-8'
68
- Use this encoding to decode the file contexts if `is_text=True`.
69
- required : bool, default False
67
+ If False, the artifact is stored in `bytes`. A value of None is equivalent to
68
+ True.
69
+ encoding : str, optional, default None
70
+ Use this encoding to decode the file contexts if `is_text=True`. A value of None
71
+ is equivalent to "utf-8".
72
+ required : bool, optional, default None
70
73
  Require that the user specified a value for the parameter.
71
- `required=True` implies that the `default` is not used.
74
+ `required=True` implies that the `default` is not used. A value of None is
75
+ equivalent to False
72
76
  help : str, optional
73
77
  Help text to show in `run --help`.
74
78
  show_default : bool, default True
75
- If True, show the default value in the help text.
79
+ If True, show the default value in the help text. A value of None is equivalent
80
+ to True.
76
81
  """
77
- def __init__(self, name: str, required: bool = False, is_text: bool = True, encoding: str = 'utf-8', help: typing.Optional[str] = None, **kwargs: typing.Dict[str, str]):
82
+ def __init__(self, name: str, required: typing.Optional[bool] = None, is_text: typing.Optional[bool] = None, encoding: typing.Optional[str] = None, help: typing.Optional[str] = None, **kwargs: typing.Dict[str, str]):
83
+ ...
84
+ def init(self):
78
85
  ...
79
86
  def load_parameter(self, v):
80
87
  ...
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.36 #
4
- # Generated on 2024-12-07T00:02:15.816924 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.901435 #
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.12.36 #
4
- # Generated on 2024-12-07T00:02:15.821752 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.906617 #
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.12.36 #
4
- # Generated on 2024-12-07T00:02:15.842517 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.932443 #
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.12.36 #
4
- # Generated on 2024-12-07T00:02:15.841892 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.931869 #
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.12.36 #
4
- # Generated on 2024-12-07T00:02:15.842161 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.932131 #
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.12.36 #
4
- # Generated on 2024-12-07T00:02:15.819299 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.903691 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -259,6 +259,8 @@ DEBUG_TRACING: bool
259
259
 
260
260
  DEBUG_STUBGEN: bool
261
261
 
262
+ DEBUG_USERCONF: bool
263
+
262
264
  AWS_SANDBOX_ENABLED: bool
263
265
 
264
266
  AWS_SANDBOX_STS_ENDPOINT_URL: None
@@ -1,18 +1,18 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.36 #
4
- # Generated on 2024-12-07T00:02:15.921504 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:58.006514 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
8
8
 
9
9
  import typing
10
10
  if typing.TYPE_CHECKING:
11
- import typing
11
+ import metaflow.metaflow_current
12
12
  import metaflow
13
- import metaflow.events
14
13
  import metaflow.plugins.cards.component_serializer
15
- import metaflow.metaflow_current
14
+ import metaflow.events
15
+ import typing
16
16
 
17
17
 
18
18
  TYPE_CHECKING: bool
@@ -225,6 +225,24 @@ class Current(object, metaclass=type):
225
225
  def graph(self):
226
226
  ...
227
227
  @property
228
+ def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
229
+ """
230
+ (only in the presence of the @card decorator)
231
+
232
+ The `@card` decorator makes the cards available through the `current.card`
233
+ object. If multiple `@card` decorators are present, you can add an `ID` to
234
+ distinguish between them using `@card(id=ID)` as the decorator. You will then
235
+ be able to access that specific card using `current.card[ID].
236
+
237
+ Methods available are `append` and `extend`
238
+
239
+ Returns
240
+ -------
241
+ CardComponentCollector
242
+ The or one of the cards attached to this step.
243
+ """
244
+ ...
245
+ @property
228
246
  def parallel(self) -> "metaflow.metaflow_current.Parallel":
229
247
  """
230
248
  (only in the presence of the @parallel decorator)
@@ -254,24 +272,6 @@ class Current(object, metaclass=type):
254
272
  """
255
273
  ...
256
274
  @property
257
- def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
258
- """
259
- (only in the presence of the @card decorator)
260
-
261
- The `@card` decorator makes the cards available through the `current.card`
262
- object. If multiple `@card` decorators are present, you can add an `ID` to
263
- distinguish between them using `@card(id=ID)` as the decorator. You will then
264
- be able to access that specific card using `current.card[ID].
265
-
266
- Methods available are `append` and `extend`
267
-
268
- Returns
269
- -------
270
- CardComponentCollector
271
- The or one of the cards attached to this step.
272
- """
273
- ...
274
- @property
275
275
  def trigger(self) -> "metaflow.events.Trigger":
276
276
  """
277
277
  (only in the presence of the @trigger_on_finish, or @trigger decorators)
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.36 #
4
- # Generated on 2024-12-07T00:02:15.819815 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.904208 #
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.12.36 #
4
- # Generated on 2024-12-07T00:02:15.821149 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.905739 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -9,8 +9,8 @@ from __future__ import annotations
9
9
  import typing
10
10
  import metaflow
11
11
  if typing.TYPE_CHECKING:
12
- import typing
13
12
  import metaflow.parameters
13
+ import typing
14
14
  import metaflow._vendor.click.types
15
15
 
16
16
  from ._vendor import click as click
@@ -18,14 +18,16 @@ from .exception import ParameterFieldFailed as ParameterFieldFailed
18
18
  from .exception import ParameterFieldTypeMismatch as ParameterFieldTypeMismatch
19
19
  from .exception import MetaflowException as MetaflowException
20
20
 
21
+ TYPE_CHECKING: bool
22
+
21
23
  class ParameterContext(tuple, metaclass=type):
22
24
  """
23
- ParameterContext(flow_name, user_name, parameter_name, logger, ds_type)
25
+ ParameterContext(flow_name, user_name, parameter_name, logger, ds_type, configs)
24
26
  """
25
27
  @staticmethod
26
- def __new__(_cls, flow_name: str, user_name: str, parameter_name: str, logger: typing.Callable[..., None], ds_type: str):
28
+ def __new__(_cls, flow_name: str, user_name: str, parameter_name: str, logger: typing.Callable[..., None], ds_type: str, configs: typing.Optional["ConfigValue"]):
27
29
  """
28
- Create new instance of ParameterContext(flow_name, user_name, parameter_name, logger, ds_type)
30
+ Create new instance of ParameterContext(flow_name, user_name, parameter_name, logger, ds_type, configs)
29
31
  """
30
32
  ...
31
33
  def __repr__(self):
@@ -38,7 +40,7 @@ class ParameterContext(tuple, metaclass=type):
38
40
  Return self as a plain tuple. Used by copy and pickle.
39
41
  """
40
42
  ...
41
- def __init__(self, flow_name: str, user_name: str, parameter_name: str, logger: typing.Callable[..., None], ds_type: str):
43
+ def __init__(self, flow_name: str, user_name: str, parameter_name: str, logger: typing.Callable[..., None], ds_type: str, configs: typing.Optional["ConfigValue"]):
42
44
  ...
43
45
  ...
44
46
 
@@ -52,6 +54,13 @@ def flow_context(flow_cls):
52
54
 
53
55
  context_proto: None
54
56
 
57
+ def replace_flow_context(flow_cls):
58
+ """
59
+ Replace the current flow context with a new flow class. This is used
60
+ when we change the current flow class after having run user configuration functions
61
+ """
62
+ ...
63
+
55
64
  class JSONTypeClass(metaflow._vendor.click.types.ParamType, metaclass=type):
56
65
  def convert(self, value, param, ctx):
57
66
  ...
@@ -86,7 +95,7 @@ class DeployTimeField(object, metaclass=type):
86
95
  def deploy_time_eval(value):
87
96
  ...
88
97
 
89
- def set_parameter_context(flow_name, echo, datastore):
98
+ def set_parameter_context(flow_name, echo, datastore, configs):
90
99
  ...
91
100
 
92
101
  class DelayedEvaluationParameter(object, metaclass=type):
@@ -135,7 +144,11 @@ class Parameter(object, metaclass=type):
135
144
  ----------
136
145
  name : str
137
146
  User-visible parameter name.
138
- default : str or float or int or bool or `JSONType` or a function.
147
+ default : Union[str, float, int, bool, Dict[str, Any],
148
+ Callable[
149
+ [ParameterContext], Union[str, float, int, bool, Dict[str, Any]]
150
+ ],
151
+ ], optional, default None
139
152
  Default value for the parameter. Use a special `JSONType` class to
140
153
  indicate that the value must be a valid JSON object. A function
141
154
  implies that the parameter corresponds to a *deploy-time parameter*.
@@ -144,15 +157,19 @@ class Parameter(object, metaclass=type):
144
157
  If `default` is not specified, define the parameter type. Specify
145
158
  one of `str`, `float`, `int`, `bool`, or `JSONType`. If None, defaults
146
159
  to the type of `default` or `str` if none specified.
147
- help : str, optional
160
+ help : str, optional, default None
148
161
  Help text to show in `run --help`.
149
- required : bool, default False
150
- Require that the user specified a value for the parameter.
151
- `required=True` implies that the `default` is not used.
152
- show_default : bool, default True
153
- If True, show the default value in the help text.
162
+ required : bool, optional, default None
163
+ Require that the user specified a value for the parameter. Note that if
164
+ a default is provide, the required flag is ignored.
165
+ A value of None is equivalent to False.
166
+ show_default : bool, optional, default None
167
+ If True, show the default value in the help text. A value of None is equivalent
168
+ to True.
154
169
  """
155
- def __init__(self, name: str, default: typing.Union[str, float, int, bool, typing.Dict[str, typing.Any], typing.Callable[[], typing.Union[str, float, int, bool, typing.Dict[str, typing.Any]]], None] = None, type: typing.Union[typing.Type[str], typing.Type[float], typing.Type[int], typing.Type[bool], JSONTypeClass, None] = None, help: typing.Optional[str] = None, required: bool = False, show_default: bool = True, **kwargs: typing.Dict[str, typing.Any]):
170
+ def __init__(self, name: str, default: typing.Union[str, float, int, bool, typing.Dict[str, typing.Any], typing.Callable[[ParameterContext], typing.Union[str, float, int, bool, typing.Dict[str, typing.Any]]], None] = None, type: typing.Union[typing.Type[str], typing.Type[float], typing.Type[int], typing.Type[bool], JSONTypeClass, None] = None, help: typing.Optional[str] = None, required: typing.Optional[bool] = None, show_default: typing.Optional[bool] = None, **kwargs: typing.Dict[str, typing.Any]):
171
+ ...
172
+ def init(self):
156
173
  ...
157
174
  def __repr__(self):
158
175
  ...
@@ -1,7 +1,7 @@
1
1
  ######################################################################################################
2
2
  # Auto-generated Metaflow stub file #
3
- # MF version: 2.12.36 #
4
- # Generated on 2024-12-07T00:02:15.825052 #
3
+ # MF version: 2.12.38 #
4
+ # Generated on 2024-12-08T03:54:57.913069 #
5
5
  ######################################################################################################
6
6
 
7
7
  from __future__ import annotations
@@ -13,17 +13,17 @@ from . import kubernetes as kubernetes
13
13
  from . import resources_decorator as resources_decorator
14
14
  from . import timeout_decorator as timeout_decorator
15
15
  from . import aws as aws
16
- from . import catch_decorator as catch_decorator
17
- from . import secrets as secrets
16
+ from . import pypi as pypi
17
+ from . import cards as cards
18
18
  from . import parallel_decorator as parallel_decorator
19
+ from . import environment_decorator as environment_decorator
20
+ from . import secrets as secrets
19
21
  from . import frameworks as frameworks
20
22
  from . import retry_decorator as retry_decorator
21
- from . import cards as cards
22
- from . import pypi as pypi
23
+ from . import datatools as datatools
23
24
  from . import airflow as airflow
25
+ from . import catch_decorator as catch_decorator
24
26
  from . import argo as argo
25
- from . import datatools as datatools
26
- from . import environment_decorator as environment_decorator
27
27
  from . import events_decorator as events_decorator
28
28
  from . import project_decorator as project_decorator
29
29
  from . import gcp as gcp
@@ -45,9 +45,6 @@ from .cards.card_modules.test_cards import TestPathSpecCard as TestPathSpecCard
45
45
  from .cards.card_modules.test_cards import TestTimeoutCard as TestTimeoutCard
46
46
  from .cards.card_modules.test_cards import TestRefreshCard as TestRefreshCard
47
47
  from .cards.card_modules.test_cards import TestRefreshComponentCard as TestRefreshComponentCard
48
- from . import tag_cli as tag_cli
49
- from . import logs_cli as logs_cli
50
- from . import package_cli as package_cli
51
48
 
52
49
  CLIS_DESC: list
53
50
 
@@ -84,6 +81,9 @@ DEPLOYER_IMPL_PROVIDERS_DESC: list
84
81
  def get_plugin_cli():
85
82
  ...
86
83
 
84
+ def get_plugin_cli_path():
85
+ ...
86
+
87
87
  STEP_DECORATORS: list
88
88
 
89
89
  FLOW_DECORATORS: list