Python格式化工具yapf使用说明

YAPF (Yet Another Python Formatter)是Google开源的一个用来格式化Python代码的工具. 支持2种代码规范

• PEP8
• Google style

安装（Ubuntu 14.04）###

$ sudo pip install yapf

常用命令###

• 直接跟文件名（并不修改文件）

$ yapf <python file>

源文件.png yapf格式化后的文件.png

• 格式化前后对比

$ yapf -d <python file>

yapf对比效果.png

• 直接修改源文件

$ yapf -i <python file>

• 导出配置文件

$ yapf --style-help > style.cfg

• 自定义配置文件并使用

此例为将缩进由4个空格改为2个空格

$ yapf --style-help > my_style.cfg
$ sed -i "s/indent_width=4/indent_width=2/" my_style.cfg
$ yapf --style my_style.cfg loops.py

缩进为2个空格.png

• 其它用法
  • 在代码中控制是否使用yapf

# yapf: disable
<code will not be formatted>
# yapf: enable

部分代码不进行格式化.png

• 并发格式化多个文件，需要futures模块支持

$ yapf -pi *.py

更多用法请参考###

$ yapf -h

https://github.com/google/yapf
https://pypi.python.org/pypi/yapf