兄弟包进口

├── 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

#1 楼

自从我在下面写下答案以来，已经有7年了。修改sys.path仍然是一种快捷技巧，对私有脚本来说效果很好，但是有了一些改进



（无论是否在virtualenv中）安装软件包都可以为您提供所需的信息，尽管我建议使用pip而不是直接使用setuptools（并使用setup.cfg存储元数据）

使用-m标志并作为程序包运行也可以（但是如果要将工作目录转换为可安装的程序包会有点尴尬）。
对于测试，特别是pytest能够在这种情况下找到api程序包，并为您解决sys.path的问题

，所以这实际上取决于您要执行的操作。不过，就您而言，既然您的目标似乎是在某个时候制作一个合适的程序包，那么通过pip -e进行安装可能是最好的选择，即使它尚不完美。

旧答案

正如在其他地方已经提到的那样，可怕的事实是，您必须进行丑陋的黑客攻击，才能允许从同级模块中导入或从__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

使用此模式，在这里path[0]是运行脚本的父文件夹，dir(path[0])是顶级文件夹。

尽管如此，我仍然不能使用相对导入，但是它确实允许从顶层绝对导入（在您的示例api的父文件夹中）。

#2 楼

对sys.path hack感到厌倦了吗？
有大量的sys.path.append -hacks可用，但是我找到了解决问题的另一种方法。
摘要

将代码包装到一个文件夹（例如packaged_stuff）
在使用setuptools.setup（）的地方使用create setup.py脚本。
使用pip install -e <myproject_folder>
以可编辑状态安装软件包。

使用from packaged_stuff.modulename import function_name导入



设置
起点是您提供的文件结构，包装在名为myproject的文件夹中。

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

我将调用.根文件夹，在我的示例中，它位于C:\tmp\test_imports\。
api.py
作为测试用例，让我们使用以下./api/api.py

def function_from_api():
    return 'I am the return value from api.api!'

test_one.py

from api.api import function_from_api

def test_function():
    print(function_from_api())

if __name__ == '__main__':
    test_function()

尝试运行test_one：

PS C:\tmp\test_imports> python .\myproject\tests\test_one.py
Traceback (most recent call last):
  File ".\myproject\tests\test_one.py", line 1, in <module>
    from api.api import function_from_api
ModuleNotFoundError: No module named 'api'

也尝试相对导入无效：
使用from ..api.api import function_from_api将导致

PS C:\tmp\test_imports> python .\myproject\tests\test_one.py
Traceback (most recent call last):
  File ".\tests\test_one.py", line 1, in <module>
    from ..api.api import function_from_api
ValueError: attempted relative import beyond top-level package

/>
步骤

将setup.py文件添加到根目录


setup.py的内容为*

from setuptools import setup, find_packages

setup(name='myproject', version='1.0', packages=find_packages())

使用虚拟环境


如果您熟悉虚拟环境，请激活一个，然后跳过进行下一步。虚拟环境的使用不是绝对必需的，但是从长远来看（当您正在进行多个项目时），它们确实可以帮助您。最基本的步骤是（在根文件夹中运行）

创建虚拟环境

python -m venv venv


激活虚拟环境


source ./venv/bin/activate（Linux，macOS）或./venv/Scripts/activate（Win）



要了解更多信息，只需Google出“ python虚拟环境教程” ”或类似内容。您可能永远不需要创建，激活和停用任何其他命令。
创建并激活虚拟环境后，控制台应在括号中给出虚拟环境的名称。

PS C:\tmp\test_imports> python -m venv venv
PS C:\tmp\test_imports> .\venv\Scripts\activate
(venv) PS C:\tmp\test_imports>

和您的文件夹树应该看起来像这样**

.
├── myproject
│   ├── api
│   │   ├── api_key.py
│   │   ├── api.py
│   │   └── __init__.py
│   ├── examples
│   │   ├── example_one.py
│   │   ├── example_two.py
│   │   └── __init__.py
│   ├── LICENCE.md
│   ├── README.md
│   └── tests
│       ├── __init__.py
│       └── test_one.py
├── setup.py
└── venv
    ├── Include
    ├── Lib
    ├── pyvenv.cfg
    └── Scripts [87 entries exceeds filelimit, not opening dir]

