Source code for jina.types.document.mixins.dump

from typing import Union, BinaryIO

from .helper import _uri_to_buffer, _get_file_context
from ....helper import T


[docs]class DumpFileMixin: """Provide helper functions for :class:`Document` to dump content to a file. """
[docs] def dump_buffer_to_file(self: T, file: Union[str, BinaryIO]) -> T: """Save :attr:`.buffer` 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: fp.write(self.buffer) return self
[docs] def dump_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: buffer = _uri_to_buffer(self.uri) fp.write(buffer) return self