python 小知识 - 代码规范最佳实践

2022 年 7 月 23 日
本文字数：996 字
阅读完需：约 3 分钟

好的代码规范可以提高团队和项目的开发和维护以及协作的效率。

而代码风格检测工具可以检测代码是否符合规范，代码格式化工具可以帮助自动排版代码。使用时可以跳过检测，直接使用格式化工具。

1.代码风格检测工具

Flake8 是由 Python 官方发布的一款辅助检测 Python 代码是否规范的工具，Flake8 检查规则灵活，支持集成额外插件，扩展性强。

安装：pip install flake8

# 单个文件python -m flake8 --max-line-length=100 file.py输出 file.py:212:101: E501 line too long (114 > 100 characters) # 整个项目，在项目根目录下运行python -m flake8 --max-line-length=100输出会列出每个文件的问题

复制代码

可以把参数存成配置文件，避免每次都写一遍参数。配置文件命名为".flake8"，放在项目根目录下或用户目录下，配置如下：

[flake8]ignore = F401max-line-length = 100

复制代码

然后运行命令就可以省去相应的参数设置。

vscode 设置里搜索“flake8”，如下设置：

会自动执行检测，如果有问题会有提示，修改完提示自动消失：

pycharm 设置参考

https://blog.csdn.net/crazy_zhangcong/article/details/87860276

2.代码格式化工具

yapf 是 google 提供的 python 代码格式化工具。详见：https://github.com/google/yapf

安装：pip install yapf

命令行方式配置文件“~/.config/yapf/style”如下设置：

[style]BASED_ON_STYLE = pep8COLUMN_LIMIT = 100

复制代码

格式化运行命令：

# 单个文件yapf -i file.py 或 python -m yapf -i file.py  # -i 表示in-place，在原文件上改动。 # 整个项目，在项目根目录下运行yapf -i -r .

复制代码

vscode 设置里搜索“yapf”，格式化工具选择 yapf，如下设置：

使用时，打开“视图”→“命令面板”，选择运行“Format Document”，当前文档自动格式化。这个命令有相应的快捷键：

pycharm 打开 pycharm，转到 file->settings->Plugins

格式化代码，打开菜单 Code，然后单击”Reformat Code with YAPF“

3.代码注释配置

File -> Settings -> Tools -> Python Integrated Tools -> Docstrings -> Docstring formats

def download_from_url(url):    """    download file from url, such as image or video    Args:        url: http://www.xxxx/xx.jpg     Returns:     """    response = requests.get(url, stream=True)    if response.status_code == requests.codes.ok:        return response.content    else:        return None