构建Python包的五个简单准则简介


Posted in Python onJune 15, 2015

创建一个软件包(package)似乎已经足够简单了,也就是在文件目录下搜集一些模块,再加上一个__init__.py文件,对吧?我们很容易看出来,随着时间的推移,通过对软件包的越来越多的修改,一个设计很差的软件包可能会出现循环依赖问题,或是可能变得不可移植和不可靠。
1. __init__.py 仅为导入服务

对于一个简单的软件包,你可能会忍不住把工具方法,工厂方法和异常处理都丢进__init__.py,千万别这样!

一个结构良好的__init__.py文件,仅为一个非常重要的目的来服务:从子模块导入。你的__init__.py应该看起来像这个样子:

# ORDER MATTERS HERE -- SOME MODULES ARE DEPENDANT ON OTHERS
# 导入顺序要考虑——一些模块会依赖另外的一些
from exceptions import FSQError, FSQEnvError, FSQEncodeError,
            FSQTimeFmtError, FSQMalformedEntryError,
            FSQCoerceError, FSQEnqueueError, FSQConfigError,
            FSQPathError, FSQInstallError, FSQCannotLockError,
            FSQWorkItemError, FSQTTLExpiredError,
            FSQMaxTriesError, FSQScanError, FSQDownError,
            FSQDoneError, FSQFailError, FSQTriggerPullError,
            FSQHostsError, FSQReenqueueError, FSQPushError 
 
# constants relies on: exceptions, internal
import constants
 
# const relies on: constants, exceptions, internal
from const import const, set_const 
# has tests
 
# path relies on: exceptions, constants, internal
import path 
# has tests
 
# lists relies on: path
from lists import hosts, queues
 
#...

2.使用__init__.py来限制导入顺序

  •     把方法和类置于软件包的作用域中,这样用户就不需要深入软件包的内部结构,使你的软包变得易用。
  •     作为调和导入顺序的唯一地方。

使用得当的话,__init__.py 可以为你提供重新组织内部软件包结构的灵活性,而不需要担心由内部导入子模块或是每个模块导入顺序所带来的副作用。因为你是以一个特定的顺序导入子模块,你的__init__.py 对于他程序员来讲应该简单易懂,并且能够明显的表示该软件包所能提供的全部功能。

文档字符串,以及在软件包层面对__all__属性的赋值应当是__init__.py中唯一的与导入模块不相关的代码:

__all__ = [ 'FSQError', 'FSQEnvError', 'FSQEncodeError', 'FSQTimeFmtError',
      'FSQMalformedEntryError', 'FSQCoerceError', 'FSQEnqueueError',
      'FSQConfigError', 'FSQCannotLock', 'FSQWorkItemError',
      'FSQTTLExpiredError', 'FSQMaxTriesError', 'FSQScanError',
      'FSQDownError', 'FSQDoneError', 'FSQFailError', 'FSQInstallError',
      'FSQTriggerPullError', 'FSQCannotLockError', 'FSQPathError',
      'path', 'constants', 'const', 'set_const', 'down', 'up',
      
# ...
     ]

3.使用一个模块来定义所有的异常

你也许已经注意到了,__init__.py中的第一个导入语句从exceptions.py子模块中导入了全部的异常。从这里出发,你将看到,在大多数的软件包中,异常被定义在引起它们的代码附近。尽管这样可以为一个模块提供高度的完整性,一个足够复杂的软件包会通过如下两种方式,使得这一模式出现问题。

    通常一个模块/程序需要从一个子模块导入一个函数, 利用它导入代码并抛出异常。为了捕获异常并保持一定的粒度,你需要导入你需要的模块,以及定义了异常的模块(或者更糟,你要导入一系列的异常)。这一系列衍生出来的导入需求,是在你的软件包中编织一张错综复杂的导入之网的始作俑者。你使用这种方式的次数越多,你的软件包内部就变的越相互依赖,也更加容易出错。
    随着异常数量的不断增长,找到一个软件包可能引发的全部异常变的越来越难。把所有的异常定义在一个单独的模块中,提供了一个方便的地方,在这里,程序员可以审查并确定你的软件包所能引发全部潜在错误状态。

你应该为你的软件包的异常定义一个基类:

class APackageException(Exception):
  
'''root for APackage Exceptions, only used to except any APackage error, never raised'''
  pass

然后确保你的软件包在任何错误状态下,只会引发这个基类异常的子类异常,这样如果你需要的话,你就可以阻止全部的异常:

try:
  
'''bunch of code from your package'''
except APackageException:
  
