Python 模块热重载工具技术文档

1. 安装指南

在开始使用 Python Module Reloader 之前，您需要先进行安装。安装过程非常简单，只需使用 pip 命令即可：

pip install reloader

请确保您的系统中已经安装了 pip。如果您使用的是虚拟环境，请先激活虚拟环境再执行上述命令。

2. 项目的使用说明

Python Module Reloader 是一个基于依赖关系的模块热重载工具。与内置的 reload() 函数不同，它不仅会重载指定的模块，还会重载所有依赖于该模块的其他模块。

启用重载器

在使用前，需要先启用重载器，以便跟踪模块间的依赖关系。通常建议在应用程序启动过程的早期就启用它。

import reloader
reloader.enable()

导入模块

启用重载器后，您可以导入其他模块。

import module1
import module2

手动重载模块

当需要手动重载一个已导入的模块时，可以使用重载器的 reload() 方法，并传入模块对象。

import example
reloader.reload(example)

如果您只有模块的名称，可以从全局的 sys.modules 字典中获取模块对象：

reloader.reload(sys.modules['example'])

查询模块依赖

您还可以查询模块的依赖关系，用于信息查询或调试。

reloader.get_dependencies(example)

禁用重载器

可以在任何时候禁用重载器的依赖跟踪功能。

reloader.disable()

模块黑名单

如果有某些模块及其依赖关系不希望被重载，可以将它们添加到黑名单中。

reloader.enable(blacklist=['os', 'ConfigParser'])

黑名单中列出的模块将不会在重载过程中被重载，但它们仍然会出现在依赖关系图中。

3. 项目API使用文档

以下是 Python Module Reloader 提供的主要API：

• reloader.enable(blacklist=None): 启用重载器，可选的黑名单参数可以指定哪些模块不被重载。
• reloader.disable(): 禁用重载器。
• reloader.reload(module): 重载指定的模块对象。
• reloader.get_dependencies(module): 获取指定模块的依赖关系。

4. 项目安装方式

如前所述，项目的安装方式是通过 pip 进行安装：

pip install reloader

请确保您有一个合适的Python环境，并且已经安装了pip。如果是使用Python 3，请根据需要使用 pip3 来代替 pip。