Skip to content

Fix extraction of text from HTML files #42

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

Merged
martinburchell merged 3 commits into from
Jan 26, 2026
Merged

Fix extraction of text from HTML files #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f25d3f
Fix silly mistake introduced in bdc9983e1cb1e2cf07783284903cab1a789a2b9e
martinburchell Jan 26, 2026
d8f60cd
Update changelog
martinburchell Jan 26, 2026
2f98e5f
Install pycairo dependencies before running tests
martinburchell Jan 26, 2026
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
4 changes: 4 additions & 0 deletions .github/workflows/run_tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ jobs:
python-version: ${{ matrix.python-version }}
- name: Change apt mirror
run: ${GITHUB_WORKSPACE}/.github/scripts/change_apt_mirror.sh
- name: Install prerequisites
run: |
set -euo pipefail
sudo apt-get -y install libcairo2-dev pkg-config python3-dev
- name: Create virtualenv
run: ${GITHUB_WORKSPACE}/.github/scripts/create_virtualenv.sh
- name: Install test Python packages
Expand Down
2 changes: 1 addition & 1 deletion cardinal_pythonlib/extract_text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1148,7 +1148,7 @@ def convert_html_to_text(
# https://bugs.launchpad.net/beautifulsoup/+bug/2110492
# beautifulsoup4==4.13.4 returns "b''" for an empty bytes array
# So we just workaround this here:
if bytes is not None and len(blob) == 0:
if blob is not None and len(blob) == 0:
return ""

with get_filelikeobject(filename, blob) as fp:
Expand Down
20 changes: 20 additions & 0 deletions cardinal_pythonlib/tests/extract_text_tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,26 @@ def test_htm_converted(self) -> None:
)
self.assertEqual(text.strip(), content)

def test_htm_file_converted(self) -> None:
content = self.fake.paragraph(nb_sentences=10)

html = f"""
<!DOCTYPE html>
<html>
<head>
</head>
<body>
{content}
</body>
</html>
"""
with NamedTemporaryFile(suffix=".htm", delete=False) as temp_file:
temp_file.write(html.encode("utf-8"))
temp_file.close()
text = document_to_text(filename=temp_file.name)

self.assertEqual(text.strip(), content)

def test_empty_htm_converted(self) -> None:
text = document_to_text(
blob="".encode("utf-8"), extension="htm", config=self.config
Expand Down
3 changes: 3 additions & 0 deletions docs/source/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -914,3 +914,6 @@ Quick links:
- ``cardinalpythonlib_grep_in_openxml``: new facility to search XML node text
(rather than raw file text), and this is now the default. Also, behind the
scenes, exceptions in subprocesses are now reported.

- Fix extraction of text from HTML files in
:func:`cardinal_pythonlib.extract_text.document_to_text`.