Add CLI document info preflight#2193
Open
godlovesmei wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a lightweight “document preflight” capability to MarkItDown’s CLI and Python API so callers can retrieve basic metadata (and the likely converter) as JSON without running a full conversion.
Changes:
- Add
DocumentInfoandMarkItDown.get_local_document_info()to inspect local files and detect an applicable converter viaStreamInfoguesses +accepts()checks. - Add
markitdown --info FILECLI flag to emit theDocumentInfopayload as JSON and exit. - Add CLI tests covering the JSON shape for a supported XLSX and an unsupported binary file.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| packages/markitdown/tests/test_cli_misc.py | Adds CLI coverage for --info JSON output and unsupported-file warning behavior. |
| packages/markitdown/src/markitdown/_markitdown.py | Introduces DocumentInfo, preflight inspection API, and refactors converter kwargs construction. |
| packages/markitdown/src/markitdown/main.py | Implements --info CLI flag and JSON emission path. |
| packages/markitdown/src/markitdown/init.py | Exports DocumentInfo as part of the public package API. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Author
|
@microsoft-github-policy-service agree |
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
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.
Summary
markitdown --info FILEfor lightweight local document metadata as JSON.StreamInfoguesses and converteraccepts()checks.detected_converter: nulland a warning.Fixes #2182
Testing
uv run --with-editable 'packages/markitdown[all]' python -m pytest packages/markitdown/tests/test_cli_misc.py -quv run --with-editable 'packages/markitdown[all]' python -m pytest packages/markitdown/tests/test_cli_vectors.py -quv run --with-editable 'packages/markitdown[all]' python -m compileall -q packages/markitdown/src packages/markitdown/tests/test_cli_misc.pygit diff --check