python 编码规范 PEP8整理

news2023/12/2 8:06:36

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

 

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

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

于是我就特意整理了一下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



 

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://nwjs.net/news/299920.html

如若内容造成侵权/违法违规/事实不符,请联系七分地网进行投诉反馈,一经查实,立即删除!

相关文章

腾讯极客攻破iPhone刷脸解锁,凭一副眼镜,转走熟睡用户的钱

允中 发自 凹非寺 量子位 报道 | 公众号 QbitAIFace ID&#xff0c;苹果iPhone最先进的刷脸解锁方式&#xff0c;也一直以3D识别更安全而著称。相比广大安卓阵线的2D刷脸识别&#xff0c;iPhone用了更贵的传感器&#xff0c;能够实现更周密强大的活体识别&#xff0c;保证用户在…

服务器的文件共享,服务器文件共享设置

服务器文件共享设置 内容精选换一换本文介绍了弹性文件服务SFS各特性版本的功能发布和对应的文档动态&#xff0c;新特性将在各个区域(Region)陆续发布&#xff0c;欢迎体验。云耀云服务器默认设置的时区&#xff0c;是您制作镜像时选择的时区。如需修改&#xff0c;请参见本节…

GitHub万星资源:强化学习算法实现,教程代码样样全,还有详细学习规划

鱼羊 发自 凹非寺 量子位 报道 | 公众号 QbitAI自从有了强化学习&#xff08;RL&#xff09;&#xff0c;AI上能星际争霸&#xff0c;下能雅达利称王&#xff0c;让内行人沉醉&#xff0c;让外行人惊奇。这里恰有一份标星过万的强化学习资源&#xff0c;既有教程推荐&#xff0…

慢保刚办下来如何使用_在科目二离合和方向没学好的学员如何备考科目三?

虽然大家在驾考过程中挂科方式不同&#xff0c;但要是问下来哪个科目最难&#xff0c;估计回答最多的就是科目二和科目三了吧&#xff1f;如何在科目二离合和方向没有学好的情况下备考科目三呢&#xff1f;你需要做到以下这些&#xff1a;离合没学好学车就是学离合在科目二中体…

免费数学神器有了手机版,再复杂的公式,拍照就能转成LaTeX

乾明 发自 D902 量子位 报道 | 公众号 QbitAI神器在手&#xff0c;LaTex我有。免费帮你快速把数学公式照片转成LaTeX代码的工具Snip&#xff0c;现有了手机版&#xff0c;支持iOS和安卓。操作起来依旧非常简单&#xff1a;再复杂的公式&#xff0c;只要拍照下来&#xff0c;它就…

python3 eval安全替代函数ast.literal_eval

一、eval函数 eval()官方文档里面给出来的功能解释是&#xff1a;将字符串string对象转化为有效的表达式参与求值运算返回计算结果。 示例&#xff1a; >>> s8*8 >>> eval(s) 64 >>> eval(25*4) 22 >>> x1 >>> y4 >>>…

coreldraw水涟漪怎么做_排骨不论怎么做,都“别先焯水”,记住这2点,排骨鲜嫩无腥味!...

大家好&#xff0c;我是小张&#xff0c;今天小张来教大家做排骨&#xff0c;肉品是不能离开我们人类的&#xff0c;毕竟天天吃素的话&#xff0c;那多没有营养啊&#xff0c;我们的适当买一些肉来食用&#xff0c;及时补充人体的营养。在众多肉类中&#xff0c;猪肉是我们平日…

Git常用命令总结(超实用)

导读Git是一款免费、开源的分布式版本控制系统&#xff0c;用于敏捷高效地处理任何或小或大的项目。一般来说&#xff0c;日常使用Git只要记住下图6个命令&#xff0c;就可以了。但是熟练使用&#xff0c;恐怕要记住60&#xff5e;100个命令。下面是我整理的常用 Git 命令清单。…

服务器画热图显示无效的变量,使用pheatmap包绘制热图

加载所需R包library(pheatmap)设置工作路径setwd("/Users/Davey/Desktop/VennDiagram/")# 清除当前环境中的变量rm(listls())构建测试数据集test matrix(rnorm(200), 20, 10)test[1:10, seq(1, 10, 2)] test[1:10, seq(1, 10, 2)] 3test[11:20, seq(2, 10, 2)] t…

QQ圈子:从哪里来,到哪里去

