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)

相关推荐

  • 18岁网贷平台哪个借款好审批?分享10个18岁能借款的软件

    借款平台需要符合18岁能借款、好审批的要求,需要满足以下条件: 1、最低借款年龄为18岁:网贷平台设置的借款年龄为满18周岁且具备完全民事行为能力的中国公民。 2、全程由系统自动审批:系统初步评估给出授信额度,提交贷款申请后,系统二次评估给出审批结果。系统审批拥有审批速度快、通过率高的优势,因此系统自动审批的网贷平台比较好通过。 18岁网贷平台哪个借款好审批…

    2024年4月26日
    405
  • 十大好借的小额贷款app:比较容易贷款,好通过,能借到钱

    小额贷款app比较好借的,一般是比较容易贷款、好通过、能借到钱的。这类贷款app通常具有以下特点: 1、申请门槛低:普遍是信用贷款,不需要担保、抵押就可以申请。不需要纸质材料,在线填写基本个人信息就可以获取额度。 2、系统自动审批:系统初步审核用户的个人信息,通过初步审核用户可以获得授信额度。提交贷款申请后,系统再次进行审核。第二次审核是终审,通常会查询用户…

    2024年4月19日
    168
  • 网贷有逾期还能下款吗?盘点十个要求低的网贷平台

    若网贷只是轻微逾期,如逾期金额小,逾期时间较短,并且已经结清的话,还是有机会获得贷款的。下面介绍一些要求较低的网贷平台,仅供参考: 1、小红花 背景:南京天下捷融互联网科技小额贷款; 贷款额度:2万元-20万元; 贷款利率:年化利率7.2%起; 放款速度:最快30秒审批,最快1分钟到账; 贷款期限:支持3-36期; 申请年龄:26-55周岁。 2、蚂蚁借呗 …

    2024年5月6日
    168
  • 信用卡怎么用提高额度快?分享6个提额技巧

    若想快速提升信用卡额度,建议从如下几个方面出发:多元化用卡消费、适当分期、补充财力证明、保持良好的信用记录、增加与发卡行的业务往来、确保负债率不高。 具体说明如下: 1、多元化用卡消费 日常可以多使用信用卡消费,并且在不同场景中去使用信用卡,比如购车、旅游、百货等,向银行展示自己的消费能力,将能更快提高信用卡额度。 注意: 千万不要将信用卡用于违规领域,比如…

    2024年4月16日
    204
  • 花户和黑户也能放款的平台不存在!2024花户借钱的平台大盘点

    市场上的借款平台,花户申请是能下款的,因为大多数平台对于借款人的征信查询次数并没有严格要求。至于黑户,借款平台都不会放款。黑户属于征信严重不良的用户,大部分平台对于征信严重不良、大数据有问题的的情况,均为不放款的态度。 黑户需要先征信或者大数据的问题,之后再尝试申请借款。 因此,花户和黑户也能放款的平台不存在。但是,只是征信查询次数多属于征信花户,那么可以借…

    2024年3月21日
    2.3K
  • 2024年最新银行经营贷款产品盘点(背景、利率、额度、期限等)

    根据各银行网站资料为大家整理并盘点2024年最新银行经营贷款产品的背景、利率、额度和授信期限,以上排名不分先后: 1、信捷贷 背景:中信银行(全国性股份制商业银行) 贷款利率:基准利率浮动,最低4.15%起 贷款额度:最高1000万(质押贷、抵押贷),最高500万(保证贷)、最高200万(信用贷) 授信期限:授信期限根据贷款性质授予,最长10年 面向群体:贷…

    2024年5月6日
    316
  • 盘点10个评分不足可以下的口子:综合评分要求低,借钱通过率高

    我们在申请网贷时,网贷审批结果有时候会出现评分不足、综合评分不足的提示。评分不足其实是指用户的信用资质条件,经过放贷机构的审核,未通过其审核标准。这时候,综合评分不足意味着用户无法申请当前的贷款。 但是,评分不足的时候,其实用户仍然可以申请其他的贷款。具体的原因是: 1、不同的网贷平台审核标准、风控模型不同,用户只要不申请同一个公司旗下的产品就行。比如,用户…

    2024年4月16日
    281
  • 信用不好在哪可以贷几万?这10个容易出款

    只要不是存在严重不良记录,且当前无逾期,信用不好也有机会贷几万的平台有: 1、水滴融 开放商:哈尔滨市元丰小贷; 申请条件:年龄22周岁以上、芝麻分650+; 贷款额度:1万-20万; 贷款利率:年化利率7.2%-24%。 2、洋钱罐 开放商:瓴岳科技; 申请条件:年龄23-50周岁,凭真实资信信息即可申请; 贷款额度:1万-20万; 贷款利率:日利率0.0…

    2024年4月23日
    204
  • 21岁哪里能贷1万?精选10个口碑平台:持牌、额度高、利率低

    只要资信状况良好,21岁可以贷1万的平台很多,下面列举10个: 1、度小满 开发商:度小满金融; 放贷牌照:网络小贷牌照; 年龄要求:18-55周岁,适合21岁借款; 贷款额度:500-20万,资信好贷1万问题不大; 贷款利率:年化利率7.2%-24%。 2、微粒贷 开发商:微众银行; 放贷牌照:民营银行牌照; 年龄要求:年满18周岁; 贷款额度:500-2…

    2024年5月22日
    198
  • 网贷平台大全列表(名称、利息、是否上征信)

    市场上的正规网贷平台有几千家,本文主要是介绍那些资质齐全、正规的网贷平台。网贷平台大全列表主要盘点15家网贷平台,并且会附上网贷平台的名称、利息以及上征信情况。 网贷平台大全列表(15家) 1、360借条 利息:年化利率7.2%-24%。 是否上征信:是。 平台特点:累计注册用户2亿+,安全性较好。 2、度小满 利息:年化利率7.2%-24%。 是否上征信:…

    2024年5月6日
    1.2K

发表回复

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