[spelling checker] Better help message and code organization #8338
Conversation
Pierre-Sassoulas
added
Maintenance
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #8338 +/- ##
=======================================
Coverage ? 95.56%
=======================================
Files ? 178
Lines ? 18763
Branches ? 0
=======================================
Hits ? 17930
Misses ? 833
Partials ? 0
|
Pierre-Sassoulas
force-pushed
the
better-name-spelling-checker
branch
from
4d14d60 to
72de85a
Compare
This comment has been minimized.
This comment has been minimized.
Pierre-Sassoulas
changed the title
This comment has been minimized.
This comment has been minimized.
| @@ -35,8 +35,11 @@ | |||
| WikiWordFilter, | |||
| get_tokenizer, | |||
| ) | |||
|
|
|||
| PYENCHANT_AVAILABLE = True | |||
| except ImportError: | |||
| enchant = None | |||
There was a problem hiding this comment.
| enchant = None |
Does this line serve a purpose anymore now that the PYENCHANT_AVAILABLE is here?
There was a problem hiding this comment.
Yeah it's basically so it's defined and we don't get screamed at by linters 😅 The design of this is peculiar, I'm thinking an external plugin would make more sense, because then it could convey in pip metadata that it NEED py-enchant and we could remove all of this. Maybe something to do as a breaking change in 4.0.
tests/checkers/unittest_spelling.py
Outdated
| enchant.Broker().list_dicts(), pyenchant_available=True | ||
| ) | ||
| else: | ||
| pytest.skip("'enchant' is not installed.") |
| def _get_enchant_dict_choices( | ||
| inner_enchant_dicts: list[tuple[Any, enchant.ProviderDesc]] | ||
| ) -> list[str]: | ||
| return [""] + [d[0] for d in inner_enchant_dicts] |
There was a problem hiding this comment.
Is the [""] a default - would this work also? Feel free to leave as-is 🕺
| return [""] + [d[0] for d in inner_enchant_dicts] | |
| return [d[0] for d in inner_enchant_dicts] or [""] |
There was a problem hiding this comment.
Yeah, basically an empty dict name means you're not checking anything it's the default value. But when some dict are installed you get a list like ["", "en", "gb"], and you need the empty value.
| dicts = "none" | ||
| dict_choices = [""] | ||
| instr = " To make it work, install the 'python-enchant' package." | ||
| def _get_enchant_dicts() -> list[tuple[Any, enchant.ProviderDesc]]: |
There was a problem hiding this comment.
I was a bit confused by the use of the word dicts while a list of tuples are returned - but this is enchant terminology?
There was a problem hiding this comment.
enchant.ProviderDesc are the dict, as in an actual dict with word in it, for the spelling check, not a python data structure.
Following a failed attempt to add functional tests for spelling checker in pylint-dev#6137
Pierre-Sassoulas
force-pushed
the
better-name-spelling-checker
branch
from
9aa359d to
8435e2b
Compare
…ylint-dev#8338)" This reverts commit 5e0223b.
|
🤖 According to the primer, this change has no effect on the checked open source code. 🤖🎉 This comment was generated for commit 8435e2b |
Type of Changes
Description
Following a failed attempt to add functional tests for spelling checker in #6137. Branch forgotten for some time but recovered after a global cleanup 😄