两个pip安装的模块同名，如何选择加载哪个？

如何解决两个pip安装的模块同名，如何选择加载哪个？

我正在编写一个依赖于特定模块 rtmidi 的 Python program。事实是，PyPI 中至少有两个不同的包有一个具有该名称的模块，rtmidi 和 python-rtmidi。它们提供几乎相同的功能，但具有不同的语法。

当只安装了“正确”的包时，一切正常。但是如果两个包都安装了，使用 import rtmidi 会加载“错误”的模块，我的程序就会崩溃。让它再次工作的唯一方法是卸载这两个软件包，然后重新安装正确的软件包。当然，由于用户可能会依赖其他模块来运行其他程序，我不能指望他们这样做。

尝试使用 rtmidi.__name__ 标识模块对两个包的结果相同。

所以我的问题是，我该如何解决这个名称冲突问题？有没有最佳实践方法来处理这个问题？

解决方法

您不能同时安装它们（如果依赖于默认的 pip 行为）。在这里，我将使用几个具有导入名称冲突的简单纯 Python 包进行演示：coveralls 和 python-coveralls。

# in a fresh environment
pip install python-coveralls
python -c "import coveralls; print(dir(coveralls)); print(coveralls.__file__)"
# ['__author__','__builtins__','__cached__','__classifiers__','__copyright__',# '__doc__','__docformat__','__file__','__license__','__loader__','__name__',# '__package__','__path__','__spec__','__version__','parse_args','wear']
# /path/to/lib/python3.8/site-packages/coveralls/__init__.py

这些是python-coveralls的内容。请注意，实际的 __init__.py 文件位于 site-packages/coveralls/ 目录中。

pip install coveralls
python -c "import coveralls; print(dir(coveralls)); print(coveralls.__file__)"
# ['Coveralls','__all__','__doc__',# '__loader__','__package__',# 'api','exception','git','reporter','version']
# /path/to/lib/python3.8/site-packages/coveralls/__init__.py

这些是coveralls的内容。 python-coveralls 已被覆盖。请注意，这是相同文件。旧 __init__.py 中的任何内容都消失了。

pip uninstall coveralls
python -c "import coveralls; print(dir(coveralls)); print(coveralls.__file__)"
# ['__doc__',# '__spec__']
# None

那里仍然有一个包的幽灵，但它的内容已经消失了（除了所有包内部都有的东西）。请注意，文件现在为 None：此包没有 __init__.py 文件。

您也可以通过运行 pip uninstall python-coveralls 然后重新安装任何您想要的来取消您的环境。

解决方案

您确实必须要求您的用户只使用符合您要求的软件包，但这就是我们使用虚拟环境的原因。或者，想要直接使用其他包的用户可以使用 --target option to pip 更改安装位置（以及加载时使用的名称）（但这对使用其他库的其他应用没有帮助）。

在实践中，最好将此视为安装过程的一部分。您要么需要 (a) 告诉您的用户他们需要安装什么要求；或者 (b) 有一些自动化流程来满足正确的要求。

我认为最佳做法是 (b)。执行此操作的常用方法是使用 setuptools，并为 install_requires 函数定义 setup 参数。这是指 PyPI 上的包名称，而不是导入名称。 The setuptools quickstart 是一个很好的起点。

以下内容基于hoefling的评论和dwhswenson的回答（后者很好地说明了问题所在）。

将其标记给项目所有者，以便他们更改其模块的名称。从理论上讲，这是迄今为止最好的解决方案，因为它不仅可以解决您的问题，还可以避免其他人的问题，这符合模块开发人员的最大利益。在实践中，它打开了一整罐蠕虫，关于哪个应该更改名称。
或者将模块包含在您的项目中，又名 vendoring，然后使用路径 my_project/_vendor/the_module（或在 sys.path 中首先添加该路径）导入它。如果模块只是一个 .py 文件并且许可证允许，这是解决问题的最简单方法。这在我的情况下是不可行的，因为我需要的模块包括一些需要编译的 C 代码，包括整个源代码然后要求用户编译它似乎是一个很大的问题。所以我不得不这样做：
或者告诉用户将模块安装在您项目的文件夹中。 使用带有选项 pip 的 --target 后跟项目中的文件夹路径，您可以可以获得您自己的模块副本，该副本不会覆盖系统副本。然后，您可以在导入之前检查该文件夹是否存在。如果是，请从那里导入模块，如果不是，您可以检查系统安装的模块是否正确，如果不是，则提示用户。

这是我如何在项目中实现代码的粗略示例。它取代了 import rtmidi

if os.path.isdir('my_project/rtmidi'):
    from .rtmidi.rtmidi import _rtmidi as rtmidi
else:
    try:
        import rtmidi
    except ImportError:
        print('Please run: pip3 install rtmidi')
        exit()
    try:
        # something that only works with the right module:
        test = rtmidi.MidiMessage() 
    except:
        print('Please run: pip3 install --target=./my_project/rtmidi rtmidi')
        exit()

注意：我可能应该只使用 try 来导入本地文件夹模块，而不是使用条件语句，并使用路径 my_project/_vendor/rtmidi。

我认为您应该查看您不想要哪个并将其删除，然后再次尝试导入。您可以在 site-packages 文件夹中找到包。

如果包名不同，则用包名导入，如果相同可以修改包名

两个pip安装的模块同名，如何选择加载哪个？

如何解决两个pip安装的模块同名，如何选择加载哪个？

解决方法

解决方案

相关推荐