Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix markitdown.convert_stream handling of leading blanks #223

Closed
wants to merge 1 commit into from
+15 −1
Closed

Fix markitdown.convert_stream handling of leading blanks #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion src/markitdown/_markitdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1344,7 +1344,7 @@ def convert_stream(
result = None
try:
# Write to the temporary file
content = stream.read()
content = self._strip_leading_blanks(stream.read())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The stream might not be text -- in which case stripping characters could be very problematic. Suggest we move this to the inside of the if statement below.

if isinstance(content, str):
fh.write(content.encode("utf-8"))
else:
Expand All @@ -1367,6 +1367,10 @@ def convert_stream(

return result

def _strip_leading_blanks(self, content: bytes) -> bytes:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need a helper function for lstrip?

"""Helper function to strip leading blank characters or line breaks from content."""
return content.lstrip()

def convert_url(
self, url: str, **kwargs: Any
) -> DocumentConverterResult: # TODO: fix kwargs type
Expand Down
10 changes: 10 additions & 0 deletions tests/test_markitdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,10 +300,20 @@ def test_markitdown_llm() -> None:
assert test_string in result.text_content.lower()


def test_markitdown_strip_leading_blanks() -> None:
markitdown = MarkItDown()

# Test input with leading blank characters
input_data = b" \n\n\n<html><body><h1>Test</h1></body></html>"
result = markitdown.convert_stream(io.BytesIO(input_data), file_extension=".html")
assert "<h1>Test</h1>" in result.text_content
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test will fail. The output will be Markdown, not HTML



if __name__ == "__main__":
"""Runs this file's tests from the command line."""
test_markitdown_remote()
test_markitdown_local()
test_markitdown_exiftool()
test_markitdown_deprecation()
test_markitdown_llm()
test_markitdown_strip_leading_blanks()
Loading