在Ubuntu系统中设置Python代码风格,你可以遵循以下步骤:
flake8
和black
:flake8
是一个用于检查Python代码风格的工具,而black
是一个自动格式化Python代码的工具。要安装它们,请打开终端并运行以下命令:
pip install flake8 black
.flake8
文件:在你的项目根目录下创建一个名为.flake8
的文件。这个文件将包含你的代码风格规则。例如,你可以添加以下内容:
[flake8]
max-line-length = 88
exclude = .git,__pycache__,dist
这将设置最大行长度为88个字符,并排除.git
、__pycache__
和dist
文件夹。
pyproject.toml
文件:pyproject.toml
文件用于配置Python项目的构建系统和依赖项。要创建此文件,请运行以下命令:
touch pyproject.toml
然后,使用文本编辑器打开pyproject.toml
文件,并添加以下内容:
[tool.black]
line-length = 88
target-version = ['py37'] # 根据你的Python版本进行修改
[tool.flake8]
max-line-length = 88
exclude = .git,__pycache__,dist
这将配置black
和flake8
使用相同的行长度。
flake8
和black
添加到pre-commit
钩子:pre-commit
钩子会在你提交代码之前自动运行flake8
和black
。要安装pre-commit
,请运行以下命令:
pip install pre-commit
接下来,在项目根目录下创建一个名为.pre-commit-config.yaml
的文件,并添加以下内容:
repos:
- repo: local
hooks:
- id: flake8
name: flake8
entry: flake8 --config=.flake8
language: system
types: [python]
- id: black
name: black
entry: black --config=pyproject.toml
language: system
types: [python]
这将配置pre-commit
钩子以在提交Python代码之前运行flake8
和black
。
pre-commit
钩子:运行以下命令以安装pre-commit
钩子:
pre-commit install
现在,每当你尝试提交Python代码时,flake8
和black
都会自动运行,以确保你的代码符合项目设定的风格。
注意:这些步骤适用于Python 3。如果你使用的是Python 2,请相应地修改配置文件。