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 中的以下警告相冲突:

Attention! This PEP has been rejected. Guido views running scripts within a package as an anti-pattern.

如果包中的脚本是反模式的，我该如何设置以将公共(public)代码保留在同一个项目中？或者这里可以接受基于模块和包的系统吗？哪种方法最干净？ (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 期望它指示属性访问。这意味着这些模块永远无法导入。 (我猜这只是示例文件的产物，而不是您在真实代码中拥有的东西。)