我應該如何為此設置 python 包

Question

我正在創建一個我計划放在 Github 上的工具。 它非常籠統，但是我還想包括一些使用示例。 因此，我設置了以下文件夾結構。

此工具適用於 python 3。

repository/
   commonTool.py
   commonTool2.py
   specificUsage/
     runTheSpecificUsage.py
     helpRunTheSpecificUsage.py

現在， specificUsage/文件夾中的兩個腳本都將導入 commonTool.py 和 commonTool2.py 中的方法。

我的問題是理想情況下用戶將能夠 go

python repository/specificUsage/runTheSpecificUsage.py

但是我不能讓它工作。 它永遠無法導入其上方文件夾中的功能。 我已經嘗試了各種關於如何從超級文件夾中導入文件但沒有運氣的帖子。

我應該如何設置這些文件夾？ 我應該有一個init .py 還是兩個？ 在哪里？

Answer 1

您可以在頂層創建setup.py以及commonTool.py和commonTool2.py 。 在 setup.py 中，輸入以下行：

import setuptools
setuptools.setup(packages=setuptools.find_packages())

然后將__init__.py放在同一級別以及specificUsage/中。 您應該能夠像這樣從specificUsage導入：

import commonTool

設置文件后，從頂層運行：

pip install -e .

您可能還想考慮 Python 對模塊和包具有很強的命名約定，並且通常不贊成駝峰式。 如果您願意，可以在這里閱讀更多內容。