1.编写规则
Python中采用PEP 8作为编码规范 其中PEP是Pyhon Enhancement Proposal的缩写 翻译过来是Python增强建议书 而PEP 8表示版本 它是Python代码的样式指南 下面给出PEP 8编码规范中的一些应该严格遵守的条目。
每个import语句只导入一个模块 尽量避免一次导入多个模块。
推荐
import os
import sys
不推荐
import os,sys
不要在行尾添加分号”;”,也不要用分号将两条命令放在同一行。
不规范写法
height float(input(“请输入您的身高 ”));
weight float(input(“请输入您的体重 ”));
建议每行不超过80个字符 如果超过 建议使用小括号”()”将多行内容隐式地连接起来 而不推荐使用反斜杠””进行连接。例如 如果一个字符串文本在一行上显示不下 那么可以使用小括号”()”将其分行显示 比如
print(“我一直认为我是一只蜗牛。我一直在爬 也许还没有爬到金字塔的顶端。”
“但是只要你在爬 就足以给自己留下令生命感动的日子。”)
但是这个是不推荐的
print(“我一直认为我是一只蜗牛。我一直在爬 也许还没有爬到金字塔的顶端。
但是只要你在爬 就足以给自己留下令生命感动的日子。”)
不过两种情况除外 导入模块的语句过长 注释里的URL
使用必要的空行可以增加代码的可读性。一般在顶级定义 如函数或者类的定义 之间空两行 而方法定义之间空一行。另外 在用于分隔某些功能的位置也可以空一行。
通常情况 运算符两侧、函数参数之间、逗号”,”两侧建议使用空格进行分隔。
应该避免在循环中使用 和 操作符累加字符串。这是因为字符串是不可变的 这样做会创建不必要的临时对象。推荐的做法是将每个字符串加入列表 然后在循环结束后使用join()方法连接列表。
适当使用异常处理结构提高程序容错性 但不能过多依赖异常处理结构 适当的显式判断还是必要的。
2.命名规范
命名规范在编写代码中起到很重要的作用 虽然不遵循命名规范 程序也可以进行 但是使用命名规范可以更加直观地了解代码所代表的含义。下面将介绍python中常用的一些命名规范。
模块名尽量短小 并且使用全部小写字母 可以使用下划线分隔多个字母。例如 game_main、game_register、bmiexponent都是推荐使用的模块名称。
包名尽量短小 并且使用全部小写字母 不推荐使用下划线。例如 com.mingrisoft、com.mr、com.mr.book都是推荐使用的包名称 而com_mingrisoft就是不推荐的。
类名采用单词首字母大写形式 即Pascal风格 。例如 定义一个借书类 可以命名BorrowBook。
模块内部的类采用下划线”_” Pascal风格的类名组成。例如 在BorrowBook类中的内部类 可以使用_BorrowBook命名。
函数、类的属性和方法的命名规范同模块类似 也是全部采用小写字母 多个字母间用下划线 _ 分隔。
常量命名时采用全部大写字母 可以使用下划线。
使用单下划线”_”开头的模块变量或者函数是受保护的 在使用import * from 语句从模块中导入时 这些变量或者函数不能被导入。
使用双下划线”__”开头的实例变量或方法是类私有的。
