规范

我们以PEP8 (opens new window)作为项目中的代码规范准则。为了饯行上述准则，我们引入以下工具帮助我们。

工具

flake8

我们使用 flake8 进行 pep8 规范检查，具体安装参阅：pycharm-guide/c08_15.md at master · imoyao/pycharm-guide (opens new window)

[flake8]
ignore = D401,D202,E226,E302,E41
max-line-length = 120
exclude = migrations/*,.git,__pycache__,old,build,dist
max-complexity = 10

• 扩展工具

# 配置
File / Settings / Tools / External Tools / Add
Name: Flake8
Program: $PyInterpreterDirectory$/python
Parameters: -m flake8 --max-complexity 10 --ignore E501 $FilePath$      # 自定义规则
Working directory: $ProjectFileDir$

Output Filters / Add
Name: Filter 1
Regular expression to match output:
$FILE_PATH$\:$LINE$\:$COLUMN$\:.*

Output Filters / Add
Name: Filter 2
Regular expression to match output:
$FILE_PATH$\:$LINE$\:.*

# 运行
Tools / External Tools / Flake8

Flake8 integrated with PyCharm (opens new window) Pycharm 配置使用 flake8 进行语法检测_张聪的博客-CSDN 博客 (opens new window)

isort

使用 isort 来解决自动导入的问题。下面一个我个人使用的配置，TODO:后期可能继续对比修改配置

[isort]
multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
balanced_wrapping = True
ensure_newline_before_comments = True
line_length = 120
known_flask = flask,flask_wtf,wtforms,flask_login,flask_bcrypt,flask_caching,flask_migrate,flask_sqlalchemy,flask_static_digest
known_test = pytest,webtest,factory
sections = FUTURE,STDLIB,FLASK,TEST,FIRSTPARTY,THIRDPARTY,LOCALFOLDER

include_trailing_comma = True的说明：

如果列表，元组或 python 字典的字面值分布在多行中，则更容易添加更多元素，因为不必记住在上一行中添加逗号。这些行也可以重新排序，而不会产生语法错误。

为什么 Python 在列表和元组的末尾允许使用逗号？ - 红皮橘子 - 博客园 (opens new window) 此外处理预提交时的配置中增加：

• 预提交配置 Pre Commit - isort (opens new window)
• IDE 配置 isort Plugins · PyCQA/isort Wiki (opens new window)

yapf

一种自动修复 pep8 错误的工具

[yapf]
based_on_style = pep8
spaces_before_comment = 2
split_before_logical_operator = true
BLANK_LINE_BEFORE_NESTED_CLASS_OR_DEF = true
COLUMN_LIMIT = 120

配置方案参考此处：How do I install yapf in pycharm · Issue #631 · google/yapf (opens new window)

mypy

Applying mypy to real world projects (opens new window)

pre-commit

# 安装
pip install pre-commit
# 安装 hook
pre-commit install
# 安装配置好后，最好做个全文的检查，修复问题
pre-commit run --all-files

项目管理：代码检查 pre-commit 使用详解_老五的作坊-CSDN 博客_pre-commit (opens new window)

相关阅读

我为什么不喜欢 black - 小明明 s à domicile (opens new window) How I use black, flake8 and isort to format Python2 code (opens new window)

配置可参考（TODO）： flask/setup.cfg at master · pallets/flask (opens new window) dkistdc / logging_config / setup.cfg — Bitbucket (opens new window) 延伸到 setup.py 的写法