兄弟包导入

我试着通读关于兄弟姐妹导入的问题，甚至软件包文档，但我还没找到答案。

结构如下:

├── LICENSE.md
├── README.md
├── api
│   ├── __init__.py
│   ├── api.py
│   └── api_key.py
├── examples
│   ├── __init__.py
│   ├── example_one.py
│   └── example_two.py
└── tests
│   ├── __init__.py
│   └── test_one.py

示例和测试目录中的脚本如何从 API模块和从命令行运行?

另外，我希望避免对每个文件都使用难看的sys.path.insert。肯定这可以在Python中完成，对吧?

当前回答

我想评论一下np8提供的解决方案，但我没有足够的声誉，所以我只想说，你可以完全按照他们建议的那样创建一个setup.py文件，然后执行pipenv install——dev -e。将其转换为可编辑的依赖项。然后你的绝对导入将工作，例如从api。API import foo，你就不必在系统范围的安装上瞎折腾了。

文档

2020-10-25 00:34:03

其他回答

下面是我在tests文件夹的Python文件顶部插入的另一个替代方案:

# Path hack.
import sys, os
sys.path.insert(0, os.path.abspath('..'))

2012-02-25 17:02:56

七年之后

由于我把答案写在下面，修改sys.;Path仍然是一种快速而肮脏的技巧，适用于私有脚本，但是已经有了一些改进

安装包(在virtualenv中或不在virtualenv中)会给你想要的，尽管我建议使用pip来完成，而不是直接使用setuptools(并使用setup.cfg存储元数据) 使用-m标志并作为包运行也可以(但是如果您想将工作目录转换为可安装包，则会有点尴尬)。具体来说，对于测试，pytest能够在这种情况下找到api包，并负责sys. exe。给你的路径技巧

所以这取决于你想做什么。但是，在您的情况下，由于您的目标似乎是在某种程度上制作一个适当的包，因此通过pip -e安装可能是您的最佳选择，即使它还不完美。

旧的答案

正如在其他地方已经说过的，可怕的事实是，你必须做一些丑陋的hack来允许从__main__模块的兄弟模块或父包导入。该问题在PEP 366中有详细说明。PEP 3122试图以更合理的方式处理导入，但Guido拒绝了它

唯一的用例似乎是运行发生的脚本在一个模块的目录中，我总是把它看作一个反模式。

(在这里)

不过，我经常使用这种模式

# Ugly hack to allow absolute import from the root folder
# whatever its name is. Please forgive the heresy.
if __name__ == "__main__" and __package__ is None:
    from sys import path
    from os.path import dirname as dir

    path.append(dir(path[0]))
    __package__ = "examples"

import api

这里的路径[0]是运行脚本的父文件夹，目录(路径[0])是顶级文件夹。

虽然我还不能使用相对导入，但它确实允许从顶层(在示例api的父文件夹中)进行绝对导入。

2011-06-24 09:48:53

我还没有对python学有必要的理解，以了解在不相关的项目之间共享代码的预期方式，而没有兄弟姐妹/亲戚导入黑客。在那一天到来之前，这就是我的解决方案。用于从..导入内容的示例或测试。\api，它看起来像:

import sys.path
import os.path
# Import from sibling directory ..\api
sys.path.append(os.path.dirname(os.path.abspath(__file__)) + "/..")
import api.api
import api.api_key

2012-04-12 20:32:45

对于主要问题:

调用兄弟文件夹作为模块:

从. .进口siblingfolder

从兄弟文件夹调用a_file.py作为模块:

从. .兄弟文件夹导入a_file

在兄弟文件夹中的文件中调用a_function作为模块:

从. . siblingmodule。A_file import func_name_exists_in_a_file

最简单的方法。

进入lib/site-packages文件夹。

如果存在“easy_install.pth”文件，只需编辑它并添加您有脚本的目录，将其作为模块。

如果不存在，就把它变成一个…把你想要的文件夹放在那里