兄弟姐妹包進口

Question

我已經嘗試閱讀有關兄弟姐妹進口甚至 package documentation的問題，但我還沒有找到答案。

結構如下：

├── 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模塊examples和tests目錄導入腳本並從命令行運行？

此外，我想避免醜陋的sys.path.insert破解每個文件。當然 這可以在Python中完成，對吧？

Answer 1

如在別處已經說過的，可怕的事實是，你必須做的醜陋黑客以允許從__main__模塊從兄弟姐妹模塊的進口或父母包。該問題詳述於PEP 366。 PEP 3122試圖處理進口更合理的方式，但圭多已經拒絕了一個賬戶的

The only use case seems to be running scripts that happen to be living inside a module's directory, which I've always seen as an antipattern.

（here）

雖然，我使用定期這種模式與

# 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的父文件夾）。

Answer 2

您需要查看導入語句是如何寫入相關代碼的。如果examples/example_one.py使用以下import語句：

import api.api 

...那麼，它預計該項目的根目錄是在系統路徑。

來支持這一點沒有任何黑客（因爲你把它），可運行從頂級目錄的例子，比如最簡單的方法：

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

Answer 3

首先，你應該避免與文件與模塊本身同名。它可能會打破其他進口。

當您導入文件時，首先解釋器檢查當前目錄，然後搜索全局目錄。

內examples或tests您可以撥打：

from ..api import api 

Answer 4

這裏是我在Python文件的頂部tests文件夾中插入另一選擇：

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

Answer 5

我還沒有Pythonology所必需的理解看到的共享代碼之間不相關的項目預期的方式沒有兄弟姐妹/相對進口黑客攻擊。直到那一天，這是我的解決方案。對於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 

Answer 6

萬一有人使用Eclipse的Pydev的結束了在這裏：你可以爲添加的兄弟姐妹的父路徑（因而調用模塊的母公司）外部庫文件夾使用項目 - >屬性和設置外部庫在左側菜單Pydev-PYTHONPATH。然後你可以從你的兄弟姐妹導入， G。 from sibling import some_class。

Answer 7

你不需要也不應該破解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代替。

你也可以刪除examples__init__.py（它不是一個Python包），並在api是例如安裝了virtualenv中運行示例，pip install -e .在virtualenv中，如果你有正確的setup.py將安裝就位api包。

Answer 8

對於兄弟姐妹包導入，可以使用任一插入或追加的方法[sys.path中] [2]模塊：

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' argument啓動腳本（注意，在這種情況下，你一定不要給「的.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