deepset-ai--haystack/test/dataclasses/test_byte_stream.py

# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
#
# SPDX-License-Identifier: Apache-2.0

import warnings

import pytest

from haystack.dataclasses import ByteStream


def test_from_file_path(tmp_path, request):
    test_bytes = b"Hello, world!\n"
    test_path = tmp_path / request.node.name
    with open(test_path, "wb") as fd:
        assert fd.write(test_bytes)

    b = ByteStream.from_file_path(test_path)
    assert b.data == test_bytes
    assert b.mime_type is None

    b = ByteStream.from_file_path(test_path, mime_type="text/plain")
    assert b.data == test_bytes
    assert b.mime_type == "text/plain"

    b = ByteStream.from_file_path(test_path, meta={"foo": "bar"})
    assert b.data == test_bytes
    assert b.meta == {"foo": "bar"}


@pytest.mark.parametrize(
    "file_path, expected_mime_types",
    [
        ("spam.jpeg", {"image/jpeg"}),
        ("spam.jpg", {"image/jpeg"}),
        ("spam.png", {"image/png"}),
        ("spam.gif", {"image/gif"}),
        ("spam.svg", {"image/svg+xml"}),
        ("spam.js", {"text/javascript", "application/javascript"}),
        ("spam.txt", {"text/plain"}),
        ("spam.html", {"text/html"}),
        ("spam.htm", {"text/html"}),
        ("spam.css", {"text/css"}),
        ("spam.csv", {"text/csv"}),
        ("spam.md", {"text/markdown"}),  # custom mapping
        ("spam.markdown", {"text/markdown"}),  # custom mapping
        ("spam.msg", {"application/vnd.ms-outlook"}),  # custom mapping
        ("spam.pdf", {"application/pdf"}),
        ("spam.xml", {"application/xml", "text/xml"}),
        ("spam.json", {"application/json"}),
        ("spam.doc", {"application/msword"}),
        ("spam.docx", {"application/vnd.openxmlformats-officedocument.wordprocessingml.document"}),
        ("spam.xls", {"application/vnd.ms-excel"}),
        ("spam.xlsx", {"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"}),
        ("spam.ppt", {"application/vnd.ms-powerpoint"}),
        ("spam.pptx", {"application/vnd.openxmlformats-officedocument.presentationml.presentation"}),
    ],
)
def test_from_file_path_guess_mime_type(file_path, expected_mime_types, tmp_path):
    test_file = tmp_path / file_path
    test_file.touch()

    b = ByteStream.from_file_path(test_file, guess_mime_type=True)
    assert b.mime_type in expected_mime_types


def test_explicit_mime_type_is_not_overwritten_by_guessing(tmp_path):
    # create empty file with correct extension
    test_file = tmp_path / "sample.md"
    test_file.touch()

    explicit_mime_type = "text/x-rst"
    b = ByteStream.from_file_path(test_file, mime_type=explicit_mime_type, guess_mime_type=True)
    assert b.mime_type == explicit_mime_type


def test_from_string():
    test_string = "Hello, world!"
    b = ByteStream.from_string(test_string)
    assert b.data.decode() == test_string
    assert b.mime_type is None

    b = ByteStream.from_string(test_string, mime_type="text/plain")
    assert b.data.decode() == test_string
    assert b.mime_type == "text/plain"

    b = ByteStream.from_string(test_string, meta={"foo": "bar"})
    assert b.data.decode() == test_string
    assert b.meta == {"foo": "bar"}


def test_to_string():
    test_string = "Hello, world!"
    b = ByteStream.from_string(test_string)
    assert b.to_string() == test_string


def test_to_from_string_encoding():
    test_string = "Hello Baščaršija!"
    with pytest.raises(UnicodeEncodeError):
        ByteStream.from_string(test_string, encoding="ISO-8859-1")

    bs = ByteStream.from_string(test_string)  # default encoding is utf-8

    assert bs.to_string(encoding="ISO-8859-1") != test_string
    assert bs.to_string(encoding="utf-8") == test_string


def test_to_string_encoding_error():
    # test that it raises ValueError if the encoding is not valid
    b = ByteStream.from_string("Hello, world!")
    with pytest.raises(UnicodeDecodeError):
        b.to_string("utf-16")


def test_to_file(tmp_path, request):
    test_str = "Hello, world!\n"
    test_path = tmp_path / request.node.name

    ByteStream(test_str.encode()).to_file(test_path)
    with open(test_path, "rb") as fd:
        assert fd.read().decode() == test_str


def test_str_truncation():
    test_str = "1234567890" * 100
    b = ByteStream.from_string(test_str, mime_type="text/plain", meta={"foo": "bar"})
    string_repr = str(b)
    assert len(string_repr) < 200
    assert "text/plain" in string_repr
    assert "foo" in string_repr


def test_to_dict():
    test_str = "Hello, world!"
    b = ByteStream.from_string(test_str, mime_type="text/plain", meta={"foo": "bar"})
    d = b.to_dict()
    assert d["data"] == list(test_str.encode())
    assert d["mime_type"] == "text/plain"
    assert d["meta"] == {"foo": "bar"}


def test_to_trace_dict():
    b = ByteStream(data=b"Hello, world!", mime_type="text/plain", meta={"foo": "bar"})
    d = b._to_trace_dict()
    assert d["data"] == "Binary data (13 bytes)"
    assert d["mime_type"] == "text/plain"
    assert d["meta"] == {"foo": "bar"}


def test_from_dict():
    test_str = "Hello, world!"
    b = ByteStream.from_string(test_str, mime_type="text/plain", meta={"foo": "bar"})
    d = b.to_dict()
    b2 = ByteStream.from_dict(d)
    assert b2.data == b.data
    assert b2.mime_type == b.mime_type
    assert b2.meta == b.meta
    assert str(b2) == str(b)


def test_no_warning_on_init():
    with warnings.catch_warnings():
        warnings.simplefilter("error", Warning)
        ByteStream(data=b"hello", mime_type="text/plain", meta={"k": "v"})


def test_warn_on_inplace_mutation():
    b = ByteStream(data=b"hello")
    with pytest.warns(Warning, match="dataclasses.replace"):
        b.data = b"world"