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

metaflow-stubs/client/core.pyi

@@ -1,130 +1,30 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.445428                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.572805                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import datetime
-    import tarfile
     import metaflow.client.core
     import metaflow.events
-    import metaflow.exception
+    import datetime
+    import tarfile
     import typing
-    import metaflow
-    import metaflow.metaflow_current
-
-TYPE_CHECKING: bool
 
-current: metaflow.metaflow_current.Current
+from ..metaflow_current import current as current
+from ..events import Trigger as Trigger
+from ..exception import MetaflowInternalError as MetaflowInternalError
+from ..exception import MetaflowInvalidPathspec as MetaflowInvalidPathspec
+from ..exception import MetaflowNamespaceMismatch as MetaflowNamespaceMismatch
+from ..exception import MetaflowNotFound as MetaflowNotFound
+from ..includefile import IncludedFile as IncludedFile
+from .filecache import FileCache as FileCache
 
-class Trigger(object, metaclass=type):
-    """
-    Defines a container of event triggers' metadata.
-    """
-    def __init__(self, _meta = None):
-        ...
-    @classmethod
-    def from_runs(cls, run_objs: typing.List["metaflow.Run"]):
-        ...
-    @property
-    def event(self) -> typing.Optional[metaflow.events.MetaflowEvent]:
-        """
-        The `MetaflowEvent` object corresponding to the triggering event.
-        
-        If multiple events triggered the run, this property is the latest event.
-        
-        Returns
-        -------
-        MetaflowEvent, optional
-            The latest event that triggered the run, if applicable.
-        """
-        ...
-    @property
-    def events(self) -> typing.Optional[typing.List[metaflow.events.MetaflowEvent]]:
-        """
-        The list of `MetaflowEvent` objects correspondings to all the triggering events.
-        
-        Returns
-        -------
-        List[MetaflowEvent], optional
-            List of all events that triggered the run
-        """
-        ...
-    @property
-    def run(self) -> typing.Optional["metaflow.Run"]:
-        """
-        The corresponding `Run` object if the triggering event is a Metaflow run.
-        
-        In case multiple runs triggered the run, this property is the latest run.
-        Returns `None` if none of the triggering events are a `Run`.
-        
-        Returns
-        -------
-        Run, optional
-            Latest Run that triggered this run, if applicable.
-        """
-        ...
-    @property
-    def runs(self) -> typing.Optional[typing.List["metaflow.Run"]]:
-        """
-        The list of `Run` objects in the triggering events.
-        Returns `None` if none of the triggering events are `Run` objects.
-        
-        Returns
-        -------
-        List[Run], optional
-            List of runs that triggered this run, if applicable.
-        """
-        ...
-    def __getitem__(self, key: str) -> typing.Union["metaflow.Run", metaflow.events.MetaflowEvent]:
-        """
-        If triggering events are runs, `key` corresponds to the flow name of the triggering run.
-        Otherwise, `key` corresponds to the event name and a `MetaflowEvent` object is returned.
-        
-        Returns
-        -------
-        Union[Run, MetaflowEvent]
-            `Run` object if triggered by a run. Otherwise returns a `MetaflowEvent`.
-        """
-        ...
-    def __iter__(self):
-        ...
-    def __contains__(self, ident: str) -> bool:
-        ...
-    ...
-
-class MetaflowInternalError(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-class MetaflowInvalidPathspec(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, msg):
-        ...
-    ...
-
-class MetaflowNamespaceMismatch(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, namespace):
-        ...
-    ...
-
-class MetaflowNotFound(metaflow.exception.MetaflowException, metaclass=type):
-    ...
-
-class IncludedFile(object, metaclass=type):
-    def __init__(self, descriptor: typing.Dict[str, typing.Any]):
-        ...
-    @property
-    def descriptor(self):
-        ...
-    @property
-    def size(self):
-        ...
-    def decode(self, name, var_type = "Artifact"):
-        ...
-    ...
+TYPE_CHECKING: bool
 
 DEFAULT_METADATA: str
 
@@ -138,46 +38,6 @@ CONTROL_TASK_TAG: str
 
 INFO_FILE: str
 
-class FileCache(object, metaclass=type):
-    def __init__(self, cache_dir = None, max_size = None):
-        ...
-    @property
-    def cache_dir(self):
-        ...
-    def get_logs_stream(self, ds_type, ds_root, stream, attempt, flow_name, run_id, step_name, task_id):
-        ...
-    def get_log_legacy(self, ds_type, location, logtype, attempt, flow_name, run_id, step_name, task_id):
-        ...
-    def get_legacy_log_size(self, ds_type, location, logtype, attempt, flow_name, run_id, step_name, task_id):
-        ...
-    def get_log_size(self, ds_type, ds_root, logtype, attempt, flow_name, run_id, step_name, task_id):
-        ...
-    def get_data(self, ds_type, flow_name, location, key):
-        ...
-    def get_artifact_size_by_location(self, ds_type, location, attempt, flow_name, run_id, step_name, task_id, name):
-        """
-        Gets the size of the artifact content (in bytes) for the name at the location
-        """
-        ...
-    def get_artifact_size(self, ds_type, ds_root, attempt, flow_name, run_id, step_name, task_id, name):
-        """
-        Gets the size of the artifact content (in bytes) for the name
-        """
-        ...
-    def get_artifact_by_location(self, ds_type, location, data_metadata, flow_name, run_id, step_name, task_id, name):
-        ...
-    def get_artifact(self, ds_type, ds_root, data_metadata, flow_name, run_id, step_name, task_id, name):
-        ...
-    def get_all_artifacts(self, ds_type, ds_root, data_metadata, flow_name, run_id, step_name, task_id):
-        ...
-    def get_artifacts(self, ds_type, ds_root, data_metadata, flow_name, run_id, step_name, task_id, names):
-        ...
-    def create_file(self, path, value):
-        ...
-    def read_file(self, path):
-        ...
-    ...
-
 class Metadata(tuple, metaclass=type):
     """
     Metadata(name, value, created_at, type, task)
@@ -382,7 +242,7 @@ class MetaflowObject(object, metaclass=type):
         ...
     def __repr__(self):
         ...
-    def __getitem__(self, id: str) -> MetaflowObject:
+    def __getitem__(self, id: str) -> "MetaflowObject":
         """
         Returns the child object named 'id'.
         

metaflow-stubs/client/filecache.pyi

@@ -1,22 +1,18 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.473431                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.599338                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
-    import metaflow.datastore.content_addressed_store
     import metaflow.exception
+    import metaflow.datastore.content_addressed_store
 
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
+from ..exception import MetaflowException as MetaflowException
 
 CLIENT_CACHE_PATH: str
 

metaflow-stubs/clone_util.pyi

@@ -1,33 +1,13 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.470946                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.576868                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 
-class MetaDatum(tuple, metaclass=type):
-    """
-    MetaDatum(field, value, type, tags)
-    """
-    @staticmethod
-    def __new__(_cls, field, value, type, tags):
-        """
-        Create new instance of MetaDatum(field, value, type, tags)
-        """
-        ...
-    def __repr__(self):
-        """
-        Return a nicely formatted representation string
-        """
-        ...
-    def __getnewargs__(self):
-        """
-        Return self as a plain tuple.  Used by copy and pickle.
-        """
-        ...
-    ...
+from .metadata_provider.metadata import MetaDatum as MetaDatum
 
 def clone_task_helper(flow_name, clone_run_id, run_id, step_name, clone_task_id, task_id, flow_datastore, metadata_service, origin_ds_set = None, attempt_id = 0):
     ...

metaflow-stubs/events.pyi

@@ -1,8 +1,8 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.447979                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.560838                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
@@ -11,6 +11,7 @@ if typing.TYPE_CHECKING:
     import metaflow.events
     import metaflow
 
+
 TYPE_CHECKING: bool
 
 class MetaflowEvent(tuple, metaclass=type):

metaflow-stubs/exception.pyi

@@ -1,15 +1,17 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.435800                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.555071                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
+import metaflow
 import typing
 if typing.TYPE_CHECKING:
     import metaflow.exception
 
+
 METAFLOW_EXIT_DISALLOW_RETRY: int
 
 METAFLOW_EXIT_ALLOW_RETRY: int
@@ -30,7 +32,7 @@ class MetaflowExceptionWrapper(Exception, metaclass=type):
     ...
 
 class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
+    def __init__(self, msg = '', lineno = None):
         ...
     def __str__(self):
         ...

metaflow-stubs/flowspec.pyi

@@ -1,116 +1,26 @@
-##################################################################################
-#                       Auto-generated Metaflow stub file                        #
-# MF version: 2.12.28                                                            #
-# Generated on 2024-11-01T10:21:04.447088                                        #
-##################################################################################
+######################################################################################################
+#                                 Auto-generated Metaflow stub file                                  #
+# MF version: 2.12.29                                                                                #
+# Generated on 2024-11-07T22:19:34.560104                                                            #
+######################################################################################################
 
 from __future__ import annotations
 
 import typing
+import metaflow
 if typing.TYPE_CHECKING:
-    import typing
-    import metaflow.parameters
     import metaflow.exception
-    import metaflow.flowspec
-    import metaflow.datastore.inputs
     import metaflow.unbounded_foreach
+    import metaflow.datastore.inputs
+    import typing
+    import metaflow.flowspec
 
-class DelayedEvaluationParameter(object, metaclass=type):
-    """
-    This is a very simple wrapper to allow parameter "conversion" to be delayed until
-    the `_set_constants` function in FlowSpec. Typically, parameters are converted
-    by click when the command line option is processed. For some parameters, like
-    IncludeFile, this is too early as it would mean we would trigger the upload
-    of the file too early. If a parameter converts to a DelayedEvaluationParameter
-    object through the usual click mechanisms, `_set_constants` knows to invoke the
-    __call__ method on that DelayedEvaluationParameter; in that case, the __call__
-    method is invoked without any parameter. The return_str parameter will be used
-    by schedulers when they need to convert DelayedEvaluationParameters to a
-    string to store them
-    """
-    def __init__(self, name, field, fun):
-        ...
-    def __call__(self, return_str = False):
-        ...
-    ...
-
-class Parameter(object, metaclass=type):
-    """
-    Defines a parameter for a flow.
-    
-    Parameters must be instantiated as class variables in flow classes, e.g.
-    ```
-    class MyFlow(FlowSpec):
-        param = Parameter('myparam')
-    ```
-    in this case, the parameter is specified on the command line as
-    ```
-    python myflow.py run --myparam=5
-    ```
-    and its value is accessible through a read-only artifact like this:
-    ```
-    print(self.param == 5)
-    ```
-    Note that the user-visible parameter name, `myparam` above, can be
-    different from the artifact name, `param` above.
-    
-    The parameter value is converted to a Python type based on the `type`
-    argument or to match the type of `default`, if it is set.
-    
-    Parameters
-    ----------
-    name : str
-        User-visible parameter name.
-    default : str or float or int or bool or `JSONType` or a function.
-        Default value for the parameter. Use a special `JSONType` class to
-        indicate that the value must be a valid JSON object. A function
-        implies that the parameter corresponds to a *deploy-time parameter*.
-        The type of the default value is used as the parameter `type`.
-    type : Type, default None
-        If `default` is not specified, define the parameter type. Specify
-        one of `str`, `float`, `int`, `bool`, or `JSONType`. If None, defaults
-        to the type of `default` or `str` if none specified.
-    help : str, optional
-        Help text to show in `run --help`.
-    required : bool, default False
-        Require that the user specified a value for the parameter.
-        `required=True` implies that the `default` is not used.
-    show_default : bool, default True
-        If True, show the default value in the help text.
-    """
-    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], metaflow.parameters.JSONTypeClass, None] = None, help: typing.Optional[str] = None, required: bool = False, show_default: bool = True, **kwargs: typing.Dict[str, typing.Any]):
-        ...
-    def __repr__(self):
-        ...
-    def __str__(self):
-        ...
-    def option_kwargs(self, deploy_mode):
-        ...
-    def load_parameter(self, v):
-        ...
-    @property
-    def is_string_type(self):
-        ...
-    def __getitem__(self, x):
-        ...
-    ...
-
-class MetaflowException(Exception, metaclass=type):
-    def __init__(self, msg = "", lineno = None):
-        ...
-    def __str__(self):
-        ...
-    ...
-
-class MissingInMergeArtifactsException(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, msg, unhandled):
-        ...
-    ...
-
-class UnhandledInMergeArtifactsException(metaflow.exception.MetaflowException, metaclass=type):
-    def __init__(self, msg, unhandled):
-        ...
-    ...
+from . import parameters as parameters
+from .parameters import DelayedEvaluationParameter as DelayedEvaluationParameter
+from .parameters import Parameter as Parameter
+from .exception import MetaflowException as MetaflowException
+from .exception import MissingInMergeArtifactsException as MissingInMergeArtifactsException
+from .exception import UnhandledInMergeArtifactsException as UnhandledInMergeArtifactsException
 
 INCLUDE_FOREACH_STACK: bool
 
@@ -133,7 +43,13 @@ class ParallelUBF(metaflow.unbounded_foreach.UnboundedForeachInput, metaclass=ty
         ...
     ...
 
-class FlowSpec(object, metaclass=_FlowSpecMeta):
+class FlowSpecMeta(type, metaclass=type):
+    @staticmethod
+    def __new__(cls, name, bases, dct):
+        ...
+    ...
+
+class FlowSpec(object, metaclass=FlowSpecMeta):
     """
     Main class from which all Flows should inherit.
     

metaflow-stubs/generated_for.txt

@@ -1 +1 @@
-2.12.28 2024-11-01T10:21:04.417883
+2.12.29 2024-11-07T22:19:34.553326