python 程式碼格式化工具：YAPF

微微微笑發表於2015-12-25
Python

學習資料： https://github.com/google/yapf

 

背景

現在的大多數 Python 程式碼格式化工具（比如：autopep8 和 pep8ify）是可以移除程式碼中的 lint 錯誤。這顯然有些侷限性。比如：遵循 PEP 8 指導的程式碼可能就不會被格式化了，但這並不說明程式碼看起來就舒服。

但 YAPF 獨闢蹊徑。它脫胎於由 Daniel Jasper 開發的 clang-format。大體上來說，這個演算法獲取程式碼，然後把初始程式碼重新編排，即便初始程式碼並沒有違背規範，也可使其達到遵循程式碼規範的最佳格式。這個理念和 Go 語言中的 gofmt 工具相似，終結關於格式的各種“聖戰”。如果一個專案的程式碼庫，無論何時修改，通過 YAPF 優化後，程式碼風格可統一，在每次 code review 中，也就沒有必要爭論風格了。

YAPF 的終極目標是生成和遵循程式碼規範的程式設計師寫出的一樣的程式碼。可幫你減少維護程式碼的苦差事。

YAPF 支援 Python 2.7 和 3.4+。

安裝

#pip install yapf

 

用法 

usage: yapf [-h] [-v] [-d | -i] [-r | -l START-END] [-e PATTERN]
            [--style STYLE] [--style-help] [--no-local-style]
            [--verify]
            [files [files ...]]

Formatter for Python code.

positional arguments:
  files

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show version number and exit
  -d, --diff            print the diff for the fixed source
  -i, --in-place        make changes to files in place
  -r, --recursive       run recursively over directories
  -l START-END, --lines START-END
                        range of lines to reformat, one-based
  -e PATTERN, --exclude PATTERN
                        patterns for files to exclude from formatting
  --style STYLE         specify formatting style: either a style name (for
                        example "pep8" or "google"), or the name of a file
                        with style settings. The default is pep8 unless a
                        .style.yapf or setup.cfg file located in one of the
                        parent directories of the source file (or current
                        directory for stdin)
  --style-help          show style settings and exit
  --no-local-style      don't search for local style definition (.style.yapf)
  --verify              try to verify reformatted code for syntax errors

 

具體用法

使用yapf的兩種方式是： FormatCode 和 FormatFile

FormatCode的引數為程式碼內容。

>>> from yapf.yapf_api import FormatCode # reformat a string of code
>>> FormatCode("f ( a = 1, b = 2 )")
'f(a=1, b=2)\n'

我這邊 from yapf.yapf_api import FormatCode 會提示“from yapf.yapf_api import FormatCode”錯誤，但是“import yapf"是好的

本人的使用方式：

>>>import yapf
>>>yapf.yapf_api.FormatCode("f ( a = 1, b = 2 )")
('f(a=1, b=2)\n',True)

 

style_config引數：使用特定的style

style_config的值可以是一個格式樣式設定的檔案路徑，也可以是一個樣式名。

如果不進行定義的話，使用style.DEFAULT_STYLE_FACTORY設定的預設樣式。

>>> FormatCode("def g():\n return True", style_config='pep8')
'def g():\n return True\n'

 

lines引數：設定要應用樣式的特定行

>>> FormatCode("def g( ):\n a=1\n b = 2\n return a==b", lines=[(1, 1), (2, 3)])
'def g():\n a = 1\n b = 2\n return a==b\n'

print_diff引數：返回原始檔和更改後的檔案之間的diff 

感覺跟linux的diff很像，表示不習慣。

>>> print(FormatCode("a==b", filename="foo.py", print_diff=True))
--- foo.py (original)
+++ foo.py (reformatted)
@@ -1 +1 @@
-a==b
+a == b

 

FormatFile 的引數是檔案。

>>> from yapf.yapf_api import FormatFile

假設需要更改的原始檔是”foo.py”。

>>> print(open("foo.py").read()) #檢視檔案內容

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]

>>> FormatFile("foo.py")
('a == b\n', 'utf-8')

in_place引數：如果值為True的話，會直接用更改好的內容替代原始檔

>>> FormatFile("foo.py", in_place=True)
(None, 'utf-8')

相關文章