mirror of
https://github.com/docling-project/docling.git
synced 2025-07-04 07:34:47 +00:00

* feat: Implement csv backend and format detection Signed-off-by: Tobias Strebitzer <tobias.strebitzer@magloft.com> * test: Implement csv parsing and format tests Signed-off-by: Tobias Strebitzer <tobias.strebitzer@magloft.com> * docs: Add example and CSV format documentation Signed-off-by: Tobias Strebitzer <tobias.strebitzer@magloft.com> * feat: Add support for various CSV dialects and update documentation Signed-off-by: Tobias Strebitzer <tobias.strebitzer@magloft.com> * feat: Add validation for delimiters and tests for inconsistent csv files Signed-off-by: Tobias Strebitzer <tobias.strebitzer@magloft.com> --------- Signed-off-by: Tobias Strebitzer <tobias.strebitzer@magloft.com>
96 lines
2.7 KiB
Python
96 lines
2.7 KiB
Python
import json
|
|
import os
|
|
from pathlib import Path
|
|
|
|
from pytest import warns
|
|
|
|
from docling.datamodel.base_models import InputFormat
|
|
from docling.datamodel.document import ConversionResult, DoclingDocument
|
|
from docling.document_converter import DocumentConverter
|
|
|
|
GENERATE = True
|
|
|
|
|
|
def get_csv_paths():
|
|
|
|
# Define the directory you want to search
|
|
directory = Path(f"./tests/data/csv/")
|
|
|
|
# List all CSV files in the directory and its subdirectories
|
|
return sorted(directory.rglob("*.csv"))
|
|
|
|
|
|
def get_csv_path(name: str):
|
|
|
|
# Return the matching CSV file path
|
|
return Path(f"./tests/data/csv/{name}.csv")
|
|
|
|
|
|
def get_converter():
|
|
|
|
converter = DocumentConverter(allowed_formats=[InputFormat.CSV])
|
|
|
|
return converter
|
|
|
|
|
|
def verify_export(pred_text: str, gtfile: str):
|
|
|
|
if not os.path.exists(gtfile) or GENERATE:
|
|
with open(gtfile, "w") as fw:
|
|
fw.write(pred_text)
|
|
|
|
return True
|
|
|
|
else:
|
|
with open(gtfile, "r") as fr:
|
|
true_text = fr.read()
|
|
|
|
assert pred_text == true_text, "pred_itxt==true_itxt"
|
|
return pred_text == true_text
|
|
|
|
|
|
def test_e2e_valid_csv_conversions():
|
|
valid_csv_paths = get_csv_paths()
|
|
converter = get_converter()
|
|
|
|
for csv_path in valid_csv_paths:
|
|
print(f"converting {csv_path}")
|
|
|
|
gt_path = csv_path.parent.parent / "groundtruth" / "docling_v2" / csv_path.name
|
|
|
|
conv_result: ConversionResult = converter.convert(csv_path)
|
|
|
|
doc: DoclingDocument = conv_result.document
|
|
|
|
pred_md: str = doc.export_to_markdown()
|
|
assert verify_export(pred_md, str(gt_path) + ".md"), "export to md"
|
|
|
|
pred_itxt: str = doc._export_to_indented_text(
|
|
max_text_len=70, explicit_tables=False
|
|
)
|
|
assert verify_export(
|
|
pred_itxt, str(gt_path) + ".itxt"
|
|
), "export to indented-text"
|
|
|
|
pred_json: str = json.dumps(doc.export_to_dict(), indent=2)
|
|
assert verify_export(pred_json, str(gt_path) + ".json"), "export to json"
|
|
|
|
|
|
def test_e2e_invalid_csv_conversions():
|
|
csv_too_few_columns = get_csv_path("csv-too-few-columns")
|
|
csv_too_many_columns = get_csv_path("csv-too-many-columns")
|
|
csv_inconsistent_header = get_csv_path("csv-inconsistent-header")
|
|
converter = get_converter()
|
|
|
|
print(f"converting {csv_too_few_columns}")
|
|
with warns(UserWarning, match="Inconsistent column lengths"):
|
|
converter.convert(csv_too_few_columns)
|
|
|
|
print(f"converting {csv_too_many_columns}")
|
|
with warns(UserWarning, match="Inconsistent column lengths"):
|
|
converter.convert(csv_too_many_columns)
|
|
|
|
print(f"converting {csv_inconsistent_header}")
|
|
with warns(UserWarning, match="Inconsistent column lengths"):
|
|
converter.convert(csv_inconsistent_header)
|