遵循PEP8风格指南

整理来自 effective python

一 空白

  1 使用space来标识缩进,而不是tab

  2 和语法相关的每层缩进都使用4个空格

  3 每行的字符数不应该超过79

  4 对于多行的表达式,除了首行,其他行再缩进4个空格

  5 文件中的函数和类之间用两个空行隔开

  6 同一个类中,各个函数使用一个空行隔开

  7 在使用下标来获取元素,调用函数或者给关键字赋值的时候,不要再两旁添加空格

  8 为变量赋值的时候,赋值符号的左侧和右侧应该各自写上一个空格,而且只写一个就好

二 命名

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

  2 受保护的实例属性应该以一个下划线开头

  3 私有的实例属性应该以两个下划线开头

  4 类与异常,应该以每个单词的首字母大写来书写,CapitalizedWord

  5 模块级别的常量,所有字符均大写,单词之间使用下划线相连,ALL_CAPS

  6 类的实例方法(Instance method)应该把首个参数命名为self,以表示对象本身

  7 类方法(Class method)应该把首个参数命名为cls,以表示类自身

三 表达式和语句

  1 采用内联形式的否定词,而不是把否定词放在整个表达式的前面,例如 应该写if a is not b 而不是 if not a is b

  2 不要通过检查长度的办法(如 if len(somelist)==0) 来判定somelist是否为[] 或者‘’ 等空值,而应该采用 if not somelist这种写法来判断,它会假定:空值将自动评估为False

  3 检测somelist是否为[1]或者‘hi‘等非空值时,也该如此,if somelist 语句默认会把非空值判定为True

  4 不要编写单行if /for/ while/ except复合语句,而是应该把这些语句分成多行来写。

  5 import语句应该始终位于文件的开头

  6 引入模块的时候应该总是使用绝对名称,而不应该根据当前的路径来使用相对名称,例如,引入bar包中的foo模块时,应该完整地写出from bar import foo,而不应该简单写成import foo

  7 如果一定要以相对名称来编写import语句,那就采用明确的写法:from.import foo

  8 文件中的import语句应该按照顺序分成三个部分,分别表示标准库模块,第三方模块以及自用模块。在每一部分之中,各import语句应该按照模块的字母顺序来排列。

时间: 2024-10-29 11:16:00

遵循PEP8风格指南的相关文章

Effective Python 条目二:遵循PEP8风格规约

Python 增强建议#8,也被称为PEP8,是格式化Python代码的风格指引.只要符合语法,你可以随心所欲地写Python代码.然而,一致的风格使你的代码更加亲和与易于理解,及在一个大型社区中与其他Python程序员分享时促进协作.但是即使只有你自己一个人读你的代码,遵循这个风格规约将会使得以后修改起来更加容易. PEP8有一些列丰富的关于怎样去编写清晰干净的Python代码的细节.随着Python语言的演变,它将会持续更新.这是非常值得去阅读整个在线规约的(http://www.pytho

PEP8风格和python版本区别

python解释器 官方Cpython C语言开发,最广泛的Python解释器 IPython 一个交互式,功能增强的Cpython PyPy Python语言写的Python解释器,JIT技术,动态编译Python代码 Jython Python的源码编译成Java的字节码,跑在JVM上 IronPython 与Jython类似,运行在.Net平台上的解释器,Python代码被编译成.Net的字节码 版本区别 2.X和3.X区别 语句函数化,例如print(1,2)打印出1 2,但是2.x中意

PSR-2 代码风格指南

代码必须遵循“编码风格指南” PSR [PSR-1]. 代码必须使用4个空格缩进,而不是tab. 对一行的长度不能是一个硬性的限制:但对每一行必须限制在120字符之内,每一行应该80个字符或者更少. 在namespace声明之后必须有一个空行,在use声明之后也必须有一个空行. 类的打开的大括号必须在下一行,关闭大括号必须类的主体之后的下一行. 方法的打开的大括号必须在方法的下一行,关闭大括号必须在主体之后的下一行. 所有的属性和方法必须声明可见性:abstract和final必须在可见性声明之

python代码风格指南:pep8 中文翻译

摘要 本文给出主Python版本标准库的编码约定.CPython的C代码风格参见?PEP7.本文和?PEP 257 文档字符串标准改编自Guido最初的<Python Style Guide>, 并增加了Barry的?GNU Mailman Coding Style Guide的部分内容.本文会随着语言改变等而改变.许多项目都有自己的编码风格指南,冲突时自己的指南为准. 本文给出主Python版本标准库的编码约定.CPython的C代码风格参见PEP7. 本文和PEP 257 文档字符串标准改

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

本文档所提供的编码规范,适用于主要的Python发行版中组成标准库的Python代码.请参阅PEP关于Python的C实现的C编码风格指南的描述. 本文档和PEP257(文档字符串规范)改编自Guido的<Python Style Guide>一文,并从<Barry's style guide>添加了部分内容作为补充. 这篇风格指南随着时间的推移而逐渐演变,随着语言本身的变化,一些过去的约定已经过时,并确定了更多新的约定. 许多项目都有自己的编码风格指南.如果有任何冲突,优先使用该

Swift 编程风格指南(raywenderlich.com 版本)

官方 raywenderlich.com Swift 编程风格指南 本文版权归 raywenderlich.com .The Official raywenderlich.com Swift Style Guide项目以及所有贡献者所有.译者翻译仅供知识传播使用. 本风格指南的目标是让Swift代码更简洁.可读更强. 语言 推荐使用跟苹果API文档风格统一的英语. 推荐: var color = "red" 不推荐: var colour = "red" 空白 使用

来自 Google 的 R 语言编码风格指南

本文转自Xiao Nan的博客 R语言是一门主要用于统计计算和绘图的高级编程语言. 这份 R 语言编码风格指南旨在让我们的 R 代码更容易阅读.分享和检查. 以下规则系与 Google 的 R 用户群体协同设计而成. 概要: R编码风格约定 文件命名: 以 .R (大写) 结尾 标识符命名: variable.name, FunctionName, kConstantName 单行长度: 不超过 80 个字符 缩进: 两个空格, 不使用制表符 空白 花括号: 前括号不折行写, 后括号独占一行 赋

google C++编程风格指南之头文件的包含顺序

google C++编程风格对头文件的包含顺序作出如下指示: (1)为了加强可读性和避免隐含依赖,应使用下面的顺序:C标准库.C++标准库.其它库的头文件.你自己工程的头文件.不过这里最先包含的是首选的头文件,即例如a.cpp文件中应该优先包含a.h.首选的头文件是为了减少隐藏依赖,同时确保头文件和实现文件是匹配的.具体的例子是:假如你有一个cc文件(linux平台的cpp文件后缀为cc)是google-awesome-project/src/foo/internal/fooserver.cc,

Google Java编程风格指南(转)

目录 前言 源文件基础 源文件结构 格式 命名约定 编程实践 Javadoc 后记 前言 这份文档是Google Java编程风格规范的完整定义.当且仅当一个Java源文件符合此文档中的规则, 我们才认为它符合Google的Java编程风格. 与其它的编程风格指南一样,这里所讨论的不仅仅是编码格式美不美观的问题, 同时也讨论一些约定及编码标准.然而,这份文档主要侧重于我们所普遍遵循的规则, 对于那些不是明确强制要求的,我们尽量避免提供意见. 1.1 术语说明 在本文档中,除非另有说明: 术语cl