【转】Python开发指南:最佳实践精选
价值
- “为别人开发你也想要使用的工具。” ——Kenneth Reitz
- "简洁总是胜过可用。" ——Pieter Hintjens
- "满足90%的使用场景。忽略那些说不的人。" ——Kenneth Reitz
- "优美胜过丑陋。" ——PEP 20
- 为开源(甚至是闭源项目)而开发。
一般开发准则
- “明确胜过含蓄。” —— PEP 20
- “易读亦有价。” —— PEP 20
- “人人都能打补丁。” —— 可汗学院开发文档
- 一旦发现破窗(设计错误,决策失误或编码质量低),马上修补。
- “现在做也要胜过不去做。” —— PEP 20
- "测试要彻底。撰写新功能文档。"
- 人力驱动型开发,比测试驱动型开发更重要。(译者:原文为Even more important that Test-Driven Development--Human-Driven Development,译者认为more important that应该是more important than,应该是作者笔误,否则意思不通,)
- 这些准则可能——应该是很可能——会改变。
特殊准则
风格
感觉合理的话,就遵循PEP 8。
命名
- 变量、函数、方法、包、模块
- 小写,并使用下划线分隔单词(lower_case_with_underscores)
- 类、异常
- 首字母大写(CapWords)
- 受保护的方法和内部函数
- 单下划线开头(_single_leading_underscore(self, ...))
- 私有的方法
- 双下划线开头(__double_leading_underscore(self, ...))
- 常量
- 字母全部大写,单词间用下划线分隔(ALL_CAPS_WITH_UNDERSCORES)
一般命名准则
尽量不要使用只有一个字母的变量名(例如,l,I,O等)。
例外:在很简短的代码块中,如果变量名的意思可以从上下文明显地看出来,即可。
没问题
for e in elements:
e.mutate()
避免重复变量名。
正确的做法
import audio core = audio.Core()
controller = audio.Controller()
错误的做法
import audio core = audio.AudioCore()
controller = audio.AudioController()
“反向标记”更好。
正确的做法
elements = ...
elements_active = ...
elements_defunct = ...
错误的做法
elements = ...
active_elements = ...
defunct_elements ...
避免使用getter和setter方法。
正确的做法
person.age = 42
错误的做法
person.set_age(42)
缩进
用4个空格符——永远别用Tab制表符。就说这么多。
模块引用
引用整个模块,而不是模块中的单个标识符。举个例子,假设一个cantee模块下面,有一个sessions.py文件,
正确的做法
import canteen
import canteen.sessions
from canteen import sessions
错误的做法
from canteen import get_user # Symbol from canteen/__init__.py
from canteen.sessions import get_session # Symbol from canteen/sessions.py
例外:如果第三方代码的文档中明确说明要单个引用,即可。
理由:避免循环引用。看这里。
把代码引用部分放在文件的顶部,按下面的顺序分成三个部分,每个部分之间空一行。 1. 系统引用 2. 第三方引用 3. 本地引用
理由:明确显示每个模块的引用来源。
文档
遵循PEP 257提出的文档字符串准则。reStructuredText (reST) 和Sphinx有助于确保文档符合标准。
对于功能明显的函数,撰写一行文档字符串。
"""返回``foo``的路径名."""
多行文档字符串应包括:
- 一行摘要
- 合适的话,请描述使用场景
- 参数
返回数据类型和语义信息,除非返回
None
"""训练一个用来区分Foo和Bar的模型。
用法::
>>> import klassify
>>> data = [("green", "foo"), ("orange", "bar")]
>>> classifier = klassify.train(data):param train_data:
(color, label)
形式的一个元祖列表。:rtype: A :class:
Classifier <Classifier>
"""
注意
使用主动词(“返回”),而不是描述性的单词(“返回值”)。 在类的文档字符串中为__init__
方法撰写文档。
class Person(object):
"""A simple representation of a human being. :param name: A string, the person's name.
:param age: An int, the person's age.
"""
def __init__(self, name, age):
self.name = name
self.age = age
关于注释
尽量少用。与其写很多注释,不如提高代码可读性。通常情况下,短小的方法比注释更有效。
错误的做法
# If the sign is a stop sign
if sign.color == 'red' and sign.sides == 8:
stop()
正确的做法
def is_stop_sign(sign):
return sign.color == 'red' and sign.sides == 8 if is_stop_sign(sign):
stop()
但是的确要写注释时,请牢记:“遵循斯托克与怀特所写的《风格的要素》。” —— PEP 8
每行的长度
不要过分在意。80到100个字符都是没问题的。
使用括号延续当前行。
wiki = (
"The Colt Python is a .357 Magnum caliber revolver formerly manufactured "
"by Colt's Manufacturing Company of Hartford, Connecticut. It is sometimes "
'referred to as a "Combat Magnum". It was first introduced in 1955, the '
"same year as Smith & Wesson's M29 .44 Magnum."
)
测试
尽量争取测试全部代码,但也不必执着于覆盖率。
一般测试准则
- 使用较长的、描述性的名称。通常情况下,这能避免在测试方法中再写文档。
- 测试之间应该是孤立的。不要与真实地数据库或网络进行交互。使用单独的测试数据库,测试完即可销毁,或者是使用模拟对象。
- 使用工厂模式,而不是fixture。
- 别让不完整的测试通过,否则你就有可能忘记。你应该加上一些占位语句,比如
assert False, "TODO: finish me"
。
单元测试
- 每次聚焦一个很小的功能点。
- 运行速度要快,但是速度慢总比不测试好。
- 通常,每一个类或模型都应该有一个测试用例类。
import unittest
import factories class PersonTest(unittest.TestCase): def setUp(self):
self.person = factories.PersonFactory() def test_has_age_in_dog_years(self):
self.assertEqual(self.person.dog_years, self.person.age / 7)
功能测试
功能测试是更高层次的测试,更接近最终用户如何与应用交互这一层面。通常用在网络应用与图形应用测试。
- 按照场景撰写测试。测试用例的测试方法命名应该看上去像场景描述。
- 在编写代码之前,通过注释说明具体场景信息。
import unittest class TestAUser(unittest.TestCase): def test_can_write_a_blog_post(self):
# Goes to the her dashboard
...
# Clicks "New Post"
...
# Fills out the post form
...
# Clicks "Submit"
...
# Can see the new post
...
请注意,测试用例的类名称和测试方法的名称放在一起,就像是“测试一名用户能否发布博文”。
本文受到下列资料的启发...
- PEP 20 (The Zen of Python)
- PEP 8 (Style Guide for Python)
- The Hitchiker's Guide to Python
- Khan Academy Development Docs
- Python Best Practice Patterns
- Pythonic Sensibilities
- The Pragmatic Programmer
- 以及其他诸多资料
原文链接:http://codingpy.com/article/bobp-guide-for-python-development/
【转】Python开发指南:最佳实践精选的更多相关文章
- paip.python ide 总结最佳实践o4.
paip.python ide 总结最佳实践o4. ====2个重要的标准 1.可以自动补全 2.可以断点调试 =======选型使用报告 Komodo正好儿俄机器上有,使用累挂,自动补全还凑火.就是 ...
- paip.python连接mysql最佳实践o4
paip.python连接mysql最佳实践o4 python连接mysql 还使用了不少时间...,相比php困难多了..麻烦的.. 而php,就容易的多兰.. python标准库没mysql库,只 ...
- Struts2、Spring、Hibernate 高效开发的最佳实践(转载)
Struts2.Spring.Hibernate 高效开发的最佳实践 Struts2.Spring.Hibernate(SSH)是最常用的 Java EE Web 组件层的开发技术搭配,网络中和许多 ...
- Windows 平台做 Python 开发的最佳组合
在 Windows 上怎样做 Python 开发?是像大神那样使用纯文本编辑器,还是用更加完善的 IDE?到底是用自带的命令行工具,还是需要装新的 Terminal?本文将带你了解如何利用微软官方维护 ...
- ES6 开发规范-最佳实践
ES6 开发规范(最佳实践) 本文为开发规范,收集方便日后查看. [开发规范]https://blog.csdn.net/zzzkk2009/article/details/53171058?utm_ ...
- (转)Android开发:性能最佳实践-管理应用内存
翻自:http://developer.android.com/training/articles/memory.html 在任何软件开发环境中,RAM都是宝贵的资源,但在移动操作系统中更加珍贵.尽管 ...
- [Docker] 容器开发环境最佳实践理论
保持 image 小 选择合适的 base image. 使用 multi-stage 构建. https://docs.docker.com/develop/develo ...
- Python开发指南规范
分号 不要在行尾加分号, 也不要用分号将两条命令放在同一行. 行长度 每行不超过80个字符 例外: 长的导入模块语句 注释里的URL 不要使用反斜杠连接行. Python会将 圆括号, 中括号和花括号 ...
- [蟒蛇菜谱]Python日志记录最佳实践
# -*- coding: utf8 -*- import logging # 创建一个logger logger = logging.getLogger('mylogger') logger.set ...
随机推荐
- 15款提高工作效率的 Web 项目管理工具
在今天的快节奏的商业世界里,能够通过计划.组织.和管理资源池以及评估开发资源的模式来管理一个项目,是一个很艰巨的任务. 有很多现成的项目管理软件来帮助减轻项目管理的负担,并且他们几乎覆盖了所有类型的业 ...
- iOS-定时器
一.定时器的作用 在软件开发过程中,我们常常需要在某个时间后执行某个方法,或者是按照某个周期一直执行某个方法.在这个时候,我们就需要用到定时器. 二.定时器的种类 大概有三种方法:NSTimer.CA ...
- es6新特性学习
本文用来记录一下es6的新特性,持续更新.... es6在前端目前还不能大面试使用,包括移动端兼容也不好.不过在node中已可以使用其中96%的特性.也可使用一些插件将es6转化为es5,比如babl ...
- .NET ORM 哪家强
ORM到底哪家强? 很多人都想知道这个问题,自已也没测试过,只能道听途说. 闲的无聊就将几个ORM拿出来比一比,假如怀疑测试代码有问题可以将它下载下来慢慢研究. 参赛ORM 1.SqlSugar:是一 ...
- ASP.NET MVC分页实现之改进版-增加同一个视图可设置多个分页
我之前就已经实现了ASP.NET MVC分页(查看该博文),但它有局限性,必须确保在同一个视图中只能有一处分页,若需要在同一个视图中设置多个分页,却无能为力,为此,我重新对原先的代码进行了优化,增加了 ...
- JS魔法堂:浏览器模式和文档模式怎么玩?
一.前言 从IE8开始引入了文档兼容模式的概念,作为开发人员的我们可以在开发人员工具中通过“浏览器模式”和“文档模式”(IE11开始改为“浏览器模式”改成更贴切的“用户代理字符串”)品味一番,它的出现 ...
- python+selenium+unittest,爬虫电影网站
以前经常在这个网站上下载电影下来看,这个网站比较坑的就是,主页上只有电影的名称,但是评分是看不到的:只有再点击电影名字,进入电影主页时才能看到评分.一般下载的电影都是评分高的才看,低的就忽略掉了.每次 ...
- 重构第25天 引入契约设计(Introduce Design By Contract checks)
理解:本文中的”引入契约式设计”是指我们应该对应该对输入和输出进行验证,以确保系统不会出现我们所想象不到的异常和得不到我们想要的结果. 详解:契约式设计规定方法应该对输入和输出进行验证,这样你便可以保 ...
- 如何用c语言调用c++做成的动态链接库
今天在做东西的时候遇到一个问题,就是如何在C语言中调用C++做的动态链接库so文件如果你有一个c++做的动态链接库.so文件,而你只有一些相关类的声明, 那么你如何用c调用呢,别着急,本文通过一个小小 ...
- 很有趣的Java分形绘制
部分与整体以某种形式相似的形,称为分形. 首先我们举个例子: 我们可以看到西兰花一小簇是整个花簇的一个分支,而在不同尺度下它们具有自相似的外形.换句话说,较小的分支通过放大适当的比例后可 ...