Provider Capabilities Matrix

​

Overview

​

Capability Matrix

​

Legend

• ✅ Full: Fully implemented with optimized performance
• ⚠️ Optional: Supported if data is provided during initialization
• ❌ Not Supported: Returns default value (0, None, or empty)
• Default: Uses default implementation (iterates over individual calls)
• Optimized: Uses batch queries for better performance

​

Provider Selection Guide

​

SQLiteProvider (Recommended for Production)

• Production deployments
• Large dictionaries (100K+ entries)
• Concurrent access from multiple threads
• Full spell checking with context validation

• Disk-based storage with memory-mapped I/O
• Connection pooling for thread safety
• Optimized batch queries
• Full N-gram and POS support

from myspellchecker.providers import SQLiteProvider

provider = SQLiteProvider(
    database_path="myspell.db",
    cache_size=2048,
    pool_max_size=5,
)

​

MemoryProvider (Best for Testing/Development)

• Unit testing with controlled data
• Development and debugging
• Small dictionaries
• Maximum performance (no I/O)

• In-memory storage
• Fast initialization
• Full N-gram and POS support
• No disk dependencies

from myspellchecker.providers import MemoryProvider

provider = MemoryProvider(
    syllables={"မြန်": 1000, "မာ": 500},
    words={"မြန်မာ": 800},
    bigrams={("မြန်", "မာ"): 0.5},
    trigrams={("ကျွန်", "တော်", "သည်"): 0.3},
    word_pos={"မြန်မာ": "N"},
)

​

JSONProvider (For Simple Use Cases)

• Simple dictionary files
• Human-readable configuration
• Small datasets
• Testing with external data

• N-gram and POS data supported only if provided in the JSON file
• Not optimized for large datasets

from myspellchecker.providers import JSONProvider

provider = JSONProvider(json_path="dictionary.json")

​

CSVProvider (For Data Import)

• Importing from spreadsheets
• Simple frequency lists
• Data migration

• N-gram and POS data supported only if provided in CSV files
• Column-based format only

from myspellchecker.providers import CSVProvider

provider = CSVProvider(
    syllables_csv="syllables.csv",
    words_csv="words.csv",
    bigrams_csv="bigrams.csv",
)

​

Method Behavior When Not Supported

​

Creating Custom Providers

from myspellchecker.providers import DictionaryProvider

class MyCustomProvider(DictionaryProvider):
    def is_valid_syllable(self, syllable: str) -> bool:
        # Your implementation
        pass

    def is_valid_word(self, word: str) -> bool:
        # Your implementation
        pass

    # ... implement all abstract methods