• UID11822
  • 登录2017-03-02
  • 粉丝2
  • 关注0
  • 发帖31
  • 主页http://www.gooseeker.com/
  • 金币198枚
社区居民
原创写手
fullerhua 发布于2016-06-03 11:50
0/557

Python编程规范

楼层直达
1,Python编程规范

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

> 注释
业界普遍认同 Python 的注释分为两种,
  • 一种是由 # 开头的“真正的”注释,例如,用于表明为何选择当前实现以及这种实现的原理和难点
  • 另一种是 docstrings,例如,用于表明如何使用这个包、模块、类、函数(方法),甚至包括使用示例和单元测试
坚持适当注释原则。对不存在技术难点的代码坚持不注释,对存在技术难点的代码必须注释。但与注释不同,建议对每一个包、模块、类、函数(方法)写 docstrings,除非代码一目了然,非常简单。

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

>  空格
空格在 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) 不要在逗号、分号、冒号前面加空格,但应该在它们后面加(除了在行尾)
   6) 不要用空格来垂直对齐多行间的标记,因为这会成为维护的负担(适用于:,#,=等)

>  空行
适当的空行有利于增加代码的可读性,加空行可以参考如下几个准则:
   1) 在类、函数的定义间加空行;
   2) 在 import 不同种类的模块间加空行;
   3) 在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起,作为一个逻辑段落,段落间以空行分隔;

>  断行
尽管现在的宽屏显示器已经可以单屏显示超过 256 列字符,但本规范仍然坚持行的最大长度不得超过 80   个字符的标准。折叠长行的方法有以下几种方法:
   1) 为长变量名换一个短名,如:
this.is.a.very.long.variable_name = this.is.another.long.variable_name
       应改为:
variable_name1 = this.is.a.very.long.variable_name
variable_name2 = this.is.another.variable_name
variable_name1 = variable_name2s
   2) Python会将圆括号、中括号和花括号中的行隐式的连接起来,你可以利用这个特点。如需要,你可以在表达式外围增加一对额外的圆括号
   3) 在长行加入续行符强行断行,断行的位置应在操作符前,且换行后多一个缩进,以使维护人员看代码的时候看到代码行首即可判定这里存在换行,如:
if color == WHITE or color == BLACK \
    or color == BLUE: # 注意 or 操作符在新行的行首而不是旧行的行尾
do_something(color);

>  字符串
   1)  避免在循环中用+和+=操作符来累加字符串。由于字符串是不可变的,这样做会创建不必要的临时对象,并且导致二次方而不是线性的运行时间。作为替代方案,你可以将每个子串加入列表,然后在循环结束后用 .join 连接列表。(也可以将每个子串写入一个 cStringIO.StringIO 缓存中)
   2)  为多行字符串使用三重双引号而非三重单引号。不过要注意, 通常用隐式行连接更清晰,因为多行字符串与程序其他部分的缩进方式不一致。

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

>>  常量
常量名所有字母大写,由下划线连接各个单词,如
WHITE = 0XFFFFFF
THIS_IS_A_CONSTANT = 1

>>  变量
变量名全部小写,由下划线连接各个单词,如
color = WHITE
this_is_a_variable = 1
私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
变量名不应带有类型信息,因为 Python 是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。

>>  函数
函数名的命名规则与变量名相同。

>>  类
对类名使用大写字母开头的单词(如CapWords, 即Pascal风格),不使用下划线连接单词。如:
class ThisIsAClass(object):pass

>>  模块
模块名全部小写,对于包内使用的模块,可以加一个下划线前缀,如
module.py
_internal_module.py

>>  包
包的命名规范与模块相同。

>>  缩写
命名应当尽量使用全拼写的单词,缩写的情况有如下两种:
   1) 常用的缩写,如 XML、ID等,在命名时也应只大写首字母,如
class XmlParser(object):pass
   2) 命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式,如去除元音、包含辅音的首字符等方式,例如:
       function 缩写为 fn
       text 缩写为 txt
       object 缩写为 obj
       count 缩写为 cnt
       number 缩写为 num,等。

>>  特定命名方式
主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名,它的意义在于这种形式的变量是只读的,这种形式的类成员函数尽量不要重载。如
class Base(object):
    def __init__(self, id, parent =None):
        self.__id__ = id
        self.__parent__ = parent
    def __message__(self, msgid):
        # …略
其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。

>>  导入格式
   1) import 的次序,先 import Python 内置模块,再 import 第三方模块,最后 import 自己开发的项目中的其它模块;这几种模块用空行分隔开来。
   2) 每个import应该独占一行。
   3) 不要使用 from module import *,除非是 import 常量定义模块或其它你确保不会出现命名空间冲突的模块。

>  赋值
对于赋值语言,主要是不要做无谓的对齐,如:
a            = 1                               # 这是一个行注释
variable = 2                               # 另一个行注释
fn           = callback_function    # 还是行注释
没有必要做这种对齐,原因有两点:一是这种对齐会打乱编程时的注意力,大脑要同时处理两件事(编程和对齐);二是以后阅读和维护都很困难,因为人眼的横向视野很窄,把三个字段看成一行很困难,而且维护时要增加一个更长的变量名也会破坏对齐。直接这样写为佳:
a = 1 # 这是一个行注释
variable = 2 # 另一个行注释
fn = callback_function # 还是行注释

