概要

我正在为Anki(开源抽认卡程序)开发一系列附加组件。 Anki附加组件以Python软件包的形式提供，其基本文件夹结构如下所示:

anki_addons/
    addon_name_1/
        __init__.py
    addon_name_2/
        __init__.py

addon_name_1/
    __init__.py
    _vendor/
        __init__.py
        library1
        library2
        dependency_of_library2
        ...

from ._vendor import library1

最佳答案

首先，我建议不要出售。一些主要软件包以前曾使用过供应商，但是为了避免不得不处理供应商的痛苦，已经放弃了。这样的例子之一是 requests library。如果您依靠使用pip install来安装软件包的人员，则只需使用依赖项并向人们介绍虚拟环境。不要假设您需要承担使依赖关系困惑的负担，也不必阻止人们在全局Python site-packages位置中安装依赖关系。

同时，我知道第三方工具的插件环境有所不同，并且如果对该工具使用的Python安装添加依赖项很麻烦或无法进行商贩销售，则是可行的选择。我看到Anki在不支持setuptools的情况下将扩展名作为.zip文件分发，因此肯定是这种环境。

因此，如果您选择供应商依赖性，则可以使用脚本来管理依赖性并更新其导入。这是您的选择＃1，但自动化。

这是pip项目选择的路径，有关其自动化的信息，请参见 tasks subdirectory，该路径建立在 invoke library之上。请参阅pip项目vendoring README了解其政策和基本原理(其中的主要之处是pip需要自举，例如，可以使用其依赖项来安装任何东西)。

您不应使用任何其他选项；您已经列举了＃2和＃3的问题。

使用自定义导入程序的选项＃4的问题在于，您仍然需要重写导入。换句话说，setuptools使用的自定义导入程序钩子(Hook)根本无法解决供应商 namespace 的问题，相反，如果缺少供应商化的软件包( pip solves with a manual debundling process这个问题)，则可以动态导入顶级软件包。 setuptools实际上使用选项＃1，在那里他们重写供应商软件包的源代码。参见packaging供应子包中的these lines in the setuptools project。 setuptools.extern命名空间由自定义导入挂钩处理，如果从供应商化程序包的导入失败，则它将重定向到setuptools._vendor或顶级名称。

用来更新供应商软件包的pip自动化执行以下步骤:

import shutil
import subprocess
import re

from functools import partial
from itertools import chain
from pathlib import Path

WHITELIST = {'README.txt', '__init__.py', 'vendor.txt'}

def delete_all(*paths, whitelist=frozenset()):
    for item in paths:
        if item.is_dir():
            shutil.rmtree(item, ignore_errors=True)
        elif item.is_file() and item.name not in whitelist:
            item.unlink()

def iter_subtree(path):
    """Recursively yield all files in a subtree, depth-first"""
    if not path.is_dir():
        if path.is_file():
            yield path
        return
    for item in path.iterdir():
        if item.is_dir():
            yield from iter_subtree(item)
        elif item.is_file():
            yield item

def patch_vendor_imports(file, replacements):
    text = file.read_text('utf8')
    for replacement in replacements:
        text = replacement(text)
    file.write_text(text, 'utf8')

def find_vendored_libs(vendor_dir, whitelist):
    vendored_libs = []
    paths = []
    for item in vendor_dir.iterdir():
        if item.is_dir():
            vendored_libs.append(item.name)
        elif item.is_file() and item.name not in whitelist:
            vendored_libs.append(item.stem)  # without extension
        else:  # not a dir or a file not in the whilelist
            continue
        paths.append(item)
    return vendored_libs, paths

def vendor(vendor_dir):
    # target package is <parent>.<vendor_dir>; foo/_vendor -> foo._vendor
    pkgname = f'{vendor_dir.parent.name}.{vendor_dir.name}'

    # remove everything
    delete_all(*vendor_dir.iterdir(), whitelist=WHITELIST)

    # install with pip
    subprocess.run([
        'pip', 'install', '-t', str(vendor_dir),
        '-r', str(vendor_dir / 'vendor.txt'),
        '--no-compile', '--no-deps'
    ])

    # delete stuff that's not needed
    delete_all(
        *vendor_dir.glob('*.dist-info'),
        *vendor_dir.glob('*.egg-info'),
        vendor_dir / 'bin')

    vendored_libs, paths = find_vendored_libs(vendor_dir, WHITELIST)

    replacements = []
    for lib in vendored_libs:
        replacements += (
            partial(  # import bar -> import foo._vendor.bar
                re.compile(r'(^\s*)import {}\n'.format(lib), flags=re.M).sub,
                r'\1from {} import {}\n'.format(pkgname, lib)
            ),
            partial(  # from bar -> from foo._vendor.bar
                re.compile(r'(^\s*)from {}(\.|\s+)'.format(lib), flags=re.M).sub,
                r'\1from {}.{}\2'.format(pkgname, lib)
            ),
        )

    for file in chain.from_iterable(map(iter_subtree, paths)):
        patch_vendor_imports(file, replacements)

if __name__ == '__main__':
    # this assumes this is a script in foo next to foo/_vendor
    here = Path('__file__').resolve().parent
    vendor_dir = here / 'foo' / '_vendor'
    assert (vendor_dir / 'vendor.txt').exists(), '_vendor/vendor.txt file not found'
    assert (vendor_dir / '__init__.py').exists(), '_vendor/__init__.py file not found'
    vendor(vendor_dir)

关于python - 在不修改sys.path或第三方软件包的情况下，在Python软件包中导入供应商依赖性，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/52538252/