pyInstaller 参数简介

深藏阁楼爱情的钟 2021-08-20 00:09 382阅读 0赞

### 说明 ###

以下介绍假设用户脚本为main.py，生成结果为main.exe。  
有些参数实在很少用到，只列出简单介绍，具体请参阅原文。  
原文(英文): https://pyinstaller.readthedocs.io/en/v3.3.1/usage.html

**通用参数**

<table> 
 <thead> 
  <tr> 
   <th>参数名</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-h</td> 
   <td>显示帮助</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>-v</td> 
   <td>显示版本号</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>–distpath</td> 
   <td>生成文件放在哪里</td> 
   <td>默认：当前目录的dist文件夹内</td> 
  </tr> 
  <tr> 
   <td>–workpath</td> 
   <td>生成过程中的中间文件放在哪里</td> 
   <td>默认：当前目录的build文件夹内</td> 
  </tr> 
  <tr> 
   <td>-y</td> 
   <td>如果dist文件夹内已经存在生成文件，则不询问用户，直接覆盖</td> 
   <td>默认：询问是否覆盖</td> 
  </tr> 
  <tr> 
   <td>–upx-dir UPX_DIR</td> 
   <td>指定upx工具的目录</td> 
   <td>默认：execution path</td> 
  </tr> 
  <tr> 
   <td>-a</td> 
   <td>不包含unicode支持</td> 
   <td>默认：尽可能支持unicode</td> 
  </tr> 
  <tr> 
   <td>–clean</td> 
   <td>在本次编译开始时，清空上一次编译生成的各种文件</td> 
   <td>默认：不清除</td> 
  </tr> 
  <tr> 
   <td>–log-level LEVEL</td> 
   <td>控制编译时pyi打印的信息</td> 
   <td>一共有6个等级，由低到高分别为TRACE DEBUG INFO(默认) WARN ERROR CRITICAL。也就是默认清空下，不打印TRACE和DEBUG信息</td> 
  </tr> 
 </tbody> 
</table>

### 与生成结果有关的参数 ###

<table> 
 <thead> 
  <tr> 
   <th>参数名</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-D</td> 
   <td>生成one-folder的程序（默认）</td> 
   <td>生成结果是一个目录，各种第三方依赖、资源和exe同时存储在该目录</td> 
  </tr> 
  <tr> 
   <td>-F</td> 
   <td>生成one-file的程序</td> 
   <td>生成结果是一个exe文件，所有的第三方依赖、资源和代码均被打包进该exe内</td> 
  </tr> 
  <tr> 
   <td>–specpath</td> 
   <td>指定.spec文件的存储路径</td> 
   <td>默认：当前目录</td> 
  </tr> 
  <tr> 
   <td>-n</td> 
   <td>生成的.exe文件和.spec的文件名</td> 
   <td>默认：用户脚本的名称，即main.py和main.spec</td> 
  </tr> 
 </tbody> 
</table>

### 指定打包哪些资源、代码 ###

<table> 
 <thead> 
  <tr> 
   <th>参数名</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>–add-data</td> 
   <td>打包额外资源</td> 
   <td>用法：pyinstaller&nbsp;<a href="http://main.py/" rel="nofollow">main.py</a>&nbsp;--add-data=src;dest。windows以;分割，linux以:分割</td> 
  </tr> 
  <tr> 
   <td>–add-binary</td> 
   <td>打包额外的代码</td> 
   <td>用法：同–add-data。与–add-data不同的是，用binary添加的文件，pyi会分析它引用的文件并把它们一同添加进来</td> 
  </tr> 
  <tr> 
   <td>-p</td> 
   <td>指定额外的import路径，类似于使用PYTHONPATH</td> 
   <td>参见PYTHONPATH</td> 
  </tr> 
  <tr> 
   <td>–hidden-import</td> 
   <td>打包额外py库</td> 
   <td>pyi在分析过程中，有些import没有正确分析出来，运行时会报import error，这时可以使用该参数</td> 
  </tr> 
  <tr> 
   <td>–additional-hooks-dir</td> 
   <td>指定用户的hook目录</td> 
   <td>hook用法参见其他，系统hook在PyInstaller\hooks目录下</td> 
  </tr> 
  <tr> 
   <td>–runtime-hook</td> 
   <td>指定用户runtime-hook</td> 
   <td>如果设置了此参数，则runtime-hook会在运行main.py之前被运行</td> 
  </tr> 
  <tr> 
   <td>–exclude-module</td> 
   <td>需要排除的module</td> 
   <td>pyi会分析出很多相互关联的库，但是某些库对用户来说是没用的，可以用这个参数排除这些库，有助于减少生成文件的大小</td> 
  </tr> 
  <tr> 
   <td>–key</td> 
   <td>pyi会存储字节码，指定加密字节码的key</td> 
   <td>16位的字符串</td> 
  </tr> 
 </tbody> 
</table>

–add-binary 使用实例可以参考：《python3 pyinstaller 打包后执行文件运行错误 No such file or directory 和 Cannot load native module 解决方法》[https://blog.csdn.net/whatday/article/details/118065649][https_blog.csdn.net_whatday_article_details_118065649]

### 生成参数 ###

<table> 
 <thead> 
  <tr> 
   <th>参数名</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-d</td> 
   <td>执行生成的main.exe时，会输出pyi的一些log，有助于查错</td> 
   <td>默认：不输出pyi的log</td> 
  </tr> 
  <tr> 
   <td>-s</td> 
   <td>优化符号表</td> 
   <td>原文明确表示不建议在windows上使用</td> 
  </tr> 
  <tr> 
   <td>–noupx</td> 
   <td>强制不使用upx</td> 
   <td>默认：尽可能使用。</td> 
  </tr> 
 </tbody> 
</table>

### 其他 ###

<table> 
 <thead> 
  <tr> 
   <th>参数名</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>–runtime-tmpdir</td> 
   <td>指定运行时的临时目录</td> 
   <td>默认：使用系统临时目录</td> 
  </tr> 
 </tbody> 
</table>

### Windows和Mac特有的参数 ###

<table> 
 <thead> 
  <tr> 
   <th>参数名</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-c</td> 
   <td>显示命令行窗口</td> 
   <td>与-w相反，默认含有此参数</td> 
  </tr> 
  <tr> 
   <td>-w</td> 
   <td>不显示命令行窗口</td> 
   <td>编写GUI程序时使用此参数有用。</td> 
  </tr> 
  <tr> 
   <td>-i</td> 
   <td>为main.exe指定图标</td> 
   <td>pyinstaller -i beauty.ico&nbsp;<a href="http://main.py/" rel="nofollow">main.py</a></td> 
  </tr> 
 </tbody> 
</table>

### Windows特有的参数 ###

<table> 
 <thead> 
  <tr> 
   <th>参数名</th> 
   <th>描述</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>–version-file</td> 
   <td>添加版本信息文件</td> 
   <td>pyinstaller --version-file ver.txt</td> 
  </tr> 
  <tr> 
   <td>-m, --manifest</td> 
   <td>添加manifest文件</td> 
   <td>pyinstaller -m main.manifest</td> 
  </tr> 
  <tr> 
   <td>-r RESOURCE</td> 
   <td>请参考原文</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>–uac-admin</td> 
   <td>请参考原文</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>–uac-uiaccess</td> 
   <td>请参考原文</td> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

[https_blog.csdn.net_whatday_article_details_118065649]: https://blog.csdn.net/whatday/article/details/118065649