MicroPython的Manifest文件介绍

摘要

MicroPython除了能够从文件系统加载Python代码外，还可以把Python代码“冻结”到固件加载，这样做有几个好处：

• 代码已被预编译为字节码，无需在加载时编译Python源代码。
• 字节码可以直接从ROM（即闪存）中执行，而无需复制到内存。同样，任何常量对象（字符串、元组等）也从ROM中加载，这可以大大增加应用程序的可用内存。
• 在没有文件系统的设备上，这也是加载Python代码的唯一方法。

在开发过程中，一般不建议冻结，因为每次更新都需要重新刷新整个固件，这会大大降低开发周期，不过，有选择性地冻结一些很少变化的依赖项（如第三方库）还是很有用的。

“manifest”本身也是Python文件，列出了要冻结到固件的其他Python文件，会在构建的时候解释执行。通常情况下，可以将manifest文件作为电路板定义的一部分来编写，当然也可以编写一个独立的manifest文件，将其与现有的电路板定义一起使用。

manifest文件可以定义对microropython-lib库和文件系统中的Python文件的依赖关系，也可以定义对其它manifest文件的依赖关系。

编写 manifest 文件

manifest文件是一个包含一系列函数调用的Python文件。请参阅下面定义的可用函数。

manifest文件中使用的任何路径都可以包含以下变量。这些变量都解析为绝对路径。

• $(MPY_DIR) - MicroPython 仓库的路径。
• $(MPY_LIB_DIR) - microropython-lib子模块的路径。最好使用require()。
• $(PORT_DIR) - 当前端口的路径（例如 ports/stm32）
• $(BOARD_DIR) - 当前板子的路径（例如 ports/stm32/boards/PYBV11）

自定义manifest文件不应放在MicroPython主资源库中，而是应该把它们与项目的其余部分一起进行版本控制。

通常情况下，用于编译固件的manifest需要包含端口manifest，其中可能包括电路板运行所需的冻结模块。如果只想在现有电路板上添加其他模块，则应包含电路板manifest（这反过来又会包含端口manifest）。

使用自定义manifest构建

可以在 make 命令行中指定manifest：

$ make BOARD=MYBOARD FROZEN_MANIFEST=/path/to/my/project/manifest.py