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

metaflow-stubs/plugins/cards/component_serializer.pyi

@@ -0,0 +1,227 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.975110                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.plugins.cards.card_modules.basic
+    import metaflow.exception
+    import metaflow.plugins.cards.card_modules.card
+    import metaflow.plugins.cards.card_modules.components
+
+class MetaflowCardComponent(object, metaclass=type):
+    @property
+    def component_id(self):
+        ...
+    @component_id.setter
+    def component_id(self, value):
+        ...
+    def update(self, *args, **kwargs):
+        """
+        #FIXME document
+        """
+        ...
+    def render(self):
+        """
+        `render` returns a string or dictionary. This class can be called on the client side to dynamically add components to the `MetaflowCard`
+        """
+        ...
+    ...
+
+class ErrorComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def __init__(self, headline, error_message):
+        ...
+    def render(self):
+        ...
+    ...
+
+class SectionComponent(metaflow.plugins.cards.card_modules.basic.DefaultComponent, metaclass=type):
+    def __init__(self, title = None, subtitle = None, columns = None, contents = []):
+        ...
+    @classmethod
+    def render_subcomponents(cls, component_array, additional_allowed_types = [str, dict], allow_unknowns = False):
+        ...
+    def render(self):
+        ...
+    ...
+
+class UserComponent(metaflow.plugins.cards.card_modules.card.MetaflowCardComponent, metaclass=type):
+    def update(self, *args, **kwargs):
+        ...
+    ...
+
+def create_component_id(component):
+    ...
+
+class StubComponent(metaflow.plugins.cards.card_modules.components.UserComponent, metaclass=type):
+    def __init__(self, component_id):
+        ...
+    def update(self, *args, **kwargs):
+        ...
+    ...
+
+class ComponentOverwriteNotSupportedException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, component_id, card_id, card_type):
+        ...
+    ...
+
+RUNTIME_CARD_RENDER_INTERVAL: int
+
+def get_card_class(card_type):
+    ...
+
+def warning_message(message, logger = None, ts = False):
+    ...
+
+class WarningComponent(metaflow.plugins.cards.card_modules.basic.ErrorComponent, metaclass=type):
+    def __init__(self, warning_message):
+        ...
+    ...
+
+class ComponentStore(object, metaclass=type):
+    def __init__(self, logger, card_type = None, components = None, user_set_id = None):
+        ...
+    @property
+    def layout_last_changed_on(self):
+        """
+        This property helps the CardComponentManager identify when the layout of the card has changed so that it can trigger a re-render of the card.
+        """
+        ...
+    def __iter__(self):
+        ...
+    def __setitem__(self, key, value):
+        ...
+    def __getitem__(self, key):
+        ...
+    def __delitem__(self, key):
+        ...
+    def __contains__(self, key):
+        ...
+    def append(self, component, id = None):
+        ...
+    def extend(self, components):
+        ...
+    def clear(self):
+        ...
+    def keys(self):
+        ...
+    def values(self):
+        ...
+    def __str__(self):
+        ...
+    def __len__(self):
+        ...
+    ...
+
+class CardComponentManager(object, metaclass=type):
+    def __init__(self, card_uuid, decorator_attributes, card_creator, components = None, logger = None, no_warnings = False, user_set_card_id = None, runtime_card = False, card_options = None, refresh_interval = 5):
+        ...
+    def append(self, component, id = None):
+        ...
+    def extend(self, components):
+        ...
+    def clear(self):
+        ...
+    def refresh(self, data = None, force = False):
+        ...
+    @property
+    def components(self):
+        ...
+    def __iter__(self):
+        ...
+    ...
+
+class CardComponentCollector(object, metaclass=type):
+    def __init__(self, logger = None, card_creator = None):
+        ...
+    @staticmethod
+    def create_uuid():
+        ...
+    def get(self, type = None):
+        """
+        `get`
+        gets all the components arrays for a card `type`.
+        Since one `@step` can have many `@card` decorators, many decorators can have the same type. That is why this function returns a list of lists.
+        
+        Args:
+            type ([str], optional): `type` of MetaflowCard. Defaults to None.
+        
+        Returns: will return empty `list` if `type` is None or not found
+            List[List[MetaflowCardComponent]]
+        """
+        ...
+    def __getitem__(self, key):
+        """
+        Choose a specific card for manipulation.
+        
+        When multiple @card decorators are present, you can add an
+        `ID` to distinguish between them, `@card(id=ID)`. This allows you
+        to add components to a specific card like this:
+        ```
+        current.card[ID].append(component)
+        ```
+        
+        Parameters
+        ----------
+        key : str
+            Card ID.
+        
+        Returns
+        -------
+        CardComponentManager
+            An object with `append` and `extend` calls which allow you to
+            add components to the chosen card.
+        """
+        ...
+    def __setitem__(self, key, value):
+        """
+        Specify components of the chosen card.
+        
+        Instead of adding components to a card individually with `current.card[ID].append(component)`,
+        use this method to assign a list of components to a card, replacing the existing components:
+        ```
+        current.card[ID] = [FirstComponent, SecondComponent]
+        ```
+        
+        Parameters
+        ----------
+        key: str
+            Card ID.
+        
+        value: List[MetaflowCardComponent]
+            List of card components to assign to this card.
+        """
+        ...
+    def append(self, component, id = None):
+        """
+        Appends a component to the current card.
+        
+        Parameters
+        ----------
+        component : MetaflowCardComponent
+            Card component to add to this card.
+        """
+        ...
+    def extend(self, components):
+        """
+        Appends many components to the current card.
+        
+        Parameters
+        ----------
+        component : Iterator[MetaflowCardComponent]
+            Card components to add to this card.
+        """
+        ...
+    @property
+    def components(self):
+        ...
+    def clear(self):
+        ...
+    def refresh(self, *args, **kwargs):
+        ...
+    ...
+

