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

metaflow-stubs/metaflow_current.pyi

@@ -0,0 +1,327 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:44.017390                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
+    import metaflow.events
+    import metaflow
+    import metaflow.plugins.cards.component_serializer
+    import typing
+
+TYPE_CHECKING: bool
+
+TEMPDIR: str
+
+class Parallel(tuple, metaclass=type):
+    @staticmethod
+    def __new__(_cls, main_ip, num_nodes, node_index):
+        """
+        Create new instance of Parallel(main_ip, num_nodes, node_index)
+        """
+        ...
+    def __repr__(self):
+        """
+        Return a nicely formatted representation string
+        """
+        ...
+    def __getnewargs__(self):
+        """
+        Return self as a plain tuple.  Used by copy and pickle.
+        """
+        ...
+    ...
+
+class Current(object, metaclass=type):
+    def __init__(self):
+        ...
+    def __contains__(self, key: str):
+        ...
+    def get(self, key: str, default = None) -> typing.Optional[typing.Any]:
+        ...
+    @property
+    def is_running_flow(self) -> bool:
+        """
+        Returns True if called inside a running Flow, False otherwise.
+        
+        You can use this property e.g. inside a library to choose the desired
+        behavior depending on the execution context.
+        
+        Returns
+        -------
+        bool
+            True if called inside a run, False otherwise.
+        """
+        ...
+    @property
+    def flow_name(self) -> typing.Optional[str]:
+        """
+        The name of the currently executing flow.
+        
+        Returns
+        -------
+        str, optional
+            Flow name.
+        """
+        ...
+    @property
+    def run_id(self) -> typing.Optional[str]:
+        """
+        The run ID of the currently executing run.
+        
+        Returns
+        -------
+        str, optional
+            Run ID.
+        """
+        ...
+    @property
+    def step_name(self) -> typing.Optional[str]:
+        """
+        The name of the currently executing step.
+        
+        Returns
+        -------
+        str, optional
+            Step name.
+        """
+        ...
+    @property
+    def task_id(self) -> typing.Optional[str]:
+        """
+        The task ID of the currently executing task.
+        
+        Returns
+        -------
+        str, optional
+            Task ID.
+        """
+        ...
+    @property
+    def retry_count(self) -> int:
+        """
+        The index of the task execution attempt.
+        
+        This property returns 0 for the first attempt to execute the task.
+        If the @retry decorator is used and the first attempt fails, this
+        property returns the number of times the task was attempted prior
+        to the current attempt.
+        
+        Returns
+        -------
+        int
+            The retry count.
+        """
+        ...
+    @property
+    def origin_run_id(self) -> typing.Optional[str]:
+        """
+        The run ID of the original run this run was resumed from.
+        
+        This property returns None for ordinary runs. If the run
+        was started by the resume command, the property returns
+        the ID of the original run.
+        
+        You can use this property to detect if the run is resumed
+        or not.
+        
+        Returns
+        -------
+        str, optional
+            Run ID of the original run.
+        """
+        ...
+    @property
+    def pathspec(self) -> typing.Optional[str]:
+        """
+        Pathspec of the current task, i.e. a unique
+        identifier of the current task. The returned
+        string follows this format:
+        ```
+        {flow_name}/{run_id}/{step_name}/{task_id}
+        ```
+        
+        This is a shorthand to `current.task.pathspec`.
+        
+        Returns
+        -------
+        str, optional
+            Pathspec.
+        """
+        ...
+    @property
+    def task(self) -> typing.Optional["metaflow.Task"]:
+        """
+        Task object of the current task.
+        
+        Returns
+        -------
+        Task, optional
+            Current task.
+        """
+        ...
+    @property
+    def run(self) -> typing.Optional["metaflow.Run"]:
+        """
+        Run object of the current run.
+        
+        Returns
+        -------
+        Run, optional
+            Current run.
+        """
+        ...
+    @property
+    def namespace(self) -> str:
+        """
+        The current namespace.
+        
+        Returns
+        -------
+        str
+            Namespace.
+        """
+        ...
+    @property
+    def username(self) -> typing.Optional[str]:
+        """
+        The name of the user who started the run, if available.
+        
+        Returns
+        -------
+        str, optional
+            User name.
+        """
+        ...
+    @property
+    def parallel(self):
+        ...
+    @property
+    def tags(self):
+        """
+        [Legacy function - do not use]
+        
+        Access tags through the Run object instead.
+        """
+        ...
+    @property
+    def tempdir(self) -> typing.Optional[str]:
+        """
+        Currently configured temporary directory.
+        
+        Returns
+        -------
+        str, optional
+            Temporary director.
+        """
+        ...
+    @property
+    def graph(_):
+        ...
+    @property
+    def card(self) -> "metaflow.plugins.cards.component_serializer.CardComponentCollector":
+        """
+        (only in the presence of the @card decorator)
+        
+        The `@card` decorator makes the cards available through the `current.card`
+        object. If multiple `@card` decorators are present, you can add an `ID` to
+        distinguish between them using `@card(id=ID)` as the decorator. You will then
+        be able to access that specific card using `current.card[ID].
+        
+        Methods available are `append` and `extend`
+        
+        Returns
+        -------
+        CardComponentCollector
+            The or one of the cards attached to this step.
+        """
+        ...
+    @property
+    def trigger(self) -> "metaflow.events.Trigger":
+        """
+        (only in the presence of the @trigger, or @trigger_on_finish decorators)
+        
+        Returns `Trigger` if the current run is triggered by an event
+        
+        Returns
+        -------
+        Trigger
+            `Trigger` if triggered by an event
+        """
+        ...
+    @property
+    def project_name(self) -> str:
+        """
+        (only in the presence of the @project decorator)
+        
+        The name of the project assigned to this flow, i.e. `X` in `@project(name=X)`.
+        
+        Returns
+        -------
+        str
+            Project name.
+        """
+        ...
+    @property
+    def project_flow_name(self) -> str:
+        """
+        (only in the presence of the @project decorator)
+        
+        The flow name prefixed with the current project and branch. This name identifies
+        the deployment on a production scheduler.
+        
+        Returns
+        -------
+        str
+            Flow name prefixed with project information.
+        """
+        ...
+    @property
+    def branch_name(self) -> str:
+        """
+        (only in the presence of the @project decorator)
+        
+        The current branch, i.e. `X` in `--branch=X` set during deployment or run.
+        
+        Returns
+        -------
+        str
+            Branch name.
+        """
+        ...
+    @property
+    def is_user_branch(self) -> bool:
+        """
+        (only in the presence of the @project decorator)
+        
+        True if the flow is deployed without a specific `--branch` or a `--production`
+        flag.
+        
+        Returns
+        -------
+        bool
+            True if the deployment does not correspond to a specific branch.
+        """
+        ...
+    @property
+    def is_production(self) -> bool:
+        """
+        (only in the presence of the @project decorator)
+        
+        True if the flow is deployed with the `--production` flag
+        
+        Returns
+        -------
+        bool
+            True if the flow is deployed with `--production`.
+        """
+        ...
+    ...
+
+current: Current
+

