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的方式。

本文来自投稿,不代表搜贷吧_网贷口子_新口子秒批贷款_好下款网贷口子_网贷口子发布平台立场,如若转载,请注明出处:https://www.soudai8.com/1717126.html

(13)

相关推荐

  • 抖音月付在哪还款?教你正确的还款方式

    要给抖音月付还款,详细的操作路径如下: 第一步、打开手机上的抖音APP,点击菜单栏的“我”,进入个人中心; 第二步、点击个人账户页面右上角的“≡”图标; 第三步、系统弹出右侧窗口,点击“我的钱包”选项; 第四步、点击“金融支付”栏目下的“抖音月付”选项; 第五步、进入“抖音月付”页面后,系统会显示下月待还金额,点击“提前还款”选项; 第六步、确认还款金额后点…

    2024年5月7日
    64
  • 大额信用贷款哪个平台好?这10个门槛低、高额低息、下款快

    比较好的大额信用贷款平台有: 1、度小满 开发商:度小满金融; 申请门槛:年龄18-55周岁的非在校学生,提供二代身份证、银行卡、手机号即可借款; 贷款额度:500-20万; 贷款利率:年化利率7.2%-24%; 下款速度:最快30秒审批、1分钟到账。 2、360借条 开发商:奇富科技; 申请门槛:年龄24-55周岁,凭身份证、银行卡、手机号即可申请; 贷款…

    2024年4月22日
    68
  • 借款平台关闭无法还款怎么办?试试这些方法

    借款平台关闭无法还款,可以采取如下措施:等待系统代扣、多渠道尝试还款、联系平台客服、联系债务接手机构、联系备案机构、留意平台的公告。 具体说明如下: 1、等待系统代扣 在申请贷款时,一般会与借款平台签订自动还款协议。因此,即便是借款平台关闭,但因为扣款协议仍然生效,仍可能会在还款日自动划扣。所以,用户只需确保银行卡内余额充足且卡片状态正常,等待系统自动代扣即…

    2024年4月18日
    79
  • 十大0抵押贷款平台排行榜:无面审、容易通过审核,下款率高

    根据希财网文章用户点击量作为参考依据,十大0抵押贷款平台排行榜中上榜的平台都是资质齐全、持牌运营、符合国家监管要求的合法平台。排名不分先后,不具备实际意义,仅供大家参考。 下面,来看看十大0抵押贷款平台排行榜有哪些平台上榜: 1、360借条 贷款额度:最高20万。 年化利率:7.2%-24%。 平台特点:免担保免抵押,凭借个人信用审核,没有面审环节。 2、洋…

    2024年4月16日
    109
  • 车抵押贷款条件及流程 全面了解车抵押贷款办理指南

    车抵押贷款条件主要包括以下几点: (一)借款人 1、年龄在18周岁及以上,具备完全民事行为能力; 2、在当地拥有有效居留身份(提供户口本或暂住证); 3、拥有稳定、合法的经济收入来源,具备按时偿还贷款本息的能力; 4、信用状况保持良好,个人征信报告中没有不良记录。 (二)抵押车辆 1、具有一定的价值空间; 2、车龄、行驶里程在规定范围内。 提醒: 不同金融机…

    2024年5月5日
    56
  • 借款软件app前十名:借款比较快,不用交会员费,好下款

    根据希财网文章总点击量作为参考依据,点击量较大的借款软件app前十名全都在这了。这些借款软件app全都资质正规、合法运营。本文章的排名不分先后,不具备实际意义,仅供参考。 借款软件app前十名(排名不分先后) 1、小红花 贷款条件:年龄26-55岁周岁。 贷款资料: 实名制手机号、二代有效身份证。 到账速度:当天下款、到账。 2、榕树贷款 贷款条件:年龄20…

    2024年3月22日
    56
  • 贷款哪个平台好?15家正规贷款平台名单

    一般经银监会批准成立,持有银监会核发的消费金融牌照或者互联网小贷牌照的贷款平台比较好,属于正规平台,接受银监会的监管,安全更有保障一些。 介绍15家正规贷款平台名单: 主要是根据希财网后台的产品申请量精选出来的,排名不分先后,仅供参考。 1、借钱呗 额度可高至20万元; 年化利率7.2%-24%; 线上智能审批,无抵押; 凭身份证+个人资料就能借。 2、小红…

    2024年3月22日
    105
  • 新手必看:借款平台哪个靠谱利息低?这10个网贷不容错过

    首先,靠谱的借款平台一般都经过银保监会的批准成立,接受银保监会的监管,持有正规的消费金融牌照或网络小贷牌照。 其次,利息低的借款平台所执行的利率通常最高不会超出高利贷的界定标准,即4倍LPR上限或24%的司法保护线。 下面根据希财网后台的关键词热度优选出10个靠谱利息低的借款平台(排名不分先后,仅供参考): 1、度小满 最高额度至20万元; 年化利率区间7….

    2024年4月23日
    68
  • 年底什么平台容易下款?盘点十大容易放款的借款平台

    年底容易下款的平台,可以说需要具备以下的特点: 1、知名大平台:平台的母公司是上市公司,或者平台放贷规模很大等,都可以证明平台的实力雄厚。实力雄厚的大平台一般资金充足,与其他平台相比更容易下款。 2、有成熟的审核体系:平台拥有自己成熟的审核体系,用户提交贷款申请后,一般是自动化审核。自动化审核的优势在于审核速度快,更加容易通过以及下款。 3、提供小额贷款服务…

    2024年4月29日
    80
  • 贷款年利率5%怎么算利息?一分钟搞懂

    知道贷款年利率如何计算利息,本文会用贷款年利率5%的计算案例来告知大家如何计算利息。 市场上常规的还款方式是等额本息以及按日计息,那么设计的计算案例如下: (1)A用户申请了10万贷款,贷款年利率5%,借款期限为一年,还款方式默认等额本息,计算借款一年的利息。 第1期:月供8560.75元,月供本金8144.08元,月供利息416.67元。 第2期:月供85…

    2024年4月15日
    94

发表回复

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