pywayne-helper

Pywayne Helper

项目配置管理辅助工具，实现跨进程、跨文件的参数共享机制。

Quick Start

from pywayne.helper import Helper

# 初始化（自动检测调用者所在目录作为项目根目录）
helper = Helper()

# 进程 A：写入配置
helper.set_module_value('database', 'host', value='127.0.0.1')

# 进程 B：读取配置（自动等待直到值存在）
db_host = helper.get_module_value('database', 'host', max_waiting_time=10)
print(f"数据库主机: {db_host}")

跨进程/跨文件参数共享

Helper 通过项目根目录下的 YAML 配置文件实现参数共享：

project_root/
├── common_info.yaml          # 配置文件，自动创建
├── module_a/              # 模块 A
└── module_b/              # 模块 B

工作原理：

1. 任何模块初始化 Helper 实例，自动定位到项目根目录
2. 配置文件统一位于 {project_root}/common_info.yaml
3. 各模块通过 set_module_value 写入配置
4. 各模块通过 get_module_value 读取配置
5. 支持等待机制，确保读取到其他进程写入的值

适用场景：

场景	说明
多进程协作	进程 A 写配置，进程 B 读配置
分布式任务	主进程设置参数，子进程读取执行
配置传递	程序启动时写入配置，后续模块读取
动态参数	模块间共享动态生成的参数（如 token、临时 ID）

Initialization

# 使用调用者所在目录作为项目根目录（推荐）
helper = Helper('./')

# 指定项目根目录
helper = Helper('/path/to/project')

# 自定义配置文件名
helper = Helper('/path/to/project', config_file_name='shared_config.yaml')

Methods

set_module_value

设置嵌套配置键的值。

# 写入数据库配置
helper.set_module_value('database', 'host', value='127.0.0.1')
helper.set_module_value('database', 'port', value=5432)

# 写入 API 配置
helper.set_module_value('api', 'token', value='abc123')
helper.set_module_value('api', 'endpoint', value='https://api.example.com')

# 写入共享临时参数
helper.set_module_value('shared', 'temp_id', value='temp_123')
helper.set_module_value('shared', 'status', value='running')

参数说明：

• *keys: 按嵌套层级排列的键
• value: 要设置的值

get_module_value

获取嵌套配置键的值，支持等待机制。

# 基本获取
host = helper.get_module_value('database', 'host')

# 等待最多 10 秒，直到值存在（跨进程场景）
host = helper.get_module_value('database', 'host', max_waiting_time=10)

# 禁用调试输出
host = helper.get_module_value('database', 'host', debug=False)

# 未找到时返回 None
if host is None:
    print("配置未找到")

参数说明：

• *keys: 按嵌套层级排列的键
• max_waiting_time (可选): 最大等待时间（秒），轮询配置文件直到值存在
• debug (可选): 是否启用调试信息，默认 True