1 / 7
文档名称:

python编码规范汇编.doc

格式:doc   大小:73KB   页数:7页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

python编码规范汇编.doc

上传人:相惜 2021/1/7 文件大小:73 KB

下载得到文件列表

python编码规范汇编.doc

文档介绍

文档介绍:Python 编码规范
遵循良好的编码风格,可以有效的提高代码的可读性,降低出错几率和维护难度。在团队开发中,使用(尽量)统一的编码风格,还可以降低沟通成本。
网上有很多版本的编码规范,基本上都是遵循 PEP8 的规范:
PEP 0008 – Style Guide for Python Code
Google 的 Python 风格指南
Python Guide - Code Style
Pocoo Styleguide
除了在编码时主动遵循规范,还有很多有用的工具:
IntelliJ IDEA 和 PyCharm 的格式化代码功能
Google 开源的 Python 文件格式化工具:
pyflakes, pylint 等工具及各种编辑器的插件
本文的内容主要摘自互联网上各种版本的规范,因为公司有些小伙伴代码风格不太好,所以整理了一份算是团队的编码规范。
缩进
不要使用 tab 缩进
使用任何编辑器写 Python,请把一个 tab 展开为 4 个空格
绝对不要混用 tab 和空格,否则容易出现 IndentationError
空格
在 list, dict, tuple, set, 参数列表的 , 后面加一个空格
在 dict 的 : 后面加一个空格
在注释符号 # 后面加一个空格,但是 #!/usr/bin/python 的 # 后不能有空格
操作符两端加一个空格,如 +, -, *, /, |, &, =
接上一条,在参数列表里的 = 两端不需要空格
括号((), {}, [])内的两端不需要空格
空行
function 和 class 顶上两个空行
class 的 method 之间一个空行
函数内逻辑无关的段落之间空一行,不要过度使用空行
不要把多个语句写在一行,然后用 ; 隔开
if/for/while 语句中,即使执行语句只有一句,也要另起一行
换行
每一行代码控制在 80 字符以内
使用 \ 或 () 控制换行,举例:
def foo(first, second, third, fourth, fifth,
sixth, and_some_other_very_long_param):
user = (first=first, second=second, third=third) \
.skip(100).limit(100) \
.all()
text = ('Long strings can be made up '
'of several shorter strings.')
命名
使用有意义的,英文单词或词组,绝对不要使用汉语拼音
package/module 名中不要出现 -
各种类型的命名规范:
Type
Public
Internal
Modules
lower_with_under
_lower_with_under
Packages
lower_with_under
 
Classes
CapWords
_CapWords
Excepti