整理来自 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语句应该按照模块的字母顺序来排列。

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

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

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

  2. 遵循PEP8风格

    遵循PEP8风格 在编写python代码的时候我们应该采用统一的风格来编写代码,可以使代码更加容易读懂.采用和其他程序员统一的编码风格来写代码,也可以使项目更利于多人协作开发.即便代码只有你自己能看懂 ...

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

    摘要 本文给出主Python版本标准库的编码约定.CPython的C代码风格参见​PEP7.本文和​PEP 257 文档字符串标准改编自Guido最初的<Python Style Guide&g ...

  4. python的PEP8 代码风格指南

    PEP8 代码风格指南 这篇文章原文实际上来自于这里:https://www.python.org/dev/peps/pep-0008/ 知识点 代码排版 字符串引号 表达式和语句中的空格 注释 版本 ...

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

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

  6. Python PEP-8编码风格指南中文版

    #PEP 8 – Python编码风格指南 PEP: 8 Title: Style Guide for Python Code Author: Guido van Rossum , Barry War ...

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

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

  8. Python 编码风格指南

    原文:http://python.jobbole.com/84618/ 本文超出 PEP8 的范畴以涵盖我认为优秀的 Python 风格.本文虽然坚持己见,却不偏执.不仅仅涉及语法.模块布局等问题,同 ...

  9. R 语言编码风格指南

    R 语言是一门主要用于统计计算和绘图的高级编程语言.这份 R 语言编码风格指南旨在让我们的 R代码更容易阅读.分享和检查.以下规则系与 Google 的 R 用户群体协同设计而成. 概要: R编码风格 ...

随机推荐

  1. Python 进阶_OOP 面向对象编程_静态方法和类方法

    目录 目录 静态方法 类方法 使用函数修饰符来声明静态方法和类方法 静态方法 静态方法仅是类中的函数, 不需要绑定实例, 也就是说静态方法的定义不需要传入 self 参数. 静态方法不属于类的某一个实 ...

  2. Charles重发请求

    1.如下图 2.选中某个接口,右键--选择 Repeat Advanced选项,设置请求多次 3.

  3. CRF条件随机场在机器视觉中的解释

    CRF是一种判别模型,本质是给定观察值集合的马尔科夫随机场(MRF),而MRF是加了马尔科夫性质限制的随机场. 马尔科夫性质:全局.局部.成对 随机场:看做一组随机变量的集合(对应于同一个样本空间), ...

  4. OSX 创建 randisk(或称 tmpfs)

    创建步骤: #!/bin/bash ramdisk_size_in_mb= mount_point=/private/tmp ramdisk_size_in_sectors=$((${ramdisk_ ...

  5. docker安装中遇到的问题

    错误一 提示:Segmentation Fault or Critical Error encountered. Dumping core and aborting. Aborted 解答:安装错误安 ...

  6. java多态的实现机制

    Java提供了编译时多态和运行时多态两种多态机制.前者是通过方法重载实现的,后者是通过方法的覆盖实现的. 在方法覆盖中,子类可以覆盖父类的方法,因此同类的方法会在父类与子类中有着不同的表现形式. 在J ...

  7. Codeforces 1140C(贪心+堆)

    题面 传送门 题意: 给出长度为n的序列b,t,定义一个子序列的值为\(\min\{ b_i\} \times \sum t_i\),求所有子序列中值最大的一个,输出最大值 分析 假如固定某个b[i] ...

  8. 设计模式--简单工厂(Simple Factory)

    工厂模式是最常用的一种创建型模式,通常所说的工厂模式一般是指工厂方法模式.本篇是是工厂方法模式的“小弟”,我们可以将其理解为工厂方法模式的预备知识,它不属于GoF 23种设计模式,但在软件开发中却也应 ...

  9. 面试题:实现call、apply、bind

    面试题:实现call.apply.bind 实现bind module.exports = function(Tcontext, ...args) { let globalThis = typeof ...

  10. 记录Angular2.0学习遇到的问题

    最近开始学习Angular2.0,准备持续记录下踩过得坑 1如何读取本地json文件: 需要通过http请求读取本地json文件,数据文件要放在assets文件夹下面 Service中的代码如下:   ...