ob-metaflow-stubs 6.0.4.4rc0__py2.py3-none-any.whl → 6.0.4.6__py2.py3-none-any.whl

metaflow-stubs/packaging_sys/v1.pyi

@@ -1,145 +0,0 @@
-######################################################################################################
-#                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.1.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-15T21:03:18.220531                                                            #
-######################################################################################################
-
-from __future__ import annotations
-
-import typing
-import metaflow
-if typing.TYPE_CHECKING:
-    import typing
-    import metaflow.packaging_sys
-
-from ..exception import MetaflowException as MetaflowException
-from ..user_decorators.user_flow_decorator import FlowMutatorMeta as FlowMutatorMeta
-from ..user_decorators.user_step_decorator import UserStepDecoratorMeta as UserStepDecoratorMeta
-from . import ContentType as ContentType
-from . import MetaflowCodeContentV1Base as MetaflowCodeContentV1Base
-from .distribution_support import modules_to_distributions as modules_to_distributions
-from .utils import suffix_filter as suffix_filter
-from .utils import walk as walk
-
-EXT_EXCLUDE_SUFFIXES: list
-
-MFCONTENT_MARKER: str
-
-class MetaflowCodeContentV1(metaflow.packaging_sys.MetaflowCodeContentV1Base, metaclass=type):
-    def __init__(self, code_dir: str = '.mf_code', other_dir: str = '.mf_meta', criteria: typing.Callable[[module], bool] = ...):
-        ...
-    def create_mfcontent_info(self) -> typing.Dict[str, typing.Any]:
-        ...
-    def get_excluded_tl_entries(self) -> typing.List[str]:
-        """
-        When packaging Metaflow from within an executing Metaflow flow, we need to
-        exclude the files that are inserted by this content from being packaged (possibly).
-        
-        Use this function to return these files or top-level directories.
-        
-        Returns
-        -------
-        List[str]
-            Files or directories to exclude
-        """
-        ...
-    def content_names(self, content_types: typing.Optional[int] = None) -> typing.Generator[typing.Tuple[str, str], None, None]:
-        """
-        Detailed list of the content of this MetaflowCodeContent. This will list all files
-        (or non files -- for the INFO or CONFIG data for example) present in the archive.
-        
-        Parameters
-        ----------
-        content_types : Optional[int]
-            The type of content to get the names of. If None, all content is returned.
-        
-        Yields
-        ------
-        Generator[Tuple[str, str], None, None]
-            Path on the filesystem and the name in the archive
-        """
-        ...
-    def contents(self, content_types: typing.Optional[int] = None) -> typing.Generator[typing.Tuple[typing.Union[bytes, str], str], None, None]:
-        """
-        Very similar to content_names but returns the content of the non-files
-        as well as bytes. For files, identical output as content_names
-        
-        Parameters
-        ----------
-        content_types : Optional[int]
-            The type of content to get the content of. If None, all content is returned.
-        
-        Yields
-        ------
-        Generator[Tuple[Union[str, bytes], str], None, None]
-            Content of the MF content
-        """
-        ...
-    def show(self) -> str:
-        """
-        Returns a more human-readable string representation of the content of this
-        MetaflowCodeContent. This will not, for example, list all files but summarize what
-        is included at a more high level.
-        
-        Returns
-        -------
-        str
-            A human-readable string representation of the content of this MetaflowCodeContent
-        """
-        ...
-    def add_info(self, info: typing.Dict[str, typing.Any]):
-        """
-        Add the content of the INFO file to the Metaflow content
-        
-        Parameters
-        ----------
-        info: Dict[str, Any]
-            The content of the INFO file
-        """
-        ...
-    def add_config(self, config: typing.Dict[str, typing.Any]):
-        """
-        Add the content of the CONFIG file to the Metaflow content
-        
-        Parameters
-        ----------
-        config: Dict[str, Any]
-            The content of the CONFIG file
-        """
-        ...
-    def add_module(self, module: module):
-        """
-        Add a python module to the Metaflow content
-        
-        Parameters
-        ----------
-        module_path: ModuleType
-            The module to add
-        """
-        ...
-    def add_code_file(self, file_path: str, file_name: str):
-        """
-        Add a code file to the Metaflow content
-        
-        Parameters
-        ----------
-        file_path: str
-            The path to the code file to add (on the filesystem)
-        file_name: str
-            The path in the archive to add the code file to
-        """
-        ...
-    def add_other_file(self, file_path: str, file_name: str):
-        """
-        Add a non-python file to the Metaflow content
-        
-        Parameters
-        ----------
-        file_path: str
-            The path to the file to add (on the filesystem)
-        file_name: str
-            The path in the archive to add the file to
-        """
-        ...
-    ...
-