'''blanked condition to handle all errors from your package'''

对于一般的错误状态,这里有一些重要的异常处理已经被包括在标准库中了(例如,TypeError, ValueError等)

灵活地定义异常处理并保持足够的粒度:

# from fsq
class FSQEnvError(FSQError):
  
'''An error if something cannot be loaded from env, or env has an invalid
    
value'''
  pass
 
class FSQEncodeError(FSQError):
  
'''An error occured while encoding or decoding an argument'''
  pass
# ... and 20 or so more

在你的异常处理中保持更大的粒度,有利于让程序员们在一个try/except中包含越来越大的,互相不干涉的代码段。

# this
try:
  item = fsq.senqueue('queue', 'str', 'arg', 'arg')
  scanner = fsq.scan('queue')
except FSQScanError:
  
'''do something'''
except FSQEnqueueError:
  
'''do something else'''
 
# not this
try:
  item = fsq.senqueue('queue', 'str', 'arg', 'arg')
except FSQEnqueueError:
  
'''do something else'''
try:
  scanner = fsq.scan('queue')
except FSQScanError:
  
'''do something'''
 
# and definitely not
try:
  item = fsq.senqueue('queue', 'str', 'arg', 'arg')
  try:
    scanner = fsq.scan('queue')
  except FSQScanError:
    
'''do something'''
except FSQEnqueueError:
  
'''do something else'''

在异常定义时保持高度的粒度,会减少错综复杂的错误处理,并且允许你把正常执行指令和错误处理指令分别开来,使你的代码更加易懂和更易维护。
4. 在软件包内部只进行相对导入

在子模块中你时常见到的一个简单错误,就是使用软件包的名字来导入软件包。

# within a sub-module
from a_package import APackageError

这样做会导致两个不好的结果:

  1.     子模块只有当软件包被安装在 PYTHONPATH 内才能正确运行。
  2.     子模块只有当这个软件包的名字是 a_package 时才能正确运行。

尽管第一条看上去并不是什么大问题,但是考虑一下,如果你在 PYTHONPATH 下的两个目录中,有两个同名的软件包。你的子模块可能最终导入了另一个软件包,你将无意间使得某个或某些对此毫无戒备的程序员(或是你自己)debug 到深夜。
 

# within a sub-module 
from . import FSQEnqueueError, FSQCoerceError, FSQError, FSQReenqueueError,
       constants as _c, path as fsq_path, construct,
       hosts as fsq_hosts, FSQWorkItem
from .internal import rationalize_file, wrap_io_os_err, fmt_time,
           coerce_unicode, uid_gid
# you can also use ../... etc. in sub-packages.

5. 让模块保持较小的规模

你的模块应当比较小。记住,那个使用你软件包的程序员会在软件包作用域进行导入,同时你会使用你的 __init__.py 文件来作为一个组织工具,来暴露一个完整的接口。

好的做法是一个模块只定义一个类,伴随一些帮助方法和工厂方法来协助建立这个模块。

class APackageClass(object):
  
'''One class'''
 
def apackage_builder(how_many):
  for i in range(how_many):
    yield APackageClass()

如果你的模块暴露了一些方法,把一些相互依赖的方法分为一组放进一个模块,并且把不相互依赖的方法移动到单独的模块中:

####### EXPOSED METHODS #######
def enqueue(trg_queue, item_f, *args, **kwargs):
  
'''Enqueue the contents of a file, or file-like object, file-descriptor or
    
the contents of a file at an address (e.g. '/my/file') queue with
    
arbitrary arguments, enqueue is to venqueue what printf is to vprintf
  
'''
  return venqueue(trg_queue, item_f, args, **kwargs)
 
def senqueue(trg_queue, item_s, *args, **kwargs):
  
'''Enqueue a string, or string-like object to queue with arbitrary
    
arguments, senqueue is to enqueue what sprintf is to printf, senqueue
    
is to vsenqueue what sprintf is to vsprintf.
  
'''
  return vsenqueue(trg_queue, item_s, args, **kwargs)
 
def venqueue(trg_queue, item_f, args, user=None, group=None, mode=None):
  
'''Enqueue the contents of a file, or file-like object, file-descriptor or
    
the contents of a file at an address (e.g. '/my/file') queue with
    
an argument list, venqueue is to enqueue what vprintf is to printf
    
if entropy is passed in, failure on duplicates is raised to the caller,
    
if entropy is not passed in, venqueue will increment entropy until it
    
can create the queue item.
  
'''
  
# setup defaults
  trg_fd = name = None
  
