setuptools 包上的 Pyinstaller

Question

我正在尝试使用Click库在 Python 中构建的 CLI 应用程序上运行 PyInstaller。 我在使用 PyInstaller 构建项目时遇到问题。 PyInstaller 在他们的 GitHub wiki 中有一个名为Recipe Setuptools Entry Point的文档，它提供了有关如何将 PyInstaller 与setuptools包一起使用的信息，我在这个项目中使用了它。 但是，当我运行pyinstaller --onefile main.spec时，它似乎找不到基本模块。

我的问题是：问题仅仅是我的文件夹结构有问题吗？ Recipe Setuptools 入口点是否采用特定的文件结构？

相关资料

pyinstaller 输出

184 INFO: PyInstaller: 3.3.1
184 INFO: Python: 3.6.4
189 INFO: Platform: Darwin-16.7.0-x86_64-i386-64bit
193 INFO: UPX is available.
Traceback (most recent call last):
  File "/usr/local/bin/pyinstaller", line 11, in <module>
    sys.exit(run())
  File "/usr/local/lib/python3.6/site-packages/PyInstaller/__main__.py", line 94, in run
    run_build(pyi_config, spec_file, **vars(args))
  File "/usr/local/lib/python3.6/site-packages/PyInstaller/__main__.py", line 46, in run_build
    PyInstaller.building.build_main.main(pyi_config, spec_file, **kwargs)
  File "/usr/local/lib/python3.6/site-packages/PyInstaller/building/build_main.py", line 791, in main
    build(specfile, kw.get('distpath'), kw.get('workpath'), kw.get('clean_build'))
  File "/usr/local/lib/python3.6/site-packages/PyInstaller/building/build_main.py", line 737, in build
    exec(text, spec_namespace)
  File "<string>", line 40, in <module>
  File "<string>", line 26, in Entrypoint
  File "/usr/local/lib/python3.6/site-packages/pkg_resources/__init__.py", line 582, in get_entry_info
    return get_distribution(dist).get_entry_info(group, name)
  File "/usr/local/lib/python3.6/site-packages/pkg_resources/__init__.py", line 564, in get_distribution
    dist = get_provider(dist)
  File "/usr/local/lib/python3.6/site-packages/pkg_resources/__init__.py", line 436, in get_provider
    return working_set.find(moduleOrReq) or require(str(moduleOrReq))[0]
  File "/usr/local/lib/python3.6/site-packages/pkg_resources/__init__.py", line 984, in require
    needed = self.resolve(parse_requirements(requirements))
  File "/usr/local/lib/python3.6/site-packages/pkg_resources/__init__.py", line 870, in resolve
    raise DistributionNotFound(req, requirers)
pkg_resources.DistributionNotFound: The 'myapp' distribution was not found and is required by the application

该main.spec文件main.py ，这是我的CLI应用程序入口点：

block_cipher = None

def Entrypoint(dist, group, name,
               scripts=None, pathex=None, hiddenimports=None,
               hookspath=None, excludes=None, runtime_hooks=None):
    import pkg_resources

    # get toplevel packages of distribution from metadata
    def get_toplevel(dist):
        distribution = pkg_resources.get_distribution(dist)
        if distribution.has_metadata('top_level.txt'):
            return list(distribution.get_metadata('top_level.txt').split())
        else:
            return []

    hiddenimports = hiddenimports or []
    packages = []
    for distribution in hiddenimports:
        packages += get_toplevel(distribution)

    scripts = scripts or []
    pathex = pathex or []
    # get the entry point
    ep = pkg_resources.get_entry_info(dist, group, name)
    # insert path of the egg at the verify front of the search path
    pathex = [ep.dist.location] + pathex
    # script name must not be a valid module name to avoid name clashes on import
    script_path = os.path.join(workpath, name + '-script.py')
    print ("creating script for entry point", dist, group, name)
    with open(script_path, 'w') as fh:
        print("import", ep.module_name, file=fh)
        print("%s.%s()" % (ep.module_name, '.'.join(ep.attrs)), file=fh)
        for package in packages:
            print ("import", package, file=fh)

    return Analysis([script_path] + scripts, pathex, hiddenimports, hookspath, excludes, runtime_hooks)

a = Entrypoint('myapp', 'console_scripts', 'myapp')

pyz = PYZ(a.pure, a.zipped_data,
             cipher=block_cipher)
exe = EXE(pyz,
          a.scripts,
          exclude_binaries=True,
          name='main',
          debug=False,
          strip=False,
          upx=True,
          console=True )
