使用 pre-commit、flake8、black、isort、pylint 等简化行长度

Question

当使用多个检查或格式化 python 文件的工具时，有没有办法一次性设置行长度？

目前我有：

.flake8文件：

max-line-length = 120

.isort.cfg文件：

line-length = 120

.black文件：

line-length = 120

.pylintrc文件：

max-line-length = 120

Answer 1

如果您使用Poetry，可以在pyproject.toml文件中配置上述所有内容作为解决方法。

例如，我的项目如下所示：

[tool.black]
line-length = 130
target-version = ['py310']
include = '\.pyi?$'
exclude = '''
/(
    \.git
| \.hg
| \.mypy_cache
| \.tox
| \.venv
| _build
| buck-out
| build
)/
'''

[tool.flake8]
max-line-length = 130
extend-ignore = ["D203", "E203", "E251", "E266", "E302", "E305", "E401", "E402", "E501", "F401", "F403", "W503"]
exclude = [".git", "__pycache__", "dist"]
max-complexity = 10

[tool.isort]
atomic = true
profile = "black"
line_length = 130
skip_gitignore = true

它与.pre-commit-config.yaml文件结合在一起，分别在提交时启动每个工具：

[tool.black]
line-length = 130
target-version = ['py310']
include = '\.pyi?$'
exclude = '''
/(
    \.git
| \.hg
| \.mypy_cache
| \.tox
| \.venv
| _build
| buck-out
| build
)/
'''

[tool.flake8]
max-line-length = 130
extend-ignore = ["D203", "E203", "E251", "E266", "E302", "E305", "E401", "E402", "E501", "F401", "F403", "W503"]
exclude = [".git", "__pycache__", "dist"]
max-complexity = 10

[tool.isort]
atomic = true
profile = "black"
line_length = 130
skip_gitignore = true

在预提交钩子之外没有太多使用单独的 linter，但会认为它们在通过poetry shell或运行时的行为方式相同poetry run black --check --diff file_name.py。

Answer 2

添加到@pythoninthegrass \的答案：

\n

我经常使用的一种方法是使用cookiecutter生成项目样板代码生成项目样板代码，它允许使用 jinja 语法对所有实例进行模板化

\n

例如

\n

pyproject.toml

\n

[tool.black]\ntarget-version = ["py39"]\nline-length = {{ cookiecutter.line_length }}\n\n[tool.isort]\npy_version = 39\nline_length = {{ cookiecutter.line_length }}\n

\n

和你的cookiecutter.json文件

\n

{\n  "project_name": "python-project",\n  "line_length": 88\n}\n

\n

用你的例子

\n

.flake8文件：

\n

max-line-length = {{ cookiecutter.line_length }}\n

\n

.isort.cfg文件：

\n

line-length = {{ cookiecutter.line_length }}\n

\n

.black文件：

\n

line-length = {{ cookiecutter.line_length }}\n

\n

.pylintrc文件：

\n

max-line-length = {{ cookiecutter.line_length }}\n

\n

执行

\n

\n
• 我设置了一个简单的存储库以快速执行
\n

\n

max-line-length = {{ cookiecutter.line_length }}\n

\n

directory structure

\n

line-length = {{ cookiecutter.line_length }}\n

\n

\n
• cookiecutter 文档
\n

\n