Skip to main content

Flake8 plugin to find commented out code

Project description

flake8-eradicate

flake8 plugin to find commented out (or so called "dead") code.

This is quite important for the project in a long run. This tool is based on eradicate project.

wemake.services Build Status Coverage Python Version PyPI version

Installation

pip install flake8-eradicate

Usage

Run your flake8 checker as usual. Commented code should raise an error.

We prefer not to raise a warning than to raise a false positive. So, we ignore --aggressive option from eradicate.

Error codes

Error code Description
E800 Found commented out code

Output example

» flake8 tests/fixtures/incorrect.py
tests/fixtures/incorrect.py:1:1: E800: Found commented out code:
--- before/tests/fixtures/incorrect.py
+++ after/tests/fixtures/incorrect.py
@@ -1,16 +1,10 @@

 class Some(object):
-    # property_name = 1
     other_property = 2


-# def function_name():
-#     return None


-# class CommentedClass(object):
 #     def __init__(self) -> None:
-#         self.property = None

 #     def __str__(self) -> str:
-#         return self.__class__.__name__

License

MIT.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
flake8_eradicate-0.1.1-py3-none-any.whl (5.6 kB) Copy SHA256 hash SHA256 Wheel py3
flake8-eradicate-0.1.1.tar.gz (4.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page