pip以可编辑状态安装项目


使用myproject安装顶级软件包pip。诀窍是在安装时使用-e标志。这样，它将以可编辑状态安装，并且对.py文件所做的所有编辑将自动包含在已安装的软件包中。
在根目录中，运行
pip install -e .（请注意点号，代表“当前目录”）
您还可以看到它是通过使用pip freeze安装的

(venv) PS C:\tmp\test_imports> pip install -e .
Obtaining file:///C:/tmp/test_imports
Installing collected packages: myproject
  Running setup.py develop for myproject
Successfully installed myproject
(venv) PS C:\tmp\test_imports> pip freeze
myproject==1.0

将myproject.添加到您的导入中


请注意，您仅需将myproject.添加到否则无法正常工作的导入中。在没有setup.py和pip install的情况下可以正常工作的导入仍然可以正常工作。请参阅下面的示例。

测试解决方案
现在，让我们使用上面定义的api.py和下面定义的test_one.py测试解决方案。
test_one.py

from myproject.api.api import function_from_api

def test_function():
    print(function_from_api())

if __name__ == '__main__':
    test_function()

运行测试

(venv) PS C:\tmp\test_imports> python .\myproject\tests\test_one.py
I am the return value from api.api!

*有关更多详细的setup.py示例，请参阅setuptools文档。
**实际上，您可以将虚拟环境放在任何地方都很难磁盘。

#3 楼

这是我在tests文件夹中的Python文件顶部插入的另一种选择：

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

#4 楼

除非有必要，否则您不需要也不应修改sys.path，在这种情况下则没有必要。使用：

import api.api_key # in tests, examples

从项目目录运行：python -m tests.test_one。

您可能应该将tests（如果它们是api的单元测试）移动到api内，并运行python -m api.test来运行所有测试（假设存在__main__.py），或者运行python -m api.test.test_one来运行test_one。

还可以从__init__.py（不是Python软件包）中删除examples，并在安装了api的virtualenv中运行示例，例如，如果您具有正确的pip install -e .，则virtualenv中的api会在内部安装setup.py软件包。

#5 楼

我还没有掌握Python知识的必要知识，以了解在没有同级/相对导入hack的情况下在不相关的项目之间共享代码的预期方式。直到那天，这是我的解决方案。对于examples或tests从..\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

#6 楼

对于同级包导入，可以使用[sys.path] [2]模块的insert或append方法：

if __name__ == '__main__' and if __package__ is None:
    import sys
    from os import path
    sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )
    import api

如下所示启动脚本：

python examples/example_one.py
python tests/test_one.py

另一方面，您也可以使用相对导入：

if __name__ == '__main__' and if __package__ is not None:
    import ..api.api

在这种情况下，您将必须使用'-m'参数启动脚本（请注意，在这种情况下，请勿输入'.py'扩展名）：

python -m packageName.examples.example_one
python -m packageName.tests.test_one

当然，您可以混合使用两种方法，这样无论脚本如何调用，脚本都可以正常工作：

if __name__ == '__main__':
    if __package__ is None:
        import sys
        from os import path
        sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )
        import api
    else:
        import ..api.api

#7 楼

TLDR

此方法不需要setuptools，path hacks，其他命令行参数或在项目的每个文件中指定软件包的顶层。

您要调用的__main__的父目录中的脚本，然后从那里运行所有内容。有关进一步的解释，请继续阅读。

解释

可以完成此操作，而无需一起寻找新路径，额外的命令行参数或向每个程序添加代码以识别其含义。同胞。

之所以失败，是因为我相信之前已经提到过，被调用的程序将其__name__设置为__main__。发生这种情况时，被调用的脚本会接受自身位于程序包的顶层，并拒绝识别兄弟目录中的脚本。

但是，目录顶层下的所有内容仍然可以识别任何其他内容在顶层之下。这意味着要使同级目录中的文件相互识别/利用，您只需要做的就是从其父目录中的脚本中对其进行调用。

概念证明
dir具有以下结构：

