Add write_html and write_pdf methods for RTFDocument
#176
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Implement a function to check for pypdf installation. - Update the LibreOffice check to validate successful document conversion. - Introduce new tests for HTML, PDF, and DOCX export functionalities. - Remove outdated test files related to DOCX export.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds write_html() and write_pdf() methods to RTFDocument, following the same pattern as the existing write_docx() method. The implementation uses LibreOffice for conversion from temporary RTF files.
Key changes:
- Implements
RTFDocument.write_html()andRTFDocument.write_pdf()methods with optionalconverter=parameter - Adds HTML resource directory handling for LibreOffice-generated companion files
- Refactors tests to use parameterized testing across DOCX/HTML/PDF formats
- Adds
pypdfdependency (version 6.5.0) for PDF text extraction in tests - Improves LibreOffice availability checking with actual conversion test
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/rtflite/encode.py | Adds write_html() and write_pdf() methods following the same pattern as write_docx() |
| tests/test_write_format.py | New parameterized integration tests covering all three export formats (DOCX/HTML/PDF) |
| tests/test_write_format_args.py | New parameterized unit tests for testing converter reuse and temp file handling |
| tests/conftest.py | Enhanced LibreOffice availability check with actual conversion test; adds pypdf check |
| tests/test_write_docx.py | Removed (replaced by parameterized tests) |
| tests/test_write_docx_args.py | Removed (replaced by parameterized tests) |
| pyproject.toml | Adds pdf optional dependency with pypdf>=5.0.0 |
| uv.lock | Locks pypdf 6.5.0 with dependencies |
| docs/index.md | Updates dev setup to use --all-extras |
| README.md | Updates dev setup to use --all-extras |
| docs/changelog.md | Documents new features and testing improvements |
| CHANGELOG.md | Documents new features and testing improvements |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
elong0527
approved these changes
Dec 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #175
This PR:
RTFDocument.write_html()andRTFDocument.write_pdf()alongsidewrite_docx(), using the same temporary RTF + LibreOffice conversion flow and optionalconverter=reuse.pdfextra (pypdf).