PEP8文档:https://peps.python.org/pep-0008/

与空白有关的建议:

  用空格(space)表示缩进,而不要用制表符(tab)。

  和语法相关的每一层缩进都用4个空格表示。每行不超过79个字符。

  对于占据多行的长表达式来说,除了首行之外的其余各行都应该在通常的缩进级别之上再加4个空格。

  在同一份文件中,函数与类之间用两个空行隔开。

  在同一个类中,方法与方法之间用一个空行隔开。

  使用字典时,键与冒号之间不加空格,写在同一行的冒号和值之间应该加一个空格。

  给变量赋值时,赋值符号的左边和右边各加一个空格,并且只加一个空格就好。

  给变量的类型做注解(annotation)时,不要把变量名和冒号隔开,但在类型信息前应该有一个空格。

与命名有关的建议:

  函数、变量及属性用小写字母来拼写,各单词之间用下划线相连,例如:lowercase_underscore。

  受保护的实例属性,用一个下划线开头,例如:_leading_underscore。

  私有的实例属性,用两个下划线开头,例如:__double_leading_underscore。

  类(包括异常)命名时,每个单词的首字母均大写,例如:CapitalizedWord。

  模块级别的常量,所有字母都大写,各单词之间用下划线相连,例如:ALL_CAPS。

  类中的实例方法,应该把第一个参数命名为self,用来表示该对象本身。

  类方法的第一个参数,应该命名为cls,用来表示这个类本身。

与表达式和语句有关的建议:

  采用行内否定,即把否定词直接写在要否定的内容前面,而不要放在整个表达式的前面,例如应该写if a is not b,而不是if not a is b。

  不要通过长度判断容器或序列是不是空的,例如不要通过if len(somelist)== 0判断somelist是否为[]或''等空值,而是应该采用if not somelist这样的写法来判断,因为Python会把空值自动评估为False。

  如果要判断容器或序列里面有没有内容(比如要判断somelist是否为[1]或'hi'这样非空的值),也不应该通过长度来判断,而是应该采用if somelist语句,因为Python会把非空的值自动判定为True。

  不要把if语句、for循环、while循环及except复合语句挤在一行。应该把这些语句分成多行来写,这样更加清晰。

  如果表达式一行写不下,可以用括号将其括起来,而且要适当地添加换行与缩进以便于阅读。

  多行的表达式,应该用括号括起来,而不要用\符号续行。

与引入有关的建议:

  import语句(含from x import y)总是应该放在文件开头。

  引入模块时,总是应该使用绝对名称,而不应该根据当前模块路径来使用相对名称。例如,要引入bar包中的foo模块,应该完整地写出from bar import foo,即便当前路径为bar包里,也不应该简写为import foo。

  如果一定要用相对名称来编写import语句,那就应该明确地写成:from . import foo。

  文件中的import语句应该按顺序划分成三个部分:首先引入标准库里的模块,然后引入第三方模块,最后引入自己的模块。属于同一个部分的import语句按字母顺序排列。

PEP8风格检查:

  安装:pip3 install pycodestyle

  运行:pycodestyle xx.py

自动化PEP8风格:

  安装:pip3 install autopep8

  运行:autopep8 --in-place xx.py

pycharm使用autopep8:

  1,pip3 install autopep8

  2,pycharm配置中添加

  

  3,右键运行

  

  

