ahaque12 / why-misspelling-name

An engineering solution to the rescue

Why do you keep misspelling my name?

Code to support Munich Re Integrated Analytics blog post.

Installation

The module (alitheia_spell_checker.py) needs to be made available to pylint either by putting this module's parent directory in your $PYTHONPATH environment variable or by adding alitheia_spell_checker.py to the pylint/checkers directory if running from source.

Running

You can run the linter using

$ pylint --load-plugins alitheia_spell_checker sample.py
************* Module why-misspelling-name.sample
sample.py:4:0: C1991: "alitheia" is misspelled. (alitheia-misspelling)
sample.py:5:0: C1991: "alitheia" is misspelled. (alitheia-misspelling)

----------------------------------------------------------------------
Your code has been rated at -10.00/10 (previous run: -10.00/10, +0.00)

You can also run the specific function that implements checking an alitheia misspelling using alitheia_spell_checker.alitheia_misspelling.

>>> from alitheia_spell_checker import alitheia_misspelling
>>> alitheia_misspelling('aletheia')
True

Testing

$ pytest --doctest-modules

Performance of the linter can be tested using timeit.

In [1]: import alitheia_spell_checker as asc

In [2]: %timeit asc.alitheia_misspelling('aleetheia')
16.7 µs ± 409 ns per loop (mean ± std. dev. of 7 runs, 100000 loops each)

The implication is that a code base with 100k words would take 40ms to lint.