assertIn false positivies

[nijel]

Codespell 2.3.0 started to complain about assertIn method:

weblate/lang/tests.py:330: assertIn ==> asserting, assert in, assertion
weblate/lang/tests.py:331: assertIn ==> asserting, assert in, assertion

I know I can allow this particular word, but complaining on standard Python test suite API seems a bit annoying.

[DimitriPapadopoulos]

How about moving it to the code dictionary? Merge requests welcome.

[CodyCBakerPhD]

@DimitriPapadopoulos

How about moving it to the code dictionary? Merge requests welcome.

Happy to try to fix this, tracked it down to this entry in the global dict: https://github.com/codespell-project/codespell/blob/master/codespell_lib/data/dictionary.txt#L5633

What I'm not clear on is how moving this to dictionary_code would help; it seems what we would want it to do is ignore the specific capitalization of .assertIn (either pre-ambled by self or TestCase) when in .py files

Is there a separate place in codespell to specify conditional code-related ignores of items from the dictionary that would otherwise make sense in normal text?

[DimitriPapadopoulos]

By design, codespell is mostly case-insensitive and doesn't make a difference between assertIn and assertin.

[CodyCBakerPhD]

OK, so how would I define an ignore rule for assertin when scanning Python code?

[DimitriPapadopoulos]

There's the code dictionary. Because codespell is language agnostic, you cannot define a rule for Python files only.

[CodyCBakerPhD]

The code dictionary seems to have definitions of common misspellings of code, e.g.,

agrv->argv
...
arange->arrange, a range,

these make sense

The problem is that a simple pure Python built-in snippet like

import unittest

class MyTest(unittest.TestCase):
    def some_test(self):
        self.assertIn("a", ["b"])

makes codespell think that the code line is a misspelling with suggestions corresponding to the non-code dictionary: https://github.com/codespell-project/codespell/blob/master/codespell_lib/data/dictionary.txt#L5633

So are you saying that this is a broader issue that the non-code dictionary is running and making suggestions on code instead of just normal text?

[DimitriPapadopoulos]

Everything's text as far as codespell is concerned, whether Shakespeare prose or source code.

You just get to select the typo lists/dictionaries you want to use - the default ones or your own selection. The code dictionary contains typos that are invalid English words in a general context, but are valid words in the context of source code. You're supposed to avoid the code dictionary when spellchecking source code - or use it at the expense of more false positives in the hope of catching a few true positives.