Effective Python:第2条 遵循PEP 8风格指南的更多相关文章

  1. PEP8中文版 -- Python编码风格指南

    Python部落组织翻译, 禁止转载 目录      缩进      制表符还是空格?      行的最大长度      空行      源文件编码      导入      无法忍受的      其 ...

  2. python代码风格指南:pep8 中文版

    本文档所提供的编码规范,适用于主要的Python发行版中组成标准库的Python代码.请参阅PEP关于Python的C实现的C编码风格指南的描述. 本文档和PEP257(文档字符串规范)改编自Guid ...

  3. Effective Python之编写高质量Python代码的59个有效方法

                                                         这个周末断断续续的阅读完了<Effective Python之编写高质量Python代码 ...

  4. 《Effective Python:编写高质量Python代码的59个有效方法》读书笔记(完结)

    Effective Python 第1章 用Pythonic方式来思考 be pythonic 遵守pep8 python3有两种字符序列类型:bytes(原始的字节)和str(Unicode字符). ...

  5. (转)PEP 8——Python编码风格指南

    PEP 8——Python编码风格指南标签(空格分隔): Python PEP8 编码规范原文:https://lizhe2004.gitbooks.io/code-style-guideline-c ...

  6. [Effective Python] 用Pythonic方式来思考

    Effective Python chap.1 用Pythonic方式来思考 Pythonic: 一门语言的编程习惯是由用户来确立的. 1. 确认自己所使用的Python版本 2. 遵循PEP8风格指 ...

  7. 第2条:遵循PEP8风格指南

    <Python Enhancement Proposal #8>(8号Python增强提案)又叫PEP8,它是针对Python代码格式而编订的风格指南. 尽管可以在保证语法正确的前提下随意 ...

  8. Python字符进度条

    Python字符进度条 看看这个神奇的module from tqdm import trange from time import sleep for r in trange(10, 1, -1): ...

  9. Python的编码规范(PEP 8 & Google Python guide)

    PEP 8 Python 代码规范整理 click here Goole Python 风格指南 中文版 click here 大家有取舍的看吧. 因为文章不是原创的,所以只贴地址,给大家造成麻烦了, ...

  10. Effective Python 中文版

    如题,博主正在翻译一本Python相关的书. 图为Python作者. [美]Brett Slatkin的名作. Effective Python: 59 Specific Ways to Write ...

随机推荐

  1. vue使用cordova的大坑!!

    额,前段时间用 cordova 包了个 vue 项目,跑真机,完美.跑公司安卓系统虚拟机,垮. 原因找了很久,最后发现是路由的问题,使用了 createWebHistory ,去掉了 hash ,虽然 ...

  2. 搞清楚Promise.all的异常处理

    参考资料: https://www.jianshu.com/p/356f10ee476d https://blog.csdn.net/aaqingying/article/details/122966 ...

  3. 苹果AppleMacOs系统Sonoma本地部署无内容审查(NSFW)大语言量化模型Causallm

    最近Mac系统在运行大语言模型(LLMs)方面的性能已经得到了显著提升,尤其是随着苹果M系列芯片的不断迭代,本次我们在最新的MacOs系统Sonoma中本地部署无内容审查大语言量化模型Causallm ...

  4. clickhouse快速上手和问题记录

    clickhouse官方中文社区实战经验:手把手教你搭建单机clickhouse开发环境 我是用的是centOS7的虚拟机, 官方教程中的:sudo /etc/init.d/clickhouse-se ...

  5. stm32 使用多串口通信调试总结

    前记:   stm32使用多个串口通信,这个项目遇到了不少问题,值得反思和深入总结一下.   提纲:  这次的问题,主要有几个部分组成: A 多串口的DMA配置,这个需要注意,尽量不要使用同一个DMA ...

  6. tomcat报错Exception loading sessions from persistent storage解决方案

    现象:项目在重启时报错:严重: Exception loading sessions from persistent storage的问题.该问题的原因是tomcat的session持久化机制引起的, ...

  7. .gvfs 文件夹 异常

    PS:要转载请注明出处,本人版权所有. PS: 这个只是基于<我自己>的理解, 如果和你的原则及想法相冲突,请谅解,勿喷. 前置说明   本文作为本人csdn blog的主站的备份.(Bl ...

  8. 记录--你真的能区分JavaScript的各种导入导出方式吗?

    这里给大家分享我在网上总结出来的一些知识,希望对大家有所帮助 前言 我们在无论是在查阅别人的代码,还是在实际项目开发的过程中,肯定都会使用导入导出的功能,有时候我们会搞混这几种方式到底有什么区别,今天 ...

  9. 记录--Openlayers 高德腾讯、百度、天地图坐标相互转换

    这里给大家分享我在网上总结出来的一些知识,希望对大家有所帮助 在地图开发过程中,坐标的转换是很常用的功能,国内的话一般西安80(EPSG:4610).北京54(EPSG:2433)转WGS84比较多, ...

  10. C++简单实现unique_ptr

    唯一指针 管理指针的存储,提供有限的垃圾回收工具,与内置指针相比几乎没有开销(取决于所使用的删除程序). 这些对象具有获取指针所有权的能力:一旦它们获得所有权,它们就会通过在某个时候负责删除指向的对象 ...