flake8-comments
Report redundant comments in python code.
An example of a bad comment:
# create user
user.create(force=True)
In this example, the comment gives even less information that the code itself. So, you can safely remove the comment without losing any information. The goal is to reduce the information redundancy, leaving in the code only what is actually important and helpful.
Installation
python3 -m pip install flake8-comments
Usage
Check that plugin was added in your flake8:
$ python3 -m flake8 --version
3.7.7 (flake8-comments: 0.1.0, mccabe: 0.6.1, pycodestyle: 2.5.0, pyflakes: 2.1.1) CPython 3.6.7 on Linux
If you don't see flake8-comments in the previous command output, check that flake8 and flake8-comments is installed in the same interpreter.
If everything is OK, run flake8:
python -m flake8 example.py
Similar projects
There are a few more good flake8 plugins targeted on cleaning up comments:
- flake8-eradicate detects commented out code.
- flake8-todos controls consistency of TODO comments.
- wemake-python-styleguide has a few checks targeted on comments, like if there are empty comments, too many
noqa,no cover, bad shebangs.
1 maintainer
Metadata
1 maintainer
Release files for flake8-comments 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| flake8-comments-0.1.2.tar.gz | 5.3 kB | Without provenance | Details for flake8-comments-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| flake8_comments-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for flake8_comments-0.1.2-py3-none-any.whl |
Total release size: 10.5 kB
Release files / flake8-comments-0.1.2.tar.gz
| Download URL | flake8-comments-0.1.2.tar.gz |
|---|---|
| Size | 5.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
780b4fc2820ed4ff8a0a98f3fc993f776ede1aecbe0c6cec64d93814b21c9234
|
|
BLAKE2b-256 checksum How to use checksums |
83383d8706aea09d9bfb22ea3a7f9d04e11090aaa21711051d2f688695ef5892
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.25.1
|
Release files / flake8_comments-0.1.2-py3-none-any.whl
| Download URL | flake8_comments-0.1.2-py3-none-any.whl |
|---|---|
| Size | 5.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
42250cb4a51dc59e6db25f1291cfb16b78ea233f72dac32a5bc7b09c691235ea
|
|
BLAKE2b-256 checksum How to use checksums |
9b324e4ad1131cf7d2aff04f6dbce80c74a2a39ac290acf4870d343879e5b2bf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.25.1
|
Security for flake8-comments 0.1.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.