.
|__Main.py
|
|__Siblings
   |
   |___sib1
   |   |
   |   |__call.py
   |
   |___sib2
       |
       |__callsib.py

Main.py包含以下代码：

import sib1.call as call


def main():
    call.Call()


if __name__ == '__main__':
    main()

sib1 / call。 py包含：

import sib2.callsib as callsib


def Call():
    callsib.CallSib()


if __name__ == '__main__':
    Call()

和sib2 / callsib.py包含：

def CallSib():
    print("Got Called")

if __name__ == '__main__':
    CallSib()

如果重现此示例您会注意到，即使通过Main.py调用了sib2/callsib.py，调用sib2/callsib.py也会导致按照sib1/call.py的定义打印“ Got Called”。但是，如果直接调用sib1/call.py（在对导入进行了适当的更改之后），它将引发异常。即使它由其父目录中的脚本调用时可以工作，但是如果它认为自己位于程序包的顶层，则它将无法工作。

#8 楼

您需要查看如何在相关代码中编写导入语句。如果examples/example_one.py使用以下导入语句：

import api.api

...则它期望项目的根目录位于系统路径中。

最简单的方法来支持此操作（如您所说的那样）是从顶级目录运行示例，如下所示：

PYTHONPATH=$PYTHONPATH:. python examples/example_one.py 

#9 楼

以防万一有人在Eclipse上使用Pydev的情况出现在这里：您可以使用Project-> Properties并在左侧菜单Pydev-PYTHONPATH下设置External Libraries，将同级的父路径（以及调用模块的父路径）添加为外部库文件夹。然后，您可以从兄弟姐妹中导入，例如G。 from sibling import some_class。

#10 楼

我制作了一个示例项目来演示如何处理此问题，这确实是如上所述的另一个sys.path hack。 Python Sibling导入示例，该示例依赖于：

if __name__ == '__main__': import os import sys sys.path.append(os.getcwd())

，只要您的工作目录位于Python项目的根目录下，这似乎非常有效。如果有人将其部署在真实的生产环境中，那么很高兴知道它在这里是否也能正常工作。

#11 楼

我想评论一下np8提供的解决方案，但是我的信誉不高，所以我只想提一下，您可以按照他们的建议完全创建setup.py文件，然后从项目根目录执行pipenv install --dev -e .来将其打开变成可编辑的依赖项然后您的绝对导入将起作用例如from api.api import foo，您不必弄乱系统范围的安装。
文档

#12 楼

项目

1.1用户
1.1.1 about.py
1.1.2 init.py
1.2技术
1.2.1信息。 py
1.1.2 init.py
现在，如果要访问User包中的about.py模块，请从Tech包中的info.py模块中获取cmd（在Windows中）的项目路径，即按照上述“包”示例中的
C：\ Users \ Personal \ Desktop \ Project> **。然后从该路径输入python -m Package_name.module_name
例如，对于我们必须执行的上述Package，
C：\ Users \ Personal \ Desktop \ Project> python -m Tech。 info
Imp Points

在信息模块（即python -m Tech.info.py
）之后不要使用.py扩展名，请输入此名称，其中兄弟姐妹包处于同一级别。
-m是标志，要检查它，可以从cmd python --help


键入

#13 楼

针对主要问题：
将兄弟文件夹作为模块：
从.. import siblingfolder
从兄弟文件夹中将a_file.py调用作为模块：
从..siblingfolder导入a_file
在同级文件夹中的文件内调用a_function作为模块：
从..siblingmodule.a_file导入func_name_exists_in_a_file
最简单的方法。
转到lib / site-packages文件夹。
如果存在“ easy_install.pth”文件，则对其进行编辑，然后添加具有要使其作为模块的脚本的目录。
如果不存在，则使其成为一个...并放置您要的文件夹在其中
添加...之后，python会自动将其视为类似于站点包的文件夹，并且您可以将该文件夹或子文件夹中的每个脚本作为模块进行调用。手机，并且很难设置它，以使每个人都能轻松阅读。

#14 楼

首先，应避免使用与模块本身同名的文件。可能会中断其他导入。

导入文件时，首先解释器检查当前目录，然后搜索全局目录。

在examples或tests内部，您可以调用：

from ..api import api