Python 语言的自动格式化工具

2023-02-28

代码工具格式

每种编程语言都有自己专属的格式化工具，比如golang语言的gofmt，JavaScript语言的prettier，php语言的php-cs-fixer，和这些编程语言类似，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]1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.

上面杂乱无章的代码经过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]
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.