Skip to main content

Removes commented-out code.

Project description

Build status

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.py

Before 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 False

After running eradicate.

a = 4

def foo(x, y, z):
    print(x, y, z)

    # This is a real comment.
    return False

Whitelisting

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.

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

eradicate-3.0.0.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

eradicate-3.0.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file eradicate-3.0.0.tar.gz.

File metadata

  • Download URL: eradicate-3.0.0.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for eradicate-3.0.0.tar.gz
Algorithm Hash digest
SHA256 b237d9f2309b181035d2a87b24385b4f11ab7bb858b75bff496964b5f453aa77
MD5 76e292925026a183f8a74507f913aebc
BLAKE2b-256 7234f902c21eaa96ce08342b51278861b1a921fabb6d4a5874189745111d3342

See more details on using hashes here.

File details

Details for the file eradicate-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: eradicate-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for eradicate-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 935af46a483c0d69baf155a9435ad847319389ba1c47cf2ee7196ca66dc586a2
MD5 81fe64b69fb1e3b5d6a5403c88287e20
BLAKE2b-256 ac6051234db342048b9dce2f2b8893db5c943f2be383e32a9f81fdcf177f0316

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page