PEP8:Python 编码规范整理

身为一名程序员,写代码固然是很有意思的。但是别忘了,代码是写给人看的,所以代码规范就显得格外重要了。

这里介绍一下 Python 的 PEP8 标准,主要整理一些个人经常用到的代码规范。

一、缩进

每级缩进都用 4 个空格。

换行时,下一行与前面对齐。

if 过长,可以拆成几行,也对齐。

有括号的,后括号另起一行与元素对齐或顶格。

注意:不能制表符 Tab 和空格 混用,可以设置一下,将所有制表符转换为空格。(建议用空格)

二、行长

每行不超过 79 字符。

注释的行长不能超过 72 字符。

太长的就用 backslash 换行处理。

换行后开始是二元运算符。

三、空行

空行不能滥用。

顶层函数以及类定义和其他部分用两个空行隔开。

类之内的方法定义之间用一个空行隔开。

对于一组相关的函数和其他之间可以有额外的空行。

可以使用空行来区分逻辑块。

四、源代码编码

py3 用 UTF-8 ,py2 用 ASCII 。

py3 已经用了 UTF-8 ,py2 已经用了 ASCII 的源代码,不应该有编码声明。

五、import

各个 import 独立成行。

import 应该在文件最上面,在模块注释和文档字符串之后,在模块变量和常量之前。

先 import 标准库。

再 import 相关的第三方库。

最后 import 本地应用和库。

单引号双引号都一样。

六、空格

各种括号中,不要加空格。

逗号,分号,冒号之前不要加空格。

冒号作为分隔符,前后都要加空格。

函数调用的函数和括号直接不要加空格。

后面跟的是索引或者切片的中括号,a[1]。

赋值语句,前后各一个空格。

七、条件测试的格式设置

在诸如 ==>=<= 等比较运算符两边各添加一个空格,例如

if age < 4:

比下面这个好。

if age<4:

八、注释

改代码一定要改注释,保证注释最新。

注释应该是完整句子。

短注释结尾的句号可以省,块注释每一个句子都应该有句号。

句子结束的句号后应该有两个句号。

用英语写作时,遵守 Strunk and White 风格。

都用英语注释。

块注释

每一行都是 # 加一个空格。

行内注释

和语句至少两个空格。

显然的东西不加注释。

九、文档字符串

公用模块、函数、类和方法,都要写文档字符串。

""" 用来结束一个多行文档字符串应该的时候应该独立成行。

如果仅仅是一行的文档字符串,”“” 可以在同一行。

十、命名传统

避免使用 ‘l’ (小写的 L ),‘O’ (大写的欧),‘I’ (大写的哎)。

模块名:短小,全小写。

包名:短小,全小写。

其他

一行的末尾不要加空格。

二元运算符前后一个空格。

一个表达式不同优先级运算符,添加空格区别优先级。

调用函数时,作为参数不要加空格 比如 func(a=3, b=4) 而不是 func(a = 3, b = 4)

带箭头的函数,箭头两段各空一个。

函数声明的默认参数,只有在有 notation 的时候前后有等号,否则前后没有等号。

例如:

# 这里有等号
def func(sep: AnyStr = None): ...
# 这里没有
def func(sep=None): ... 

多条语句最好不要在一行,if 之后如果只有一条语句也最好不要在一行,如果有多条,则绝对不要在一行。

致谢

Python 编程 从入门到实践

pep8 要求归纳

Python 官网

版权声明:本文为博主原创文章,如有错误,恳请大家在评论区指出,在下不胜感激~如要转载注明出处即可~

全部评论

相关推荐

点赞 评论 收藏
分享
避坑恶心到我了大家好,今天我想跟大家聊聊我在成都千子成智能科技有限公司(以下简称千子成)的求职经历,希望能给大家一些参考。千子成的母公司是“同创主悦”,主要经营各种产品,比如菜刀、POS机、电话卡等等。听起来是不是有点像地推销售公司?没错,就是那种类型的公司。我当时刚毕业,急需一份临时工作,所以在BOSS上看到了千子成的招聘信息。他们承诺无责底薪5000元,还包住宿,这吸引了我。面试的时候,HR也说了同样的话,感觉挺靠谱的。于是,我满怀期待地等待结果。结果出来后,我通过了面试,第二天就收到了试岗通知。试岗的内容就是地推销售,公司划定一个区域,然后你就得见人就问,问店铺、问路人,一直问到他们有意向为止。如果他们有兴趣,你就得摇同事帮忙推动,促进成交。说说一天的工作安排吧。工作时间是从早上8:30到晚上18:30。早上7点有人叫你起床,收拾后去公司,然后唱歌跳舞(销售公司都这样),7:55早课(类似宣誓),8:05同事间联系销售话术,8:15分享销售技巧,8:30经理训话。9:20左右从公司下市场,公交、地铁、自行车自费。到了市场大概10点左右,开始地推工作。中午吃饭时间大约是12:00,公司附近的路边盖饭面馆店自费AA,吃饭时间大约40分钟左右。吃完饭后继续地推工作,没有所谓的固定中午午休时间。下午6点下班后返回公司,不能直接下班,需要与同事交流话术,经理讲话洗脑。正常情况下9点下班。整个上班的一天中,早上到公司就是站着的,到晚上下班前都是站着。每天步数2万步以上。公司员工没有自己的工位,百来号人挤在一个20平方米的空间里听经理洗脑。白天就在市场上奔波,公司的投入成本几乎只有租金和工资,没有中央空调。早上2小时,晚上加班2小时,纯蒸桑拿。没有任何福利,节假日也没有3倍工资之类的。偶尔会有冲的酸梅汤和西瓜什么的。公司的晋升路径也很有意思:新人—组长—领队—主管—副经理—经理。要求是业绩和团队人数,类似传销模式,把人留下来。新人不能加微信、不能吐槽公司、不能有负面情绪、不能谈恋爱、不能说累。在公司没有任何坐的地方,不能依墙而坐。早上吃早饭在公司外面的安全通道,未到上班时间还会让你吃快些不能磨蹭。总之就是想榨干你。复试的时候,带你的师傅会给你营造一个钱多事少离家近的工作氛围,吹嘘工资有多高、还能吹自己毕业于好大学。然后让你早点来公司、无偿加班、抓住你可能不会走的心思进一步压榨你。总之,大家在找工作的时候一定要擦亮眼睛,避免踩坑!———来自网友
qq乃乃好喝到咩噗茶:不要做没有专业门槛的工作
点赞 评论 收藏
分享
05-26 09:07
已编辑
门头沟学院 Java
点赞 评论 收藏
分享
评论
点赞
收藏
分享

创作者周榜

更多
牛客网
牛客网在线编程
牛客网题解
牛客企业服务