没有合适的资源?快使用搜索试试~ 我知道了~
python开发编码规范.pdf
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 104 浏览量
2022-07-13
20:27:47
上传
评论
收藏 426KB PDF 举报
温馨提示
试读
14页
python开发编码规范.pdfpython开发编码规范.pdfpython开发编码规范.pdfpython开发编码规范.pdfpython开发编码规范.pdfpython开发编码规范.pdf
资源推荐
资源详情
资源评论
Python 开发编码规范
目 录
1 代码的布局...............................................................................................................................3
1.1 缩进...........................................................................................................................3
1.2 制表符还是空格?.....................................................................................................3
1.3 行的最大长度...........................................................................................................3
1.4 空行...........................................................................................................................3
编码 ..........................................................................................................................................4
2.1 导入...........................................................................................................................4
2.2 空格...........................................................................................................................5
2.3 其它建议(Other Recommendations) ........................................................................6
2.4 注释...........................................................................................................................7
2.4.1 注释块...............................................................................................................7
2.4.2 行内注释...........................................................................................................7
2.5 文档化.......................................................................................................................8
2.6 版本注记...................................................................................................................9
2.7 命名约定...................................................................................................................9
2.7.1 描述:命名风格 ...............................................................................................10
2.7.2 说明:命名约定 ...............................................................................................11
2.7.3 应避免的名字.................................................................................................11
2.7.3.1 模块名(Module Names)..........................................................................11
2.7.3.2 类名(Class Names) .................................................................................11
2.7.3.3 异常名(Exception Names)...................................................................... 11
2.7.3.4 全局变量名(Global Variable Names).....................................................12
2.7.3.5 函数名(Function Names)........................................................................12
2.7.3.6 方法名和实例变量(Method Names and Instance Variables).................12
2.7.3.7 继承的设计(Designing for inheritance) .................................................12
设计建议(Programming Recommendations) .........................................................................13
2
3
1 代码的布局
1.1 缩进
使用 Emacs 的 Python-mode 的默认值:4 个空格一个缩进层次。对于确实
古老的代码,你不希望产生混乱,可以继续使用 8 空格的制表符(8-space tabs)。
Emacs Python-mode 自动发现文件中主要的缩进层次,依此设定缩进参数。
1.2 制表符还是空格?
永远不要混用制表符和空格。最流行的 Python 缩进方式是仅使用空格,
其次是仅使用制表符。混合着制表符和空格缩进的代码将被转换成仅使用空
格。 (在 Emacs 中,选中整个缓冲区,按 ESC-x 去除制表符(untabify)。) 调用
python 命令行解释器时使用-t 选项,可对代码中不合法得混合制表符和空格
发出警告(warnings)。 使用-tt 时警告(warnings)将变成错误(errors)。这些选项
是被高度推荐的。 对于新的项目,强烈推荐仅使用空格(spaces-only)而不是制
表 符 。 许 多 编 辑 器 拥 有 使 之 易 于 实 现 的 功 能 。 ( 在 Emacs 中 , 确 认
indent-tabs-mode 是 nil)。
1.3 行的最大长度
周围仍然有许多设备被限制在每行 80 字符;而且,窗口限制在 80 个字符
使将多个窗口并排放置成为可能。在这些设备上使用默认的折叠 (wrapping)
方式看起来有点丑陋。 因此,请将所有行限制在最大 79 字符(Emacs 准确得
将行限制为长 80 字符), 对顺序排放的大块文本(文档字符串或注释),推荐将
长度限制在 72 字符。折叠长行的首选方法是使用 Pyhon 支持的圆括号,方括
号(brackets)和花括号(braces)内的行延续。 如果需要,你可以在表达式周围增
加一对额外的圆括号, 但是有时使用反斜杠看起来更好。确认恰当得缩进了
延续的行。 Emacs 的 Python-mode 正确得完成了这些。一些例子:
Toggle line numbers
1 class Rectangle(Blob):
2
3 def __init__(self, width, height,
4 color='black', emphasis=None, highlight=0):
5 if width == 0 and height == 0 and \
color == 'red' and emphasis == 'strong' or \
highlight > 100:
6 raise ValueError, "sorry, you lose"
7 if width == 0 and height == 0 and (color == 'red' or
8 emphasis is None):
9 raise ValueError, "I don't think so"
10 Blob。__init__(self, width, height,
11 color, emphasis, highlight)
1.4 空行
用两行空行分割顶层函数和类的定义,类内方法的定义用单个空行分割。
额外的空行可被用于 (保守的 (sparingly))分割相关函数组成的群 (groups of
剩余13页未读,继续阅读
资源评论
a66889999
- 粉丝: 36
- 资源: 1万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功