将Python源代码拆分到单独的目录中？

Question

以下是我的公司“foo.com”使用的一些各种 Python 包：

com.foo.bar.web
com.foo.bar.lib
com.foo.zig.web
com.foo.zig.lib
com.foo.zig.lib.lib1
com.foo.zig.lib.lib2

这是将源代码存储在磁盘上的传统方法：

pysrc/
  com/
    foo/
      bar/
        web/
        lib/
      zig/
        web/
        lib/
          lib1/
          lib2/

PYTHONPATH=pysrc

但出于组织目的（不同的团队、不同的版本控制等），我们希望将它们存储如下：

bar/
  pysrc/
    com/
      foo/
        bar/
          web/
          lib/
zig/
  pysrc/
    com/
      foo/
        zig/
          web/
          lib/
            lib1/
            lib2/

PYTHONPATH=bar/pysrc:zig/pysrc

问题是：

第二种组织方法有什么问题吗？

例如，如果我们 import com.foo，Python 会在哪里查找 __init__.py？

符号链接这些目录有意义吗？例如：

pysrc/
  com/
    foo/
      bar/ -> symlink to /bar/pysrc/com/foo/
      zig/ -> symlink to /zig/pysrc/com/foo/

欢迎任何一般代码组织建议。

Answer 1

Python 将按顺序遍历 sys.path（包括 PYTHONPATH 等），在每个路径中查找 com.foo 包。它找到的第一个名称空间将用于排除其他名称空间，这与 Perl 或 Java 不同，它们有效地将包名称空间合并在一起。您可以对 __path__ 执行一些操作来更改此行为，但“第一个匹配获胜”是 Python 开箱即用的行为方式。

只要将所有 com.foo.bar 完全保留在 bar/ 中并将所有 com.foo.zig 完全保留在 zig/ 中，第二种布局就不会有任何问题。

Answer 2

通读 PEP 420 页面，您似乎可以添加以下内容__init__.py 到共享包：

from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)

所以你的目录结构将如下（*标记的__init__.py文件具有上述代码）：

myroot/
├── bar
│   └── pysrc
│       └── com
│           ├── ****__init__.py****
│           └── foo
│               ├── ****__init__.py****
│               └── bar
│                   ├── __init__.py
│                   ├── lib
│                   │   ├── __init__.py
│                   │   └── barlib.py
│                   └── web
│                       ├── __init__.py
│                       ├── barweb.py
└── zig
    └── pysrc
        └── com
            ├── ****__init__.py****
            └── foo
                ├── ****__init__.py****
                └── zig
                    ├── __init__.py
                    ├── lib
                    │   ├── __init__.py
                    │   ├── lib1
                    │   │   ├── __init__.py
                    │   │   └── ziblib1.py
                    │   └── lib2
                    │       ├── __init__.py
                    │       └── ziblib2.py
                    └── web
                        ├── __init__.py
                        ├── zigweb.py

设置python路径指向到您的 com/ 目录：

barPath=/myroot/bar/pysrc/
zigPath=/myroot/zig/pysrc/
export PYTHONPATH=$PYTHONPATH:$barPath:$zigPath

要测试（我在 2.7.14 和 3.6.4 上尝试过）：

from com.foo.bar.web.barweb import BarWeb
from com.foo.zig.web.zigweb import ZigWeb
b = BarWeb()
z = ZigWeb()

没有 __init__.py 代码会产生：

ImportError: No module named zig.web.zigweb