如何在本地开发python包？

Question

我试图对现有的python模块进行更改，然后在本地测试它。最好的方法是什么？

我克隆了github模块并做了修改，但是我不确定如何导入本地包而不是已经安装的包。

Answer 1

您可能应该在虚拟环境中完成大部分开发工作。您的工作流程可能如下所示：

# activate the virtual environment in ~/vpy
. $HOME/vpy/bin/activate

# install my app and its dependencies
cd $HOME/src/myapp
pip install -e .

# use my forked library instead
cd $HOME/src/forkedlib
pip install -e .
pytest # or whatever tests the forked lib has

# try it out with my application too
cd $HOME/src/myapp
pytest # or whatever tests your app has
myapp

pip安装-e做了一些神奇的事情，所以每当你导入库中的模块时，它会直接路由到签出的源代码树，所以如果你在forkedlib中进行编辑，然后重新运行myapp，您将直接看到这些更改。

完成后，您可以pip卸载forkedlib，然后重新运行pip安装-e.以重新安装应用程序的（声明的）依赖项。（如果更容易的话，也可以删除并重新创建虚拟环境。）

Answer 2

你可以：

• 通过在与要运行的脚本相同的文件夹中创建另一个具有相同名称的模块/包来覆盖模块/包。

我推荐阅读这篇文章，它很好地解释了模块和包。

您需要创建一个模块或一个包（这没什么区别），使用与您想要的模块/包相同的名称，并将其放在与要使用它的脚本相同的文件夹中。

这是因为从sys.path变量开始搜索模块（其中第一个元素是脚本的目录）

1. 创建包含以下内容的脚本：

import platform

print(platform.system())

启动它（python您的测试脚本.py）应该返回：

现在，在前面的测试脚本的同一目录中创建一个名为platform.py的文件，其内容如下：

def system():
    """Just a docstring passing by"""
    return "We have just overwritten default 'platform' module...\nFeel the force!"

如果现在启动脚本，您会注意到输出不同：

如果您的项目更复杂，则是更好的选择。

从包的根目录（启动构建的地方）：

pip install -e ./ 

现在，您可以编辑代码并实时查看更改。

从包装的乐趣中：

它将一个链接（实际上是*.pth文件）放入python安装中，以便安装您的包，但任何更改都将立即生效。

这样，您的所有测试代码、客户机代码等都可以以通常的方式导入您的包。

没有系统路径黑客

Answer 3

进行这种测试最简单的方法是创建一个虚拟环境，然后在开发模式下安装包。

假设您在Linux上，它看起来是这样的。

$ virtualenv dev_env
$ source dev_env/bin/activate
$ cd ~/project_folder
$ pip install -e .

此工作流不会覆盖系统上已安装的软件包。另一种可能更简单的选择是只使用一个IDE来为您处理大部分这方面的问题，例如PyCharm。