coll = COLLECT(exe,
               a.binaries,
               a.zipfiles,
               a.datas,
               strip=False,
               upx=True,
               name='main')

运行pip3 install --editable .时生成的myapp脚本的内容pip3 install --editable . 在我的虚拟环境中：

#!/some/path/to/myapp-cli/venv/bin/python3.6
# EASY-INSTALL-ENTRY-SCRIPT: 'myapp','console_scripts','myapp'
__requires__ = 'myapp'
import re
import sys
from pkg_resources import load_entry_point

if __name__ == '__main__':
    sys.argv[0] = re.sub(r'(-script\.pyw?|\.exe)?$', '', sys.argv[0])
    sys.exit(
        load_entry_point('myapp', 'console_scripts', 'myapp')()
    )

最后，我的存储库结构：

myapp-cli/
├── README.md
├── myapp
│   ├── __init__.py
│   ├── main.py
│   ├── main.spec
│   ├── resources
│   │   ├── __init__.py
│   │   └── functions.py
│   ├── subcommands
│   │   ├── __init__.py
│   │   ├── config
│   │   │   ├── __init__.py
│   │   │   └── cli.py
│   │   ├── create
│   │   │   ├── __init__.py
│   │   │   └── cli.py
│   │   ├── destroy
│   │   │   ├── __init__.py
│   │   │   └── cli.py
│   │   └── switch
│   │       ├── __init__.py
│   │       └── cli.py
│   └── variables.py
├── requirements.txt
└── setup.py

还有我的setup.py文件：

from setuptools import find_packages
from setuptools import setup
import os

base_dir = os.path.dirname(__file__)

setup(
    entry_points = '''
        [console_scripts]
        myapp=myapp.main:entry_point
    ''',
    install_requires = [
        'packageone==1.0',
        'packagetwo==2.0',
    ],
    name = "myapp",
    packages=find_packages(),
    setup_requires="setuptools",
    version = "0.1",
)

Answer 1

第一：我结合了斯蒂芬的答案和我自己的一些挖掘来找到答案。 最后，Stephen 的第一部分成功了：手动添加/导出PYTHONPATH变量。 您实际上可以在Entrypoint函数中使用pathex指定它，如下Entrypoint ：

a = Entrypoint('myapp-cli',
    'console_scripts',
    'myapp',
    pathex=['/some/path/to/myapp-cli/myapp', '/some/path/to/myapp-cli']
)

毕竟我最终不需要myapp.main 。

第二：我仍然遇到 PyInstaller无法生成单个二进制文件的问题。 对我来说，这成功了：

• 将最新版本的 PyInstaller 添加到您的requirements.txt或setup.py的install_requires ： https://github.com/pyinstaller/pyinstaller/archive/develop.zip 。
• 此外，您可以使用pyi-makespec的--onefile选项制作.spec文件，如下--onefile ： pyi-makespec --onefile myapp.py 。 这将生成一个.spec文件，以确保您的所有软件包都编译为二进制文件。

最后，下面的规范文件起到了作用，我能够制作一个完全可用的二进制文件：

# -*- mode: python -*-

block_cipher = None

def Entrypoint(dist, group, name,
               scripts=None, pathex=None, hiddenimports=None,
               hookspath=None, excludes=None, runtime_hooks=None):
    import pkg_resources

    # get toplevel packages of distribution from metadata
    def get_toplevel(dist):
        distribution = pkg_resources.get_distribution(dist)
        if distribution.has_metadata('top_level.txt'):
            return list(distribution.get_metadata('top_level.txt').split())
        else:
            return []

    hiddenimports = hiddenimports or []
    packages = []
    for distribution in hiddenimports:
        packages += get_toplevel(distribution)

    scripts = scripts or []
    pathex = pathex or []
    # get the entry point
    ep = pkg_resources.get_entry_info(dist, group, name)
    # insert path of the egg at the verify front of the search path
    pathex = [ep.dist.location] + pathex
    # script name must not be a valid module name to avoid name clashes on import
    script_path = os.path.join(workpath, name + '-script.py')
    print ("creating script for entry point", dist, group, name)
    with open(script_path, 'w') as fh:
        print("import", ep.module_name, file=fh)
        print("%s.%s()" % (ep.module_name, '.'.join(ep.attrs)), file=fh)
        for package in packages:
            print ("import", package, file=fh)

    return Analysis([script_path] + scripts, pathex, hiddenimports, hookspath, excludes, runtime_hooks)

a = Entrypoint('myapp-cli',
    'console_scripts',
    'myapp',
    pathex=['/some/path/to/myapp-cli/myapp', '/some/path/to/myapp-cli']
)

