逃离平庸

5200.3 Styling

2 min read

5200.3 Styling

PEP8规范

  • indentation - 用 4 个空格而不是 tab
  • line length - 79-character standard - 72 characters per line - OR 99characters limit
  • blank lines
    • group parts of program visually
    • 不要太多的空行，空行用来分割不同的业务代码
  • 符号之间要有一个空格
    • a = b

Styling Functions

  • 有描性的名字
  • 用小写字母和下划线相连
  • 模块名字也遵循这个规则
  • 每一个函数都应该有一个注释，立刻出现在方法定义后面，使用docstring 格式
  • 如果你指定默认的值，不要在=中间加空格。
def function_name(parameter_0, parameter_1='default value')
  • key arguments 也遵循同样的规则
  • 一行不要操作 79 个字符，如果超过，就在操作符之后加回车,下一行用tab开始。
def function_name(
        parameter_0, parameter_1, parameter_2,
        parameter_3, parameter_4, parameter_5):
    function body...
  • 多个函数用两个空白行隔开
  • 所有的 import 都要放到文件的开始

Styling Classes

  • 类名需要驼峰形式
  • 实例和模块名称要小写加下划线
  • 每个类在定义之后，要立即写一个docstring
  • 每一个模块要在第一行写一个docstring
  • 在类里面，用一个空白行区分方法
  • 在一个模块里面，用两个空白行去区分不同的类
  • import的时候，标准库放在上面， 自定义的模块放在下面，用一个空白行区分

Graph View