chore: re-export DocumentStream explicitly for type checkers#3181
Merged
cau-git merged 1 commit intoMar 25, 2026
Merged
Conversation
Fixes docling-project#3165 Signed-off-by: Eugenio-BAYE <baye.eugenio.egnb@gmail.com>
Contributor
|
✅ DCO Check Passed Thanks @Eugenio-BAYE, all your commits are properly signed off. 🎉 |
Contributor
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a static type-checking (Pyright) export issue by making DocumentStream an explicit re-export from docling.datamodel.base_models, aligning with PEP 484 expectations for py.typed packages.
Changes:
- Switches
DocumentStreamimport to an explicit re-export form (DocumentStream as DocumentStream) so type checkers treat it as public.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cau-git
approved these changes
Mar 25, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
cau-git
changed the title
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.
Fixes #3165
DocumentStreamwas imported with a plainimport, which Pyright treats as a private symbol inpy.typedpackages and raisesreportPrivateImportUsagefor users importing it fromdocling.datamodel.base_models.Using
import X as X(PEP 484) marks it as an intentional re-export.