Difference between revisions of "Python-for-Automation/C3/Spelling-and-Grammar-Checker/English"

Welcome

Learning Objectives

• Create functions to identify spelling and grammar errors
• Implement text processing techniques in Python
• Create a GUI application with a text area and buttons

System Requirements

Ubuntu Linux OS 22.04

Python 3.12.3

• Ubuntu Linux OS version 22.04
• Python 3.12.3

Prerequisite

https:/spoken-tutorial.org

• You must have basic knowledge of using Linux Terminal and Python
• For pre-requisite Linux and Python Tutorials, please visit this website
• Python libraries required for automation must be installed

Code files

• The files used in this tutorial are provided in the Code files link.

• Please download and extract the files.

• Make a copy and then use them while practicing.

Spelling and Grammar Checker - GUI

Spelling and Grammar Checker

• The checker will refer to an inbuilt dictionary to identify wrong spellings
• It will use language_tool_python to recognize incorrect grammar and suggest corrections

Spelling and Grammar Checker - Libraries

• Language_tool_python provides grammar and style checking capabilities.
• NLTK is a library for text processing and natural language understanding tasks.

Spelling and Grammar Checker - Libraries

• re module helps to manipulate strings based on patterns using regular expressions.
• tkinter is the standard GUI toolkit for Python.
• docx is for reading and writing Microsoft Word files.
• Fitz (PyMuPDF) is for reading PDF files

If not, please install using the below commands.

import re import tkinter as tk from tkinter import scrolledtext, filedialog from nltk.corpus import words import nltk import language_tool_python import docx import fitz

This helps to create scrollable text areas and file dialogs.

It also provides access to Python’s inbuilt spelling dictionary and grammar library.

try:

nltk.download('words')

This corpus has a large collection of English words used for spell-checking.

except Exception as e:

print(f"NLTK Download Error: {e}")

try:

tool = language_tool_python .LanguageTool('en-US')

It checks grammar and style according to US English.

except language_tool_python.ServerException as e: print(f"Language Tool Initialization Error: {e}")

def checkSpelling(text):

wordList = set(words.words())

A set will allow for faster look-up.

misspelled = []

for word in re.findall(r'\b\w+\b', text):

re.findall method finds all words in the text using regular expressions.

if word.lower() not in wordList:

misspelled.append(word)

return misspelled

If the word is not found in the wordList, it is added to the misspelled list.

def checkGrammar(text):

matches = tool.check(text) return matches

We store the result of the grammar check in a variable named matches.

def checkText():

text = textArea.get("1.0", tk.END)

“1.0”

It points to the beginning of the first line.

spellingErrors = checkSpelling(text)

grammarErrors = checkGrammar(text)

result = "Spelling Errors:\n"

if spellingErrors:

result += ", ".join(spellingErrors)

else: result += "None"

result += "\n\nGrammar Errors:\n" if grammarErrors: for match in grammarErrors: result += f"{match.context} -> {match.message}\n" else: result += "None"

If no errors are found, the word None is appended to result.

resultArea.config(state=tk.NORMAL)

In the config method set the state to tk dot NORMAL to make the result area editable.

This will allow the program to print the error results in the result area.

resultArea.delete("1.0", tk.END)

resultArea.insert(tk.END, result)

resultArea.config(state=tk.DISABLED)

def uploadFile():

It reads the file content, and inserts it into the text area.

file_path = filedialog.askopen filename(filetypes=[("Text files", "*.txt"), ("Word documents", "*.docx"), ("PDF files", "*.pdf")])

filetypes=[("Text files", "*.txt"), ("Word documents", "*.docx"), ("PDF files", "*.pdf")]

if file_path:

if file_path.endswith(".txt"):

with open(file_path, 'r', encoding='utf-8') as file:

text = file.read()

If yes, then we open the file in read mode with UTF-8 encoding.

Then we read the entire content of the file into the variable text.

elif file_path.endswith(".docx "): doc = docx.Document(file_ path) text = '\n'.join([para.text for para in doc.paragraphs])

Open the word document using the docx library.

We then join all the content into the variable text.

elif file_path.endswith(".pdf"):

pdf_document = fitz.open (file_path) text = ""

for page_num in range(pdf_ document.page_count):

page = pdf_document.load_ page(page_num)

text += page.get_text()

Open the PDF file using the fitz library.

Content from each page of the PDF is appended to the variable text.

textArea.delete("1.0", tk.END)

textArea.insert(tk.END, text)

Then we insert the content of the file into the text area.

root = tk.Tk()

root.title("Spelling and Grammar Checker")

root dot title sets the title of the window.

textArea = scrolledtext.ScrolledText(root, wrap=tk.WORD, width=60, height=15)

textArea.pack(pady=10)

uploadButton = tk.Button (root, text="Upload", command=uploadFile)

uploadButton.pack(pady=5)

command=uploadFile

checkButton = tk.Button(root, text="Check", command=checkText)

checkButton.pack(pady=5)

resultArea = scrolledtext.Scro lledText(root,wrap=tk.WORD, width=60, height=15, state =tk.DISABLED)

resultArea.pack(pady=10)

state=tk.DISABLED

root.mainloop()

Open terminal -

Press Ctrl + Alt + T

Open the terminal by pressing Control, Alt and T keys simultaneously.

source Automation/bin/activate

Type source space Automation forward slash bin forward slash activate.

Then press Enter.

> cd Downloads

> Python3 checker.py

Next type python3 checker.py and press enter.

Tkinter window opens up on running the code

The tkinter window will pop up once the code is executed.

As you can see, there is a text area, an upload and check button and a result area.

Let us test out our Spelling and Grammar checker application.

Hello wrold.

Click on check button

Highlight:

In the result area, we can see that the wrong spelling of world has been detected.

Let us correct the spelling of world.

Now click on the check button.

We can see there are no errors.

What is you favorite lanugage

Click on check button

Highlight:

This time we can see grammar and spelling errors.

In the result area, corrections for the errors are also suggested.

Hello world. Python is my favorite language

Click on check button

Highlight:

Content in result area

The correct sentence would be What is your favorite language?. (correct this first)

Click on Check. (then correct this)

Now there are no errors, so the result area displays None.

• Click on upload button
• Select file type
• Select file
• Click Open

Here we can select the type of file we want to upload.

Let us select this paragraph.txt file and click on Open.

Content in text area

Click Check button

Highlight:

Content in result area

Click on the Check button.

Please wait as it might take some time to process the spell check.

Some spelling and grammar errors are displayed in the result area.

deactivate

This will allow you to exit the virtual environment.

Summary

Let us summarize.

In this tutorial, we have learnt to

• Create functions to identify spelling and grammar errors
• Implement text processing techniques in Python
• Create a GUI application with a text area and buttons

Assignment

• Modify the checker.py and print the total number of errors in the result area.
• Hint: Use the len function to calculate the number of errors.

About the Spoken Tutorial Project

Spoken Tutorial Workshops

For more details, please write to us.

FOSSEE Forum

Acknowledgement

Thank You

Thanks for joining.