Replace codespell with pyspelling

[strickvl]

TL;DR Quick Summary:

• Our old automated spellchecker wasn’t actually checking our spelling, so I switched it out and now we’re using pyspelling
• It’s a bit more aggressive than codespell
• If it’s claiming a word is an error but it’s a legitimate (correctly spelled) word, then you can add that word as a new line to our canonical list of ignored words: .pyspelling-ignore-words

We use pyspelling at ZenML to guard against typos and other non-standard uses of words being used in our codebase. (We previously used codespell for this but it only checked against a known list of typos and therefore missed lots of errors).

It takes one or two minutes to run apyspelling check over the entire codebase, unfortunately, so this spellcheck only runs at the Github Action CI level by default. (In other words, it is no longer part of our pre-commit checks.)

If you wish to run the spellchecks manually on your local machine, first install aspell (using brew or apt-get), run poetry update to get the relevant dependency and then simply use:

poetry run bash scripts/check-spelling.sh

Note that there are some quirks / less-than-ideal realities of working with pyspelling:

• it is a LOT more aggressive about finding typos than codespell was
• it isn’t particularly smart about knowing whether a particular term is misspelled vs it just hasn’t seen it before. In particular, referencing ZenML specific class or variable names often causes it to detect failures.
• it is currently set up to check
  • all our Python files (mainly checking comments and docstring text)
  • all our .md markdown files
• Technically it is supposed to ignore URLs and code inside triple ``` backticks, but this doesn't always work perfectly, it seems.

⚠️ What do do when spelling errors are found?

When spelling errors are detected, it won’t suggest an alternative (as codespell did) so you’ll have to examine your text to see whether it’s a legitimate failure or not. If you find a word that is legitimate and not a typo, you will need to add it to our list of ignored words: .pyspelling-ignore-words. As you’ll note, this file is already fairly long. Just add your word onto a new line anywhere. If you want to sort it at the end, you can run sort -o .pyspelling-ignore-words .pyspelling-ignore-words on a *nix machine but no need to do that for pyspelling to work.

June 2022 UPDATE: pyspelling is currently only added on the zenml repo, but I’ll likely add it to all the other key repos (ZenBytes, ZenFiles, Blog) in due course once we’ve ironed out any issues.

(This note is currently captured in Notion as well, for future reference).

Pre-requisites

Please ensure you have done the following:

• I have read the CONTRIBUTING.md document.
• If my change requires a change to docs, I have updated the documentation accordingly.
• If I have added an integration, I have updated the integrations table.
• I have added tests to cover my changes.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Other (add details above)

[schustmi]

LGTM!

[AlexejPenner]

Luuks Gud tu mi!