PEP 8-Python编码规范整理

学习.png

我是用Python的IDE:pycharm来编写Python代码的,用IDE编写代码有一个好处就是语法高亮,智能提示。Python的代码样式规范称之为PEP 8规范,每次编写代码如果有出现不符合PEP 8规范的话,pycharm就会提示我,就像下面这样:

image

上面的提示意思就是:语句后面跟注释的话至少要隔两个空格,而我只打了一个空格。

养成一个良好的编码习惯是非常重要的,因为代码是写给人读的,一手漂亮的代码看起来就是赏心悦目。在学习编程之初就要有意培养起良好的编码风格,这是很受益的。

于是我就特意整理了一下PEP 8规范中一些常用的准则,如果需要掌握更加详尽的Python代码规范,请看PEP 8的官方文档:

https://www.python.org/dev/peps/pep-0008/

一:代码布局

1 缩进:

每个缩进级别使用4个空格。

def __init__(self):
    """初始化属性"""
   self.new_urls = set()  # 未爬取的url集合
   self.old_urls = set()  # 已爬取的url集合

2 制表符or空格?

空格是首选的缩进方法。
Python 3不允许混合使用制表符和空格来缩进。
Python 2代码缩进与制表符和空格的混合应转换为使用空格专有。

有研究显示:使用空格缩进的程序员的薪资比使用制表符缩进的程序员的薪资多8%。所以一定要用空格缩进呀。

3 每行代码的最大长度:

将所有行限制为最多79个字符。
Python标准库是保守的,需要将行限制为79个字符(文档字符串/注释为72)。

4 空白行:

用两个空白行分隔顶层函数和类定义。
类中的方法定义用一个空行分隔。
可以使用额外的空白行(节省空间)来分隔相关功能组。在一堆相关的单行程序(例如一组虚拟执行程序)之间可能会省略空白行。
在函数中使用空行来节省逻辑部分。
恰当的使用空白行可以提高代码的可读性。

5 源文件编码:

核心Python发行版中的代码应该始终使用UTF-8(或Python 2中的ASCII)。
使用ASCII(Python 2)或UTF-8(Python 3)的文件不应该有编码声明。
但是在Python 2中使用UTF-8编码就需要有编码声明:

# -*- coding: utf-8 -*-
#! /usr/bin/env python2

上面两行代码常放在Python 2代码中的开头,第一行意思是指定源文件以utf-8格式编码,第二行意思是指定源文件的python解释器在环境变量中去寻找。

6 导入库函数:

若是导入多个库函数,应该分开依次导入:

import requests
import csv

导入总是放在文件的顶部,在任何模块注释和文档字符串之后,在模块全局变量和常量之前。

"""
一种简单的方式是使用模块json来存储数据
"""
# 使用函数json.dump()来存储数据# 函数json.dump()接受两个对象:要存储的数据以及可用于存储数据的文件对象
import json

numbers = [2, 3, 5, 7, 11, 13]
filename = "numbers.json"  # 使用文件扩展名.json来指出文件存储的数据为JSON格式with open(filename, "w") as file_object:  # 以写入模式打开文件
    json.dump(numbers, file_object)

导入应按以下顺序进行:
① 标准库导入
② 有关的第三方库进口
③ 本地应用程序/库特定的导入

import sys
import pygamefrom bullet 
import Bulletfrom alien 
import Alienfrom time 
import sleep

从包含类的模块中导入一个类时,通常可以这样写:

from settings import Settings
from ship import Ship
import game_functions as gf
from pygame.sprite import Group
from game_stats import GameStats
from button import Button
from scoreboard import Scoreboard

应避免通配符导入(import *),因为它们使名称空间中出现的名称不清楚

二:字符串

1 在Python中,单引号字符串和双引号字符串是相同的。这个PEP没有为此提出建议。

2 对于三引号字符串,常用三个双引号作文档字符串,文档字符串常用在模块的开端用以说明模块的基本功能,或紧跟函数定义的后面用以说明函数的基本功能,关于三引号字符串更多具体的细节,可以查阅其官方文档:

https://www.python.org/dev/peps/pep-0257/

三:表达式和语句中的空格
1 在以下情况下避免无关的空格:

① 在括号或大括号内:

Yes: spam(ham[1], {eggs: 2}) 
No:  spam( ham[ 1 ], { eggs: 2 } )

② 在尾随逗号和后面的右括号之间:

Yes: foo = (0,) 
No:  bar = (0, )

③ 在逗号,分号或冒号前面:

Yes: if x == 4: print x, y; x, y = y, x 
No:  if x == 4 : print x , y ; x , y = y , x

④ 紧接在开始函数调用的参数列表的开括号之前:

Yes: spam(1) 
No:  spam (1)

⑤ 紧接在开始括号之前,开始索引或切片:

Yes: dct['key'] = lst[index] 
No:  dct ['key'] = lst [index]

⑥ 在一个赋值(或其他)运算符周围有多于一个的空间来对齐它:

Yes:

x = 1 y = 2 long_variable = 3

No:

x             = 1 y             = 2 long_variable = 3

2 其他建议:

① 总是围绕这些二元运算符在两侧使用一个空格:

赋值(=),扩充赋值(+ =,- = 等),
比较(==,<,>,!=,<>,<=, > =,在,不在,是,是不是),
布尔值(和, 或,不)

② 用于指示关键字参数或默认参数值时,不要在=符号周围使用空格。

Yes:

def complex(real, imag=0.0):     return magic(r=real, i=imag)

No:

def complex(real, imag = 0.0):     return magic(r = real, i = imag)

四:注释

1 代码更改时,相应的注释也要随之更改。

2 块注释:块注释通常适用于后面的一些(或全部)代码,并缩进到与该代码相同的级别。块注释的每一行都以#和一个空格开始。

3 行注释:顾名思义就是对某一语句行进行注释,注释应该与语句至少隔开两个空格,用#和一个空格开始。

五:命名约定

1 采用描述性的命名规则,例如一个实现某种功能的类或函数,那这个类或函数的名字就以相应的功能实现作为命名,简单易懂。

2 类的命名采用驼峰命名法,即每个单词的首字母大写。

3 切勿将字符’l’(小写字母el),’O’(大写字母oh)或’I’(大写字母)作为单个字符变量名称。在一些字体中,这些字符与数字1和零是无法区分的。当试图使用“l”时,请使用“L”。

4 函数名称应该是小写的,为了提高可读性,必须使用由下划线分隔的单词。如果函数参数的名称与保留关键字冲突,通常最好追加一个尾部下划线,而不是使用缩写或拼写损坏。

更多具体的编码规范请查阅其官方文档:

https://github.com/python/peps/blob/master/pep-0008.txt

每天学习一点点,每天进步一点点.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269

推荐阅读更多精彩内容

  • 更新时间:2016/5/13 介绍 本文档所提供的编码规范,适用于主要的Python发行版中组成标准库的Pytho...
    超net阅读 5,806评论 0 15
  • Python是一种对代码风格很重视的语言,从缩进就能看出这一点,Python强调易于理解。最近在负责代码重构的工作...
    知曰阅读 10,495评论 1 85
  • --< > 令人讨厌的小人物身上有着愚蠢的一致性 --(A Foolish Consistency is the ...
    LittleWizard阅读 3,149评论 0 4
  • PEP介绍 PEP是 Python Enhancement Proposal 的缩写,是Python增强建议书的意...
    JasonDing阅读 4,749评论 3 40
  • 源地址:http://www.runoob.com/w3cnote/google-python-styleguid...
    skaiger阅读 496评论 0 0