概述
YAPF(Yet Another Python Formatter)是Google开源的一个用来格式化Python代码的工具。它的目标是生成的代码和遵循代码规范的程序员写出的代码一样。这意味着,如果你的代码已经是符合PEP8或Google风格指南的,那么YAPF将不会改变它。否则,它可能会进行一些调整,以使代码看起来更加整洁和一致。
功能
YAPF支持2种代码规范,PEP8和Google style。它不仅能将代码格式化为符合PEP8代码指南的格式,还能格式化为符合Google代码指南的格式。这使得你的代码更加漂亮,可读性更强。此外,YAPF还支持自定义的格式化风格,你可以通过配置文件来定义自己的代码格式化规则。
应用场景
YAPF不仅可以在命令行中使用,我们还可以在项目运行时使用。一个比较常见的场景是用户在你的web网站上提交了python代码,你希望能一键格式化这些代码,那将yapf作为格式化的模块则再好不过。此外,如果你在编写Python代码时,想要快速地将代码格式化为符合某种风格指南的格式,YAPF也是一个非常好的工具。
用法举例
- 安装yapf
在命令行中输入以下命令来安装yapf:
pip install yapf
- yapf的命令行参数
你可以在命令行中直接使用yapf,参数如下:
yapf [-h] [-v] [-d | -i | -q] [-r | -l START-END] [-e PATTERN] [--style STYLE] [--style-help] [--no-local-style] [-p] [-vv] [files ...]
其中:
-h, --help:显示帮助信息
-v, --version:显示程序的版本号
-d, --diff:打印格式化前后差异
-i, --in-place:格式化文件并替换
-q, --quiet:什么都不输出
-r, --recursive:在目录上递归运行
-l START-END, --lines START-END:重新格式化的行范围
-e PATTERN, --exclude PATTERN:需要排除的文件
–style STYLE:指定格式化样式(例如“pep8”或“google”)
-p, --parallel:并行格式化(多个文件时有效)
-vv, --verbose:在处理时打印出文件名
3. 使用yapf格式化代码
假设我们有一个名为1.py的文件,其中包含以下的混乱格式代码:
x = { 'a':37,'b':42, 'c':927}
y = 'hello ''world'
z = 'hello '+'world'
a = 'hello {}'.format('world')
class foo ( object ):
def f (self ):
return 37*-+2
def g(self, x,y=42):
return y
def f ( a ) :
return 37+-+a[42-x : y**3]
为了格式化它,我们可以在命令行中执行以下命令:
yapf -i 1.py
这样,1.py文件就被格式化了。
4. 作为模块使用yapf
YAPF还可以作为模块使用,例如:
from yapf.yapflib.yapf_api import FormatCode
formatted_code, changed = FormatCode("f ( a = 1, b = 2 )")
print(formatted_code) # 'f(a=1, b=2)\n'
print(changed) # True
你还可以传递style_config决定使用哪种指南做格式化:
from yapf.yapflib.yapf_api import FormatCode
print(FormatCode("def g():\n return True", style_config='pep8')[0]) # 'def g():\n return True\n'
欢迎关注我的公众号: