Python编码规范基本内容简介

开发 后端
Python编码规范是一个初学者在掌握这一编程语言之前必须要掌握的一个知识点。我们将会在接下来的文章中详细介绍这方面内容。

Python编程语言的应用,首先需要熟悉的是它的编码规范。那么接下来我们将会通过一些主要的方面来为大家详细解读一下Python编码规范的一些主要内容,希望给大家带来一些帮助,方便实际应用。#t#

编码

在Python编码规范中,所有的 Python 脚本文件都应在文件头标上 # -*- coding:utf-8 -*- 。设置编辑器,默认保存为 utf-8 格式。

注释

业界普遍认同 Python 的注释分为两种的概念,一种是由 # 开头的“真正的”注释,另一种是 docstrings。前者表明为何选择当前实现以及这种实现的原理和难点,后者表明如何使用这个包、模块、类、函数(方法),甚至包括使用示例和单元测试。

坚持适当注释原则。对不存在技术难点的代码坚持不注释,对存在技术难点的代码必须注释。但与注释不同,推荐对每一个包、模块、类、函数(方法)写 docstrings,除非代码一目了然,非常简单。

缩进

Python 依赖缩进来确定代码块的层次,行首空白符主要有两种:tab 和空格,但严禁两者混用。如果使用 tab 缩进,设定 tab 为 4 个空格。
公司内部推荐使用 4 个空格的 tab 进行缩进。

空格

空格在 Python 代码中是有意义的,因为 Python 的语法依赖于缩进,在行首的空格称为前导空格。在这一节不讨论前导空格相关的内容,只讨论非前导空格。非前导空格在 Python 代码中没有意义,但适当地加入非前导空格可以增进代码的可读性。

1) 在二元算术、逻辑运算符前后加空格:如 a = b + c;

2) 在一元前缀运算符后不加空格,如 if !flg: pass;

3) “:”用在行尾时前后皆不加空格,如分枝、循环、函数和类定义语言;用在非行尾时两端加空格,如 dict 对象的定义 d = {‘key’ : ’value’}。

4) 括号(含圆括号、方括号和花括号)前后不加空格,如 do_something(arg1, arg2),而不是 do_something( arg1, arg2 );

5) 逗号后面加一个空格,前面不加空格;s

空行

适当的空行有利于增加代码的可读性,加空行可以参考如下几个Python编码规范准则:

1) 在类、函数的定义间加空行;

2) 在 import 不同种类的模块间加工行;

3) 在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起,作为一个逻辑段落,段落间以空行分隔;

断行

尽管现在的宽屏显示器已经可以单屏显示超过 256 列字符,但本规范仍然坚持行的***长度不得超过 78 个字符的标准。折叠长行的方法有以下几种方法:

1) 为长变量名换一个短名,如:

this.is.a.very.long.variable_name = this.is.another.long.variable_name

应改为:

  1. variable_name1 = this.is.a.very.long.variable_name  
  2. variable_name2 = this.is.another.variable_name  
  3. variable_name1 = variable_name2s 

2) 在括号(包括圆括号、方括号和花括号)内换行,如:

  1. class Edit(CBase):  
  2. def __init__(self, parent, width,   
  3. font = FONTcolor = BLACKpos = POSstyle = 0): 

或:

  1. very_very_very_long_variable_name = Edit(parent, \  
  2. width, \  
  3. font, \  
  4. color, \  
  5. pos) 

如果行长到连***个括号内的参数都放不下,则每个元素都单独占一行:

  1. very_very_very_long_variable_name = ui.widgets.Edit( \  
  2. panrent, \  
  3. width, \  
  4. font, \  
  5. color, \  
  6. pos) 

3) 在长行加入续行符强行断行,断行的位置应在操作符前,且换行后多一个缩进,以使维护人员看代码的时候看到代码行首即可判定这里存在换行,如:

  1. if color == WHITE or color == BLACK \  
  2. or color == BLUE: # 注意 or 操作符在新行的行首而不是旧行的行尾  
  3. do_something(color); 

命名

一致的命名可以给开发人员减少许多麻烦,而恰如其分的命名则可以大幅提高代码的可读性,降低维护成本。

以上就是我们为大家介绍的有关Python编码规范的相关内容。

责任编辑:曹凯 来源: 博客园
相关推荐

2010-03-05 11:53:20

Python命名约定

2013-04-09 15:49:04

iOSSQLite基础内容简

2010-07-13 09:02:16

Perl

2010-01-28 10:07:52

C++手册

2010-01-04 15:21:37

Silverlight

2010-04-26 09:51:54

Oracle OCP

2010-04-22 09:36:56

Oracle数据字典

2010-01-28 15:33:37

Android程序架构

2010-02-25 15:49:05

WCF消息模式

2010-03-02 15:53:02

WCF服务合同

2017-10-25 06:50:27

数据科学数据数据分析

2010-02-25 17:51:04

WCF服务地址

2010-02-06 13:58:13

C++ Bost库

2010-02-05 10:08:55

C++名字空间

2010-02-04 15:51:07

C++迭代器

2010-03-02 17:55:37

WCF终结点地址

2010-03-15 13:35:25

Python GUI

2010-03-05 15:56:02

Python流程控制关

2010-04-12 12:52:54

WiMAX无线技术

2010-05-11 14:19:52

MySQL 5.0
点赞
收藏

51CTO技术栈公众号