Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/markitdown/src/markitdown/_markitdown.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
ZipConverter,
EpubConverter,
DocumentIntelligenceConverter,
CsvConverter,
)

from ._base_converter import DocumentConverter, DocumentConverterResult
Expand Down Expand Up @@ -194,6 +195,7 @@ def enable_builtins(self, **kwargs) -> None:
self.register_converter(PdfConverter())
self.register_converter(OutlookMsgConverter())
self.register_converter(EpubConverter())
self.register_converter(CsvConverter())

# Register Document Intelligence converter at the top of the stack if endpoint is provided
docintel_endpoint = kwargs.get("docintel_endpoint")
Expand Down
2 changes: 2 additions & 0 deletions packages/markitdown/src/markitdown/converters/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
DocumentIntelligenceFileType,
)
from ._epub_converter import EpubConverter
from ._csv_converter import CsvConverter

__all__ = [
"PlainTextConverter",
Expand All @@ -43,4 +44,5 @@
"DocumentIntelligenceConverter",
"DocumentIntelligenceFileType",
"EpubConverter",
"CsvConverter",
]
79 changes: 79 additions & 0 deletions packages/markitdown/src/markitdown/converters/_csv_converter.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
import sys
import csv
import io
from typing import BinaryIO, Any
from charset_normalizer import from_bytes
from ._html_converter import HtmlConverter
from .._base_converter import DocumentConverter, DocumentConverterResult
from .._stream_info import StreamInfo

ACCEPTED_MIME_TYPE_PREFIXES = [
"text/csv",
"application/csv",
]
ACCEPTED_FILE_EXTENSIONS = [".csv"]


class CsvConverter(DocumentConverter):
"""
Converts CSV files to Markdown tables.
"""

def __init__(self):
super().__init__()

def accepts(
self,
file_stream: BinaryIO,
stream_info: StreamInfo,
**kwargs: Any, # Options to pass to the converter
) -> bool:
mimetype = (stream_info.mimetype or "").lower()
extension = (stream_info.extension or "").lower()
if extension in ACCEPTED_FILE_EXTENSIONS:
return True
for prefix in ACCEPTED_MIME_TYPE_PREFIXES:
if mimetype.startswith(prefix):
return True
return False

def convert(
self,
file_stream: BinaryIO,
stream_info: StreamInfo,
**kwargs: Any, # Options to pass to the converter
) -> DocumentConverterResult:
# Read the file content
if stream_info.charset:
content = file_stream.read().decode(stream_info.charset)
else:
content = str(from_bytes(file_stream.read()).best())

# Parse CSV content
reader = csv.reader(io.StringIO(content))
rows = list(reader)

if not rows:
return DocumentConverterResult(markdown="")

# Create markdown table
markdown_table = []

# Add header row
markdown_table.append("| " + " | ".join(rows[0]) + " |")

# Add separator row
markdown_table.append("| " + " | ".join(["---"] * len(rows[0])) + " |")

# Add data rows
for row in rows[1:]:
# Make sure row has the same number of columns as header
while len(row) < len(rows[0]):
row.append("")
# Truncate if row has more columns than header
row = row[: len(rows[0])]
markdown_table.append("| " + " | ".join(row) + " |")

result = "\n".join(markdown_table)

return DocumentConverterResult(markdown=result)
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import sys
import re
import os

from typing import BinaryIO, Any, List
from typing import BinaryIO, Any, List, Optional, Union
from enum import Enum

from ._html_converter import HtmlConverter
Expand All @@ -26,6 +25,28 @@
# Preserve the error and stack trace for later
_dependency_exc_info = sys.exc_info()

# Define these types for type hinting when the package is not available
class AzureKeyCredential:
pass

class TokenCredential:
pass

class DocumentIntelligenceClient:
pass

class AnalyzeDocumentRequest:
pass

class AnalyzeResult:
pass

class DocumentAnalysisFeature:
pass

class DefaultAzureCredential:
pass


# TODO: currently, there is a bug in the document intelligence SDK with importing the "ContentFormat" enum.
# This constant is a temporary fix until the bug is resolved.
Expand Down
9 changes: 5 additions & 4 deletions packages/markitdown/tests/_test_vectors.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,11 @@ class FileTestVector(object):
charset="cp932",
url=None,
must_include=[
"名前,年齢,住所",
"佐藤太郎,30,東京",
"三木英子,25,大阪",
"髙橋淳,35,名古屋",
"| 名前 | 年齢 | 住所 |",
"| --- | --- | --- |",
"| 佐藤太郎 | 30 | 東京 |",
"| 三木英子 | 25 | 大阪 |",
"| 髙橋淳 | 35 | 名古屋 |",
],
must_not_include=[],
),
Expand Down