Pure Python Spell Checking based on Peter Norvig’s blog post on setting up a simple spell checking algorithm.
It uses a Levenshtein Distance algorithm to find permutations within an edit distance of 2 from the original word. It then compares all permutations (insertions, deletions, replacements, and transpositions) to known words in a word frequency list. Those words that are found more often in the frequency list are more likely the correct results.
pyspellchecker supports multiple languages including English, Spanish, German, French, and Portuguese. Dictionaries were generated using the WordFrequency project on GitHub.
pyspellchecker supports Python 3. If may work for Python 2.7 but it is not guaranteed (especially for Non-English dictionaries)!
pyspellchecker allows for the setting of the Levenshtein Distance to check. For longer words, it is highly recommended to use a distance of 1 and not the default 2. See the quickstart to find how one can change the distance parameter.
Installation
The easiest method to install is using pip:
pip install pyspellcheckerTo install from source:
git clone https://github.com/barrust/pyspellchecker.git
cd pyspellchecker
python setup.py installAs always, I highly recommend using the Pipenv package to help manage dependencies!
Quickstart
After installation, using pyspellchecker should be fairly straight forward:
from spellchecker import SpellChecker
spell = SpellChecker()
# find those words that may be misspelled
misspelled = spell.unknown(['something', 'is', 'hapenning', 'here'])
for word in misspelled:
# Get the one `most likely` answer
print(spell.correction(word))
# Get a list of `likely` options
print(spell.candidates(word))If the Word Frequency list is not to your liking, you can add additional text to generate a more appropriate list for your use case.
from spellchecker import SpellChecker
spell = SpellChecker() # loads default word frequency list
spell.word_frequency.load_text_file('./my_free_text_doc.txt')
# if I just want to make sure some words are not flagged as misspelled
spell.word_frequency.load_words(['microsoft', 'apple', 'google'])
spell.known(['microsoft', 'google']) # will return both now!If the words that you wish to check are long, it is recommended to reduce the distance to 1. This can be accomplished either when initializing the spell check class or after the fact.
from spellchecker import SpellChecker
spell = SpellChecker(distance=1) # set at initialization
# do some work on longer words
spell.distance = 2 # set the distance parameter back to the defaultAdditional Methods
On-line documentation is available; below contains the cliff-notes version of some of the available functions:
correction(word): Returns the most probable result for the misspelled word
candidates(word): Returns a set of possible candidates for the misspelled word
known([words]): Returns those words that are in the word frequency list
unknown([words]): Returns those words that are not in the frequency list
word_probability(word): The frequency of the given word out of all words in the frequency list
The following are less likely to be needed by the user but are available:
edit_distance_1(word): Returns a set of all strings at a Levenshtein Distance of one based on the alphabet of the selected language
edit_distance_2(word): Returns a set of all strings at a Levenshtein Distance of two based on the alphabet of the selected language
Credits
Peter Norvig blog post on setting up a simple spell checking algorithm
hermetdave’s WordFrequency project for providing the basis for Non-English dictionaries
1 maintainer
Metadata
1 maintainer
Release files for pyspellchecker 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyspellchecker-0.3.0.tar.gz | 1.9 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyspellchecker-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.8 MB
Release files / pyspellchecker-0.3.0.tar.gz
| Download URL | pyspellchecker-0.3.0.tar.gz |
|---|---|
| Size | 1.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
17ae50085bcdfc6ab30fb08077969f1934e38f538a7704196efd68679c856a73
|
|
BLAKE2b-256 checksum How to use checksums |
a5a2dac9cf4641f4e5faa3f1cc7cc3ae05693ee260df72aa13f557c436be4254
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.2
|
Release files / pyspellchecker-0.3.0-py3-none-any.whl
| Download URL | pyspellchecker-0.3.0-py3-none-any.whl |
|---|---|
| Size | 1.9 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
236ecc7855847cfda09699ad89d78ce3d9a2226cd58e492c898a60031da82334
|
|
BLAKE2b-256 checksum How to use checksums |
6ab3f1d5af6dcd4cd50fbe75b425e386013a6afb9e2bdba59a2e6b9f200c1319
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.2
|
