厌倦了 sys.path 黑客?
有很多sys.path.append
可用的-hacks,但我找到了解决手头问题的另一种方法。
概括
- 将代码打包到一个文件夹中(例如
packaged_stuff
)
setup.py
在您使用setuptools.setup()的地方创建脚本。(见下文最小setup.py
)
- Pip 以可编辑状态安装包
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())
- 使用虚拟环境
如果您熟悉虚拟环境,请激活一个,然后跳到下一步。虚拟环境的使用不是绝对必要的,但从长远来看,它们确实会帮助你(当你有超过 1 个正在进行的项目时......)。最基本的步骤是(在根文件夹中运行)
- 创建虚拟环境
- 激活虚拟环境
source ./venv/bin/activate
(Linux、macOS) 或./venv/Scripts/activate
(Win)
要了解更多信息,只需谷歌搜索“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!
* 请参阅setuptools 文档以获取更详细的 setup.py 示例。
** 实际上,您可以将虚拟环境放在硬盘上的任何位置。