metaflow-stubs/mflog/mflog.pyi

@@ -0,0 +1,22 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.950058                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import datetime
+
+VERSION: bytes
+
+RE: bytes
+
+ISOFORMAT: str
+
+MISSING_TIMESTAMP: datetime.datetime
+
+MISSING_TIMESTAMP_STR: str
+

metaflow-stubs/multicore_utils.pyi

@@ -0,0 +1,62 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.891302                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import typing
+
+class MulticoreException(Exception, metaclass=type):
+    ...
+
+def parallel_imap_unordered(func: typing.Callable[[typing.Any], typing.Any], iterable: typing.Iterable[typing.Any], max_parallel: typing.Optional[int] = None, dir: typing.Optional[str] = None) -> typing.Iterator[typing.Any]:
+    """
+    Parallelizes execution of a function using multiprocessing. The result
+    order is not guaranteed.
+    
+    Parameters
+    ----------
+    func : Callable[[Any], Any]
+        Function taking a single argument and returning a result
+    iterable : Iterable[Any]
+        Iterable over arguments to pass to fun
+    max_parallel int, optional, default None
+        Maximum parallelism. If not specified, uses the number of CPUs
+    dir : str, optional, default None
+        If specified, directory where temporary files are created
+    
+    Yields
+    ------
+    Any
+        One result from calling func on one argument
+    """
+    ...
+
+def parallel_map(func: typing.Callable[[typing.Any], typing.Any], iterable: typing.Iterable[typing.Any], max_parallel: typing.Optional[int] = None, dir: typing.Optional[str] = None) -> typing.List[typing.Any]:
+    """
+    Parallelizes execution of a function using multiprocessing. The result
+    order is that of the arguments in `iterable`
+    
+    Parameters
+    ----------
+    func : Callable[[Any], Any]
+        Function taking a single argument and returning a result
+    iterable : Iterable[Any]
+        Iterable over arguments to pass to fun
+    max_parallel int, optional, default None
+        Maximum parallelism. If not specified, uses the number of CPUs
+    dir : str, optional, default None
+        If specified, directory where temporary files are created
+    
+    Returns
+    -------
+    List[Any]
+        Results. The items in the list are in the same order as the items
+        in `iterable`.
+    """
+    ...
+

metaflow-stubs/parameters.pyi

@@ -0,0 +1,114 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.892945                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import typing
+    import metaflow.parameters
+    import metaflow._vendor.click.types
+    import metaflow.exception
+
+class ParameterFieldFailed(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, name, field):
+        ...
+    ...
+
+class ParameterFieldTypeMismatch(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, msg):
+        ...
+    ...
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+class ParameterContext(tuple, metaclass=type):
+    @staticmethod
+    def __new__(_cls, flow_name: str, user_name: str, parameter_name: str, logger: typing.Callable[..., None], ds_type: str):
+        """
+        Create new instance of ParameterContext(flow_name, user_name, parameter_name, logger, ds_type)
+        """
+        ...
+    def __repr__(self):
+        """
+        Return a nicely formatted representation string
+        """
+        ...
+    def __getnewargs__(self):
+        """
+        Return self as a plain tuple.  Used by copy and pickle.
+        """
+        ...
+    def __init__(self, flow_name: str, user_name: str, parameter_name: str, logger: typing.Callable[..., None], ds_type: str):
+        ...
+    ...
+
+parameters: list
+
+context_proto: None
+
+class JSONTypeClass(metaflow._vendor.click.types.ParamType, metaclass=type):
+    def convert(self, value, param, ctx):
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+class DeployTimeField(object, metaclass=type):
+    def __init__(self, parameter_name, parameter_type, field, fun, return_str = True, print_representation = None):
+        ...
+    def __call__(self, deploy_time = False):
+        ...
+    @property
+    def description(self):
+        ...
+    def __str__(self):
+        ...
+    def __repr__(self):
+        ...
+    ...
+
+def deploy_time_eval(value):
+    ...
+
+def set_parameter_context(flow_name, echo, datastore):
+    ...
+
+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], 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):
+        ...
+    ...
+
+def add_custom_parameters(deploy_mode = False):
+    ...
+