没有合适的资源?快使用搜索试试~ 我知道了~
首页PythonCodingRule.pdf
PythonCodingRule.pdf
4星 · 超过85%的资源 需积分: 10 25 下载量 77 浏览量
更新于2023-03-16
评论
收藏 323KB PDF 举报
无私分享,用于Python的入门学习 讲解了Python的一些基本用法 语法规范等知识 很好的入门资料
资源详情
资源评论
资源推荐
Python开发编码规范
介绍1.
一致性的建议
2.
代码的布局
缩进
1.
制表符还是空格?2.
行的最大长度
3.
空行
4.
编码
5.
3.
导入
4.
空格
其它建议1.
5.
注释
注释块1.
行内注释2.
6.
文档化7.
版本注记8.
命名约定
描述:命名风格1.
说明:命名约定
应避免的名字1.
模块名2.
类名3.
异常名4.
全局变量名5.
函数名
6.
方法名和实例变量
7.
继承的设计
8.
2.
9.
设计建议
10.
1.
PythonCodingRule
译稿
Python开发编码规范
开发编码规范开发编码规范
开发编码规范
1. Python开发编码规范
1. Python开发编码规范1. Python开发编码规范
1. Python开发编码规范
--- hoxide
初译
dreamingk
校对发布
040724
--- xyb
重新排版
040915
--- ZoomQuiet MoinMoin
美化
050610
用
用用
用Python进行开发时的编码风格约定
进行开发时的编码风格约定进行开发时的编码风格约定
进行开发时的编码风格约定 原文:epes:PEP 008《Style Guide for Python Code》
1.1. 介绍
1.1. 介绍1.1. 介绍
1.1. 介绍
这篇文档所给出的编码约定适用于在主要的Python发布版本中组成标准库的Python 代码.请查阅相
关的关于在Python的C实现中C代码风格指南的描述.
这篇文档改编自Guido最初的《Python风格指南》一文. 并从《Barry's style guide》中添加了部分内
容. 在有冲突的地方,Guide的风格规则应该是符合本PEP的意图 (译注:就是当有冲突时,应以
Guido风格为准) 这篇PEP也许仍然尚未完成(实际上,它可能永远不会结束).
1.2. 一致性的建议
1.2. 一致性的建议1.2. 一致性的建议
1.2. 一致性的建议
愚蠢得使用一致性是无知的妖怪
愚蠢得使用一致性是无知的妖怪愚蠢得使用一致性是无知的妖怪
愚蠢得使用一致性是无知的妖怪(A Foolish Consistency is the Hobgoblin of Little Minds)
呆板的坚持一致性是傻的没边了
!
-- Zoomq
在这篇风格指导中的一致性是重要的. 在一个项目内的一致性更重要. 在一个模块或函数内的一致
性最重要.
但最重要的是:知道何时会不一致 -- 有时只是没有实施风格指导.当出现疑惑时,
运用你的最佳判断.看看别的例子,然后决定怎样看起来更好.并且要不耻下问!
打破一条既定规则的两个好理由:
当应用这个规则是将导致代码可读性下降,即便对某人来说,他已经习惯于按这条规则来阅读代码了.1.
为了和周围的代码保持一致而打破规则(也许是历史原因)
--
虽然这也是个清除其它混乱的好机会(真正的XP风格).
2.
1.3. 代码的布局
1.3. 代码的布局1.3. 代码的布局
1.3. 代码的布局
(Code lay-out)
1.3.1. 缩进
1.3.1. 缩进1.3.1. 缩进
1.3.1. 缩进
(Indentation)
使用Emacs的Python-mode的默认值:4个空格一个缩进层次. 对于确实古老的代码,你不希望产生混乱,可以继续使用8空格的制表符
(8-space tabs). Emacs Python-mode自动发现文件中主要的缩进层次,依此设定缩进参数.
1.3.2. 制表符还是空格?
1.3.2. 制表符还是空格?1.3.2. 制表符还是空格?
1.3.2. 制表符还是空格?
(Tabs or Spaces)
永远不要混用制表符和空格. 最流行的Python缩进方式是仅使用空格, 其次是仅使用制表符.混合着制表符和空格缩进的代码将被转换
成仅使用空格. (在Emacs中,选中整个缓冲区,按ESC-x去除制表符(untabify).) 调用python命令行解释器时使用-t选项,可对代码中不合法
得混合制表符和空格发出警告(warnings). 使用-tt时警告(warnings)将变成错误(errors).这些选项是被高度推荐的.
对于新的项目,强烈推荐仅使用空格(spaces-only)而不是制表符. 许多编辑器拥有使之易于实现的功能.(在Emacs中,确认indent-tabs-
mode是nil).
1.3.3. 行的最大长度
1.3.3. 行的最大长度1.3.3. 行的最大长度
1.3.3. 行的最大长度
(Maximum Line Length)
周围仍然有许多设备被限制在每行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.3.4. 空行
1.3.4. 空行1.3.4. 空行
1.3.4. 空行
(Blank Lines)
用两行空行分割顶层函数和类的定义,类内方法的定义用单个空行分割. 额外的空行可被用于(保守的(sparingly))分割相关函数组成的
群(groups of related functions). 在一组相关的单句中间可以省略空行.(例如.一组哑元(a set of dummy implementations)).
当空行用于分割方法(method)的定义时,在'class'行和第一个方法定义之间也要有一个空行.
在函数中使用空行时,请谨慎的用于表示一个逻辑段落(indicate logical sections).
Python接受contol-L(即^L)换页符作为空格;Emacs(和一些打印工具) 视这个字符为页面分割符,因此在你的文件中,可以用他们来为相
关片段(sections)分页.
1.3.5. 编码
1.3.5. 编码1.3.5. 编码
1.3.5. 编码
(Encodings)epes:(PEP 263)
Python核心发布中的代码必须始终使用ASCII或Latin-1编码(又名 ISO-8859-1). 使用ASCII的文件不必有译码cookie(coding cookie).
Latin-1仅当注释或文档字符串涉及作者名字需要Latin-1时才被使用; 另外使用\x转义字符是在字符串中包含非ASCII(non-ASCII)数据
剩余14页未读,继续阅读
换个名啊
- 粉丝: 0
- 资源: 1
上传资源 快速赚钱
- 我的内容管理 收起
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
会员权益专享
最新资源
- ExcelVBA中的Range和Cells用法说明.pdf
- 基于单片机的电梯控制模型设计.doc
- 主成分分析和因子分析.pptx
- 共享笔记服务系统论文.doc
- 基于数据治理体系的数据中台实践分享.pptx
- 变压器的铭牌和额定值.pptx
- 计算机网络课程设计报告--用winsock设计Ping应用程序.doc
- 高电压技术课件:第03章 液体和固体介质的电气特性.pdf
- Oracle商务智能精华介绍.pptx
- 基于单片机的输液滴速控制系统设计文档.doc
- dw考试题 5套.pdf
- 学生档案管理系统详细设计说明书.doc
- 操作系统PPT课件.pptx
- 智慧路边停车管理系统方案.pptx
- 【企业内控系列】企业内部控制之人力资源管理控制(17页).doc
- 温度传感器分类与特点.pptx
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论2