总结Pyinstaller打包的高级用法

一、安装pyinstaller

pyinstaller是一个用来将python程序打包成一个独立可执行文件的第三方包。

因是第三方包，所以需要安装一下：

pip install pyinstaller

或者升级到最新版本：

pip install --upgrade pyinstaller

或者安装开发者版本：

pip install https://github.com/pyinstaller/pyinstaller/archive/develop.tar.gz

当然了，也可以下载whl文件，然后pip install安装

更多可参考官网指引：

二、打包初体验

我们简单试下打包python代码为exe可执行文件，测试代码如下：

# 测试.py
import os

path = os.getcwd()
print(f'当前文件路径：{path}')
os.system('pause')

这段代码是打印文件所在的目录，我们用pyinstaller简单打包的命令如下：

pyinstaller -f 测试.py

这个命令，执行过程如下：

(env_test) f:\pythoncool\pyinstaller>pyinstaller -f 测试.py    
403 info: pyinstaller: 4.3
403 info: python: 3.8.10 (conda)
434 info: platform: windows-10-10.0.19042-sp0
436 info: wrote f:\pythoncool\pyinstaller\测试.spec
455 info: upx is not available.
468 info: extending pythonpath with paths
['f:\\pythoncool\\pyinstaller', 'f:\\pythoncool\\pyinstaller']
501 info: checking analysis
...
...
15006 info: appending archive to exe f:\pythoncool\pyinstaller\dist\测试.exe
18999 info: building exe from exe-00.toc completed successfully.

成功后会在同级目录下生成一个dist文件，里面就是一个和代码文件名同名的可执行文件：

双击该可执行文件，我们可以看到直接在python解释器里运行测试.py文件时一样的结果：

这里需要注意的是，我们在进行打包的时候，有必要指定被打包的py文件的路径，两种方式供选择：

方式一：先切换到被打包py文件目录，再执行打包指令

(base) c:\users\gdc>cd f:\pythoncool\pyinstaller
(base) c:\users\gdc>f:
(base) f:\pythoncool\pyinstaller>pyinstaller -f 测试.py

方式二：打包指令中指定py文件的绝对路径

(base) c:\users\gdc>pyinstaller -f f:\pythoncool\pyinstaller\测试.py

关于成功打包的测试.exe可执行文件，我们发现其图标是默认的，且启动时会显示命令行窗口。那么，我们可以怎么自定义exe图标，又或者去掉命令行窗口呢？

三、打包进阶体验

好了，接下来，我们先看看关于pyinstaller打包时候的一些别的参数都有哪些，如何自定义exe图标以及如何去掉命令行窗口等等。

(env_test) f:\pythoncool\pyinstaller>pyinstaller -h

pyinstaller -h可以查看其参数说明，由于较多这里不做完整展示，摘取部分常用参数做简要介绍：

参数	说明
-f	产生单个的可执行文件
-d	产生一个目录（包含多个文件）作为可执行程序
-a	不包含 unicode 字符集支持
-d	debug 版本的可执行文件
-w	指定程序运行时不显示命令行窗口（仅对 windows 有效）
-c	指定使用命令行窗口运行程序（仅对 windows 有效）
-o	指定 spec 文件的生成目录。如果没有指定，则默认使用当前目录来生成 spec 文件
-p	设置 python 导入模块的路径（和设置 pythonpath 环境变量的作用相似）。也可使用路径分隔符（windows 使用分号，linux 使用冒号）来分隔多个路径
-n	指定项目（产生的 spec）名字。如果省略该选项，那么第一个脚本的主文件名将作为 spec 的名字

打包一个带自定义icon的exe可执行文件

我们可以去这里下载icon文件：

可以去这里将图片转化为icon文件：

然后，用一下命令可以自定义exe图标：

(env_test) f:\pythoncool\pyinstaller>pyinstaller -f -i icon.ico 测试.py 

成功后，我们可以看到图标变成了我们自定义的这个：

打包去掉命令行弹窗的exe可执行文件

如果我们是有gui的程序，想在启动的时候去掉命令行窗口，那么可以用以下指令进行打包，这里以tkinter内置gui库为例展示：

# 测试.py
import tkinter

top = tkinter.tk()
# 进入消息循环
top.mainloop()

以上测试代码，如果用初体验中的方式，在gui界面出现的同时也会出现命令行弹窗，我们想去掉命令行弹窗可以：

(env_test) f:\pythoncool\pyinstaller>pyinstaller -f -w -i icon.ico 测试.py  

双击打包后的exe文件，可以看到只会出现gui界面，命令行窗口并没有出现。

四、带配置文件打包

所谓带配置文件打包，这里是指打包的时候除了py文件、依赖的库之外，还存在需要引用的其他资源文件。直接用以上方式打包的时候，这些资源是无法被打进包的，我们需要进行修改打包时的spec文件来实现。

spec文件是告诉pyinstaller怎么打包py文件，比如路径、资源、动态库、隐式调用的模块等等。一般来说，我们不需要对它进行修改…

这里我用此前《词云绘制小工具》的案例来进行介绍。

我们直接用打包进阶体验中的命令可以进行成功打包，不过这里我们发现有两个问题：①包体很大，比此前案例里大了10倍左右；②启动exe文件的时候报错了。

