pr-properties 1.8.7

A Python library for reading, writing and managing .properties configuration files with file lock support.

pr_properties

一个轻量级的 Python properties 文件处理库，支持线程安全的读写操作。

安装

pip install pr-properties

快速开始

示例 1：从文件读取并修改

from pr_properties import PropertiesHandler

# 读取配置文件
props = PropertiesHandler('config.properties')
props.read()

# 获取/设置值
value = props.get('username', 'guest')
print("username =", value)

props['new_key'] = 'new_value'

# 删除某个键
if 'password' in props.keys():
    del props['password']

# 保存文件
props.write()

---

示例 2：直接从字符串内容加载

from pr_properties import PropertiesHandler

content = """
# 应用配置
host = localhost
port = 8080

; 数据库设置
db_user = root
db_pass = 123456
"""

props = PropertiesHandler().read_content(content)

print("host =", props['host'])
print("port =", props.get('port'))

# 修改并打印输出结果（不会写入文件）
props['db_user'] = 'admin'
print(str(props))

---

示例 3：遍历配置项

from pr_properties import PropertiesHandler

props = PropertiesHandler('config.properties').read()

# 遍历所有键值对
for key, value in props.items():
    print(f"{key} -> {value}")

---

示例 4：结合默认值

from pr_properties import PropertiesHandler

props = PropertiesHandler('config.properties').read()

# 如果键不存在，则返回默认值
debug_mode = props.get('debug', 'false')
print("Debug mode:", debug_mode)

特性

• 🔒 线程安全的文件操作
• 📝 支持注释和空行
• 🔄 自动备份机制
• 🎯 字典风格的 API

基本用法

读取文件

props = PropertiesHandler()
props.read('config.properties', encoding='utf-8')

操作属性

# 获取值
host = props.get('database.host', 'localhost')
port = props['server.port']

# 设置值
props['app.name'] = 'MyApp'
props['debug'] = 'true'

# 删除
del props['old_key']

保存文件

props.write()  # 自动创建 .pr_bak 备份

Properties 格式

# 注释行
database.host=localhost
database.port=5432
# 应用配置
app.name=My Application
app.debug=false

线程安全

多线程环境下为每个线程创建独立实例：

# 推荐
props = PropertiesHandler('config.properties')

# 避免在多线程中使用全局实例
from pr_properties import pr_properties  # 单线程可用

依赖

• Python >= 3.7
• filelock == 3.12.2

许可证

Apache License 2.0