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.hujinzicha.net/126.html

(13)
北方经济网的头像北方经济网
上一篇 2017年4月17日 下午5:21
下一篇 2017年4月17日 下午10:54

相关推荐

  • 溜溜梅冲刺港交所IPO:2024年营收16亿

    4月16日,知名果类零食品牌溜溜梅母公司溜溜果园集团股份有限公司向港交所递交招股书,中信证券和国元证券担任联席保荐人。于2022年、2023年及2024年,溜溜果园的总收入分别为人民币11.74亿元、人民币13.22亿元及人民币16.16亿元;同期的净利润则为分别0.68亿元、0.99亿元和1.48亿元。截至2024年12月31日,溜溜果园已建立覆盖全国34…

    经济 2025年4月17日
    5900
  • 获300亿纾困基金输血?天津最高烂尾楼117大厦重启,3月已全面复工

    2025年1月,天津市第二中级人民法院裁定受理高银地产破产清算申请,并指定清算组接管天津摩天大楼项目——117大厦。 300亿元纾困基金输血117大厦 2015年,香港高银集团因股市暴跌,市值蒸发超过1200亿港元,导致资金链断裂,项目被迫停工。尽管2017年中国信达曾出资90亿元支持项目复工,但由于后续资金缺口过大,项目再次陷入停滞。2025年破产清算后,…

    经济 2025年3月26日
    5500
  • 时隔不到半月,成都土拍楼面成交价再创纪录,价格首次超4万元/平方米

    3月27日,成都一宗土地出让再破纪录。本次成都推出的金融城三期H10地块,土地出让面积约32495平方米,起拍价16.25亿元,起始楼面价2万元/平方米。 这一成交楼面价也再次创造成都土拍最高价格纪录。上一个纪录创造于今年3月11日,高新区桂溪街道地块以31700元/平方米的楼面价格,在当时成为成都最高楼面价。 此外,该地块一街之隔就是贝好家去年拿下的金三地…

    经济 2025年3月27日
    5600
  • 事关22.97万户股东!中航产融拟主动退市,称公司经营存在重大不确定性

    A股或将迎来2025年第二单主动退市的案例。 当日,中航产融召开第九届董事会独立董事专门会议2025年第四次会议审议通过《关于以股东大会决议方式主动终止公司股票上市事项的议案》。同日,公司还召开第九届董事会第四十一次会议审议通过《关于以股东大会决议方式主动终止公司股票上市事项的议案》。 中航产融自3月28日开市起停牌,计划自3月31日开市起复牌。3月27日收…

    经济 2025年3月29日
    6100
  • 艾芬豪矿业:卡库拉矿山西区预计月底恢复生产

    6月3日,艾芬豪矿业公布,继2025年5月20日宣布卡库拉矿山暂停井下开采作业后,高级管理层继续与世界级岩土工程专家团队紧密合作,安全和慎重地重启采矿作业。卡莫阿铜业的工程团队正在更新卡库拉矿山东区和西区重启作业的短期、中期、长期计划;预计6月下旬重启卡库拉西区地下采矿作业,视抽水工作的进展而定。卡库拉矿山西区未被水淹,排水能力为1000升/秒。预期在抽水工…

    经济 2025年6月4日
    2600

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信