# ...

上面的例子是 fsq/enqueue.py,它暴露了一系列的方法来为同一个功能提供不同的接口(就像 simplejson 中的l oad/loads)。尽管这个例子足够直观,让你的模块保持较小规模需要一些判断,但是一个好的原则是:

当你有疑问的时候,就去创建一个新的子模块吧。

Python 相关文章推荐
Python的Bottle框架中获取制定cookie的教程
Apr 24 Python
Python的randrange()方法使用教程
May 15 Python
python 爬取微信文章
Jan 30 Python
Python实现的选择排序算法示例
Nov 29 Python
对python自动生成接口测试的示例讲解
Nov 30 Python
python处理DICOM并计算三维模型体积
Feb 26 Python
Python实现Linux监控的方法
May 16 Python
在SQLite-Python中实现返回、查询中文字段的方法
Jul 17 Python
python 设置xlabel,ylabel 坐标轴字体大小,字体类型
Jul 23 Python
python GUI库图形界面开发之PyQt5输入对话框QInputDialog详细使用方法与实例
Feb 27 Python
用python实现名片管理系统
Jun 18 Python
Matplotlib绘制混淆矩阵的实现
May 27 Python
Python中文字符串截取问题
Jun 15 #Python
python获取mp3文件信息的方法
Jun 15 #Python
python实现批量下载新浪博客的方法
Jun 15 #Python
深入理解Python中各种方法的运作原理
Jun 15 #Python
python字符串编码识别模块chardet简单应用
Jun 15 #Python
Python字符串格式化
Jun 15 #Python
Java中重定向输出流实现用文件记录程序日志
Jun 12 #Python
You might like
?算你??的 PHP 程式大小
2006/12/06 PHP
php+redis在实际项目中HTTP 500: Internal Server Error故障排除
2017/02/05 PHP
thinkphp5框架扩展redis类方法示例
2019/05/06 PHP
基于PHP实现微信小程序客服消息功能
2019/08/12 PHP
数组Array进行原型prototype扩展后带来的for in遍历问题
2010/02/07 Javascript
理解Javascript_07_理解instanceof实现原理
2010/10/15 Javascript
ExtJS DOM元素操作经验分享
2013/08/28 Javascript
学习Bootstrap组件之下拉菜单
2015/07/28 Javascript
深入解析JavaScript中函数的Currying柯里化
2016/03/19 Javascript
vue-lazyload图片延迟加载插件的实例讲解
2018/02/09 Javascript
浅谈node中的cluster集群
2018/06/02 Javascript
[36:33]Ti4 循环赛第四日 附加赛NEWBEE vs Mouz
2014/07/13 DOTA
Python threading多线程编程实例
2014/09/18 Python
python嵌套函数使用外部函数变量的方法(Python2和Python3)
2016/01/31 Python
Python结巴中文分词工具使用过程中遇到的问题及解决方法
2017/04/15 Python
python Socket之客户端和服务端握手详解
2017/09/18 Python
Python 使用with上下文实现计时功能
2018/03/09 Python
pandas系列之DataFrame 行列数据筛选实例
2018/04/12 Python
tensorflow 用矩阵运算替换for循环 用tf.tile而不写for的方法
2018/07/27 Python
解决pyinstaller打包pyqt5的问题
2019/01/08 Python
Python实现DDos攻击实例详解
2019/02/02 Python
在python里从协程返回一个值的示例
2019/02/19 Python
django多对多表的创建,级联删除及手动创建第三张表
2019/07/25 Python
python 普通克里金(Kriging)法的实现
2019/12/19 Python
使用Keras中的ImageDataGenerator进行批次读图方式
2020/06/17 Python
Python+unittest+DDT实现数据驱动测试
2020/11/30 Python
利用HTML5+CSS3实现3D转换效果实例详解
2017/05/02 HTML / CSS
德国骆驼商店:ActiveFashionWorld
2017/11/18 全球购物
英国女性运动服品牌:Sweaty Betty
2018/11/08 全球购物
了解AppleShare protocol(AppleShare协议)吗
2015/08/28 面试题
师范学院教师自荐书
2014/01/31 职场文书
2014年高中教师工作总结
2014/12/19 职场文书
幼儿教师师德师风自我评价
2015/03/05 职场文书
行政后勤人员工作计划应该怎么写?
2019/08/16 职场文书
浅谈mysql返回Boolean类型的几种情况
2021/06/04 MySQL
使用Python开发贪吃蛇游戏 SnakeGame
2022/04/30 Python