Skip to main content

replace Inflammatory words like blacklist and slave with more appropriate words

Project description

flake8-Inflammatory-jargon

A flake8 plugin that checks your code for inflammable words like blacklist, whitelist,master, etc.. and suggests to replace them with more appropriate words

What Inflammatory language is?

Inflammatory language is a form of speech that is used with the intent to stir up emotions, elicit anger, or invoke a physical reaction. Name calling is one form, but the use is generally wider in scope, in the sense that it is used to attack, oppress, or denigrate groups of people, or focus hate or anger on a public figure. (rationalwiki)

Warnings

This package adds 1 new flake8 warning

  • IJU100: inflammatory jargon detected, consider switching %inflammatory word% with %appropriate word%

Installation

If you don't already have it, install flake8::

$ pip install flake8

Then, install the extension::

$ pip install flake8-Inflammatory-jargon

Usage

Run the following to verify that the plugin has been installed correctly::

$ flake8 --version
2.0 (pep8: 1.4.6, flake8-Inflammatory-jargon: 1.0.0, pyflakes: 0.7.3)

Now, when you run flake8, the plugin will automatically be used.

Extending the inflammatory jargon

flake8-Inflammatory-jargon is highly extensible and built to easily allow the addition of more inflammable words and matching replacements suggestions. All you need to do is to open data/inflammatory_words.json and add inflammatory words together with their appropriate replacement suggestions

Contributing

  1. Clone
  2. Add more inflammatory words & replacement suggestions the data/inflammatory_words.json file
  3. Type pip install -e . in order to test your changes (I am using pytest)
  4. Submit a PR

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8-Inflammatory-Jargon-1.0.1.tar.gz (5.2 kB view details)

Uploaded Source

File details

Details for the file flake8-Inflammatory-Jargon-1.0.1.tar.gz.

File metadata

  • Download URL: flake8-Inflammatory-Jargon-1.0.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.8.6

File hashes

Hashes for flake8-Inflammatory-Jargon-1.0.1.tar.gz
Algorithm Hash digest
SHA256 2fe0491de63de0e8a02eb57f07c664a4213d452a50b30588751a8e61a6010d45
MD5 54bbb52a5e039a9c7fb5da7e0764b5d5
BLAKE2b-256 df9f766d6f4af50a70c909b2261caeeb95c06f14897e004a163f07790e47a623

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page