Python:在一系列脚本中共享公共代码

Question

我正在一个项目中编写一系列Python脚本; 每个脚本都在项目的子目录中,如下所示:

projectroot
  |
  |- subproject1
  |    |
  |    |- script1.main.py
  |    `- script1.merger.py
  |
  |- subproject2
  |    |
  |    |- script2.main.py
  |    |- script2.matcher.py
  |    `- script2.merger.py
  |
  `- subproject3
       |
       |- script3.main.py
       |- script3.converter.py
       |- script3.matcher.py
       `- script3.merger.py

现在有几个脚本共享一些代码.共享代码最好被认为是项目本身的一部分,而不是我单独编译并创建一个库,或者放入一个全站的PYTHONPATH.我可以将该代码放在各种位置,例如在projectroot目录本身中,或者在projectroot被调用的子目录中common(可能).

但是,到目前为止,我所考虑的大部分方法都是使用空__init__.py文件和使用相对导入(或sys.path在每个子项目中冗余地搞乱)从子项目中创建包.更糟糕的是,似乎围绕这个脚本系列构建包结构被拒绝的PEP-3122发出以下警告:

注意!该PEP已被拒绝.Guido将包中的脚本视为反模式.

如果包中的脚本是反模式的,那么如何以一种将公共代码保存在同一项目中的方式进行设置？或者这里是否可以接受基于模块和包的系统？哪种方法最干净？(FWIW我更喜欢在项目根目录中有一个文件,shared.py或者common.py在项目根目录中,而不是创建一个实用程序目录,它是"真正的"子项目的兄弟.)

Answer 1

我建议将琐碎的"启动器"脚本放在项目的顶层,并将每个子项目文件夹放入包中.包中的模块可以相互导入,也可以将公共代码分解到common包中.

如果我们假设各种merger模块可以重构为共享版本,那么这就是结构的样子:

projectroot
  |- script1.py # launcher scripts, see below for example code
  |- script2.py
  |- script3.py
  |
  |- common
  |    |- __init__.py
  |    |- merger.py # from other packages, use from ..common import merger to get this
  |
  |- subproject1
  |    |- __init__.py # this can be empty
  |    |- script1_main.py
  |
  |- subproject2
  |    |- __init__.py
  |    |- script2_main.py
  |    |- script2_matcher.py
  |
  |- subproject3
       |- __init__.py
       |- script3_main.py
       |- script3_converter.py
       |- script3_matcher.py

启动器脚本可以非常简单:

from subproject1 import script1_main

if __name__ == "__main__":
    script1_main.main()

也就是说,它所做的就是导入适当的"scriptN_main"模块并在其中运行一个函数.使用简单的脚本也可能对脚本启动速度有一些小的好处,因为main模块可以将其编译的字节码缓存到.pyc文件中,而脚本永远不会被缓存.

注意:我重命名了您的模块,_为.字符交换字符.您不能拥有.标识符(例如模块名称),因为Python期望它指示属性访问.这意味着永远不能导入这些模块.(我猜这只是示例文件的工件,而不是你真实代码中的东西.)