将 pyinstaller 与 setuptools 一起使用时，“未找到分发且应用程序需要该分发”

Question

我正在尝试从 setuptools 发行版制作可执行文件，我具有以下结构：

TEST-DIST
├── app.spec
├── my_package
│   ├── __init__.py
│   ├── __main__.py
│   ├── script1.py
│   └── script2.py
└── setup.py

设置.py：

from importlib.metadata import entry_points
import setuptools

setuptools.setup(
    name="testapp",
    version="0.0.1",
    author="Example Author",
    author_email="[email protected]",
    description="A small example package",
    url="https://github.com/pypa/sampleproject",
    project_urls={
        "Bug Tracker": "https://github.com/pypa/sampleproject/issues",
    },
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    entry_points={'console_scripts': ["mytestscript1=my_package.script1:main", "mytestscript2=my_package.script2:main"]},
    python_requires=">=3.6"
)

app.spec 使用 此脚本 与 setuptools 一起使用

block_cipher = None


def Entrypoint(dist, group, name, **kwargs):
    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 []

    kwargs.setdefault('hiddenimports', [])
    packages = []
    for distribution in kwargs['hiddenimports']:
        packages += get_toplevel(distribution)

    kwargs.setdefault('pathex', [])
    # 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
    kwargs['pathex'] = [ep.dist.location] + kwargs['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] + kwargs.get('scripts', []),
        **kwargs
    )

a = Entrypoint("testapp", 'console_scripts', 'mytestscript1')
pyz = PYZ(a.pure, a.zipped_data)

exe = EXE(pyz,
          a.scripts,
          a.binaries,
          a.zipfiles,
          a.datas,
          [],
          name='mytestscript1')

我首先使用

python3 -m build

构建包，然后执行 pyinstaller

pyinstaller app.spec

，这会导致以下错误：

27 INFO: PyInstaller: 4.10
27 INFO: Python: 3.8.10
34 INFO: Platform: Linux-5.10.60.1-microsoft-standard-WSL2-x86_64-with-glibc2.29
35 INFO: UPX is not available.
Traceback (most recent call last):
  File "/usr/local/bin/pyinstaller", line 8, in <module>
    sys.exit(run())
  File "/home/admin/.local/lib/python3.8/site-packages/PyInstaller/__main__.py", line 124, in run
    run_build(pyi_config, spec_file, **vars(args))
  File "/home/admin/.local/lib/python3.8/site-packages/PyInstaller/__main__.py", line 58, in run_build
    PyInstaller.building.build_main.main(pyi_config, spec_file, **kwargs)
  File "/home/admin/.local/lib/python3.8/site-packages/PyInstaller/building/build_main.py", line 803, in main
    build(specfile, distpath, workpath, clean_build)
  File "/home/admin/.local/lib/python3.8/site-packages/PyInstaller/building/build_main.py", line 725, in build
    exec(code, spec_namespace)
  File "app.spec", line 42, in <module>
    a = Entrypoint("testapp", 'console_scripts', 'mytestscript1', datas=[('testapp.egg-info/*','testapp.egg-info')])
  File "app.spec", line 25, in Entrypoint
    ep = pkg_resources.get_entry_info(dist, group, name)
  File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 500, in get_entry_info
    return get_distribution(dist).get_entry_info(group, name)
  File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 482, in get_distribution
    dist = get_provider(dist)
  File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 358, in get_provider
    return working_set.find(moduleOrReq) or require(str(moduleOrReq))[0]
  File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 901, in require
    needed = self.resolve(parse_requirements(requirements))
  File "/usr/lib/python3/dist-packages/pkg_resources/__init__.py", line 787, in resolve
    raise DistributionNotFound(req, requirers)
pkg_resources.DistributionNotFound: The 'testapp' distribution was not found and is required by the application

调用异常是因为

pkg_resources.get_entry_info

从 pyinstaller 执行时找不到我的发行版，但是当我从根目录中的任何普通脚本运行它时，可以毫无问题地找到它：

>>> import pkg_resources
>>> pkg_resources.get_entry_info("testapp", 'console_scripts', 'mytestscript1')
EntryPoint.parse('mytestscript1 = my_package.script1:main')

这里的解决方案都没有帮助！

Answer 1

我想我们可能遇到同样的问题。我的文件结构与您相同，包名称的命名与代码所在目录的名称不同（包名称为

testapp

，但目录名称为 

my_package

）。我注意到，当我 

pip install

 我的包时，在 

site-packages

 中，

egg-info

 目录（或者在您的情况下可能是 

dist-info

）的名称是 

testapp_etc_.egg-info

，源代码目录是 

my_package

。我手动将其更改为

mypackage_etc_.egg-info

并且

pkg_resources

能够找到入口点。

我还应该提到我不需要对

.spec

 文件进行任何更改。昨天我盯着 setuptools 的 Recipe 看了一会儿，然后放弃了，我只是在使用 

pyinstaller

 时使用了常规命令行参数。最后，手动更改目录名称并不是正确的解决方案，我只是这样做来看看这是否是问题所在。实际的解决方案是更改 

setup.setup()

 中的包参数名称。