无法显示包含单击入口点的Python二进制PEX版本

Question

Python单击CLI应用程序

使用单击库构建Python CLI应用程序时，可以执行以下操作：

@click.version_option()
def cli():
    '''
    Main Entry Point to Click Interface
    '''

要做到这一点：

[user@host]$ clickapp --version

单击打包在pex

但是，当我将其打包为pex文件时，我的click应用程序的每个其他参数、选项、命令、子命令都可以工作，除了--version

当我运行时（clickapp现在是一个二进制可执行文件pex）：

[user@host]$ ./clickapp --version

我得到以下错误：

Traceback (most recent call last):
  File "/~/clickapp/.bootstrap/pex/pex.py", line 446, in execute
  File "/~/clickapp/.bootstrap/pex/pex.py", line 378, in _wrap_coverage
  File "/~/clickapp/.bootstrap/pex/pex.py", line 409, in _wrap_profiling
  File "/~/clickapp/.bootstrap/pex/pex.py", line 508, in _execute
  File "/~/clickapp/.bootstrap/pex/pex.py", line 610, in execute_entry
  File "/~/clickapp/.bootstrap/pex/pex.py", line 626, in execute_pkg_resources
  File "/~/.pex/installed_wheels/7bcb1b5bf49ca3f89c348c338d33c04e3d59dfc1/click-7.1.2-py2.py3-none-any.whl/click/core.py", line 829, in __call__
    return self.main(*args, **kwargs)
  File "/~/.pex/installed_wheels/7bcb1b5bf49ca3f89c348c338d33c04e3d59dfc1/click-7.1.2-py2.py3-none-any.whl/click/core.py", line 781, in main
    with self.make_context(prog_name, args, **extra) as ctx:
  File "/~/.pex/installed_wheels/7bcb1b5bf49ca3f89c348c338d33c04e3d59dfc1/click-7.1.2-py2.py3-none-any.whl/click/core.py", line 700, in make_context
    self.parse_args(ctx, args)
  File "/~/.pex/installed_wheels/7bcb1b5bf49ca3f89c348c338d33c04e3d59dfc1/click-7.1.2-py2.py3-none-any.whl/click/core.py", line 1212, in parse_args
    rest = Command.parse_args(self, ctx, args)
  File "/~/.pex/installed_wheels/7bcb1b5bf49ca3f89c348c338d33c04e3d59dfc1/click-7.1.2-py2.py3-none-any.whl/click/core.py", line 1048, in parse_args
    value, args = param.handle_parse_result(ctx, opts, args)
  File "/~/.pex/installed_wheels/7bcb1b5bf49ca3f89c348c338d33c04e3d59dfc1/click-7.1.2-py2.py3-none-any.whl/click/core.py", line 1630, in handle_parse_result
    value = invoke_param_callback(self.callback, ctx, self, value)
  File "/~/.pex/installed_wheels/7bcb1b5bf49ca3f89c348c338d33c04e3d59dfc1/click-7.1.2-py2.py3-none-any.whl/click/core.py", line 123, in invoke_param_callback
    return callback(ctx, param, value)
  File "/~/.pex/installed_wheels/7bcb1b5bf49ca3f89c348c338d33c04e3d59dfc1/click-7.1.2-py2.py3-none-any.whl/click/decorators.py", line 295, in callback
    raise RuntimeError("Could not determine version")
RuntimeError: Could not determine version

详细信息

setup.py文件：

from setuptools import setup, find_namespace_packages

setup(
    name='clickapp',
    version='0.1.3',
    author='Hamza M Zubair',
    packages=find_namespace_packages(),
    include_package_data=True,
    package_data={
        '': ['*.yaml'],
    },
    classifiers=[
        'Programming Language :: Python :: 3',
        'Operating System :: OS Independent',
        'Natural Language :: English',
        'License :: Other/Proprietary License',
    ],
    python_requires='>=3.6',
    install_requires=[
        'click',
        'pandas',
        'sqlalchemy',
        'jinjasql',
        'pyyaml',
        'joblib',
        'python-dateutil',
        'loguru',
        'pymysql',
        'xgboost',
        'sklearn',
        'wheel',
        'importlib-resources'
    ],
    entry_points='''
        [console_scripts]
        clickapp=clickapp.cli:cli
    ''',
)

用于创建pex文件的命令：

[user@host]$ python setup.py bdist_pex --bdist-all

工具规格

我使用以下版本的库/包在不同的系统中构建和运行pex文件。目标机器只有Python，没有库，因为pex文件不需要库/virtualenv等

Build Machine OS: CentOS Linux release 7.8.2003 (Core)  
Build Machine Python: 3.6.8  
setuptools: 51.0.0  
pex: 2.1.21  
click: 7.1.2  
Target Machine OS: CentOS Linus release 7.4.1708 (Core)
Target Machine Python: 3.6.8

我试过的

1. 我已经测试了我的clickapp的全部功能，其他所有参数和命令都可以完美地工作

即使这样，我的clickapp的帮助也能正确显示

[user@host]$ ./clickapp --help

1. 我多次尝试重新构建包
2. 我只在Python3.6中测试过这个。我没有尝试过不同的python版本，在源系统和目标系统中设置它有点困难
3. 当我删除@click.version_option()时，我得到了错误：--version not implemented，这与预期的一样
4. 我还没有在第二个目标系统上测试它，以防当前目标服务器的某些特性导致错误

更多信息

我还应该提供哪些其他信息来帮助用户

Answer 1

简短回答：setuptools缺失

---

看起来您已经单击了v7.1.2。在该版本中，自动计算版本号的一个代码路径使用pkg_resources，这是setuptools的顶级包：

                try:
                    import pkg_resources
                except ImportError:
                    pass
                else:
                    for dist in pkg_resources.working_set:
                        scripts = dist.get_entry_map().get("console_scripts") or {}
                        for _, entry_point in iteritems(scripts):
                            if entry_point.module_name == module:
                                ver = dist.version
                                break

https://github.com/pallets/click/blob/7.1.2/src/click/decorators.py#L283-L293

因此，单击在某种程度上取决于设置工具。但是还有其他不需要pkg_resources的代码路径，例如，可以在decorator的参数中显式设置版本号（如果我没有弄错的话）：@click.version_option(version='1.2.3')（doc），在这种情况下，setuptools不是强制依赖项

在大多数情况下，这只是因为（我称之为巧合）setuptools几乎总是预先安装的（例如在虚拟环境中）。但是“几乎总是”与“总是”不同，例如，绝对可能存在没有安装setuptools的环境（虚拟环境或非虚拟环境）。这看起来就像是在pex打包应用程序中发生的情况。我相信pex可以创建干净的虚拟环境（即没有pip、setuptools或wheel或其他任何东西）

由于setuptools未声明为依赖项，因此未安装它，因此导入pkg_resources失败，并且查找版本字符串失败

我想说这是点击的失败。他们应该将setuptools声明为强制依赖项，或者至少声明为可选依赖项（在extra中），并正确记录这一点

一个可能的修复方法是添加setuptools作为应用程序的直接依赖项：将setuptools添加到setup.py中的install_requires列表中

请注意，据我所知，在单击v8时情况会发生变化。查找版本字符串将依赖标准库中的importlib.metadata（作为importlib_metadata向后移植到Python<；3.8），而不是pkg_resources：

• https://github.com/pallets/click/issues/1488
• https://github.com/pallets/click/pull/1582

从表面上看，它将再次引发问题，甚至可能引发更多问题。由于单击仍然没有将^{}声明为旧Python版本的依赖项，而^{}不在标准库中（<；3.8），因此版本字符串查找将失败