无法显示带有点击入口点的 Python 二进制 PEX 版本
Can't Display Version of a Python Binary PEX with Click Entry Points
Python 单击 CLI 应用程序
当您使用 Click 库构建 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 文件，使用 libraries/packages 的以下版本。目标机器只有Python没有库，因为pex文件不需要libraries/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
我试过的
- 我已经测试了
clickapp 的全部功能，并且所有其他参数和命令都运行良好。
即使这样也能正确显示我的 clickapp 的帮助。
[user@host]$ ./clickapp --help
- 我尝试重新构建包几次
- 我只在 Python3.6 中测试过。我没有尝试过不同的 python 版本，在源系统和目标系统中设置它有点困难。
- 当我删除
@click.version_option() 时，出现错误：--version not implemented，正如预期的那样
- 我还没有在第二个目标系统上测试它，以防我当前目标服务器的某些特性导致错误
更多信息
为了帮助 SO 用户，我还应该提供哪些其他信息？
简答：缺少 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
所以在某种程度上，click 取决于 setuptools。但是还有其他的代码路径不需要pkg_resources，比如可以在装饰器的参数中显式设置版本号（如果我没记错的话）：@click.version_option(version='1.2.3') (doc ), 在这种情况下 setuptools 不是强制依赖项。
在大多数情况下，它之所以有效是因为（出于巧合）setuptools 几乎总是预先安装的（例如在虚拟环境中）。但是“almost always”与“always”不同，例如，绝对有可能拥有这样的环境（虚拟或非虚拟）没有 setuptools 安装。这看起来正是 pex 打包应用程序的情况。我相信 pex 会创建干净的虚拟环境（即没有 pip、setuptools 或 wheel 或其他任何内容）。
由于 setuptools 未声明为依赖项，因此未安装，导入 pkg_resources 失败，并查找版本字符串失败。
我会说这是 click 方面的失败。他们应该将 setuptools 声明为强制依赖项，或者至少声明为可选依赖项（在 extra 中）并正确记录。
一个可能的解决方法是将 setuptools 添加为应用程序的直接依赖项：将 setuptools 添加到 [=18] 中的 install_requires 列表中=].
请注意，据我所知，在 click v8 中情况会发生变化。找出版本字符串将依赖于标准库中的 importlib.metadata（向后移植到 Python < 3.8 作为importlib_metadata) 而不是 pkg_resources:
看样子，又要出问题了，说不定还会出问题。由于 click 仍然没有声明 importlib-metadata as a dependency for older Python versions where importlib.metadata 不在标准库中（< 3.8），版本字符串查找将失败。
Python 单击 CLI 应用程序
当您使用 Click 库构建 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 文件，使用 libraries/packages 的以下版本。目标机器只有Python没有库，因为pex文件不需要libraries/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
我试过的
- 我已经测试了
clickapp的全部功能，并且所有其他参数和命令都运行良好。
即使这样也能正确显示我的 clickapp 的帮助。
[user@host]$ ./clickapp --help
- 我尝试重新构建包几次
- 我只在 Python3.6 中测试过。我没有尝试过不同的 python 版本，在源系统和目标系统中设置它有点困难。
- 当我删除
@click.version_option()时，出现错误：--version not implemented，正如预期的那样 - 我还没有在第二个目标系统上测试它，以防我当前目标服务器的某些特性导致错误
更多信息
为了帮助 SO 用户，我还应该提供哪些其他信息？
简答：缺少 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
所以在某种程度上，click 取决于 setuptools。但是还有其他的代码路径不需要pkg_resources，比如可以在装饰器的参数中显式设置版本号（如果我没记错的话）：@click.version_option(version='1.2.3') (doc ), 在这种情况下 setuptools 不是强制依赖项。
在大多数情况下，它之所以有效是因为（出于巧合）setuptools 几乎总是预先安装的（例如在虚拟环境中）。但是“almost always”与“always”不同，例如，绝对有可能拥有这样的环境（虚拟或非虚拟）没有 setuptools 安装。这看起来正是 pex 打包应用程序的情况。我相信 pex 会创建干净的虚拟环境（即没有 pip、setuptools 或 wheel 或其他任何内容）。
由于 setuptools 未声明为依赖项，因此未安装，导入 pkg_resources 失败，并查找版本字符串失败。
我会说这是 click 方面的失败。他们应该将 setuptools 声明为强制依赖项，或者至少声明为可选依赖项（在 extra 中）并正确记录。
一个可能的解决方法是将 setuptools 添加为应用程序的直接依赖项：将 setuptools 添加到 [=18] 中的 install_requires 列表中=].
请注意，据我所知，在 click v8 中情况会发生变化。找出版本字符串将依赖于标准库中的 importlib.metadata（向后移植到 Python < 3.8 作为importlib_metadata) 而不是 pkg_resources:
看样子，又要出问题了，说不定还会出问题。由于 click 仍然没有声明 importlib-metadata as a dependency for older Python versions where importlib.metadata 不在标准库中（< 3.8），版本字符串查找将失败。