翻新

用于翻新和现代化Python代码库的工具。

例

# main.py

for filename in ["file1.txt", "file2.txt"]:
    with open(filename) as f:
        contents = f.read()

    lines = contents.splitlines()

    for line in lines:
        if not line or line.startswith("# ") or line.startswith("// "):
            continue

        for word in line.split():
            print(f"[{word}]", end="")

        print("")

运行：

$ refurb main.py
main.py:3:17 [FURB109]: Use `in (x, y, z)` instead of `in [x, y, z]`
main.py:4:5 [FURB101]: Use `y = Path(x).read_text()` instead of `with open(x, ...) as f: y = f.read()`
main.py:10:40 [FURB102]: Replace `x.startswith(y) or x.startswith(z)` with `x.startswith((y, z))`
main.py:16:9 [FURB105]: Use `print() instead of `print("")`

安装

在安装之前，建议你设置一个虚拟环境。

$ pip3 install refurb
$ refurb file.py folder/

注意：翻新仅支持蟒蛇 3.10。它可以检查Python 3.6代码及更高版本，但Refurb本身必须通过Python 3.10运行。

检查说明

你可以使用 ，其中 是你尝试查找的错误代码。例如：

refurb --explain FURB123

FURB123

$ refurb --explain FURB123
Don't cast a variable or literal if it is already of that type. For
example:

Bad:

```
name = str("bob")
num = int(123)
```

Good:

```
name = "bob"
num = 123
```

忽略错误

用于忽略错误 123。错误代码可以采用 或 的形式。此标志可以重复。

--ignore 123

FURB123

123

前缀表示这是一个内置错误。前缀是可选的，但对于所有其他错误（即 ），前缀是必需的。

FURB

FURB

ABC123

你还可以使用内联注释来禁用错误：

x = int(0)  # noqa: FURB123
y = list()  # noqa

此处，专门忽略该行的 FURB123 错误，并忽略该行上的所有错误。

noqa: FURB123

noqa

配置翻新

除了命令行参数之外，还可以在文件中添加设置。例如，以下命令行参数：

pyproject.toml

refurb file.py --ignore 100 --load some_module --quiet

对应于文件中的以下内容：

pyproject.toml

[tool.refurb]
ignore = [100]
load = ["some_module"]
quiet = true

现在，你需要键入的就是 ！提供命令行参数将覆盖配置文件中的任何现有设置。

refurb file.py

使用翻新

pre-commit

你可以通过将以下内容添加到文件中来将 Refurb 与预提交结合使用：

.pre-commit-config.yaml

  - repo: https://github.com/dosisod/refurb
    rev: REVISION
    hooks:
      - id: refurb

替换为你选择的版本或 SHA（或将其留空以查找最新的版本或 SHA）。

REVISION

pre-commit

插件

为翻新安装插件非常容易：

$ pip3 install refurb-plugin-example

其中 是插件的名称。翻新将自动加载任何已安装的插件。

refurb-plugin-example

要制作自己的翻新插件，请参阅翻新插件示例存储库以获取更多信息。

refurb gen

refurb gen

--debug

refurb --debug file.py

refurb/checks/

refurb file.py --load your.path.here

$ git clone https://github.com/dosisod/refurb
$ cd refurb
$ make install
$ make install-local

make

make black

make flake8

pytest

make test