运行setup.py时，如何获取Python wheel的文件名？

Question

我有一个使用以下命令创建Python轮子的构建过程：

python setup.py bdist_wheel

构建过程可以在许多平台（Windows，Linux，py2，py3等）上运行，我想保留默认输出名称（例如mapscript-7.2-cp27-cp27m-win_amd64.whl）以上传到PyPI。

无论如何，是否有获取生成的车轮的文件名（例如mapscript-7.2-cp27-cp27m-win_amd64.whl）并保存到变量，以便稍后可以在脚本中安装车轮以进行测试？

理想的解决方案是跨平台。我当前的方法是尝试清除文件夹，列出所有文件，然后选择列表中的第一个（也是唯一一个）文件，但是，这似乎是一个非常棘手的解决方案。

Answer 1

我当前安装轮子的方法是将 pip 指向包含轮子的文件夹并让它自行搜索：

python -m pip install --no-index --find-links=build/dist mapscript

twine 还可以直接指向文件夹，而无需知道确切的轮子名称。

Answer 2

setuptools

如果您使用setup.py脚本构建wheel 发行版，您可以使用bdist_wheel命令查询wheel 文件名。这种方法的缺点是它使用bdist_wheel的私有 API，因此wheel如果作者决定更改它，代码可能会在包更新时中断。

from setuptools.dist import Distribution


def wheel_name(**kwargs):
    # create a fake distribution from arguments
    dist = Distribution(attrs=kwargs)
    # finalize bdist_wheel command
    bdist_wheel_cmd = dist.get_command_obj('bdist_wheel')
    bdist_wheel_cmd.ensure_finalized()
    # assemble wheel file name
    distname = bdist_wheel_cmd.wheel_dist_name
    tag = '-'.join(bdist_wheel_cmd.get_tag())
    return f'{distname}-{tag}.whl'

该wheel_name函数接受您传递给该setup()函数的相同参数。用法示例：

>>> wheel_name(name="mydist", version="1.2.3")
mydist-1.2.3-py3-none-any.whl
>>> wheel_name(name="mydist", version="1.2.3", ext_modules=[Extension("mylib", ["mysrc.pyx", "native.c"])])
mydist-1.2.3-cp36-cp36m-linux_x86_64.whl

请注意，本机库（mysrc.pyx或native.c在上面的示例中）的源文件不必存在来组合轮名称。如果本机库的源还不存在（例如，您稍后通过 SWIG、Cython 或其他方式生成它们），这会很有帮助。

这使得在您定义分发元数据wheel_name的setup.py脚本中可以轻松重用：

# setup.py
from setuptools import setup, find_packages, Extension
from setup_helpers import wheel_name

setup_kwargs = dict(
    name='mydist',
    version='1.2.3',
    packages=find_packages(),
    ext_modules=[Extension(...), ...],
    ...
)
file = wheel_name(**setup_kwargs)
...
setup(**setup_kwargs)

如果您想在设置脚本之外使用它，您必须自己组织对setup()args的访问（例如从setup.cfg脚本或其他内容中读取它们）。

这部分松散地基于我对setuptools 的其他回答，提前知道本机库的轮文件名

poetry

如果您使用，事情可以简化很多（实际上是单行的），poetry因为所有相关的元数据都存储在pyproject.toml. 同样，这使用了一个未记录的 API：

from clikit.io import NullIO

from poetry.factory import Factory
from poetry.masonry.builders.wheel import WheelBuilder
from poetry.utils.env import NullEnv


def wheel_name(rootdir='.'):
    builder = WheelBuilder(Factory().create_poetry(rootdir), NullEnv(), NullIO())
    return builder.wheel_filename

该rootdir参数是一个包含你的目录pyproject.toml脚本。

flit

AFAIKflit无法使用本机扩展构建轮子，因此它只能为您提供 purelib 名称。不过，如果您的项目flit用于分发构建，它可能会很有用。请注意，这也使用了未公开的 API：

from flit_core.wheel import WheelBuilder
from io import BytesIO
from pathlib import Path


def wheel_name(rootdir='.'):
    config = str(Path(rootdir, 'pyproject.toml'))
    builder = WheelBuilder.from_ini_path(config, BytesIO())
    return builder.wheel_filename

实施您自己的解决方案

我不确定这是否值得。尽管如此，如果您想选择这条路径，请packaging.tags在找到一些已弃用的旧内容之前考虑使用，甚至决定自己查询平台。不过，您仍然必须回到私人的东西来组装正确的车轮名称。

Answer 3

我使用了 Hoefling 解决方案的修改版本。我的目标是将构建复制到“最新”轮文件。该setup()函数将返回一个包含您需要的所有信息的对象，因此您可以找出它实际构建的内容，这似乎比上面的解决方案更简单。假设您正在使用一个变量version，下面将获取我刚刚构建的文件名，然后复制它。

setup = setuptools.setup(
    # whatever options you currently have
    )
wheel_built = 'dist/{}-{}.whl'.format(
    setup.command_obj['bdist_wheel'].wheel_dist_name,
    '-'.join(setup.command_obj['bdist_wheel'].get_tag()))
wheel_latest = wheel_built.replace(version, 'latest')
shutil.copy(wheel_built, wheel_latest)
print('Copied {} >> {}'.format(wheel_built, wheel_latest))

我想一个可能的缺点是你必须实际进行构建才能获得名称，但由于这是我工作流程的一部分，所以我对此表示同意。hoefling 的解决方案的好处是让您可以规划名称而不进行构建，但它似乎更复杂。