wordfilter2 1.2.0

A simple word filter module for Python

WordFilter2

A powerful and customizable library for filtering profanity in Python.

Features

---

• Case-insensitive filtering
• Full or partial matching
• Custom replacement functions
• Load from local file or URL
• Supports multiple formats (txt, json)
• Normalize spaces in filtered output
• Optional duplicate word detection
• Find matched words in text
• Configurable timeout and size limits for remote files

Installation

---

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.

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 you can use built-in utils:

from wordfilter2 import WordFilter
from wordfilter2.utils import (mask_full, mask_partial, mask_first_last,
                               mask_censor, mask_custom)

wf = WordFilter(replace_with_func=mask_partial("#"))
wf.add_word("spoiler")

print(wf.filter("This is a spoiler."))  # Output: This is a s#####r.

Options

---

# Optional parameters:
wf = WordFilter(
    ignore_case=True,
    partial_match=True,
    replace_with="*",
    replace_with_func=None,
    normalize_spaces=True
)

Check for Profanity

---

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

Working with Files

---

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

# Load words from URL with timeout and size limit
wf.load_from_url("https://your_url/goes_here.json",  timeout=5, max_size=1024 * 1024)

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

License

---

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

---

Clean content made simple with wordfilter2.