仓库样例
README.rst
LICENSE
setup.py
requirements.txt
sample/__init__.py
sample/core.py
sample/helpers.py
docs/conf.py
docs/index.rst
tests/test_basic.py
tests/test_advanced.py
-
真正模块代码
./sample/ 或者 ./sample.py这一部分是核心代码 -
许可证
./LICENSE
在这个文件中要有完整的许可说明和授权。 -
管理
./setup.py
打包和发布管理 -
开发依赖说明
./requirements.txt
它应该指明完整工程的所有依赖包: 测试, 编译和文档生成。 -
参考文档
./docs/ -
测试用例
./test_sample.py or ./tests
包的集合和单元测试 -
常规的管理任务
./Makefile
模块
- 引入模块有很多种方法,其中最好的是 import modu
差:
稍好:from modu import * x = sqrt(4) #sqrt是模块modu的一部分吗?还是内建函数,上文有提及吗?
最好:from modu import sqrt x = sqrt(4) #如果在Import语句与这条语句之间没有被重复定义,他也许是模块modu的一部分
import modu x = mode.sqrt(4) #sqrt显然是modeu的一部分
包
- 任意包含__init__.py文件的目录都是一个python包。如果包内的模块没有代码共享的需求,使用空白__init__.py文件是很好的做法。
装饰器
- 装饰器是一个函数或类,它可以包装一个函数或者方法。被“装饰”的函数或方法会替换原来的函数或者方法。
def decorator(func):
print("one")
func()
print("two")
@decorator
def foo():
print("foo")
上下文管理器
- 使用with语句初始化上下文,以及完成with块中的所有代码,采用可调用的形式。实现这个功能有两种简单的方法:使用类或者使用生成器。
class CustomOpen(object):
def __init__(self, filename):
self.file = open(filename)
def __enter__(self):
return self.file
def __exit__(self, ctx_type, ctx_value, ctx_traceback):
self.file.close()
with CustomOpen('file') as f:
contents = f.read()
上面有两个由with语句使用的额外方法CustomOpen首先被实例化,然后调用它的__enter__方法,而且__enter__的返回值在as f语句中被赋予f。当with块中的内容被执行完后,会调用__exit__方法。
动态类型
- 重复使用命名对效率没有提升:赋值时无论如何都要创建新的对象。然而随着复杂度的提升,赋值语句被其他代码包括"if"分支和循环分支分开,使得更难查明变量的类型。避免给同一个变量重复赋值是一个好办法,并且有助于掌握可变与不可变的概念。
可变类型与不可变类型
- python提供两种内置或者用户定义的类型,可变类型允许内容的内部修改,动态类型包括字典和列表,列表有可变方法,list.append()和list.pop(),并且能就地修改。
- 不可变类型没有内置的可变的方法,像整型6,是没有"自增"的方法的,就算的x = x+1,被赋值的x变量是一个新的变量。python中字符串也是不可变类型。
- 可变类型不稳定,所以不能作为字典的"键"使用
#差
nums = ""
for i in range(20):
nums = nums+str(n)
print(nums)
#好
nums = []
for i in range(20):
nums.append(str(n))
print("".join(nums))
#更好
nums = [str(n) for i in range(0,20)]
print("".join(nums))
#最好
nums = map(str,range(20))
print("".join(nums))
当用预先确定的数量的字符串创建一个新的字符串时,使用加法操作符确实更快,但是添加到已存在字符串的情况下,使用join是更好的选择。
foo = "foo"
bar = "bar"
#好的做法
foobar = foo + bar
#差的做法
foo+= "ooo"
#好的做法
foo = "".join([foo,"ooo"])
参考链接: python最佳实践