metaflow-stubs/plugins/cards/exception.pyi

@@ -0,0 +1,71 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.973101                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.exception
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+TYPE_CHECK_REGEX: str
+
+class CardClassFoundException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, card_name):
+        ...
+    ...
+
+class TypeRequiredException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self):
+        ...
+    ...
+
+class CardNotPresentException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, pathspec, card_type = None, card_hash = None, card_id = None):
+        ...
+    ...
+
+class TaskNotFoundException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, pathspec_query, resolved_from, run_id = None):
+        ...
+    ...
+
+class IncorrectCardArgsException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, card_type, args):
+        ...
+    ...
+
+class UnrenderableCardException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, card_type, args):
+        ...
+    ...
+
+class UnresolvableDatastoreException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, task):
+        ...
+    ...
+
+class IncorrectArgumentException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, obj_type):
+        ...
+    ...
+
+class IncorrectPathspecException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, pthspec):
+        ...
+    ...
+
+class ComponentOverwriteNotSupportedException(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, component_id, card_id, card_type):
+        ...
+    ...
+

metaflow-stubs/plugins/catch_decorator.pyi

@@ -0,0 +1,58 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.930456                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import metaflow.metaflow_current
+    import metaflow.decorators
+    import metaflow.exception
+
+class MetaflowException(Exception, metaclass=type):
+    def __init__(self, msg = "", lineno = None):
+        ...
+    def __str__(self):
+        ...
+    ...
+
+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):
+        ...
+    ...
+
+current: metaflow.metaflow_current.Current
+
+NUM_FALLBACK_RETRIES: int
+
+class FailureHandledByCatch(metaflow.exception.MetaflowException, metaclass=type):
+    def __init__(self, retry_count):
+        ...
+    ...
+
+class CatchDecorator(metaflow.decorators.StepDecorator, metaclass=type):
+    def step_init(self, flow, graph, step, decos, environment, flow_datastore, logger):
+        ...
+    def task_exception(self, exception, step, flow, graph, retry_count, max_user_code_retries):
+        ...
+    def task_post_step(self, step_name, flow, graph, retry_count, max_user_code_retries):
+        ...
+    def step_task_retry_count(self):
+        ...
+    def task_decorate(self, step_func, flow, graph, retry_count, max_user_code_retries, ubf_context):
+        ...
+    ...
+