metaflow-stubs/user_decorators/__init__.pyi

@@ -1,15 +0,0 @@
-######################################################################################################
-#                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.1.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-15T21:03:18.189428                                                            #
-######################################################################################################
-
-from __future__ import annotations
-
-
-from . import mutable_flow as mutable_flow
-from . import common as common
-from . import user_step_decorator as user_step_decorator
-from . import mutable_step as mutable_step
-from . import user_flow_decorator as user_flow_decorator
-

metaflow-stubs/user_decorators/common.pyi

@@ -1,38 +0,0 @@
-######################################################################################################
-#                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.1.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-15T21:03:18.222636                                                            #
-######################################################################################################
-
-from __future__ import annotations
-
-import typing
-
-
-class ClassPath_Trie(object, metaclass=type):
-    def __init__(self):
-        ...
-    def init(self, initial_nodes: typing.Optional[typing.List[typing.Tuple[str, type]]] = None):
-        ...
-    def insert(self, classpath_name: str, value: type):
-        ...
-    def search(self, classpath_name: str) -> typing.Optional[type]:
-        ...
-    def remove(self, classpath_name: str):
-        ...
-    def unique_prefix_value(self, classpath_name: str) -> typing.Optional[type]:
-        ...
-    def unique_prefix_for_type(self, value: type) -> typing.Optional[str]:
-        ...
-    def get_unique_prefixes(self) -> typing.Dict[str, type]:
-        """
-        Get all unique prefixes in the trie.
-        
-        Returns
-        -------
-        List[str]
-            A list of unique prefixes.
-        """
-        ...
-    ...
-

metaflow-stubs/user_decorators/mutable_flow.pyi