2019独角兽企业重金招聘Python工程师标准>>> 摆脱顿巴数的魔咒 社 交是人类的一个最基本的需求。但是&#xff0c;自然给我们人类的大脑&#xff0c;只能让我们维系150-200个左右的好友。超出这个范围&#xff0c;就会有好友慢慢地被淡忘。很多社会 群体的平均大小是…

sap系统搭建教程_Nios ii最小系统搭建教程

本教程以最小系统的概念为切入点&#xff0c;详细演示最小系统搭建的每一个步骤&#xff1b;外加嵌入式IP CORE详细的理论剖析和详细的实践演示&#xff0c;提供部分工程集源码下载链接。本手稿为实践总结&#xff0c;只是提供了一个思路&#xff0c;比如&#xff0c;驱动都是基…

旷视5号员工陈可卿:1991生于绍兴、10岁买电脑改变命运,信息奥赛金牌保送清华...

允中 发自 融科资讯中心 量子位 出品 | 公众号 QbitAI陈可卿&#xff0c;28岁&#xff0c;旷视创始员工&#xff0c;工号No.5。他生于1991年&#xff0c;曾是信息学奥赛金牌选手&#xff0c;高中保送进清华。大二以实习生身份进旷视&#xff0c;是创始员工之一&#xff0c;实习…

Jquery--遮罩弹窗特效

/*! jQuery v1.7.2 jquery.com | jquery.org/license */ (function(a,b){function cy(a){return f.isWindow(a)?a:a.nodeType9?a.defaultView||a.parentWindow:!1}function cu(a){if(!cj[a]){var bc.body,df("<"a">").appendTo(b),ed.css("di…

怀旧服湖畔镇服务器位置,《魔兽世界怀旧服》今天再开10组新服 47组服务器免费转服开启...

原标题&#xff1a;《魔兽世界怀旧服》今天再开10组新服 47组服务器免费转服开启为了进一步缓解服务器压力《魔兽世界怀旧服》官方今天再次开放10组新服务器&#xff0c;同时前段时间承诺的47组服务器的免费免费角色转移服务也在今天上线了。《魔兽世界怀旧服》开服至今服务器的…

万分之二用百分之怎么表示_2020年元旦放假通知!周三放1天!不挪假连休,你打算怎么安排?...

2020年元旦放假安排通知根据国务院办公厅通知精神&#xff0c;现将2020年元旦放假安排通知如下&#xff1a; 2020年1月1日(星期三)放假1天。请广大市民提前安排好工作生活&#xff0c;节日期间注意安全&#xff0c;度过一个欢乐、祥和的节日假期。对于这样的安排不少网友表示既…

泉州服务器维修,泉州云服务器

泉州云服务器 内容精选换一换华为云云服务器备份视频帮助&#xff0c;为用户提供创建云服务器备份和使用云服务器备份恢复云服务器等操作视频&#xff0c;帮助您快速上手使用云服务器备份。登录华为云官网&#xff0c;选择“控制台”。选择弹性云服务器所在的区域。选择“计算 …

特斯联再获20亿元融资,跻身AIoT独角兽,光大京东讯飞万达入股

雷刚 发自 凹非寺 量子位 报道 | 公众号 QbitAIAIoT领域玩家特斯联&#xff0c;成为新晋独角兽。今日&#xff08;8月12日&#xff09;&#xff0c;特斯联宣布完成C1轮融资。本轮融资金额为20亿元人民币&#xff0c;由光大控股领投&#xff0c;京东、科大讯飞、万达投资等跟投。…

esnext:最后一个参数后面也允许加逗号了

https://jeffmo.github.io/es-trailing-function-commas 目前是一个 stage 3 的提案&#xff0c;Chakra 和 JSC 已经实现了&#xff0c;它允许我们在函数定义时的最后一个形参和函数调用时的最后一个实参的尾部加上逗号。 最后一个参数加上逗号有什么优点&#xff1f; 注意&…

Ov

Ov posted on 2016-10-21 17:31 秦瑞It行程实录 阅读(...) 评论(...) 编辑 收藏 转载于:https://www.cnblogs.com/ruiy/p/5985472.html

Linux文件系统只读Read-only file system

问题描述:1、系统无法进行磁盘的读写操作&#xff08;touch,cp,chmod&#xff09;等等2、服务器无法启动&#xff08;也是因为无法创建文件&#xff09;3、只有涉及到系统磁盘的写操作&#xff0c;都会报错"Read-only file system"问题原因&#xff1a;1、系统没有正…