Repository navigation
Silence Pylance missing-import warning for generated _release_info - #51
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The change is limited to comments and a targeted diagnostic suppression, with no runtime changes or unresolved findings.
No open issues 🎉
What changed in this PR
Suppresses the expected Pylance warning for the release-generated _release_info module in source checkouts, without changing runtime behavior.
Changes:
- Adds a targeted
reportMissingImportssuppression to the import. - Adds a comment explaining why the module is absent from source checkouts.
| File | Description |
|---|---|
solarfarmer/__version__.py |
Documents and suppresses the expected missing-import diagnostic while preserving the runtime fallback. |
Review effort: Balanced
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.
Pylance reports
Import "._release_info" could not be resolvedinsolarfarmer/__version__.pyon a fresh checkout ofmain.The warning is expected.
solarfarmer/_release_info.pyis created by the release workflow (release.yml) only when it builds a tagged release, and.gitignoreexcludes it, so it never exists in a source checkout. At runtime the import is already wrapped intry/except ImportError, which falls back to the latest git tag date or"unreleased".Changes
# pyright: ignore[reportMissingImports]to the import, with a comment explainingwhy the file is missing in source checkouts.
Impact
Validation
__version__.py: none.ruff checkandruff format --check: pass.pytest tests/test_version.py: 2 passed.