Include close matches in error message when key not found #30001
Conversation
3f98b36 to
144b9d6
Compare
|
Where the discussion in #28115 got stalled is over using difflib or vendoring a copy of Levenstien distance with a question of how different the results are (and then I did not have time to answer that question). Do we want to resume that discussion or just use I think either way getting close matches is better than the current state of things and contra my previous comments I'm in favor of using difflib and changing the algorithm later if it is a problem (I'm not going to consider the guessed "did you mean..." list to be something we need to maintain API stability on!). |
| cmap = _api.check_getitem( | ||
| self._cmaps, colormap=item, _error_cls=KeyError | ||
| ) |
There was a problem hiding this comment.
This fits in a line.
| cmap = _api.check_getitem( | |
| self._cmaps, colormap=item, _error_cls=KeyError | |
| ) | |
| cmap = _api.check_getitem(self._cmaps, colormap=item, _error_cls=KeyError) |
There was a problem hiding this comment.
And if you are talking about this as style, black would have put it on one line.
There was a problem hiding this comment.
My objection is mainly to bikeshedding style one comment at a time in PR review, instead of having a tool automate it for us.
| def check_getitem( | ||
| mapping, /, _error_cls=ValueError, **kwargs | ||
| ): |
There was a problem hiding this comment.
This fits in a line.
| def check_getitem( | |
| mapping, /, _error_cls=ValueError, **kwargs | |
| ): | |
| def check_getitem(mapping, /, _error_cls=ValueError, **kwargs): |
There was a problem hiding this comment.
And this violates E125, which is currently missing from ruff, but we shouldn't introduce more linting issues for the future.
This is an attempt to resurrect #28115, but make it more general so we can emit helpful error messages when keys aren't found.