setuptools软件包上的pyinstaller
问题内容:
我试图在使用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')
在虚拟环境中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",
)
问题答案:
第一:
我结合了斯蒂芬的答案和我自己的一些挖掘来找到答案。最后,Stephen的第一部分完成了窍门:手动添加/导出PYTHONPATH
变量。您实际上可以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
或您install_requires
在setup.py
:https://github.com/pyinstaller/pyinstaller/archive/develop.zip。 - 此外,你可以让你
.spec
与文件--onefile
选项pyi-makespec
像这样:pyi-makespec --onefile myapp.py
。这将创建一个.spec
文件,以确保您的所有软件包都被编译成二进制文件。
最后,下面的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,就可以解决问题。