Repository navigation
fix: narrow exceptions in get_speckit_version() from Exception to specific types - #3917
Conversation
…cific types Outer catch narrowed to PackageNotFoundError (the only expected failure from importlib.metadata.version). Inner catch narrowed to (OSError, ValueError, KeyError) for file/parse errors.
There was a problem hiding this comment.
Pull request overview
Narrows version-resolution exception handling to expected metadata, file, and TOML parsing failures.
Changes:
- Handles missing package metadata explicitly.
- Limits pyproject fallback errors to specific exception types.
Show a summary per file
| File | Description |
|---|---|
src/specify_cli/_assets.py |
Narrows exceptions in get_speckit_version(). |
Review details
Tip
Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Balanced
mnriem
left a comment
mnriem
left a comment
There was a problem hiding this comment.
Please address Copilot feedback
|
This pull request has been automatically marked as stale because it has had no activity for 60 days. It will be closed in 30 days unless there is a substantive update. If you intend to continue, please describe the current status, address or acknowledge outstanding feedback, and confirm whether the branch can be updated and the change remains ready for review. A comment that only states that the pull request is "still relevant" does not provide enough context for maintainers. |
Addresses 2 Copilot findings:
1. Guard InvalidMetadataError (Medium): importlib.metadata.version()
can raise InvalidMetadataError on malformed metadata. Mirrors the
guard in _version._get_installed_version() — the exception class
is looked up dynamically for Python versions where it is absent.
2. Add regression tests (Low): tests that FAIL against the previous
bare except Exception implementation:
- test_get_speckit_version_survives_invalid_metadata:
InvalidMetadataError falls back correctly
- test_get_speckit_version_reads_pyproject_fallback:
PackageNotFoundError triggers pyproject.toml fallback
- test_unrelated_exception_from_version_lookup_propagates:
TypeError now propagates (was swallowed)
- test_unrelated_exception_from_pyproject_propagates:
RuntimeError now propagates (was swallowed)
- test_pyproject_io_error_returns_unknown:
OSError still caught (intended path preserved)
Assisted-by: GitHub Copilot (autonomous)
|
Thank you! |
Problem
Outer catch narrowed to
PackageNotFoundError. Inner catch narrowed to(OSError, ValueError, KeyError)for file/parse errors.Fix
Narrowed both exception handlers to specific types.
Testing