跳转到主要内容

删除注释掉的代码。

项目描述

Build status

eradicate 从 Python 文件中删除注释掉的代码。

简介

随着现代修订控制技术的可用性,没有理由将注释掉的代码保存到您的仓库中。 eradicate 帮助清理现有的垃圾注释。它通过检测包含有效 Python 语法且可能被注释掉的代码的块注释来实现。 (它避免了诸如 这不是好的 这样的误报,这是一个有效的 Python 语法,但可能不是代码。)

示例

$ eradicate --in-place example.py

在运行 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

在运行 eradicate 之后。

a = 4

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

    # This is a real comment.
    return False

白名单

假阳性可能会发生,因此有一个白名单功能来修复它们。您可以使用--whitelist-extend将条目添加到默认白名单,或者用--whitelist覆盖默认设置。这两个参数都期望一个由#分隔的正则表达式字符串序列(空白将被保留)。例如:eradicate --whitelist "foo#b a r" 文件名 这些正则表达式字符串将与注释本身的起始部分进行不区分大小写的匹配。

有关默认白名单,请参阅eradicate.py

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装软件包的信息。

源代码分发

eradicate-2.3.0.tar.gz (8.5 kB 查看哈希值)

上传时间: 源代码

构建分发

eradicate-2.3.0-py3-none-any.whl (6.1 kB 查看哈希值)

上传时间: Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面