wordfilter2 0.1.1

A simple word filter module for Python

wordfilter2

wordfilter2 is a lightweight and flexible Python module for filtering and censoring words in text. It is designed to detect and optionally replace offensive, sensitive, or unwanted terms using customizable options such as case sensitivity, partial matching, and replacement strategies.

Features

---

• ✅ Add or remove custom words to filter
• 🔍 Detect profanity or unwanted words in a given text
• 🧩 Optional partial or exact word matching
• 🔠 Case-insensitive or case-sensitive filtering
• ✏️ Replace filtered words with a character or a custom function
• 📁 Load word lists from files and save them back

Installation

---

Install with PyPI:

pip install wordfilter2

Usage

---

from wordfilter2 import WordFilter

# Initialize the filter
wf = WordFilter(ignore_case=True, partial_match=False, replace_with="*")

# Add words to filter
wf.add_words(["badword", "offensive"])

# Filter text
filtered = wf.filter("This is a badword example.")
print(filtered)  # Output: This is a ******* example.

# Check if text contains profanity
contains = wf.contains_profanity("Something offensive here.")
print(contains)  # Output: True

Custom Replacement

---

from wordfilter2 import WordFilter

def censor(word: str) -> str:
    return "[" + word.upper() + "]"

wf = WordFilter(replace_with_func=censor)
wf.add_word("spoiler")
print(wf.filter("This is a spoiler."))  # Output: This is a [SPOILER].

or

from wordfilter2 import WordFilter

wf = WordFilter(replace_with_func=lambda word: "[" + word.upper() + "]")
wf.add_word("spoiler")
print(wf.filter("This is a spoiler."))  # Output: This is a [SPOILER].

Working with Files

---

# Load words from a .txt file (one word per line)
wf.load_from_file("banned_words.txt")

# Save the current word list
wf.save_to_file("output_words.txt")

License

---

This project is licensed under the MIT License. See LICENSE.md for details.

---

Clean content made simple with wordfilter2.