Repository navigation
✨ feat(api): expose MissingExtraError for public imports - #9
Merged
Merged
Conversation
Callers can catch the optional-dependency error through the package API. Use that API throughout the project to avoid absolute private imports.
Documentation build overview
25 files changed ·
|
Exporting the exception makes its meaning part of the public API. Document when callers receive it.
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.
This draft tests adoption of simplint's proposed private import rule in python-sbom. Imports of package errors now use the public API, reducing local SMP310 findings from 254 to 217. Callers can use
from python_sbom import MissingExtraErrorwhen handling a missing optional dependency.The package API already exports
SbomErrorand now exportsMissingExtraErroras well. Internal consumers and tests import both there, while the remaining findings concern other private modules and require separate API decisions. The new exception export is documented and recorded in the changelog.