Skip to main content

better_profanity

A Python library to clean swear words in strings.

release python license

Inspired from package profanity of Ben Friedland, this library only supports English language and is much faster than the original one, by using string comparison instead of regex.

Requirements

To make use of Python static tying, this package only works with Python 3.6+.

Note for non-English words

Due to the library's algorithm, it (now) only supports ASCII characters.

Words, such as аушвиц and หญิงชาติชั่ว, will fail to be checked.

Usage

By default, on the first .censor() call, profanity initializes a set of words, from profanity_wordlist.txt, to be used to compare against the input texts. This set of words will be stored in memory (~5MB+).

1. Censor swear words from a text

By default, profanity replaces each swear words with 4 asterisks ****.

from better_profanity import profanity

if __name__ == "__main__":
    text = "You p1ec3 of sHit."

    censored_text = profanity.censor(text)
    print(censored_text)    # You **** of ****.

2. Censor swear words with custom character

4 instances of the character in second parameter in .censor() will be used to replace the swear words.

from better_profanity import profanity

if __name__ == "__main__":
    text = "You p1ec3 of sHit."

    censored_text = profanity.censor(text, '-')
    print(censored_text)    # You ---- of ----.

3. Check if the string contains any swear words

from better_profanity import profanity

if __name__ == "__main__":
    dirty_text = "That l3sbi4n did a very good H4ndjob."

    profanity.contains_profanity(dirty_text) # True

4. Censor swear words with a custom wordlist

The provided list of words will replace the default wordlist.

4 instances of the character in second parameter in .censor() will be used to replace the swear words.

from better_profanity import profanity

if __name__ == "__main__":
    text = "You p1ec3 of sHit."

    custom_badwords = ['happy', 'jolly', 'merry']
    profanity.load_censor_words(custom_badwords)

    print(profanity.contains_profanity("Fuck you!"))
    # Fuck you

    print(profanity.contains_profanity("Have a merry day! :)"))
    # Have a **** day! :)

Metadata

Release files for better-profanity 0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for better-profanity 0.2
File Size Uploaded Provenance Actions
better_profanity-0.2.tar.gz 5.4 kB Without provenance Details for better_profanity-0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for better-profanity 0.2
File Interpreter ABI Platform Actions
better_profanity-0.2-py3-none-any.whl Python 3 none any Details for better_profanity-0.2-py3-none-any.whl

Total release size: 13.2 kB

Release files / better_profanity-0.2.tar.gz

Download URL better_profanity-0.2.tar.gz
Size 5.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a19d37a9a843b82cdc2b1fdfe5cee18dfebd56f07231526c1f6ff865e1a1138f
BLAKE2b-256 checksum
How to use checksums
ac7d72b78a12fec4ec2e8d803e70d0078b76d0a928de1fc159273d04b3dd764f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3

Release files / better_profanity-0.2-py3-none-any.whl

Download URL better_profanity-0.2-py3-none-any.whl
Size 7.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
974e5920770469fd1b0e8cb84bd60c5f5fe1faa69a912276e1dd89304168567b
BLAKE2b-256 checksum
How to use checksums
a37013660cc0702cc7c7779fea87e7c49930b8f849651b16b45faff546156d74
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3

Security for better-profanity 0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page