@@ -1,223 +0,0 @@
-######################################################################################################
-#                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.1.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-15T21:03:18.222246                                                            #
-######################################################################################################
-
-from __future__ import annotations
-
-import typing
-if typing.TYPE_CHECKING:
-    import typing
-    import metaflow.user_configs.config_parameters
-    import metaflow.flowspec
-    import metaflow.parameters
-    import functools
-    import metaflow.user_decorators.mutable_step
-
-from ..exception import MetaflowException as MetaflowException
-from ..user_configs.config_parameters import ConfigValue as ConfigValue
-
-TYPE_CHECKING: bool
-
-class MutableFlow(object, metaclass=type):
-    def __init__(self, flow_spec: "metaflow.flowspec.FlowSpec", pre_mutate: bool = False, statically_defined: bool = False, inserted_by: typing.Optional[str] = None):
-        ...
-    @property
-    def decorator_specs(self) -> typing.Generator[typing.Tuple[str, str, typing.List[typing.Any], typing.Dict[str, typing.Any]], None, None]:
-        """
-        Iterate over all the decorator specifications of this flow. Note that the same
-        type of decorator may be present multiple times and no order is guaranteed.
-        
-        The returned tuple contains:
-        - The decorator's name (shortest possible)
-        - The decorator's fully qualified name (in the case of Metaflow decorators, this
-          will indicate which extension the decorator comes from)
-        - A list of positional arguments
-        - A dictionary of keyword arguments
-        
-        You can use the decorator specification to remove a decorator from the flow
-        for example.
-        
-        Yields
-        ------
-        str, str, List[Any], Dict[str, Any]
-            A tuple containing the decorator name, it's fully qualified name,
-            a list of positional arguments, and a dictionary of keyword arguments.
-        """
-        ...
-    @property
-    def configs(self) -> typing.Generator[typing.Tuple[str, metaflow.user_configs.config_parameters.ConfigValue], None, None]:
-        """
-        Iterate over all user configurations in this flow
-        
-        Use this to parameterize your flow based on configuration. As an example, the
-        `pre_mutate`/`mutate` methods can add decorators to steps in the flow that
-        depend on values in the configuration.
-        
-        ```
-        class MyDecorator(FlowMutator):
-            def mutate(flow: MutableFlow):
-                val = next(flow.configs)[1].steps.start.cpu
-                flow.start.add_decorator(environment, vars={'mycpu': val})
-                return flow
-        
-        @MyDecorator()
-        class TestFlow(FlowSpec):
-            config = Config('myconfig.json')
-        
-            @step
-            def start(self):
-                pass
-        ```
-        can be used to add an environment decorator to the `start` step.
-        
-        Yields
-        ------
-        Tuple[str, ConfigValue]
-            Iterates over the configurations of the flow
-        """
-        ...
-    @property
-    def parameters(self) -> typing.Generator[typing.Tuple[str, "metaflow.parameters.Parameter"], None, None]:
-        """
-        Iterate over all the parameters in this flow.
-        
-        Yields
-        ------
-        Tuple[str, Parameter]
-            Name of the parameter and parameter in the flow
-        """
-        ...
-    @property
-    def steps(self) -> typing.Generator[typing.Tuple[str, "metaflow.user_decorators.mutable_step.MutableStep"], None, None]:
-        """
-        Iterate over all the steps in this flow. The order of the steps
-        returned is not guaranteed.
-        
-        Yields
-        ------
-        Tuple[str, MutableStep]
-            A tuple with the step name and the step proxy
-        """
-        ...
-    def add_parameter(self, name: str, value: "metaflow.parameters.Parameter", overwrite: bool = False):
-        """
-        Add a parameter to the flow. You can only add parameters in the `pre_mutate`
-        method.
-        
-        Parameters
-        ----------
-        name : str
-            Name of the parameter
-        value : Parameter
-            Parameter to add to the flow
-        overwrite : bool, default False
-            If True, overwrite the parameter if it already exists
-        """
-        ...
-    def remove_parameter(self, parameter_name: str) -> bool:
-        """
-        Remove a parameter from the flow.
-        
-        The name given should match the name of the parameter (can be different
-        from the name of the parameter in the flow. You can not remove config parameters.
-        You can only remove parameters in the `pre_mutate` method.
-        
-        Parameters
-        ----------
-        parameter_name : str
-            Name of the parameter
-        
-        Returns
-        -------
-        bool
-            Returns True if the parameter was removed
-        """
-        ...
-    def add_decorator(self, deco_type: typing.Union[functools.partial, str], deco_args: typing.Optional[typing.List[typing.Any]] = None, deco_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None, duplicates: int = 1):
-        """
-        Add a Metaflow flow-decorator to a flow. You can only add decorators in the
-        `pre_mutate` method.
-        
-        You can either add the decorator itself or its decorator specification for it
-        (the same you would get back from decorator_specs). You can also mix and match
-        but you cannot provide arguments both through the string and the
-        deco_args/deco_kwargs.
-        
-        As an example:
-        ```
-        from metaflow import project
-        
-        ...
-        my_flow.add_decorator(project, deco_kwargs={"name":"my_project"})
-        ```
-        
-        is equivalent to:
-        ```
-        my_flow.add_decorator("project:name=my_project")
-        ```
-        
-        Note in the later case, there is no need to import the flow decorator.
-        
-        The latter syntax is useful to, for example, allow decorators to be stored as
-        strings in a configuration file.
-        
-        In terms of precedence for decorators:
-          - if a decorator can be applied multiple times all decorators
-            added are kept (this is rare for flow-decorators).
-          - if `duplicates` is set to `MutableFlow.IGNORE`, then the decorator
-            being added is ignored (in other words, the existing decorator has precedence).
-          - if `duplicates` is set to `MutableFlow.OVERRIDE`, then the *existing*
-            decorator is removed and this newly added one replaces it (in other
-            words, the newly added decorator has precedence).
-          - if `duplicates` is set to `MutableFlow.ERROR`, then an error is raised but only
-            if the newly added decorator is *static* (ie: defined directly in the code).
-            If not, it is ignored.
-        
-        Parameters
-        ----------
-        deco_type : Union[partial, str]
-            The decorator class to add to this flow. If using a string, you cannot specify
-            additional arguments as all argument will be parsed from the decorator
-            specification.
-        deco_args : List[Any], optional, default None
-            Positional arguments to pass to the decorator.
-        deco_kwargs : Dict[str, Any], optional, default None
-            Keyword arguments to pass to the decorator.
-        duplicates : int, default MutableFlow.IGNORE
-            Instruction on how to handle duplicates. It can be one of:
-            - `MutableFlow.IGNORE`: Ignore the decorator if it already exists.
-            - `MutableFlow.ERROR`: Raise an error if the decorator already exists.
-            - `MutableFlow.OVERRIDE`: Remove the existing decorator and add this one.
-        """
-        ...
-    def remove_decorator(self, deco_name: str, deco_args: typing.Optional[typing.List[typing.Any]] = None, deco_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None) -> bool:
-        """
-        Remove a flow-level decorator. To remove a decorator, you can pass the decorator
-        specification (obtained from `decorator_specs` for example).
-        Note that if multiple decorators share the same decorator specification
-        (very rare), they will all be removed.
-        
-        You can only remove decorators in the `pre_mutate` method.
-        
-        Parameters
-        ----------
-        deco_name : str
-            Decorator specification of the decorator to remove. If nothing else is
-            specified, all decorators matching that name will be removed.
-        deco_args : List[Any], optional, default None
-            Positional arguments to match the decorator specification.
-        deco_kwargs : Dict[str, Any], optional, default None
-            Keyword arguments to match the decorator specification.
-        
-        Returns
-        -------
-        bool
-            Returns True if a decorator was removed.
-        """
-        ...
-    def __getattr__(self, name):
-        ...
-    ...
-

