Filip Knefel 6af6604057
feat: introduce date_from_file_object parameter to partitions (#2563)
Introduce `date_from_file_object` to `partition*` functions, by default
set to `False`.
If set to `True` and file is provided via `file` parameter, partition
will attempt to infer last modified date from `file`'s contents
otherwise last modified metadata will be set to `None`.

---------

Co-authored-by: Filip Knefel <filip@unstructured.io>
Co-authored-by: Ronny H <138828701+ron-unstructured@users.noreply.github.com>
2024-03-18 01:09:44 +00:00

242 lines
8.2 KiB
Python

import os
import pathlib
from tempfile import SpooledTemporaryFile
from test_unstructured.unit_utils import assert_round_trips_through_JSON
from unstructured.chunking.title import chunk_by_title
from unstructured.documents.elements import Table, Text
from unstructured.partition.epub import partition_epub
from unstructured.partition.utils.constants import UNSTRUCTURED_INCLUDE_DEBUG_METADATA
DIRECTORY = pathlib.Path(__file__).parent.resolve()
EXAMPLE_DOCS_PATH = os.path.join(DIRECTORY, "..", "..", "..", "example-docs")
def test_partition_epub_from_filename():
filename = os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub")
elements = partition_epub(filename=filename)
assert len(elements) > 0
assert elements[0].text.startswith("The Project Gutenberg eBook of Winter Sports")
for element in elements:
assert element.metadata.filename == "winter-sports.epub"
if UNSTRUCTURED_INCLUDE_DEBUG_METADATA:
assert {element.metadata.detection_origin for element in elements} == {"epub"}
def test_partition_epub_from_filename_returns_table_in_elements():
filename = os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub")
elements = partition_epub(filename=filename)
assert len(elements) > 0
assert (
elements[14].text.replace("\n", " ")
== Table(
text="Contents. List of Illustrations "
"(In certain versions of this etext [in certain browsers] "
"clicking on the image will bring up a larger version.) "
"(etext transcriber's note)",
).text
)
def test_partition_epub_from_filename_returns_uns_elements():
filename = os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub")
elements = partition_epub(filename=filename)
assert len(elements) > 0
assert isinstance(elements[0], Text)
def test_partition_epub_from_filename_with_metadata_filename():
filename = os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub")
elements = partition_epub(filename=filename, metadata_filename="test")
assert len(elements) > 0
assert all(element.metadata.filename == "test" for element in elements)
def test_partition_epub_from_file():
filename = os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub")
with open(filename, "rb") as f:
elements = partition_epub(file=f)
assert len(elements) > 0
assert elements[0].text.startswith("The Project Gutenberg eBook of Winter Sports")
for element in elements:
assert element.metadata.filename is None
def test_partition_epub_from_file_with_metadata_filename():
filename = os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub")
with open(filename, "rb") as f:
elements = partition_epub(file=f, metadata_filename="test")
assert len(elements) > 0
for element in elements:
assert element.metadata.filename == "test"
def test_partition_epub_from_filename_exclude_metadata():
filename = os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub")
elements = partition_epub(filename=filename, include_metadata=False)
assert elements[0].metadata.filetype is None
assert elements[0].metadata.page_name is None
assert elements[0].metadata.filename is None
assert elements[0].metadata.section is None
def test_partition_epub_from_file_exlcude_metadata():
filename = os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub")
with open(filename, "rb") as f:
elements = partition_epub(file=f, include_metadata=False)
assert elements[0].metadata.filetype is None
assert elements[0].metadata.page_name is None
assert elements[0].metadata.filename is None
assert elements[0].metadata.section is None
def test_partition_epub_metadata_date(
mocker,
filename="example-docs/winter-sports.epub",
):
mocked_last_modification_date = "2029-07-05T09:24:28"
mocker.patch(
"unstructured.partition.html.get_last_modified_date",
return_value=mocked_last_modification_date,
)
elements = partition_epub(filename=filename)
assert elements[0].metadata.last_modified == mocked_last_modification_date
def test_partition_epub_custom_metadata_date(
mocker,
filename="example-docs/winter-sports.epub",
):
mocked_last_modification_date = "2029-07-05T09:24:28"
expected_last_modification_date = "2020-07-05T09:24:28"
mocker.patch(
"unstructured.partition.html.get_last_modified_date",
return_value=mocked_last_modification_date,
)
elements = partition_epub(
filename=filename,
metadata_last_modified=expected_last_modification_date,
)
assert elements[0].metadata.last_modified == expected_last_modification_date
def test_partition_epub_from_file_metadata_date(
mocker,
filename="example-docs/winter-sports.epub",
):
mocked_last_modification_date = "2029-07-05T09:24:28"
mocker.patch(
"unstructured.partition.html.get_last_modified_date_from_file",
return_value=mocked_last_modification_date,
)
with open(filename, "rb") as f:
elements = partition_epub(file=f)
assert elements[0].metadata.last_modified is None
def test_partition_epub_from_file_explicit_get_metadata_date(
mocker,
filename="example-docs/winter-sports.epub",
):
mocked_last_modification_date = "2029-07-05T09:24:28"
mocker.patch(
"unstructured.partition.html.get_last_modified_date_from_file",
return_value=mocked_last_modification_date,
)
with open(filename, "rb") as f:
elements = partition_epub(file=f, date_from_file_object=True)
assert elements[0].metadata.last_modified == mocked_last_modification_date
def test_partition_epub_from_file_custom_metadata_date(
mocker,
filename="example-docs/winter-sports.epub",
):
mocked_last_modification_date = "2029-07-05T09:24:28"
expected_last_modification_date = "2020-07-05T09:24:28"
mocker.patch(
"unstructured.partition.html.get_last_modified_date_from_file",
return_value=mocked_last_modification_date,
)
with open(filename, "rb") as f:
elements = partition_epub(file=f, metadata_last_modified=expected_last_modification_date)
assert elements[0].metadata.last_modified == expected_last_modification_date
def test_partition_epub_from_file_without_metadata_date(
filename="example-docs/winter-sports.epub",
):
"""Test partition_epub() 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_epub(file=sf, date_from_file_object=True)
assert elements[0].metadata.last_modified is None
def test_partition_epub_with_json():
filename = "example-docs/winter-sports.epub"
elements = partition_epub(filename=filename)
assert_round_trips_through_JSON(elements)
def test_add_chunking_strategy_on_partition_epub(
filename=os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub"),
):
elements = partition_epub(filename=filename)
chunk_elements = partition_epub(filename, chunking_strategy="by_title")
chunks = chunk_by_title(elements)
assert chunk_elements != elements
assert chunk_elements == chunks
def test_add_chunking_strategy_on_partition_epub_non_default(
filename=os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub"),
):
elements = partition_epub(filename=filename)
chunk_elements = partition_epub(
filename,
chunking_strategy="by_title",
max_characters=5,
new_after_n_chars=5,
combine_text_under_n_chars=0,
)
chunks = chunk_by_title(
elements,
max_characters=5,
new_after_n_chars=5,
combine_text_under_n_chars=0,
)
assert chunk_elements != elements
assert chunk_elements == chunks
def test_partition_epub_element_metadata_has_languages():
filename = os.path.join(EXAMPLE_DOCS_PATH, "winter-sports.epub")
elements = partition_epub(filename=filename)
assert elements[0].metadata.languages == ["eng"]
def test_partition_epub_respects_detect_language_per_element():
filename = "example-docs/language-docs/eng_spa_mult.epub"
elements = partition_epub(filename=filename, detect_language_per_element=True)
langs = [element.metadata.languages for element in elements]
assert langs == [["eng"], ["spa", "eng"], ["eng"], ["eng"], ["spa"]]