pyinstaller打包含有socketio的flask项目的安装与使用

1.pyinstaller

pyinstaller可以将python程序打包为可执行文件，需要注意的是在mac上打包后的文件是Unix 可执行文件只可以在mac上使用，windows打包后的是.exe文件

2.pyinstaller的安装

• 直接使用pip安装即可，需要注意的是安装在主环境还是虚拟环境，如果安装在虚拟环境使用的时候需要使用绝对路径，详见pyinstaller的使用

  pip install pyinstaller
  

3.pyinstaller的使用

• 进入flask项目目录，执行打包命令

  # -F 打包成一个文件
  # manage.py 指定项目的入口，也就是启动项目的文件
  # --hidden-import 导入需要的包，以为打包的时候有一些包不能自动打进去，需要特殊指定
  # --add-data 添加静态文件
  #  --add-data 'CS/templates:templates' --add-data 'CS/static:static' 此处指定了模版文件夹和静态文件文件夹，其中：前是相对项目目录的模版文件路径，：后是模版名，这个模版名一定要和Flask初始化的时候的名字一致，如下图
  # -n 指定可执行文件的名字
  # 其他参数请参照文档
  pyinstaller -F manage.py --hidden-import=pymysql --add-data 'rgc/templates:templates' --add-data 'rgc/static:static' -n remotecenter
  
  

  

• 打包后会生成一个build文件和dist文件以及.spec文件

• 如果想对参数进行修改，可以修改name.spec文件然后执行下面语句

  # 修改name.spec文件后重新打包，如下图
  # 比如我在指定包的时候习惯修改.spec文件进行指定
  pyinstaller name.spec
  

  # 修改.spec文件，指定导入的包
  hiddenimports=['pymysql', 'gevent', 'geventwebsocket', 'gevent.ssl', 'gevent.builtins', 'engineio.async_drivers.threading']
  # 重新生成可执行文件
  pyinstaller name.spec
  

4.pyinstaller打包后踩到的坑

• 主环境下和虚拟环境下pyinstaller打包的区别
  在用主环境打包flask项目后，执行可执行文件报了一个和django有关的错，如下图：
  
  我怀疑是和主环境有关，所以我在虚拟环境中安装了pyinstaller，并使用绝对路径打包，命令如下：

  /Users/qxq/Desktop/remote-center/venv/bin/pyinstaller -F manage.py --hidden-import=pymysql --add-data 'rgc/templates:templates' --add-data 'rgc/static:static' -n remotecenter
  
  

  此时不再有django相关的错误，建议使用虚拟环境打包，以为虚拟环境中的包都是我们项目使用的，也比较少

• flask_socketio报错，ValueError: Invalid async_mode specified
  
  我之前的socketio实例化代码如下：

  socketio = SocketIO(app, async_mode=None)
  

  此处需要指定async_mode，修改后如下：

  socketio = SocketIO(app, async_mode='gevent')
  

• 打包时报错 16488 ERROR: Tcl/Tk improperly installed on this system. 打包后运行报错 Failed to execute script pyi_rth__tkinter
  参考链接 http://www.manongjc.com/article/99447.html
  修改/Users/qxq/Desktop/remote-center/venv/lib/python3.6/site-packages/PyInstaller/hooks/hook-_tkinter.py文件
  注意：此处的目录是PyInstaller的路径，可以使用sudo find / -name PyInstaller搜索目录，注意主环境和虚拟环境路径的区别

  # 原187行代码
  if 'Library/Frameworks' in path_to_tcl:
  # 修改为
  if 'Library/Frameworks' in path_to_tcl and 'Python' not in path_to_tcl:
  

  

• ubuntu打包，运行报错ImportError: No module named 'distutils’
  在githup上查到有人说是virtualenv版本太高导致
  
  我的virtualenv版本是16.7.4，降低版本为16.1.0
  
  注意：更换版本后虚拟环境需要重新创建！

• 又一次报错，ValueError: Invalid async_mode specified
  
  参考链接：https://github.com/miguelgrinberg/python-socketio/issues/178
  在socketio实例化的时候不指定async_mode，并且指定包engineio.async_drivers.threading

  socketio = SocketIO(app)
  

  # 指定包engineio.async_drivers.threading
  hiddenimports=['pymysql', 'gevent', 'geventwebsocket', 'gevent.ssl', 'gevent.builtins', 'engineio.async_drivers.threading']
  

  此时重新打包，成功！

mac与ubuntu已经试过，都可以成功打包并运行。

未完待续～