>  语句
通常每个语句应该独占一行。不过, 如果测试结果与测试语句在一行放得下, 你也可以将它们放在同一行。如果是if语句, 只有在没有else时才能这样做。特别地,绝不要对 try/except 这样做,因为try和except不能放在同一行。

2,参考资料

3,文档修改历史
2016-06-03:V1.0

0人打赏
您需要登录后才可以回帖
发表回复
极贡献
技术问答
专题荟萃
程序人生
视觉设计
Android开发
iOS开发
编程语言
前端开发
后端开发
服务器架构
软件测试
运维方案
创业路上



最热文章墙

  • 68872/364   【精品推荐】200多种Android动画效果的强悍框架,太全了,不看这个,再有动画的问题,不理你了^@^

  • 38951/190   情人节福利,程序员表白的正确姿势:改几行代码就变成自己的表白了

  • 36030/0   Python爬虫:常用浏览器的useragent

  • 35849/255   【精品推荐】Android版产品级的音乐播放器源码,功能太强大了,最好的产品原型有木有?

  • 35249/145   省时省力的Android组件群来了,非常棒的原型参考

  • 27847/2   超全!整理常用的iOS第三方资源

  • 26914/71   原创表白APP,以程序员的姿势备战新年后的7夕,持续完善中!

  • 26493/142   2016抢红包软件及源码

  • 21505/30   麻省理工的一帮疯子,真的实现了随意操控万物!(绝对黑科技)

  • 21163/25   Android工程师面试题大全

  • 20917/27   2016程序员跳槽全攻略

  • 20717/9   GitHub上排名前50的iOS项目:总有一款你用得着

  • 20546/155   Android版类似UC浏览器:非常赞,产品级的源码

  • 19791/20   码魂:程序员的牛B漫画

  • 18069/10   2016年最全的Android面试考题+答案 精编版

  • 17827/3   吐槽那些程序员的搞笑牛逼注释

  • 17082/42   一个绚丽的loading动效分析与实现!

  • 16887/85   Android小而全的博客源码:非常适合全面掌握开发技巧

  • 16842/73   【持续更新中】Android福利贴(二):资料源码大放送

  • 16801/1   iOS 动画总结

  • 16046/45   惊艳的App引导页:背景图片切换加各个页面动画效果

  • 15827/23   个人收集的Android 各类功能源代码

  • 15609/10   女程序员的梦,众网友的神回复

  • 15372/5   新一代Android渠道打包工具:1000个渠道包只需要5秒

  • 15310/11   年会上现场review代码是怎么样的体验!

  • 15224/81   仿京东商城客户端Android最新版,不错的原型和学习资料

  • 14826/53   基于瀑布流的美女图片浏览App,有注释的源代码

  • 14783/23   珍藏多年的素材,灵感搜寻网站

  • 14772/101   Android带弹幕的视频播放器源码,来自大名鼎鼎的Bilibili弹幕网站

  • 14697/17   用JavaScript 来开发iOS和Android 原生应用:React Native开源框架中文版来啦

  • 14625/20   Android福利第三波【Android电子书】

  • 14185/76   【精品推荐】类似360安全卫士安Android源码:非常赞的产品原型

  • 13907/0   iOS中文版资源库,非常全

  • 13840/15   基于Android支付宝支付设计和开发方案

  • 13805/18   65条最常用正则表达式,你要的都在这里了

  • 13309/17   什么是真正的黑客:收获12200+Stars,人气远超微软开源VS

  • 12960/11   有木有这样一张酷图帮你集齐所有git命令超实用

  • 12638/7   一张图搞定iOS学习路线,非常全面

  • 12577/7   用程序员的姿势抢过年的火车票

  • 12412/46   在线音乐播放器完整版(商用级的源码):非常赞,可听免费高品质专辑

  • 12280/10   成为Java顶尖程序员 ,看这11本书就够了

  • 12097/10   微信支付终于成功了(安卓,iOS),在此分享

  • 12012/18   一张图搞定Android学习路线,非常全面

  • 11851/0   GitHub iOS 库和框架Top100 

  • 11771/3   基于Node.js的强大爬虫,能直接发布抓取的文章哦

  • 11559/29   【持续更新中】Android福利贴(一):资料源码

  • 11557/61   【技巧一】搭配Android Studio,如何实现App远程真机debug?

  • 10976/4   46 个非常有用的 PHP 代码片段

  • 10858/3   即时通信第三方库

  • 10549/8   流媒体视频直播方案

  • 10407/9   B站建开源工作组:APP想支持炫酷弹幕的看过来

  • 10383/18   八个最优秀的Android Studio插件

  • 10270/9   烧了5亿美金,这家神秘的公司即将颠覆人类未来!

  • 10079/2   【精品推荐】高质量PHP代码的50个实用技巧:非常值得收藏

  • 10068/10   中国黑客的隐秘江湖:攻守对立,顶尖高手月入千万美元

  • 9492/6   开箱即用!Android四款系统架构工具

  • 9321/10   十大技巧快速提升Android应用开发性能

  • 9262/3   10款GitHub上最火爆的国产开源项目——可以媲美西半球

  • 9223/3   一张图看清Linux 内核运行原理

  • 9003/1   Android性能优化视频,文档以及工具

  • 返回顶部