metaflow-stubs/plugins/datatools/__init__.pyi

@@ -0,0 +1,339 @@
+##################################################################################
+#                       Auto-generated Metaflow stub file                        #
+# MF version: 2.11.4.1                                                           #
+# Generated on 2024-02-28T05:30:43.932327                                        #
+##################################################################################
+
+from __future__ import annotations
+
+import typing
+if typing.TYPE_CHECKING:
+    import io
+    import metaflow.plugins.datatools.s3.s3
+    import metaflow.exception
+
+def read_in_chunks(dst, src, src_sz, max_chunk_size):
+    ...
+
+class MetaflowLocalNotFound(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class MetaflowLocalURLException(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class Local(object, metaclass=type):
+    @classmethod
+    def get_root_from_config(cls, echo, create_on_absent = True):
+        ...
+    def __init__(self):
+        """
+        Initialize a new context for Local file operations. This object is based used as
+        a context manager for a with statement.
+        """
+        ...
+    def __enter__(self):
+        ...
+    def __exit__(self, *args):
+        ...
+    def get(self, key = None, return_missing = False):
+        ...
+    def put(self, key, obj, overwrite = True):
+        ...
+    def info(self, key = None, return_missing = False):
+        ...
+    ...
+
+class MetaflowS3Exception(metaflow.exception.MetaflowException, metaclass=type):
+    ...
+
+class S3(object, metaclass=type):
+    @classmethod
+    def get_root_from_config(cls, echo, create_on_absent = True):
+        ...
+    def __enter__(self) -> metaflow.plugins.datatools.s3.s3.S3:
+        ...
+    def __exit__(self, *args):
+        ...
+    def close(self):
+        """
+        Delete all temporary files downloaded in this context.
+        """
+        ...
+    def list_paths(self, keys: typing.Optional[typing.Iterable[str]] = None) -> typing.List[metaflow.plugins.datatools.s3.s3.S3Object]:
+        """
+        List the next level of paths in S3.
+        
+        If multiple keys are specified, listings are done in parallel. The returned
+        S3Objects have `.exists == False` if the path refers to a prefix, not an
+        existing S3 object.
+        
+        For instance, if the directory hierarchy is
+        ```
+        a/0.txt
+        a/b/1.txt
+        a/c/2.txt
+        a/d/e/3.txt
+        f/4.txt
+        ```
+        The `list_paths(['a', 'f'])` call returns
+        ```
+        a/0.txt (exists == True)
+        a/b/ (exists == False)
+        a/c/ (exists == False)
+        a/d/ (exists == False)
+        f/4.txt (exists == True)
+        ```
+        
+        Parameters
+        ----------
+        keys : Iterable[str], optional, default None
+            List of paths.
+        
+        Returns
+        -------
+        List[S3Object]
+            S3Objects under the given paths, including prefixes (directories) that
+            do not correspond to leaf objects.
+        """
+        ...
+    def list_recursive(self, keys: typing.Optional[typing.Iterable[str]] = None) -> typing.List[metaflow.plugins.datatools.s3.s3.S3Object]:
+        """
+        List all objects recursively under the given prefixes.
+        
+        If multiple keys are specified, listings are done in parallel. All objects
+        returned have `.exists == True` as this call always returns leaf objects.
+        
+        For instance, if the directory hierarchy is
+        ```
+        a/0.txt
+        a/b/1.txt
+        a/c/2.txt
+        a/d/e/3.txt
+        f/4.txt
+        ```
+        The `list_paths(['a', 'f'])` call returns
+        ```
+        a/0.txt (exists == True)
+        a/b/1.txt (exists == True)
+        a/c/2.txt (exists == True)
+        a/d/e/3.txt (exists == True)
+        f/4.txt (exists == True)
+        ```
+        
+        Parameters
+        ----------
+        keys : Iterable[str], optional, default None
+            List of paths.
+        
+        Returns
+        -------
+        List[S3Object]
+            S3Objects under the given paths.
+        """
+        ...
+    def info(self, key: typing.Optional[str] = None, return_missing: bool = False) -> metaflow.plugins.datatools.s3.s3.S3Object:
+        """
+        Get metadata about a single object in S3.
+        
+        This call makes a single `HEAD` request to S3 which can be
+        much faster than downloading all data with `get`.
+        
+        Parameters
+        ----------
+        key : str, optional, default None
+            Object to query. It can be an S3 url or a path suffix.
+        return_missing : bool, default False
+            If set to True, do not raise an exception for a missing key but
+            return it as an `S3Object` with `.exists == False`.
+        
+        Returns
+        -------
+        S3Object
+            An S3Object corresponding to the object requested. The object
+            will have `.downloaded == False`.
+        """
+        ...
+    def info_many(self, keys: typing.Iterable[str], return_missing: bool = False) -> typing.List[metaflow.plugins.datatools.s3.s3.S3Object]:
+        """
+        Get metadata about many objects in S3 in parallel.
+        
+        This call makes a single `HEAD` request to S3 which can be
+        much faster than downloading all data with `get`.
+        
+        Parameters
+        ----------
+        keys : Iterable[str]
+            Objects to query. Each key can be an S3 url or a path suffix.
+        return_missing : bool, default False
+            If set to True, do not raise an exception for a missing key but
+            return it as an `S3Object` with `.exists == False`.
+        
+        Returns
+        -------
+        List[S3Object]
+            A list of S3Objects corresponding to the paths requested. The
+            objects will have `.downloaded == False`.
+        """
+        ...
+    def get(self, key: typing.Union[str, metaflow.plugins.datatools.s3.s3.S3GetObject, None] = None, return_missing: bool = False, return_info: bool = True) -> metaflow.plugins.datatools.s3.s3.S3Object:
+        """
+        Get a single object from S3.
+        
+        Parameters
+        ----------
+        key : Union[str, S3GetObject], optional, default None
+            Object to download. It can be an S3 url, a path suffix, or
+            an S3GetObject that defines a range of data to download. If None, or
+            not provided, gets the S3 root.
+        return_missing : bool, default False
+            If set to True, do not raise an exception for a missing key but
+            return it as an `S3Object` with `.exists == False`.
+        return_info : bool, default True
+            If set to True, fetch the content-type and user metadata associated
+            with the object at no extra cost, included for symmetry with `get_many`
+        
+        Returns
+        -------
+        S3Object
+            An S3Object corresponding to the object requested.
+        """
+        ...
+    def get_many(self, keys: typing.Iterable[typing.Union[str, metaflow.plugins.datatools.s3.s3.S3GetObject]], return_missing: bool = False, return_info: bool = True) -> typing.List[metaflow.plugins.datatools.s3.s3.S3Object]:
+        """
+        Get many objects from S3 in parallel.
+        
+        Parameters
+        ----------
+        keys : Iterable[Union[str, S3GetObject]]
+            Objects to download. Each object can be an S3 url, a path suffix, or
+            an S3GetObject that defines a range of data to download.
+        return_missing : bool, default False
+            If set to True, do not raise an exception for a missing key but
+            return it as an `S3Object` with `.exists == False`.
+        return_info : bool, default True
+            If set to True, fetch the content-type and user metadata associated
+            with the object at no extra cost, included for symmetry with `get_many`.
+        
+        Returns
+        -------
+        List[S3Object]
+            S3Objects corresponding to the objects requested.
+        """
+        ...
+    def get_recursive(self, keys: typing.Iterable[str], return_info: bool = False) -> typing.List[metaflow.plugins.datatools.s3.s3.S3Object]:
+        """
+        Get many objects from S3 recursively in parallel.
+        
+        Parameters
+        ----------
+        keys : Iterable[str]
+            Prefixes to download recursively. Each prefix can be an S3 url or a path suffix
+            which define the root prefix under which all objects are downloaded.
+        return_info : bool, default False
+            If set to True, fetch the content-type and user metadata associated
+            with the object.
+        
+        Returns
+        -------
+        List[S3Object]
+            S3Objects stored under the given prefixes.
+        """
+        ...
+    def get_all(self, return_info: bool = False) -> typing.List[metaflow.plugins.datatools.s3.s3.S3Object]:
+        """
+        Get all objects under the prefix set in the `S3` constructor.
+        
+        This method requires that the `S3` object is initialized either with `run` or
+        `s3root`.
+        
+        Parameters
+        ----------
+        return_info : bool, default False
+            If set to True, fetch the content-type and user metadata associated
+            with the object.
+        
+        Returns
+        -------
+        Iterable[S3Object]
+            S3Objects stored under the main prefix.
+        """
+        ...
+    def put(self, key: typing.Union[str, metaflow.plugins.datatools.s3.s3.S3PutObject], obj: typing.Union[io.RawIOBase, io.BufferedIOBase, str, bytes], overwrite: bool = True, content_type: typing.Optional[str] = None, metadata: typing.Optional[typing.Dict[str, str]] = None) -> str:
+        """
+        Upload a single object to S3.
+        
+        Parameters
+        ----------
+        key : Union[str, S3PutObject]
+            Object path. It can be an S3 url or a path suffix.
+        obj : PutValue
+            An object to store in S3. Strings are converted to UTF-8 encoding.
+        overwrite : bool, default True
+            Overwrite the object if it exists. If set to False, the operation
+            succeeds without uploading anything if the key already exists.
+        content_type : str, optional, default None
+            Optional MIME type for the object.
+        metadata : Dict[str, str], optional, default None
+            A JSON-encodable dictionary of additional headers to be stored
+            as metadata with the object.
+        
+        Returns
+        -------
+        str
+            URL of the object stored.
+        """
+        ...
+    def put_many(self, key_objs: typing.List[typing.Union[typing.Tuple[str, typing.Union[io.RawIOBase, io.BufferedIOBase, str, bytes]], metaflow.plugins.datatools.s3.s3.S3PutObject]], overwrite: bool = True) -> typing.List[typing.Tuple[str, str]]:
+        """
+        Upload many objects to S3.
+        
+        Each object to be uploaded can be specified in two ways:
+        
+        1. As a `(key, obj)` tuple where `key` is a string specifying
+           the path and `obj` is a string or a bytes object.
+        
+        2. As a `S3PutObject` which contains additional metadata to be
+           stored with the object.
+        
+        Parameters
+        ----------
+        key_objs : List[Union[Tuple[str, PutValue], S3PutObject]]
+            List of key-object pairs to upload.
+        overwrite : bool, default True
+            Overwrite the object if it exists. If set to False, the operation
+            succeeds without uploading anything if the key already exists.
+        
+        Returns
+        -------
+        List[Tuple[str, str]]
+            List of `(key, url)` pairs corresponding to the objects uploaded.
+        """
+        ...
+    def put_files(self, key_paths: typing.List[typing.Union[typing.Tuple[str, typing.Union[io.RawIOBase, io.BufferedIOBase, str, bytes]], metaflow.plugins.datatools.s3.s3.S3PutObject]], overwrite: bool = True) -> typing.List[typing.Tuple[str, str]]:
+        """
+        Upload many local files to S3.
+        
+        Each file to be uploaded can be specified in two ways:
+        
+        1. As a `(key, path)` tuple where `key` is a string specifying
+           the S3 path and `path` is the path to a local file.
+        
+        2. As a `S3PutObject` which contains additional metadata to be
+           stored with the file.
+        
+        Parameters
+        ----------
+        key_paths :  List[Union[Tuple[str, PutValue], S3PutObject]]
+            List of files to upload.
+        overwrite : bool, default True
+            Overwrite the object if it exists. If set to False, the operation
+            succeeds without uploading anything if the key already exists.
+        
+        Returns
+        -------
+        List[Tuple[str, str]]
+            List of `(key, url)` pairs corresponding to the files uploaded.
+        """
+        ...
+    ...
+