mlua 1.0.1

一个基于 lupa 模块的轻量级扩展库，提供了便捷的 Lua 模块加载与管理功能。

from mlua.mlua import MLuaManagerfrom mlua.mlua.envs import MLuaPackager

MLua 使用指南

概述

一个基于 lupa 模块的轻量级扩展库，提供了便捷的 Lua 环境管理和模块加载功能。

快速开始

1. 创建 Lua 环境

from mlua import MLuaEnvironment

# 创建 Lua 运行时环境
lua_env = MLuaEnvironment()

2. 加载 Lua 模块

from mlua import MLuaModule, MLuaInstaller

# 加载单个 Lua 模块
module = MLuaModule("path/to/module.lua")

# 挂载模块到环境，指定secure=True以选择安全模式，默认选择
mlua_obj = module.mount(lua_env: MLuaEnvironment, [secure=True])

# 加载模块及其依赖
mlua_objects = module.mount_deeply(lua_env: MLuaEnvironment, [secure=True])

# 加载多个 Lua 模块，返回一个mlua_objects列表
installer = MLuaInstaller(mlua_module1: MLuaModule, mlua_module2: MLuaModule, ...)
mlua_objects = installer.mount_all(lua_env: MLuaEnvironment, [secure=True])

3. 使用模块功能

# 调用模块函数
results = mlua_obj.functions.some_function()

# 访问模块值
value = mlua_obj.values.some_variable

4. 处理模块依赖

from mlua import MLuaResolver

# 创建依赖管理器
resolver = MLuaResolver()

# 解析模块依赖（解析对象式）
modules_to_load = resolver.requirements(module: MLuaModule)

# 解析模块依赖（解析全局式）
modules_to_load = MLuaResolver.requirements_directly(module: MLuaModule)

# 打印依赖关系
MLuaResolver.relationship(modules_to_load1, modules_to_load2, modules_to_load3, ...)

5.日志

from mlua import MLuaLogsPrinter

# 打印信息日志
MLuaLogsPrinter.info("Hello, world!")

# 打印警告日志
MLuaLogsPrinter.warn("Something might be wrong!")

# 打印错误日志
MLuaLogsPrinter.error("Something went wrong!")

6.打包

# 打包模块，返回字节串
results_bytes = MLuaPackager.pack(module1: MLuaModule, module2: MLuaModule, ...)

# 解包模块，返回模块列表
results_modules = MLuaPackager.unpack(data_bytes: bytes)

7.保存至文件

# 保存模块至文件，默认仓库目录为./mlua_modules
MLuaManager.save(module1: MLuaModule, module2: MLuaModule, ..., [directory="./mlua_modules"])

# 加载模块文件，返回模块列表
results_modules = MLuaManager.load([directory="./mlua_modules"])

# 直接使用指定模块
results_modules = MLuaManager.use("module1", "module2", ..., [directory="./mlua_modules"])

校验状态

from mlua import status

status()

注意事项

1. 建议始终使用安全模式挂载模块
2. 模块依赖关系应避免循环依赖
3. 模块文件路径应为绝对路径或相对于工作目录的有效路径