Pycharm从Git子模块导入

Question

我在Pycharm中有一个python项目，其中有一个嵌套的Git子模块。以下是文件夹结构：

my-git-repo
    git-submodule-repo
        package1
           foo.py
           bar.py
    package2
        baz.py
    .gitmodules

git子模块repo中的导入结构如下：

foo.py:
from package1.bar import some_func

但是，Pycharm没有意识到这一点，而是希望我拥有以下内容：

foo.py:
from git-submodule-repo.package1.bar import some_func

这是有问题的，因为我不想更改git子模块repo中的所有导入（这似乎不是一个好的实践，也不可扩展），而且git子模块repo中有破折号，这对于导入来说不是有效的Python语法（我无法重命名repo）。

我还需要一种从我的代码中导入git-submodor-repo的方法。像这样的东西：

baz.py:
from git-submodule-repo.package1.bar import some_func

但当然，没有破折号使其语法无效。以下是.gitmodules的内容，以防有用：

[submodule "git-submodule-repo"]
    path = git-submodule-repo
    url = https://github.com/SomeAccount/git-submodule-repo.git

任何帮助都将不胜感激！

Answer 1

包名称不应包含破折号。

这个问题是由于你的包的命名包含"-"破折号，这在python中是不允许的。所以你永远不能导入git-submodor-repo。git-submodor-repo不是一个标识符。重命名子模块为git_submodule_repo，你将能够导入它就像一个普通的包。

所以这与pycharm无关，也与子模块无关。

Answer 2

SOUTION 1
通过在首选项中将子模块文件夹标记为源来使用本机PyCharm支持-

解决方案2
查看@Kevin提出的关于从git子模块导入python文件的一般解决方案。您可以在项目根目录中创建指向lib的软链接。在您的情况下，命令将是：
$ln-s git-submodule-repo.package1 package1
然后您将能够从package1.bar导入。从foo.py导入一些函数
这种方法的缺点是它不是跨平台的，例如，如果需要，您将无法从windows运行它信息技术