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)

相关推荐

  • 组合贷款如何先还商业贷款?最全攻略来袭(含流程、注意事项)

    组合贷款先还商业贷款的流程如下: 1、提前预约 提前还商业贷款,不是直接带钱到银行就可以办理,通常需要提前1个月进行预约,与银行协商还贷时间。在预约的同时,用户可向银行工作了解提前还贷的规定,做好相关的准备工作。 2、准备材料 需要准备的材料有:借款人身份证原件、还款卡、房贷合同。若是委托他人代办,还需提供代办人的有效身份证明及委托授权书。 3、提出申请 用…

    5天前
    14
  • 想借钱可各个平台都被拒了怎么办?8招轻松破解

    想借钱可各个平台都被拒了,下面分享8招破解方法: 1、申请小额贷款 可能大家会疑惑,之前各个平台都被拒了,咋又去平台上贷款呢? 注意,这种小额贷款是指额度非常低的贷款,比如支付宝备用金贷款额度500,小鹅花钱额度5万,WE支付备用金额度10000这种。 贷款额度越低,申请门槛就越低,审核标准就越宽松,这样用户通过审核的概率会增加。 2、申请民间借贷 借钱各个…

    5天前
    11
  • 2024保证能通过的网贷!不存在,盘点10个通过率高的正规平台

    2024保证能通过的网贷不存在,原因是: 1、网贷门槛虽然较低,但不意味着一定能通过。为了控制借贷风险,网贷平台仍会从多个维度评估用户的资质,若综合评估不通过,贷款申请将被拒。 2、“保证能通过”多半是噱头,一旦相信,就可能被不良机构割韭菜,甚至面临诈骗,从而给自身带来一定的经济损失。 因此,2024保证能通过的网贷不存在。当然,市面上还是存在不少高通过率的…

    2024年3月22日
    15
  • 网贷逾期多久会被起诉?这些因素说了算

    网贷逾期多久会被起诉,需要具体情况具体分析,具体如下: 1、看平台政策 网贷平台不同,在贷后管理的政策上也存在不同。比如有的声称逾期超过3个月就会起诉,有的则表示逾期超过6个月会起诉。 一般来说,逾期3个月是一个分水岭,平台要么考虑委托外部机构继续进行催收,要么则直接走法律诉讼程序。 2、看逾期金额大小 若逾期金额较小,比如只欠了几百块钱,考虑到起诉成本高于…

    2024年3月22日
    15
  • 急用钱私人借钱5000无需审核?假的!盘点快速放款平台

    急用钱私人借钱5000无需审核多半不靠谱。 详细解释如下: 一般正规的借款平台都需要经过审批才会放款,无需审核直接放款的借款平台基本是不存在的。 虽然的确有一些私人借钱平台门槛很低,提供一些个人信息即可申请借款,但也还是需要验证身份才会提供资金。 所谓的“无需审核”,大抵只是一个幌子,目的主要是吸引客户办理贷款,最终能否批款还是得看系统综合评估结果。 而宣传…

    4天前
    16
  • 征信有逾期怎么恢复?分享实用三招

    征信有逾期想要恢复,建议从如下几个方面出发: 1、尽快结清逾期欠款 若是已经发生逾期,需要尽快安排还款,减轻逾期所带来的负面影响。若逾期欠款一直不去处理,不仅会产生更多的逾期费用,而且会导致征信变黑,今后很难从正规平台获贷。 2、保持按时还款 每月按时还款,可以避免逾期的发生,同时为自身累积良好的还款记录,用好的记录去覆盖不良记录。一般来说,只要坚持2年,逾…

    2024年3月21日
    36
  • 借钱应急的软件无抵押,这10个征信花也能轻松借钱!

    借钱应急的软件无抵押,有很多网贷平台都符合要求,关键要选择正规靠谱的平台,才能保证借款资金和个人信息安全。 本文以根据希财网贷款文章总访问量、月访问量作为参考依据,挑选了10个借钱应急的软件,都是持牌金融机构放款,且门槛低,征信花也能轻松借钱,排名不分先后顺序,仅供参考,具体如下: 借钱应急的软件无抵押 1、哈哈贷 哈银消费金融公司持牌经营,具备放贷资格 无…

    2024年3月22日
    18
  • 2024放水的贷款口子:10大好通过的借钱平台

    2024放水的贷款口子有一些,这些贷款口子的门槛较低,容易申请,一般提供个人基本信息(比如身份证、手机号、银行卡)即可借款。 系统提示审批通过就能放款了,往往申请当天就能出结果,要是效率高的话,最快几分钟内放款到账的情况也是有的。 不过需要注意的是,并不存在一申请就直接下款的贷款口子,100%通过率肯定是不可能的,平台必须得经过审批才会批款。 下面列举一些2…

    5天前
    19
  • 一份简单的外包项目产品方案模板

    和内部项目的方案不同,外部项目(外包或者合作)的受众群体是客户,所以应该更加侧重于对产品功能、技术的展示。今天整理外部项目产品方案模板,给可能需要做外包项目的产品经理们。

    2017年4月17日
    2.2K
  • 小农户也能贷款!教你轻松申请农村创业贷款

    农村创业贷款,可按以下流程办理: 一、选择适合的贷款机构 农村信用社贷款、农村合作社贷款、农村商业银行贷款等都能提供农村创业贷款,具体如下: 1、农村信用社贷款:通常对本地农民提供小额贷款,利率较低,审批速度快。 2、农村合作社贷款:由当地合作社提供,通常需要成为合作社成员才能申请贷款。 3、农村商业银行贷款:通常提供更大额的贷款,但审批流程可能较复杂。 二…

    5天前
    12

发表回复

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