大部分人使用Python中的代碼格式化工具時都會選擇autopep8之類的工具，這些工具可能有一定的局限性，比如不會重新格式化已經符合 PEP8 的代碼。

而本文即將介紹的 Yapf，不僅能將代碼格式化為符合 PEP8 代碼指南的格式，還能格式化為符合 Google 代碼指南的格式，可選項更多，讓你的代碼更加漂亮。

1.準備

開始之前，你要確保Python和pip已經成功安裝在電腦上，如果沒有，可以訪問這篇文章：超詳細Python安裝指南 進行安裝。

**(可選1) **如果你用Python的目的是數據分析，可以直接安裝Anaconda：Python數據分析與挖掘好幫手—Anaconda，它內置了Python和pip.

**(可選2) **此外，推薦大家用VSCode編輯器，它有許多的優點：Python 編程的最好搭檔—VSCode 詳細指南。

請選擇以下任一種方式輸入命令安裝依賴 ：

1. Windows 環境 打開 Cmd (開始-運行-CMD)。
2. MacOS 環境 打開 Terminal (command+空格輸入Terminal)。
3. 如果你用的是 VSCode編輯器 或 Pycharm，可以直接使用界面下方的Terminal.

pip install yapf

YAPF 支持 Python 2.7 和 3.6.4+。

2.Yapf 使用方法

你可以在命令行中直接使用 Yapf, 參數如下：

yapf [-h] [-v] [-d | -i | -q] [-r | -l START-END] [-e PATTERN]
            [--style STYLE] [--style-help] [--no-local-style] [-p]
            [-vv]
            [files ...]

必選參數:

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 在處理時打印出文件名

舉個例子，如果我們有以下的混亂格式代碼 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

效果如下：

3.Yapf 作為模塊使用

Yapf 不僅可以在命令行中使用，我們還可以在項目運行時使用。

一個比較常見的場景是用戶在你的web網站上提交了python代碼，你希望能一件格式化這些代碼，那將yapf作為格式化的模塊則再好不過。

Yapf 最主要的兩個 API 是 FormatCode 和 FormatFile:

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 Truen'

FormatFile，這個函數可以從文件中讀取代碼并格式化：

from yapf.yapflib.yapf_api import FormatFile
print(open("foo.py").read())
# a==b
reformatted_code, encoding, changed = FormatFile("foo.py")
print(formatted_code)
# 'a == bn'
print(encoding)
# 'utf-8'
print(changed)
# True

如果你添加in_place參數，它將把格式化后的代碼寫回文件中：

from yapf.yapflib.yapf_api import FormatFile
print(FormatFile("foo.py", in_place=True)[:2])
# (None, 'utf-8')

print(open("foo.py").read())
# a == b