from tempfile import SpooledTemporaryFile import pytest from test_unstructured.partition.test_constants import ( EXPECTED_TABLE, EXPECTED_TABLE_WITH_EMOJI, EXPECTED_TEXT, EXPECTED_TEXT_WITH_EMOJI, EXPECTED_TEXT_XLSX, ) from test_unstructured.unit_utils import assert_round_trips_through_JSON, example_doc_path from unstructured.cleaners.core import clean_extra_whitespace from unstructured.documents.elements import Table from unstructured.partition.tsv import partition_tsv EXPECTED_FILETYPE = "text/tsv" @pytest.mark.parametrize( ("filename", "expected_text", "expected_table"), [ ("stanley-cups.tsv", EXPECTED_TEXT, EXPECTED_TABLE), ("stanley-cups-with-emoji.tsv", EXPECTED_TEXT_WITH_EMOJI, EXPECTED_TABLE_WITH_EMOJI), ], ) def test_partition_tsv_from_filename(filename, expected_text, expected_table): f_path = f"example-docs/{filename}" elements = partition_tsv(filename=f_path, include_header=False) assert clean_extra_whitespace(elements[0].text) == expected_text assert elements[0].metadata.text_as_html == expected_table assert elements[0].metadata.filetype == EXPECTED_FILETYPE for element in elements: assert element.metadata.filename == filename def test_partition_tsv_from_filename_with_metadata_filename( filename="example-docs/stanley-cups.tsv", ): elements = partition_tsv(filename=filename, metadata_filename="test", include_header=False) assert clean_extra_whitespace(elements[0].text) == EXPECTED_TEXT for element in elements: assert element.metadata.filename == "test" @pytest.mark.parametrize( ("filename", "expected_text", "expected_table"), [ ("stanley-cups.tsv", EXPECTED_TEXT, EXPECTED_TABLE), ("stanley-cups-with-emoji.tsv", EXPECTED_TEXT_WITH_EMOJI, EXPECTED_TABLE_WITH_EMOJI), ], ) def test_partition_tsv_from_file(filename, expected_text, expected_table): f_path = f"example-docs/{filename}" with open(f_path, "rb") as f: elements = partition_tsv(file=f, include_header=False) assert clean_extra_whitespace(elements[0].text) == expected_text assert isinstance(elements[0], Table) assert elements[0].metadata.text_as_html == expected_table assert elements[0].metadata.filetype == EXPECTED_FILETYPE for element in elements: assert element.metadata.filename is None def test_partition_tsv_from_file_with_metadata_filename( filename="example-docs/stanley-cups.tsv", ): with open(filename, "rb") as f: elements = partition_tsv(file=f, metadata_filename="test", include_header=False) assert clean_extra_whitespace(elements[0].text) == EXPECTED_TEXT for element in elements: assert element.metadata.filename == "test" def test_partition_tsv_filename_exclude_metadata( filename="example-docs/stanley-cups.tsv", ): elements = partition_tsv(filename=filename, include_metadata=False, include_header=False) assert clean_extra_whitespace(elements[0].text) == EXPECTED_TEXT assert isinstance(elements[0], Table) assert elements[0].metadata.text_as_html is None assert elements[0].metadata.filetype is None for element in elements: assert element.metadata.filename is None def test_partition_tsv_from_file_exclude_metadata( filename="example-docs/stanley-cups.tsv", ): with open(filename, "rb") as f: elements = partition_tsv(file=f, include_metadata=False) for i in range(len(elements)): assert elements[i].metadata.to_dict() == {} def test_partition_tsv_metadata_date( mocker, filename="example-docs/stanley-cups.tsv", ): mocked_last_modification_date = "2029-07-05T09:24:28" mocker.patch( "unstructured.partition.tsv.get_last_modified_date", return_value=mocked_last_modification_date, ) elements = partition_tsv( filename=filename, include_header=False, ) assert elements[0].metadata.last_modified == mocked_last_modification_date def test_partition_tsv_with_custom_metadata_date( mocker, filename="example-docs/stanley-cups.tsv", ): mocked_last_modification_date = "2029-07-05T09:24:28" expected_last_modification_date = "2020-07-05T09:24:28" mocker.patch( "unstructured.partition.tsv.get_last_modified_date", return_value=mocked_last_modification_date, ) elements = partition_tsv( filename=filename, metadata_last_modified=expected_last_modification_date, include_header=False, ) assert elements[0].metadata.last_modified == expected_last_modification_date def test_partition_tsv_from_file_metadata_date( mocker, filename="example-docs/stanley-cups.tsv", ): mocked_last_modification_date = "2029-07-05T09:24:28" mocker.patch( "unstructured.partition.tsv.get_last_modified_date_from_file", return_value=mocked_last_modification_date, ) with open(filename, "rb") as f: elements = partition_tsv( file=f, include_header=False, ) assert elements[0].metadata.last_modified is None def test_partition_tsv_from_file_explicit_get_metadata_date( mocker, filename="example-docs/stanley-cups.tsv", ): mocked_last_modification_date = "2029-07-05T09:24:28" mocker.patch( "unstructured.partition.tsv.get_last_modified_date_from_file", return_value=mocked_last_modification_date, ) with open(filename, "rb") as f: elements = partition_tsv( file=f, include_header=False, date_from_file_object=True, ) assert elements[0].metadata.last_modified == mocked_last_modification_date def test_partition_tsv_from_file_with_custom_metadata_date( mocker, filename="example-docs/stanley-cups.tsv", ): mocked_last_modification_date = "2029-07-05T09:24:28" expected_last_modification_date = "2020-07-05T09:24:28" mocker.patch( "unstructured.partition.tsv.get_last_modified_date_from_file", return_value=mocked_last_modification_date, ) with open(filename, "rb") as f: elements = partition_tsv( file=f, metadata_last_modified=expected_last_modification_date, include_header=False ) assert elements[0].metadata.last_modified == expected_last_modification_date def test_partition_tsv_from_file_without_metadata_date( filename="example-docs/stanley-cups.tsv", ): """Test partition_tsv() with file that are not possible to get last modified date""" with open(filename, "rb") as f: sf = SpooledTemporaryFile() sf.write(f.read()) sf.seek(0) elements = partition_tsv(file=sf, include_header=False, date_from_file_object=True) assert elements[0].metadata.last_modified is None @pytest.mark.parametrize("filename", ["stanley-cups.tsv", "stanley-cups-with-emoji.tsv"]) def test_partition_tsv_with_json(filename: str): elements = partition_tsv(example_doc_path(filename), include_header=False) assert_round_trips_through_JSON(elements) # NOTE (jennings) partition_tsv returns a single TableElement per sheet, # so no adding tests for multiple languages like the other partitions def test_partition_tsv_element_metadata_has_languages(): filename = "example-docs/stanley-cups-with-emoji.tsv" elements = partition_tsv(filename=filename, include_header=False) assert elements[0].metadata.languages == ["eng"] def test_partition_csv_header(): filename = "example-docs/stanley-cups.tsv" elements = partition_tsv(filename=filename, strategy="fast", include_header=True) assert ( clean_extra_whitespace(elements[0].text) == "Stanley Cups Unnamed: 1 Unnamed: 2 " + EXPECTED_TEXT_XLSX ) assert "" in elements[0].metadata.text_as_html