Python代码编写规范

Python代码编写规范

一、检查代码规范性的常用工具

1. 安装PEP8检查程序：pip install pycodestyle

二、Python代码布局规范

1. 缩进
   （1） 每一级缩进使用4个空格（首选）
   （2） 不允许同时使用空格和制表符的缩进
   （3） 制表符只能用于与同样使用制表符缩进的代码保持一致
   （4） 不要使用Tab缩进

2. 行的最大长度
   （1） 所有行限制的最大字符数为79
   （2）没有结构化限制的大块文本（文档字符或者注释），每行的最大字符数限制在72
   （3）需要保证在不拖动Pycharm滑动块的情况下能阅读代码
   （4）代码是在过长，推荐使用"（）"进行换行，而不是“\”

3. 插入空行
   （1）顶层函数和类的定义，前后用两个空行隔开
   （2）类里的方法定义用一个空行隔开
   （3）变量赋值和导入声明之间插入空行，分割语义

4. 代码保持紧凑
   （1）有关联的代码要保持紧凑
   （2）比如if和else之间没有必要插入空行
   （3）函数调用尽量放在一起

5. imports 导入
   （1）导入通常在分开的行
   例如：
   推荐：
   import os
   import sys
   不推荐：
   import sys, os
   （2）导入总是位于文件的顶部，在模块注释和文档字符串之后，在模块的全局变量和常量之前
   例如：
   from urlib import request, parse