format python 编码 python编码规范_第三方库


目前我们这边的自动化，大部分是以 Python 语言为主，但是经常发现，不同人的编写风格都不尽相同，所以我就给自己制定了一套规则，至少从我自己做起，保持自己的编码规范一致性。

下面所有的规范都是以实用为主，请按需取用。

1.类名使用驼峰式命名法，首字母要大写，比如：

  • class TestClass(object):
  • pass

2.方法和函数名全小写，并且使用下划线做连接符，命名最好清晰易懂，比如：

  • def read_file():
  • pass

3.尽量避免使用全局变量，如果必须使用，变量名字母必须全部大写，比如:

  • HOST = 127.0.0.1

4.所有的缩进都是要空格，每个 tab 代表 4 个空格；

5.可以使用括号把多行进行隐式链接，从而避免使用反斜杠，比如：

  • print('this is a very very very'
  • 'very very long simple')

6.顶级定义之间空两行, 方法定义之间空一行；

7.括号内不要有空格，比如：

  • def test_fun(param=false):
  • pass

8.每个导入独占一行，导入顺序：标准库、第三方库、自己实现库，比如：

  • import
  • import
  • import

9.单号注释使用 #，多行注释使用三双引号，比如：

  • """
  • 功能说明：
  • 这个函数是做测试用的
  • """
  • #this is a simple

10.除了注释使用双引号，其他引号优先使用单引号，比如：

  • def test_fun(param='apppath'):
  • test_str = 'simplepath'

11.函数或方法都需要加注释说明，注释内容包含功能说明、Args、Returns信息，比如：

  • def test_fun(param='apppath'):
  • """这是个测试函数
  • 这个函数是为了演示注释的格式
  • Args：
  • param：表示要传入的文件路径
  • Returns：
  • real_path：表示文件的真实路径
  • """
  • real_path = param
  • return


以上，Python 编码其实也没有特别统一的要求，就我看到的都有好几个版本，本次是结合个人使用习惯，同时参考 Google 的规范整理了一份简单版本，如果你有更好的建议，欢迎给我留言。