PEP8 Python 编码规范整理

决定开始Python之路了,利用业余时间,争取更深入学习Python。编程语言不是艺术,而是工作或者说是工具,所以整理并遵循一套编码规范是十分必要的。所以今天根据PEP8整理了一份,以后都照此编码了,还会持续更新。

一 代码编排

1 缩进。4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格。

2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。

3 类和top-level函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。

二 文档编排

1 模块内容的顺序:模块说明和docstring—import—globals&constants—其他定义。其中import部分,又按标准、三方和自己编写顺序依次排放,之间空一行。

2 不要在一句import中多个库,比如import os, sys不推荐。

3 如果采用from XX import XX引用库,可以省略‘module.’,都是可能出现命名冲突,这时就要采用import XX。

三 空格的使用

总体原则,避免不必要的空格。

1 各种右括号前不要加空格。

2 逗号、冒号、分号前不要加空格。3 函数的左括号前不要加空格。如Func(1)。4 序列的左括号前不要加空格。如list[2]。5 操作符左右各加一个空格,不要为了对齐增加空格。6 函数默认参数使用的赋值符左右省略空格。7 不要将多句语句写在同一行,尽管使用‘;’允许。8 if/for/while语句中,即使执行语句只有一句,也必须另起一行。

四 注释

总体原则,错误的注释不如没有注释。所以当一段代码发生变化时,第一件事就是要修改注释!注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短语,可以省略结束符。

1 块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如:

# Description : Module config. # # Input : None # # Output : None

2 行注释,在一句代码后加注释。比如:x = x + 1 # Increment x但是这种方式尽量少使用。3 避免无谓的注释。

五 文档描述

1 为所有的共有模块、函数、类、方法写docstrings;非共有的没有必要,但是可以写注释(在def的下一行)。2 如果docstring要换行,参考如下例子,详见PEP 257

“””Return a foobang Optional plotz says to frobnicate the bizbaz first. “””

六 命名规范

总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。1 尽量单独使用小写字母‘l’,大写字母‘O’等容易混淆的字母。2 模块命名尽量短小,使用全部小写的方式,可以使用下划线。3 包命名尽量短小,使用全部小写的方式,不可以使用下划线。4 类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。5 异常命名使用CapWords+Error后缀的方式。6 全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是__all__机制;二是前缀一个下划线。7 函数命名使用全部小写的方式,可以使用下划线。8 常量命名使用全部大写的方式,可以使用下划线。9 类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。9 类的属性有3种作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。11 类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。12 为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。13 类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。

七 编码建议

1 编码中考虑到其他python实现的效率等问题,比如运算符‘+’在CPython(Python)中效率很高,都是Jython中却非常低,所以应该采用.join()的方式。2 尽可能使用‘is’‘is not’取代‘==’,比如if x is not None 要优于if x。3 使用基于类的异常,每个模块或包都有自己的异常类,此异常类继承自Exception。4 异常中不要使用裸露的except,except后跟具体的exceptions。5 异常中try的代码尽可能少。比如:

try: value = collection[key] except KeyError: return key_not_found(key) else: return handle_value(value)

要优于

try: # Too broad! return handle_value(collection[key]) except KeyError: # Will also catch KeyError raised by handle_value() return key_not_found(key)

6 使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。比如

Yes: if foo.startswith(‘bar’):优于No: if foo[:3] == ‘bar’:7 使用isinstance()比较对象的类型。比如Yes: if isinstance(obj, int): 优于No: if type(obj) is type(1):8 判断序列空或不空,有如下规则Yes: if not seq:if seq:优于No: if len(seq)if not len(seq)9 字符串不要以空格收尾。10 二进制数据判断使用 if boolvalue的方式。

(13)

