Skip to main content

Pylint Plugin for enforcing boolean variable naming

Project description

Pylint Boolean Naming Checker

This is a pylint Checker to enforce variables with boolean results include common phrases implying True/False states.

Inspiration taken from here
Came across this [issue](https://github.com/pylint-dev/pylint/issues/9409) and thought it would be cool to try and do it myself.

How to Use

Install the package and then add it to the pylint runtime plugins.

# assuming git cloning until PyPI publish
git clone ...
cd pylint-boolean-naming
pip install .

# inside your code base
pylint --load-plugins pylint-boolean-naming \
    ... # other commands

Code Quality

Use pre-commit for general code quality and as a CI checker. This has hooks for: - MyPy - Ruff - Poetry

Contributing

We welcome all forms of contributions such as updates for documentation, new code, checking issues for duplicates or telling us that we can close them, confirming that issues still exist, creating issues because you found a bug or want a feature, etc. Everything is much appreciated!

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

pylint_boolean_naming-0.2.0.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

pylint_boolean_naming-0.2.0-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file pylint_boolean_naming-0.2.0.tar.gz.

File metadata

  • Download URL: pylint_boolean_naming-0.2.0.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.8 Linux/6.2.0-1019-azure

File hashes

Hashes for pylint_boolean_naming-0.2.0.tar.gz
Algorithm Hash digest
SHA256 6500037df64a12ce6bf19a27273770a1221877b96fd4b800b957e8ab67215fb9
MD5 0eff3c43d3979f701f8b0815621a6da2
BLAKE2b-256 60ed9a4e7e69e370ff19297ae4aa670ad79208d1ae4ff5088b465a42ff382808

See more details on using hashes here.

File details

Details for the file pylint_boolean_naming-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pylint_boolean_naming-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 623c52cddae65e56d64398081fd16b362ce019c32f8a2952840f7f679c20c473
MD5 7eb4c3e13946405c7b6bab84718767cf
BLAKE2b-256 cd4ae946609e76c081a0a6deabd8b1f8b3a6193bdc019ffb6c6758b00075f0f1

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