Pyinstaller 打包 Pytest项目及资源文件

目录

前言

纯Python代码的打包

包含其他文件的打包

总结

---

前言

相比于cx-freeze和Nuitka，还是pyinstaller好用些，因此使用pyinstaller来生成独立的exe文件以供其他工程师使用。项目中用到pytest来管理整个自动化测试用例，所以本文针对于pytest项目来进行pyinstaller的打包说明。

我的pytest项目结构如下所示：

- sgh_universal_test_automation
  - products (folder)
    - product_x.apk
  - utils (folder)
  - testcases (folder)
    - solution (folder)
      - test_xxx.py (test case)
      - conftest.py (conf file)
  - main_for_xxx.py
  - pytest.ini

纯Python代码的打包

如果你的软件中只有.py文件，即Python代码文件，不包括图标、图片等资源文件，那么使用pyinstaller打包是非常简单的，往往只需要下面一行命令即可：

pyinstaller -F -w -i icon.ico main_for_xxx.py

当运行这个命令之后，会对应的生成一个main_for_xxx.spec文件，这个文件之后有用处。

其中的几个选项：
-F 把整个软件（包括依赖的各种库文件）打包成单一文件；也可以用-D代替，-D是生成一个文件夹，把所有的依赖项放入文件夹中
-w 禁止Windows的命令行窗口，一般来说先不要使用，以方便看错误在哪里发生
-i 生成的exe文件会带有这个图标；
最后的main_for_xxx.py就是翻译软件的入口程序

但其实这里面打包pytest项目有个坑，pytest项目一般都会用到一些插件，诸如pytest-html等，这些模块在pyinstaller打包过程中并不会自动导入，因此需要手动在spec文件中手动写入。

一般来说，pytest项目按照如下方式修改即可：

- numpy等可以根据实际情况看是否加入，主要是pytest相关的安装包

- C:/Python38/Lib/site-packages 路径请替换成自己的本地python路径

a = Analysis(
    ['main_for_xxx.py',],
    pathex=[],
    binaries=[],
    datas=[('C:/Python38/Lib/site-packages/pytest_html', './pytest_html'),
           ('C:/python38/Lib/site-packages/pytest_html-3.1.1.dist-info', './pytest_html-3.1.1.dist-info'),
           ('C:/Python38/Lib/site-packages/py', './py'),
           ('C:/Python38/Lib/site-packages/pytest', './pytest'),
           ('C:/Python38/Lib/site-packages/_pytest', './_pytest'),
           ('C:/Python38/Lib/site-packages/pytest_assume', './pytest_assume'),
           ('C:/python38/Lib/site-packages/pytest_assume-2.4.3.dist-info', './pytest_assume-2.4.3.dist-info'),
           ('C:/Python38/Lib/site-packages/pytest_metadata', './pytest_metadata'),
           ('C:/python38/Lib/site-packages/pytest_metadata-2.0.1.dist-info','./pytest_metadata-2.0.1.dist-info'),
           ('C:/Python38/Lib/site-packages/numpy', './numpy'),
           ('C:/python38/Lib/site-packages/numpy-1.22.3.dist-info', './numpy-1.22.3.dist-info'),],

 其中，datas增加的内容实际上和pyinstaller --add-data命令起到的作用一样，以('C:/Python38/Lib/site-packages/pytest_html', './pytest_html')为例，元组第一个参数代表本地python site-packages库中的pytest_html文件夹，'./pytest_html' 代表pytest将该文件夹打包后存放的路径，相同的用add-data命令如下：--add-data="源地址;目标地址"

pyinstaller main_for_xxx.py --add-data "C:/Python38/Lib/site-packages/pytest_html, ;./pytest_html"

包含其他文件的打包

其实原理与之前说的在datas中添加资源文件类似，但是需要注意的事项多了一些。

第一步：仍然是在spec或命令行中通过--add-data来将需要的资源加入。例如项目中需要加入products文件夹下的product_x.apk。sepc文件中可以这么写：

a = Analysis(
    ['main_for_xxx.py',],
    pathex=[],
    binaries=[],
    datas=[...,

                ('products/product_x.apk','.'),]

'.' 意思是希望pyinstaller直接将apk文件打包放在TEMP根目录下。

第二步：根据spec的配置来调整代码中引用到apk文件的路径

当使用PyInstaller打包到单个文件时，运行.exe会将所有内容解压缩到TEMP目录中的文件夹中，运行脚本，然后丢弃临时文件。临时文件夹的路径会随着每次运行而更改，但对其位置的引用会添加到sys._MEIPASS中。
为了利用这一点，当Python代码读取任何也将打包到.exe中的文件时，需要更改位于sys._MEIPASS下的文件位置。换句话说，您需要将其添加到python代码中。
下面是一个示例，在打包为单个文件时，使用引用的链接中的代码将文件路径调整到正确的位置。

# myScript.py
import sys
import os

def resource_path(relative_path):
    """ Get absolute path to resource, works for dev and for PyInstaller """
    try:
        # PyInstaller creates a temp folder and stores path in _MEIPASS
        base_path = sys._MEIPASS
    except Exception:
        base_path = os.path.abspath(".")

    return os.path.join(base_path, relative_path)

def print_file(file_path):
    file_path = resource_path(file_path)
    with open(file_path) as fp:
        for line in fp:
            print(line)

if __name__ == '__main__':
    print_file('data_files/data.txt')

利用这个resource_path函数将资源所在的路径找到，如果找到 _MEIPASS 路径就以此为资源的基准路径，否则以当前路径为基准路径。这样在exe文件运行时就不会报找不到资源的错误了。

总结

总体而言，pyinstaller相较于cx-freeze和Nuitka还是比较方便快捷的，但在打包pytest项目中可能遇到一些坑，在此记录一下，其他pyinstaller相关的一些知识可以参考如下的博客，个人认为比较全面：

pyinstaller系列之一：简介，安装及简单使用_MrWind灬的博客-CSDN博客