相关推荐

  • 为什么你每次和开发沟通需求,都像打仗一样?

    今天不谈产品规划,也不谈框架,更不谈原型,咱们谈谈为什么你的需求每次和开发沟通,都像打仗一样?

    2017年4月21日
    2001
  • 微软IE浏览器正式退役

    爷青再次结,IE浏览器宣布一个月后退役,这个图标将成为历史。 什么时候开始,记忆中的东西正在以飞速消失流逝! 1995年8月,微软历史上最成功的操作系统之一: Windows 95,伴随着滚石乐队的《StartMe Up》横空出世。环境音乐大师布莱恩.伊诺( Brian Eno)创作的开机音乐也让大家至今依然耳熟能详。 作为Windows 95的默认浏览器,…

    2022年6月26日
    000
  • 支付宝余额提现收手续费了

    骚操作来了!划重点: 提现到银行卡免费,到有限额,比如卢松松的支付宝,每日限额5万元。 这个影响是比较大的: 看到有一些人说“这跟我又有什么关系呢?反正也没钱。”,怎么能这样想呢?万一哪天发财了呢? 希望在保证安全的前提下,不要过多限制支付宝,毕竟支付宝是民营,只有加入竞争者,银行的服务质量才有些许改变,真的很少见支付宝存款出现过安全隐患的。 我觉得这些应该…

    2022年6月26日
    000
  • 科大讯飞陈涛:人工智能时代,基础行业应用是中国企业的机遇

    陈涛表示,人工智能成功的三要素是核心算法、专家资源还有行业大数据。

    2017年4月17日
    303
  • 抖音开始打压抖音无货源商家

    抖音发布了一个重磅消息,大概意思是整顿打压抖音小店无货源的文件通告。通过文件阅读得知,可以肯定是是抖音这次针对的就是抖音小店的无货源商家,这对于很多做无货源的商家是一次颠覆性的事情。 最严重的会扣除违规所得货款,也就是说你抖音小店里的货款全部拿不回来。 事情的来龙去脉搞清楚了,那我们对症下药就行, 写在最后: 抖音的电商平台肯定是优质好货、好体验是平台立身之…

    2022年6月26日
    000
  • 10个步骤,了解新手入门过程的设计原则

    新手入门是每个应用程序最重要的元素之一。很多时候,它的难易程度决定了用户是否会继续使用应用程序。在用户界面上,新手入门不仅仅是简单的5个介绍软件的页面或说明性的工具提示内容。下面我会使用最有趣的例子来描述新手入门过程的设计原则。

    2017年4月17日
    501
  • 读《单天成交1w+的视频号带货蓝海项目》文章有感

    作者“摸渔之言”在卢松松博客投稿了一篇文章,叫《单天成交1w+的视频号带货蓝海项目》。文章的大意是:利用视频号的红利期去做短视频带货,通过爆款视频挂卖产品。 深度阅读了他的文章,写的确实不错,把操作思路都写出来了。操作方法: 按照作者的说法,已经有用利用这个方法日销售额1W+了。 卢松松也来说说我的看法,毕竟我也玩视频号1年多了,思路很简单,但真正要操作起来…

    2022年6月26日
    000
  • 跨境电商还能创业吗?

    今天挑这个话题来聊聊。据我了解,现在市面上大概有这么三类人想进入跨境赛道:工厂、手有余钱在找项目的、有经验的运营。 按照现在跨境电商的发展阶段,已经过了遍地黄金的时候了。从投资角度来看,DTC独立站成功率太低,亚马逊太重退出难,其实都不是好的标的了。所以这一两年的投资除了头部的几家独立站外,基本都集中在服务商上,如ERP等。 有人说不是有人在收亚马逊品牌吗?…

    2022年6月26日
    000
  • 蹭来的流量到底有用吗

    经常有人说博主蹭流量,那蹭来的流量到底有用吗?我作为一个资深运营和自媒体作者,今天奉上超级干货:流量详解! 首先流量分为商业流量和内容流量 商业(广告)流量分为公域流量和私域流量,公域流量主要来自淘宝天猫,京东,拼多多等开放型电商平台,也包括抖音快手小红书等内容平台等电商及广告。电商平台的流量自然是最值钱啦,因为用户就是来买东西的,这里面分为四大流量:搜索流…

    2022年6月26日
    000

发表评论

您的电子邮箱地址不会被公开。




联系我们

联系我们

156-6553-5109

在线咨询: QQ交谈

邮件:253000106@qq.com

工作时间:周一至周五,9:30-18:30

微信客服
微信客服
分享本页
返回顶部