Source code for docarray.document.mixins.dump

from typing import Union, BinaryIO, TYPE_CHECKING

from docarray.document.mixins.helper import _uri_to_blob, _get_file_context

if TYPE_CHECKING:  # pragma: no cover
    from docarray.typing import T


class UriFileMixin:
    """Provide helper functions for :class:`Document` to dump content to a file."""

    def save_uri_to_file(self: 'T', file: Union[str, BinaryIO]) -> 'T':
        """Save :attr:`.uri` into a file

        :param file: File or filename to which the data is saved.

        :return: itself after processed
        """
        fp = _get_file_context(file)
        with fp:
            blob = _uri_to_blob(self.uri)
            fp.write(blob)
        return self