pyz = PYZ(a.pure, a.zipped_data,
             cipher=block_cipher)
exe = EXE(pyz,
          a.scripts,
          a.binaries,
          a.zipfiles,
          a.datas,
          name='myapp',
          debug=False,
          strip=False,
          upx=True,
          runtime_tmpdir=None,
          console=True )

我认为最终将Cobra 之类的东西用于 Golang会更容易，因为 Golang 开箱即用地编译单文件二进制文件。 但是，如果您更喜欢 Python，这应该可以解决问题。

Answer 2

这个错误：

pkg_resources.DistributionNotFound：未找到“myapp”分发版，应用程序需要此分发版

表示这个包不在PYTHONPATH 。 我在 Windows 上修复了它：

set PYTHONPATH=.

调整到您选择的操作系统。

---

除了路径问题，还有：

在 setup.py 中：

setup(
    entry_points = '''
        [console_scripts]
        myapp=myapp.main:entry_point
    ''',

在 main.spec 中：

a = Entrypoint('myapp', 'console_scripts', 'myapp')

根据 setup.py，看起来您的入口点是myapp.main而不是myapp 。 所以你可能需要：

a = Entrypoint('myapp', 'console_scripts', 'myapp.main')

Answer 3

接受的答案对我不起作用。 我不得不通过.spec文件添加egg-info目录。

我对Entrypoint函数的调用如下所示：

a = Entrypoint(
        'PrintIt',
        'console_scripts',
        'printit',
        datas=[('plugins/*.egg', 'plugins/'),
               ('../PrintIt.egg-info/*', 'PrintIt.egg-info/')])

Answer 4

我注意到的一点是，一旦您按照 Scott Crooks 在勾选答案中推荐的方式修补了 Entrypoint ，添加数据文件的典型方法就不起作用了。 对我来说，我必须附加到a.datas数组。 在python3中，这看起来像：

...
a = Entrypoint(...)
from pathlib import Path
Path('/tmp/modulename/datafile.txt').write_text(Path('datafile.txt').read_text()))
a.datas.append('datafile.txt', '/tmp/modulename/datafile.txt', 'DATA')

pyz = PYZ(...)
...

Answer 5

经过大量搜索，此错误通常是由于尝试访问项目包的元数据（即版本是主要的）。

包元数据通常使用pkg_resources或较旧的distutil访问，要么显式，要么通常隐藏在其他包中（通常尝试访问包版本）。 从 Python v3.8 开始，它也将在importlib.metadata中的 stdlib 中importlib.metadata 。

如果是这种情况，您可能需要在mypackage.egg-info文件夹中包含部分或全部文件，尤其是文件PKG_INFO ，但它可能需要所有文件。

有多种方法可以做到这一点，以下是我喜欢的几种：

---

1. 如果您使用的是script.spec文件，您可以根据 Charles 的回答更新datas=行以包含此信息：

a = Analysis(['myscript.py'],
             pathex=['C:\\path\\to\\mypackage'],
             binaries=[],
             datas=[('mypackage.egg-info/*','mypackage.egg-info')],

---

2、创建自定义hook文件，放在一个目录下，在命令行中将该目录添加为自定义hooks目录。

创建一个hook-mypackage.py挂钩文件，包含以下非常简单且非常优雅的行：

from PyInstaller.utils.hooks import copy_metadata

datas = copy_metadata('md2mat')

我将其放入根包/repo 文件夹中的新hooks文件夹中，然后将以下内容添加到我的 pyinstaller 命令中：

pyinstaller -F -y --additional-hooks-dir=hooks myscript.py

它工作得很好，假设copy_metadata函数在我们从旧的元数据包转换到新的 importlib.metadata 时得到很好的维护，它应该在未来的 Python 更新中工作得很好。

---

3.直接在命令行添加额外的数据文件

这可能是我最喜欢的，如果我可以让它工作......

pyinstaller --add-data <SRC;DEST> myscript.py

此选项--add-data显示在帮助输出 ( pyinstaller --help ) 中，并指示参数的格式应为 SRC;DEST for Windows，因此我认为它必须与其他方法中的datas=格式匹配，但我无法让它工作。

我认为最接近正确格式的是以下内容：

pyinstaller -F -y --add-data "mypackage.egg-info/*;mypackage.egg-info"
pyinstaller -F -y --add-data="mypackage.egg-info/*;mypackage.egg-info"

这些会编译，但生成的 exe 只会运行而没有输出。

PyInstaller 文档中缺少--add-data选项，但在运行pyinstaller --help-commands 。