dictionary.py

"""
PLP Week 4 min-project

Learn how to load json data into a python dictionary
Create a function that returns a definition of a word
Consider a condition that the entered word is not in a dictionary
Consider input from user having different cases – upper/ lower case or mixed eg: RAIN/rain/RaIN
Make your dictionary program more intelligent incase users input a word with wrong spelling the program should be able to suggest the word that might be intended.
eg . pott instead of pot or rainn instead of rain.
Tip: use difflib library here
"""

# pip install orjson
import orjson
from re import split
from difflib import get_close_matches


class Dictionary:
    """dictionary that gets difinations from a JSON file"""

    __slots__ = (
        "word_definitions",
        "dictfile",
        "words",
        "current_word",
        "current_definition",
    )

    def __init__(self):
        # store filename for future ref
        self.dictfile = None
        # empty words and definitions
        self.word_definitions = {}
        self.words = []
        # initialize current word and definition
        self.current_word = None
        self.current_definition = None

    def from_json(self, filename: str):
        """
        read dictfile and update dictionary at runtime;
        return True on success, False otherwise
        """
        try:
            with open(filename, "rb") as file:
                # get words and definitions
                self.word_definitions: dict = orjson.loads(file.read())
            # get words for suggestions
            self.words = list(self.word_definitions.keys())
            # update file ref
            self.dictfile = filename
            return True
        except Exception:  # File not found, or Permission errors
            return False

    def _format_definition(self, definitions):
        """
        format the definitions string/list;
        use the 're' to replace numbered definitions with '\n'
        """
        if isinstance(definitions, str):
            # try split numbered definitions
            definitions = (
                line for line in split(r"[ ]*\d{1,2}.[ ]+", definitions) if line
            )
        elif isinstance(definitions, dict):
            definitions = (f"{k}: {v}" for k, v in definitions.items())
        # format definitions
        formatted_def = "".join(
            (f"\n{index + 1}. {line}" for index, line in enumerate(definitions))
        )
        return formatted_def

    def search(self, word: str) -> str | None:
        """search the definition of word in dictionary"""
        # if definition is None; suggest a word that's close
        if definition := self.word_definitions.get(word):
            # definition can be list or str
            f_definition = self._format_definition(definition)
            # update current word and definition
            self.current_word = word
            self.current_definition = f_definition
            return f_definition

    def suggest(self, word: str, **kwargs):
        """use difflib to suggest close words to word"""
        matches = get_close_matches(word, self.words, **kwargs)
        return matches