Replace Iterable with Collection/Sequence, remove stale type: ignore - #576
Open
ecomodeller wants to merge 2 commits into
Open
Replace Iterable with Collection/Sequence, remove stale type: ignore#576ecomodeller wants to merge 2 commits into
ecomodeller wants to merge 2 commits into
Conversation
…ore comments Use Collection for unordered containers (by, mod_items, aux_items, comparers) and Sequence for ordered ones (metrics, obs/mod lists). Remove 49 unused type: ignore comments confirmed stale by mypy --warn-unused-ignores.
Member
Author
|
@copilot resolve the merge conflicts in this pull request |
Co-authored-by: ecomodeller <614215+ecomodeller@users.noreply.github.com>
Contributor
Resolved by merging |
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
| from __future__ import annotations | ||
| from typing import Callable, Iterable, List, Tuple, Union | ||
| from collections.abc import Collection | ||
| from typing import Callable, Optional, List, Tuple, Union |
Member
Author
There was a problem hiding this comment.
How come this wasn't caught by ruff?
|
|
||
| @overload | ||
| def __getitem__(self, x: slice | Iterable[Hashable]) -> ComparerCollection: ... # type: ignore[overload-overlap] | ||
| def __getitem__(self, x: slice | Collection[Hashable]) -> ComparerCollection: ... |
|
|
||
| @overload | ||
| def __getitem__(self, key: Iterable[Hashable]) -> SkillGrid: ... | ||
| def __getitem__(self, key: Collection[Hashable]) -> SkillGrid: ... |
|
|
||
| @overload | ||
| def __getitem__(self, key: Iterable[Hashable]) -> SkillTable: ... | ||
| def __getitem__(self, key: Collection[Hashable]) -> SkillTable: ... |
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
Iterabletype hints withCollection(unordered:by,mod_items,comparers) andSequence(ordered:metrics,obs/modlists) for more precise API contracts# type: ignorecomments confirmed stale bymypy --warn-unused-ignoresWhy
Iterableaccepts single-pass iterators (generators) which would silently break code that iterates multiple times (e.g.ComparerCollection.__init__).CollectionandSequencebetter express the actual requirements and help downstream users relying on static type checking. Removing staletype: ignorecomments ensures future type errors aren't silently suppressed.