Removes commented-out code.
Project description
eradicate removes commented-out code from Python files.
Introduction
With modern revision control available, there is no reason to save commented-out code to your repository. eradicate helps cleans up existing junk comments. It does this by detecting block comments that contain valid Python syntax that are likely to be commented out code. (It avoids false positives like the sentence this is not good, which is valid Python syntax, but is probably not code.)
Example
$ eradicate --in-place example.pyBefore running eradicate.
#import os
# from foo import junk
#a = 3
a = 4
#foo(1, 2, 3)
def foo(x, y, z):
# print('hello')
print(x, y, z)
# This is a real comment.
#return True
return FalseAfter running eradicate.
a = 4
def foo(x, y, z):
print(x, y, z)
# This is a real comment.
return FalseWhitelisting
False positives can happen so there is a whitelist feature to fix them shorthand. You can either add entries to the default whitelist with --whitelist-extend or overwrite the default with --whitelist. Both arguments expect a string of # separated regex strings (whitespaces are preserved). E.g. eradicate --whitelist "foo#b a r" filename Those regex strings are matched case insensitive against the start of the comment itself.
For the default whitelist please see eradicate.py.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file eradicate-2.0.0.tar.gz.
File metadata
- Download URL: eradicate-2.0.0.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 27434596f2c5314cc9b31410c93d8f7e8885747399773cd088d3adea647a60c8 |
|
| MD5 | 77d267ed74b40faa3526609f6be636b5 |
|
| BLAKE2b-256 | 2c6e0b737e2bc29f0f767ed0e92a734caf3ddf15f6b9d69f2f615e5ed94223b1 |
