Python编码规范整理

Posted 大码王

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Python编码规范整理相关的知识,希望对你有一定的参考价值。

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




以上是关于Python编码规范整理的主要内容,如果未能解决你的问题,请参考以下文章

PEP8 python 编码规范整理

PEP8 Python 编码规范整理

PEP8 Python 编码规范整理

PEP8 Python 编码规范整理

PEP8 Python 编码规范整理

PEP8 Python 编码规范整理[转]