# flake8-eradicate
[](https://wemake-services.github.io)
[](https://github.com/wemake-services/flake8-eradicate/actions?query=workflow%3Atest)
[](https://codecov.io/gh/wemake-services/flake8-eradicate)
[](https://pypi.org/project/flake8-eradicate/)
[](https://pypi.org/project/flake8-eradicate/)
[](https://github.com/wemake-services/wemake-python-styleguide)
`flake8` plugin to find commented out (or so called "dead") code.
This is quite important for the project in a long run.
Based on [`eradicate`](https://github.com/myint/eradicate) project.
## Installation
```bash
pip install flake8-eradicate
```
It is also a valuable part of [`wemake-python-styleguide`](https://github.com/wemake-services/wemake-python-styleguide).
## Usage
Run your `flake8` checker [as usual](http://flake8.pycqa.org/en/latest/user/invocation.html).
Commented code should raise an error.
Example:
```bash
flake8 your_module.py
```
## Options
- `--eradicate-aggressive` to enable aggressive mode from `eradicate`, can lead to false positives
- `--eradicate-whitelist` to overwrite the whitelist from `eradicate` (`#` separated list)
- `--eradicate-whitelist-extend` to extend the whitelist from `eradicate` (`#` separated list)
## Error codes
| Error code | Description |
|:----------:|:------------------------:|
| E800 | Found commented out code |
## Output example
Here's how output looks like (we are using [`wemake` formatter](https://wemake-python-stylegui.de/en/latest/pages/usage/formatter.html)):
## License
MIT.
Raw data
{
"_id": null,
"home_page": "https://github.com/wemake-services/flake8-eradicate",
"name": "flake8-eradicate",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "flake8,plugin,linting,wemake.services,code quality",
"author": "Nikita Sobolev",
"author_email": "mail@sobolevn.me",
"download_url": "https://files.pythonhosted.org/packages/9e/72/a3975dfa4287396e9fb8fc2b4ee94a80d0809babbf92abed5af9c8e29c95/flake8_eradicate-1.5.0.tar.gz",
"platform": null,
"description": "# flake8-eradicate\n\n[](https://wemake-services.github.io)\n[](https://github.com/wemake-services/flake8-eradicate/actions?query=workflow%3Atest)\n[](https://codecov.io/gh/wemake-services/flake8-eradicate)\n[](https://pypi.org/project/flake8-eradicate/)\n[](https://pypi.org/project/flake8-eradicate/)\n[](https://github.com/wemake-services/wemake-python-styleguide)\n\n`flake8` plugin to find commented out (or so called \"dead\") code.\n\nThis is quite important for the project in a long run.\nBased on [`eradicate`](https://github.com/myint/eradicate) project.\n\n\n## Installation\n\n```bash\npip install flake8-eradicate\n```\n\nIt is also a valuable part of [`wemake-python-styleguide`](https://github.com/wemake-services/wemake-python-styleguide).\n\n\n## Usage\n\nRun your `flake8` checker [as usual](http://flake8.pycqa.org/en/latest/user/invocation.html).\nCommented code should raise an error.\n\nExample:\n\n```bash\nflake8 your_module.py\n```\n\n\n## Options\n\n- `--eradicate-aggressive` to enable aggressive mode from `eradicate`, can lead to false positives\n- `--eradicate-whitelist` to overwrite the whitelist from `eradicate` (`#` separated list)\n- `--eradicate-whitelist-extend` to extend the whitelist from `eradicate` (`#` separated list)\n\n\n## Error codes\n\n| Error code | Description |\n|:----------:|:------------------------:|\n| E800 | Found commented out code |\n\n\n## Output example\n\nHere's how output looks like (we are using [`wemake` formatter](https://wemake-python-stylegui.de/en/latest/pages/usage/formatter.html)):\n\n\n\n\n\n## License\n\nMIT.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Flake8 plugin to find commented out code",
"version": "1.5.0",
"project_urls": {
"Funding": "https://opencollective.com/wemake-python-styleguide",
"Homepage": "https://github.com/wemake-services/flake8-eradicate",
"Repository": "https://github.com/wemake-services/flake8-eradicate"
},
"split_keywords": [
"flake8",
"plugin",
"linting",
"wemake.services",
"code quality"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e2a91319b9e5eeb7d948f6db0b0ed4209bae0ec12d30ab3ee43a0ac1d8ce455f",
"md5": "beb8d8bcf1f27b152c6077cd1bdccda2",
"sha256": "18acc922ad7de623f5247c7d5595da068525ec5437dd53b22ec2259b96ce9d22"
},
"downloads": -1,
"filename": "flake8_eradicate-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "beb8d8bcf1f27b152c6077cd1bdccda2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 5144,
"upload_time": "2023-05-31T09:57:13",
"upload_time_iso_8601": "2023-05-31T09:57:13.589027Z",
"url": "https://files.pythonhosted.org/packages/e2/a9/1319b9e5eeb7d948f6db0b0ed4209bae0ec12d30ab3ee43a0ac1d8ce455f/flake8_eradicate-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e72a3975dfa4287396e9fb8fc2b4ee94a80d0809babbf92abed5af9c8e29c95",
"md5": "e2aca5337289e2279b3463365e2c0169",
"sha256": "aee636cb9ecb5594a7cd92d67ad73eb69909e5cc7bd81710cf9d00970f3983a6"
},
"downloads": -1,
"filename": "flake8_eradicate-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "e2aca5337289e2279b3463365e2c0169",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 4508,
"upload_time": "2023-05-31T09:57:15",
"upload_time_iso_8601": "2023-05-31T09:57:15.484650Z",
"url": "https://files.pythonhosted.org/packages/9e/72/a3975dfa4287396e9fb8fc2b4ee94a80d0809babbf92abed5af9c8e29c95/flake8_eradicate-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-31 09:57:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wemake-services",
"github_project": "flake8-eradicate",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flake8-eradicate"
}
JSON