关于包体较大的情况，可以试着创建虚拟环境，然后只安装程序里需要调用的库即可，这里只简单介绍：

# 创建虚拟环境
conda create -n your_env_name python=3.8.10
# 启动虚拟环境
activate your_env_name

关于启动报错的情况，由于比较复杂，我们一步一步来看：

①由于无命令行弹窗，无法查看到具体的报错，这里先去带命令行窗口形式看下报错信息，我们看报错如下：

提示缺少这个文件，我们可以在打包生成的词云绘制工具.spec配置文件里将这个资源放上

# -*- mode: python ; coding: utf-8 -*-
# 词云绘制工具.spec

block_cipher = none

a = analysis(['词云绘制工具.py'],
             pathex=['f:\\pythoncool\\pyinstaller'],
             binaries=[],
             datas=[], # 这里带上资源文件地址
             hiddenimports=[], # 动态引入的库或模块
             hookspath=[],
             runtime_hooks=[],
             excludes=[],
             win_no_prefer_redirects=false,
             win_private_assemblies=false,
             cipher=block_cipher,
             noarchive=false)
pyz = pyz(a.pure, a.zipped_data,
             cipher=block_cipher)
exe = exe(pyz,
          a.scripts,
          a.binaries,
          a.zipfiles,
          a.datas,
          [],
          name='词云绘制工具',
          debug=false,
          bootloader_ignore_signals=false,
          strip=false,
          upx=true,
          upx_exclude=[],
          runtime_tmpdir=none,
          console=true , icon='icon.ico')

通过在wordcloud模块目录里查到了stopwords文件，我们将其放到data中。

datas=[('c:\\users\\gdc\\anaconda3\\envs\\env_test\\lib\\site-packages\\wordcloud\\stopwords','wordcloud')],

前者是资源文件在本机的位置，后者为打包后文件调用的相对路径，编辑好spec文件后，通过以下命令进行打包：

(env_test) f:\pythoncool\pyinstaller>pyinstaller -d 词云绘制工具.spec  

好吧，还有一些文件未被打进包，所以又出现同样的问题了。所以，我们是需要把全部的资源文件都加到spec文件里的data中。

我们找到全部的资源文件全部加上吧，然后再执行打包命令。

datas=[('c:\\users\\gdc\\anaconda3\\envs\\env_test\\lib\\site-packages\\stylecloud\\static','stylecloud\\static'),
    ('c:\\users\\gdc\\anaconda3\\envs\\env_test\\lib\\site-packages\\wordcloud\\stopwords','wordcloud'),
    ('c:\\users\\gdc\\anaconda3\\envs\\env_test\\lib\\site-packages\\jieba\\analyse\\idf.txt','jieba\\analyse'),
    ('c:\\users\\gdc\\anaconda3\\envs\\env_test\\lib\\site-packages\\jieba\\dict.txt','jieba')]

我们将配置资源打进包后可以正常启动exe可执行文件了。

但是，又发现在执行词云绘制的时候，也会出现报错。不过看报错的情况是提示不存在xx模块，那么这是什么情况呢？！

五、添加隐式调用库

我们找到报错的地方代码如下，采用了__import__()函数用于动态加载类和函数palettable模块。

def gen_palette(palette: str):
    """generates the corresponding palette function from `palettable`."""
    palette_split = palette.split(".")
    palette_name = palette_split[-1]

    # https://*.com/a/6677505
    palette_func = getattr(
        __import__(
            "palettable.{}".format(".".join(palette_split[:-1])),
            fromlist=[palette_name],
        ),
        palette_name,
    )
    return palette_func

对于这个问题，我试过两种方案，大家可以参考一下。

方案一：在spec文件中hiddenimports中添加动态引用的模块

hiddenimports=['palettable'], # 动态引入的库或模块

这种情况下，palettable库里也有一些配置文件需要添加到spec文件里的data中

('c:\\users\\gdc\\anaconda3\\envs\\env_test\\lib\\site-packages\\palettable\\colorbrewer\\data','palettable\\colorbrewer\\data')

方案二：修改stylecloud库中调用palettable模块的代码部分

import palettable
def gen_palette(palette: str):
    palette_func = getattr(palettable.tableau,'bluered_6')
    return palette_func
 
    # """generates the corresponding palette function from `palettable`."""
    # palette_split = palette.split(".")
    # palette_name = palette_split[-1]

    #    https://*.com/a/6677505
    # palette_func = getattr(
        # __import__(
            # "palettable.{}".format(".".join(palette_split[:-1])),
            # fromlist=[palette_name],
        # ),
        # palette_name,
    # )

通过第4和5部分，我们用pyinstaller终于成功打包且正常运行使用了。

以上就是本次全部内容，大家如果遇到打包时涉及到配置文件的或者隐式调用的，可以采用这两个2技巧进行特殊打包！

不过，关于pyinstaller打包其实还有更多操作，大家可以多看看官方文档了解，主要是命令行参数及spec文件里的配置要点。

到此这篇关于总结pyinstaller打包的高级用法的文章就介绍到这了,更多相关pyinstaller打包内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！