Wingman

Appearance

API: wingman.config ​

配置管理模块，用于读写应用程序配置。

模块概述 ​

config 模块提供配置的读写功能，支持：

  • 自定义配置 - 存储用户自定义键值对
  • 持久化 - 保存配置到磁盘、从磁盘加载配置

获取自定义配置 ​

get(key) / get(key) ​

说明：获取自定义配置值。

函数签名：

python
get(key: str) -> Any
lua
get(key: string) -> any

参数：

  • key - 配置键名。键为顶层字符串，不支持点号路径嵌套（传 game.character 会查找字面名为该串的顶层键）

返回：

  • 配置值（字符串），不存在时返回 None/nil
python
from wingman import config

value = config.get("myKey")
if value:
    print(value)

设置自定义配置 ​

set(key, value) / set(key, value) ​

说明：设置自定义配置值。

函数签名：

python
set(key: str, value: str) -> None
lua
set(key: string, value: string) -> nil

参数：

  • key - 配置键名。键为顶层字符串，不支持点号路径嵌套
  • value - 配置值，仅支持字符串。传入非字符串（数字、布尔、字典等）会被静默存成空串；需要非字符串 JSON 类型时请传 JSON 字符串（内部会做 json::parse，如 config.set("count", "42") 存为数字 42）
python
from wingman import config

# 简单键值（值必须为字符串）
config.set("myKey", "myValue")
config.set("count", "42")            # 存为 JSON 数字 42
config.set("enabled", "true")        # 存为 JSON 布尔 true

删除自定义配置 ​

remove(key) / remove(key) ​

说明：删除自定义配置值。

函数签名：

python
remove(key: str) -> bool
lua
remove(key: string) -> boolean

参数：

  • key - 配置键名

返回：

  • 是否成功删除（键存在返回 True/true，否则返回 False/false）
python
from wingman import config

removed = config.remove("myKey")
if removed:
    print("配置已删除")
else:
    print("配置不存在")

保存配置 ​

save() / save() ​

说明：将当前配置保存到磁盘。

函数签名：

python
save() -> bool
lua
save() -> boolean

返回：

  • bool：是否保存成功（当前实现直写 JSON，恒为 True/true）
python
from wingman import config

# 修改后保存到磁盘
config.set("myKey", "myValue")
config.save()

加载配置 ​

load() / load() ​

说明：从磁盘加载配置。

函数签名：

python
load() -> bool
lua
load() -> boolean

返回：

  • bool：是否加载成功（当前实现直读 JSON，恒为 True/true）
python
from wingman import config

# 从磁盘重新加载配置
config.load()

可用接口 ​

Python 函数Lua 函数说明参数
get(key)get(key)获取自定义配置key: 键名（顶层字符串，不支持嵌套路径）
返回: 字符串，不存在返回 None/nil
set(key, value)set(key, value)设置自定义配置key: 键名, value: 仅字符串（非字符串静默存空串；JSON 类型传 JSON 字符串）
remove(key)remove(key)删除自定义配置key: 键名
save()save()保存配置到磁盘无
load()load()从磁盘加载配置无