PEP8编码规范(常用)

版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文链接： https://blog.csdn.net/gklcsdn/article/details/102315765

PEP8编码规范

1. 模块导入顺序

# 按标准库, 第三方库, 自定义库顺序, 中间空一行
import time
import re

import requests
from lxml import etree

from public.words.words import word_list
from conf.xb_account import account_list

2. 不要在一句import后导入多个库; 一个文件里的多个方法可以在一行

# 正确方式
import os
import sys
from public.operation_db import select_data, update_data, insert_data

# 错误方式
import os, sys

3. 命名

(1) 类名使用首字母大写(大驼峰命名)
(2) 函数名小写，如果想提高可读性可以用下划线分隔。
(3) 见名知意, 不要用拼音命名
(4) 不要使用关键字命名
(5) 文件名不要和模块名一样

4. 函数和方法参数

(1) 将 self 作为实例方法的的第一个参数。
(2) 将 cls 作为静态方法的第一个参数。

5. 空行

(1) 方法与方法之间空一行
(2) 类和模块导入之间空两行
(3) main和最后一个方法之间空两行
(4) 代码结尾空一行

6. 空格

在逗号, 分号, 冒号后面加一个空格, 末尾不要加空格

7. 注释

(1) 代码不是给你一个人看的, 一定要写注释
(2) 单行注释写在代码上方
(3) 多行注释用"""""", 不要用''''''

8. 缩进

缩进一律使用四个空格

9. 编码建议

(1) 开发过程中尽量不要使用面向过程写代码
(2) 尽量在每个py文件都加上脚本头
# coding: utf-8

后记：或许有人不认可代码的美学，认为代码写的丑没事，能跑起来就好。但是我始终认为，世间万物都应该是美好的，追求美好的脚步也不应该停止。祝大家都能写出漂亮的代码❤️❤️❤️