fix: correct Optional type annotation for context_note parameter - #3765
Merged
mnriem merged 1 commit intoJul 27, 2026
Merged
Conversation
The context_note parameter in CommandRegistrar methods was annotated as \str = None\ which is a type lie — the default is None but the type hint says str. Static type checkers (mypy/pyright) would flag this as an error. Changed to \Optional[str] = None\ for correctness, consistent with how extension_id (same class) is already typed.
Contributor
There was a problem hiding this comment.
Pull request overview
Corrects nullable context_note annotations without changing runtime behavior.
Changes:
- Uses
Optional[str]for all affected parameters. - Aligns annotations with existing typing conventions.
Show a summary per file
| File | Description |
|---|---|
src/specify_cli/agents.py |
Corrects three nullable parameter annotations. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Medium
Collaborator
|
Thank you! |
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
The
context_noteparameter inCommandRegistrarmethods was annotated asstr = None- a type lie where the default isNonebut the type hint saysstr. Static type checkers (mypy/pyright) flag this as an error.Changes
src/specify_cli/agents.py(lines 273, 600, 1019): Changedcontext_note: str = Nonetocontext_note: Optional[str] = None, consistent with howextension_idin the same class is already typed.Testing
This is a type-correctness fix - no runtime behavior change. Existing tests continue to pass.