如何从git子模块导入python文件

Question

我有一个使用git子模块的项目。在我的python文件中，我想在子模块项目中使用另一个python文件中的函数。

为了工作，我必须将init.py文件添加到路径中的所有子文件夹中。我的文件夹树如下：

myproj
├── gitmodules
│   ├── __init__.py
│   ├── __init__.pyc
│   └── mygitsubmodule
│       ├── __init__.py
│       ├── __init__.pyc
│       └── file.py
└── myfile.py

有没有办法让它在不接触mygitsubmodule的情况下工作？

谢谢

Answer 1

作为参考，

       from submodulefolder.file import func_name   

或者

       import submodulefolder.file as lib_name

其中file排除了file.py的扩展名，似乎在相对的条件下工作，而不修改子文件夹/git子模块与Python 3.3以来的init.py，如图所示。

在py3.8.5 linux本机和py3.7.8 anaconda Windows上进行测试，这两种Windows都在Spyder的Ipython控制台上进行测试，也可以通过终端在linux本机上进行测试。

Answer 2

我习惯于避免修改sys.path。

问题是，当使用git子模块时，子模块是一个项目目录，而不是Python包。你的模块和那个包之间有一个“缺口”，所以你不能导入。

假设您已经创建了一个名为foo_project的子模块，其中有一个foo包。

.
├── foo_project
│   ├── README.rst
│   └── foo
│       └── __init__.py
└── main.py

我的解决方案是创建一个软链接，将该包公开给您的模块：

ln -s foo_project/foo foo

.
├── foo_project
│   ├── README.rst
│   └── foo
│       └── __init__.py
├── foo -> foo_project/foo
└── main.py

现在可以在main.py中导入foo。

Answer 3

您可以添加到您希望能够访问模块的文件中的sys.path，例如：

import sys
sys.path.append("/home/me/myproj/gitmodules")
import mygitsubmodule

本例将添加一个路径作为原始字符串，以明确发生了什么。您应该真正使用下面描述的更复杂、独立于系统的方法来确定和组装路径。

另外，当我使用此方法时，我发现使用sys.path.insert（1，…更好，因为一些功能似乎依赖于sys.path[0]作为程序的起始目录。