metaflow-stubs/user_decorators/mutable_step.pyi

@@ -1,152 +0,0 @@
-######################################################################################################
-#                                 Auto-generated Metaflow stub file                                  #
-# MF version: 2.16.1.1+obcheckpoint(0.2.4);ob(v1)                                                    #
-# Generated on 2025-07-15T21:03:18.223296                                                            #
-######################################################################################################
-
-from __future__ import annotations
-
-import typing
-if typing.TYPE_CHECKING:
-    import typing
-    import metaflow.flowspec
-    import metaflow.user_decorator.mutable_flow
-    import metaflow.decorators
-    import metaflow.user_decorators.user_step_decorator
-    import functools
-
-from ..exception import MetaflowException as MetaflowException
-from .user_step_decorator import StepMutator as StepMutator
-from .user_step_decorator import UserStepDecoratorBase as UserStepDecoratorBase
-
-TYPE_CHECKING: bool
-
-class MutableStep(object, metaclass=type):
-    def __init__(self, flow_spec: "metaflow.flowspec.FlowSpec", step: typing.Union[typing.Callable[["metaflow.decorators.FlowSpecDerived"], None], typing.Callable[["metaflow.decorators.FlowSpecDerived", typing.Any], None]], pre_mutate: bool = False, statically_defined: bool = False, inserted_by: typing.Optional[str] = None):
-        ...
-    @property
-    def flow(self) -> "metaflow.user_decorator.mutable_flow.MutableFlow":
-        """
-        The flow that contains this step
-        
-        Returns
-        -------
-        MutableFlow
-            The flow that contains this step
-        """
-        ...
-    @property
-    def decorator_specs(self) -> typing.Generator[typing.Tuple[str, str, typing.List[typing.Any], typing.Dict[str, typing.Any]], None, None]:
-        """
-        Iterate over all the decorator specifications of this step. Note that the same
-        type of decorator may be present multiple times and no order is guaranteed.
-        
-        The returned tuple contains:
-        - The decorator's name (shortest possible)
-        - The decorator's fully qualified name (in the case of Metaflow decorators, this
-          will indicate which extension the decorator comes from)
-        - A list of positional arguments
-        - A dictionary of keyword arguments
-        
-        You can use the resulting tuple to remove a decorator for example
-        
-        Yields
-        ------
-        str, str, List[Any], Dict[str, Any]
-            A tuple containing the decorator name, it's fully qualified name,
-            a list of positional arguments, and a dictionary of keyword arguments.
-        """
-        ...
-    def add_decorator(self, deco_type: typing.Union[functools.partial, metaflow.user_decorators.user_step_decorator.UserStepDecoratorBase, str], deco_args: typing.Optional[typing.List[typing.Any]] = None, deco_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None, duplicates: int = 1):
-        """
-        Add a Metaflow step-decorator or a user step-decorator to a step.
-        
-        You can either add the decorator itself or its decorator specification for it
-        (the same you would get back from decorator_specs). You can also mix and match
-        but you cannot provide arguments both through the string and the
-        deco_args/deco_kwargs.
-        
-        As an example:
-        ```
-        from metaflow import environment
-        ...
-        my_step.add_decorator(environment, deco_kwargs={"vars": {"foo": 42})}
-        ```
-        
-        is equivalent to:
-        ```
-        my_step.add_decorator('environment:vars={"foo": 42}')
-        ```
-        
-        is equivalent to:
-        ```
-        my_step.add_decorator('environment', deco_kwargs={"vars":{"foo": 42}})
-        ```
-        
-        but this is not allowed:
-        ```
-        my_step.add_decorator('environment:vars={"bar" 43}', deco_kwargs={"vars":{"foo": 42}})
-        ```
-        
-        Note in the case where you specify a
-        string for the decorator, there is no need to import the decorator.
-        
-        The string syntax is useful to, for example, allow decorators to be stored as
-        strings in a configuration file.
-        
-        You can only add StepMutators in the pre_mutate stage.
-        
-        In terms of precedence for decorators:
-          - if a decorator can be applied multiple times (like `@card`) all decorators
-            added are kept.
-          - if `duplicates` is set to `MutableStep.IGNORE`, then the decorator
-            being added is ignored (in other words, the existing decorator has precedence).
-          - if `duplicates` is set to `MutableStep.OVERRIDE`, then the *existing*
-            decorator is removed and this newly added one replaces it (in other
-            words, the newly added decorator has precedence).
-          - if `duplicates` is set to `MutableStep.ERROR`, then an error is raised but only
-            if the newly added decorator is *static* (ie: defined directly in the code).
-            If not, it is ignored.
-        
-        Parameters
-        ----------
-        deco_type : Union[partial, UserStepDecoratorBase, str]
-            The decorator class to add to this step.
-        deco_args : List[Any], optional, default None
-            Positional arguments to pass to the decorator.
-        deco_kwargs : Dict[str, Any], optional, default None
-            Keyword arguments to pass to the decorator.
-        duplicates : int, default MutableStep.IGNORE
-            Instruction on how to handle duplicates. It can be one of:
-            - `MutableStep.IGNORE`: Ignore the decorator if it already exists.
-            - `MutableStep.ERROR`: Raise an error if the decorator already exists.
-            - `MutableStep.OVERRIDE`: Remove the existing decorator and add this one.
-        """
-        ...
-    def remove_decorator(self, deco_name: str, deco_args: typing.Optional[typing.List[typing.Any]] = None, deco_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = None) -> bool:
-        """
-        Remove a step-level decorator. To remove a decorator, you can pass the decorator
-        specification (obtained from `decorator_specs` for example).
-        Note that if multiple decorators share the same decorator specification
-        (very rare), they will all be removed.
-        
-        You can only remove StepMutators in the `pre_mutate` method.
-        
-        Parameters
-        ----------
-        deco_name : str
-            Decorator specification of the decorator to remove. If nothing else is
-            specified, all decorators matching that name will be removed.
-        deco_args : List[Any], optional, default None
-            Positional arguments to match the decorator specification.
-        deco_kwargs : Dict[str, Any], optional, default None
-            Keyword arguments to match the decorator specification.
-        
-        Returns
-        -------
-        bool
-            Returns True if a decorator was removed.
-        """
-        ...
-    ...
-