Python 語言的自動格式化工具

作者：夢回丶故里 2023-01-07 23:24:00

如果你公司或者你正在使用 python 進行項目的開發，那么選擇一款代碼格式化工具是非常必要的，它可以讓你的開發團隊節省大量時間。而且無論是你的個人代碼還是其他人的代碼格式看起來都是一樣的，這樣每個人閱讀其他人的代碼都會是一件幸福的事情。

每種編程語言都有自己專屬的格式化工具，比如 golang 語言的 gofmt，JavaScript 語言的 prettier，php 語言的 php-cs-fixer，和這些編程語言類似，python 也有自己的自動化格式工具，不過不同的是，它有很多個格式化工具，接下來我們就來看看這些不同的格式化工具究竟有什么不同。

autopep8

這個是最早的 python 格式化代碼工具，它采用 pycodestyle 來分析代碼，然后對于不符合 pep 風格的代碼進行修復。同時，它還會修復一些已經棄用的代碼，并且規范代碼的結尾，對于一些方法和函數添加一些空行分隔符。

autopep8 是支持通過配置文件進行格式化聲明的，它支持。cfg，.ini .pep8 .flake8 等格式的配置文件。目前他在 github 上有 4200 多個點贊。

yapf

這是一個谷歌推出的格式化工具，因為有大廠背書，所以它發展的很快，目前在 github 上有 13000 個點贊。他不會檢查 pep 準則，它只會格式化代碼。它采取的是類似于??clang-format??的思想，就是讀取整個文件代碼，然后格式化成最佳的格式。

它是一個可配置的代碼格式方案，不同的配置會導致不同的格式化結果，目前主流的配置有 pep8,google,facebook,chromium 等。此外，它還支持自定義配置方案，通過??--style??即可指定格式樣式。

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??格式化后，就會變得很規整，更加容易閱讀。

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]