ob-metaflow-stubs 2.11.4.1__py2.py3-none-any.whl

metaflow-stubs/client/filecache.pyi

@@ -0,0 +1,87 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.926645                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.datastore.content_addressed_store
+    import metaflow.exception
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+CLIENT_CACHE_PATH: str
+
+CLIENT_CACHE_MAX_SIZE: int
+
+CLIENT_CACHE_MAX_FLOWDATASTORE_COUNT: int
+
+CLIENT_CACHE_MAX_TASKDATASTORE_COUNT: int
+
+DATASTORES: list
+
+NEW_FILE_QUARANTINE: int
+
+def od_move_to_end(od, key):
+    ...
+
+class FileCacheException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+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 FileBlobCache(metaflow.datastore.content_addressed_store.BlobCache, metaclass=type):
+    def __init__(self, filecache, cache_id):
+        ...
+    def load_key(self, key):
+        ...
+    def store_key(self, key, blob):
+        ...
+    ...
+

metaflow-stubs/events.pyi

@@ -0,0 +1,107 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.903524                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow
+    import metaflow.events
+
+TYPE_CHECKING: bool
+
+class MetaflowEvent(tuple, metaclass=type):
+    @staticmethod
+    def __new__(_cls, name, id, timestamp, type):
+        """
+        Create new instance of MetaflowEvent(name, id, timestamp, type)
+        """
+        ...
+    def __repr__(self):
+        """
+        Return a nicely formatted representation string
+        """
+        ...
+    def __getnewargs__(self):
+        """
+        Return self as a plain tuple.  Used by copy and pickle.
+        """
+        ...
+    ...
+
+class Trigger(object, metaclass=type):
+    def __init__(self, _meta = None):
+        ...
+    @classmethod
+    def from_runs(cls, run_objs: typing.List["metaflow.Run"]):
+        ...
+    @property
+    def event(self) -> typing.Optional[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[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", 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:
+        ...
+    ...
+

metaflow-stubs/exception.pyi

@@ -0,0 +1,98 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.889094                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.exception
+
+METAFLOW_EXIT_DISALLOW_RETRY: int
+
+METAFLOW_EXIT_ALLOW_RETRY: int
+
+class MetaflowExceptionWrapper(Exception, metaclass=type):
+    def __init__(self, exc = None):
+        ...
+    def __reduce__(self):
+        ...
+    def __getstate__(self):
+        ...
+    def __setstate__(self, state):
+        ...
+    def __repr__(self):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+class ParameterFieldFailed(MetaflowException, metaclass=type):
+    def __init__(self, name, field):
+        ...
+    ...
+
+class ParameterFieldTypeMismatch(MetaflowException, metaclass=type):
+    def __init__(self, msg):
+        ...
+    ...
+
+class ExternalCommandFailed(MetaflowException, metaclass=type):
+    def __init__(self, msg):
+        ...
+    ...
+
+class MetaflowNotFound(MetaflowException, metaclass=type):
+    ...
+
+class MetaflowNamespaceMismatch(MetaflowException, metaclass=type):
+    def __init__(self, namespace):
+        ...
+    ...
+
+class MetaflowInvalidPathspec(MetaflowException, metaclass=type):
+    def __init__(self, msg):
+        ...
+    ...
+
+class MetaflowInternalError(MetaflowException, metaclass=type):
+    ...
+
+class MetaflowTaggingError(MetaflowException, metaclass=type):
+    ...
+
+class MetaflowUnknownUser(MetaflowException, metaclass=type):
+    def __init__(self):
+        ...
+    ...
+
+class InvalidDecoratorAttribute(MetaflowException, metaclass=type):
+    def __init__(self, deconame, attr, defaults):
+        ...
+    ...
+
+class CommandException(MetaflowException, metaclass=type):
+    ...
+
+class MetaflowDataMissing(MetaflowException, metaclass=type):
+    ...
+
+class UnhandledInMergeArtifactsException(MetaflowException, metaclass=type):
+    def __init__(self, msg, unhandled):
+        ...
+    ...
+
+class MissingInMergeArtifactsException(MetaflowException, metaclass=type):
+    def __init__(self, msg, unhandled):
+        ...
+    ...
+

metaflow-stubs/flowspec.pyi

@@ -0,0 +1,297 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.902675                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.exception
+    import metaflow.parameters
+    import metaflow.unbounded_foreach
+    import metaflow.datastore.inputs
+    import typing
+
+class DelayedEvaluationParameter(object, metaclass=type):
+    def __init__(self, name, field, fun):
+        ...
+    def __call__(self, return_str = False):
+        ...
+    ...
+
+class Parameter(object, metaclass=type):
+    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):
+        ...
+    ...
+
+INCLUDE_FOREACH_STACK: bool
+
+MAXIMUM_FOREACH_VALUE_CHARS: int
+
+INTERNAL_ARTIFACTS_SET: set
+
+class InvalidNextException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, msg):
+        ...
+    ...
+
+class ParallelUBF(metaflow.unbounded_foreach.UnboundedForeachInput, metaclass=type):
+    def __init__(self, num_parallel):
+        ...
+    def __getitem__(self, item):
+        ...
+    ...
+
+class FlowSpec(object, metaclass=type):
+    def __init__(self, use_cli = True):
+        """
+        Construct a FlowSpec
+        
+        Parameters
+        ----------
+        use_cli : bool, default True
+            Set to True if the flow is invoked from __main__ or the command line
+        """
+        ...
+    @property
+    def script_name(self) -> str:
+        """
+        [Legacy function - do not use. Use `current` instead]
+        
+        Returns the name of the script containing the flow
+        
+        Returns
+        -------
+        str
+            A string containing the name of the script
+        """
+        ...
+    def __iter__(self):
+        """
+        [Legacy function - do not use]
+        
+        Iterate over all steps in the Flow
+        
+        Returns
+        -------
+        Iterator[graph.DAGNode]
+            Iterator over the steps in the flow
+        """
+        ...
+    def __getattr__(self, name: str):
+        ...
+    def cmd(self, cmdline, input = {}, output = []):
+        """
+        [Legacy function - do not use]
+        """
+        ...
+    @property
+    def index(self) -> typing.Optional[int]:
+        """
+        The index of this foreach branch.
+        
+        In a foreach step, multiple instances of this step (tasks) will be executed,
+        one for each element in the foreach. This property returns the zero based index
+        of the current task. If this is not a foreach step, this returns None.
+        
+        If you need to know the indices of the parent tasks in a nested foreach, use
+        `FlowSpec.foreach_stack`.
+        
+        Returns
+        -------
+        int, optional
+            Index of the task in a foreach step.
+        """
+        ...
+    @property
+    def input(self) -> typing.Optional[typing.Any]:
+        """
+        The value of the foreach artifact in this foreach branch.
+        
+        In a foreach step, multiple instances of this step (tasks) will be executed,
+        one for each element in the foreach. This property returns the element passed
+        to the current task. If this is not a foreach step, this returns None.
+        
+        If you need to know the values of the parent tasks in a nested foreach, use
+        `FlowSpec.foreach_stack`.
+        
+        Returns
+        -------
+        object, optional
+            Input passed to the foreach task.
+        """
+        ...
+    def foreach_stack(self) -> typing.Optional[typing.List[typing.Tuple[int, int, typing.Any]]]:
+        """
+        Returns the current stack of foreach indexes and values for the current step.
+        
+        Use this information to understand what data is being processed in the current
+        foreach branch. For example, considering the following code:
+        ```
+        @step
+        def root(self):
+            self.split_1 = ['a', 'b', 'c']
+            self.next(self.nest_1, foreach='split_1')
+        
+        @step
+        def nest_1(self):
+            self.split_2 = ['d', 'e', 'f', 'g']
+            self.next(self.nest_2, foreach='split_2'):
+        
+        @step
+        def nest_2(self):
+            foo = self.foreach_stack()
+        ```
+        
+        `foo` will take the following values in the various tasks for nest_2:
+        ```
+            [(0, 3, 'a'), (0, 4, 'd')]
+            [(0, 3, 'a'), (1, 4, 'e')]
+            ...
+            [(0, 3, 'a'), (3, 4, 'g')]
+            [(1, 3, 'b'), (0, 4, 'd')]
+            ...
+        ```
+        where each tuple corresponds to:
+        
+        - The index of the task for that level of the loop.
+        - The number of splits for that level of the loop.
+        - The value for that level of the loop.
+        
+        Note that the last tuple returned in a task corresponds to:
+        
+        - 1st element: value returned by `self.index`.
+        - 3rd element: value returned by `self.input`.
+        
+        Returns
+        -------
+        List[Tuple[int, int, Any]]
+            An array describing the current stack of foreach steps.
+        """
+        ...
+    def merge_artifacts(self, inputs: metaflow.datastore.inputs.Inputs, exclude: typing.Optional[typing.List[str]] = None, include: typing.Optional[typing.List[str]] = None):
+        """
+        Helper function for merging artifacts in a join step.
+        
+        This function takes all the artifacts coming from the branches of a
+        join point and assigns them to self in the calling step. Only artifacts
+        not set in the current step are considered. If, for a given artifact, different
+        values are present on the incoming edges, an error will be thrown and the artifacts
+        that conflict will be reported.
+        
+        As a few examples, in the simple graph: A splitting into B and C and joining in D:
+        ```
+        A:
+          self.x = 5
+          self.y = 6
+        B:
+          self.b_var = 1
+          self.x = from_b
+        C:
+          self.x = from_c
+        
+        D:
+          merge_artifacts(inputs)
+        ```
+        In D, the following artifacts are set:
+          - `y` (value: 6), `b_var` (value: 1)
+          - if `from_b` and `from_c` are the same, `x` will be accessible and have value `from_b`
+          - if `from_b` and `from_c` are different, an error will be thrown. To prevent this error,
+            you need to manually set `self.x` in D to a merged value (for example the max) prior to
+            calling `merge_artifacts`.
+        
+        Parameters
+        ----------
+        inputs : Inputs
+            Incoming steps to the join point.
+        exclude : List[str], optional, default None
+            If specified, do not consider merging artifacts with a name in `exclude`.
+            Cannot specify if `include` is also specified.
+        include : List[str], optional, default None
+            If specified, only merge artifacts specified. Cannot specify if `exclude` is
+            also specified.
+        
+        Raises
+        ------
+        MetaflowException
+            This exception is thrown if this is not called in a join step.
+        UnhandledInMergeArtifactsException
+            This exception is thrown in case of unresolved conflicts.
+        MissingInMergeArtifactsException
+            This exception is thrown in case an artifact specified in `include` cannot
+            be found.
+        """
+        ...
+    def next(self, *dsts: typing.Callable[..., None], **kwargs):
+        """
+        Indicates the next step to execute after this step has completed.
+        
+        This statement should appear as the last statement of each step, except
+        the end step.
+        
+        There are several valid formats to specify the next step:
+        
+        - Straight-line connection: `self.next(self.next_step)` where `next_step` is a method in
+          the current class decorated with the `@step` decorator.
+        
+        - Static fan-out connection: `self.next(self.step1, self.step2, ...)` where `stepX` are
+          methods in the current class decorated with the `@step` decorator.
+        
+        - Foreach branch:
+          ```
+          self.next(self.foreach_step, foreach='foreach_iterator')
+          ```
+          In this situation, `foreach_step` is a method in the current class decorated with the
+          `@step` decorator and `foreach_iterator` is a variable name in the current class that
+          evaluates to an iterator. A task will be launched for each value in the iterator and
+          each task will execute the code specified by the step `foreach_step`.
+        
+        Parameters
+        ----------
+        dsts : Callable[..., None]
+            One or more methods annotated with `@step`.
+        
+        Raises
+        ------
+        InvalidNextException
+            Raised if the format of the arguments does not match one of the ones given above.
+        """
+        ...
+    def __str__(self):
+        ...
+    def __getstate__(self):
+        ...
+    ...
+

metaflow-stubs/generated_for.txt

@@ -0,0 +1 @@
+2.11.4.1 2024-02-28T05:30:43.869462