Python读写properties文件

最近用python写个工具,涉及到properties文件的读写操作。发现Python并没有提供操作properties文件的库,只有一个 ConfigParser 类来支持 .ini 文件的读写,这显然不是我想要的,于是一番折腾后整出下面这个工具类:

property.py

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
#!/usr/bin/python
# -*- coding: utf-8 -*-


import re
import os
import tempfile

class Properties:

def __init__(self, file_name):
self.file_name = file_name
self.properties = {}
try:
fopen = open(self.file_name, 'r')
for line in fopen:
line = line.strip()
if line.find('=') > 0 and not line.startswith('#'):
strs = line.split('=')
self.properties[strs[0].strip()] = strs[1].strip()
except Exception, e:
raise e
else:
fopen.close()

def has_key(self, key):
return self.properties.has_key(key)

def get(self, key, default_value=''):
if self.properties.has_key(key):
return self.properties[key]
return default_value

def put(self, key, value):
self.properties[key] = value
replace_property(self.file_name, key + '=.*', key + '=' + value, True)

def parse(file_name):
return Properties(file_name)


def replace_property(file_name, from_regex, to_str, append_on_not_exists=True):
file = tempfile.TemporaryFile() #创建临时文件

if os.path.exists(file_name):
r_open = open(file_name,'r')
pattern = re.compile(r'' + from_regex)
found = None
for line in r_open: #读取原文件
if pattern.search(line) and not line.strip().startswith('#'):
found = True
line = re.sub(from_regex, to_str, line)
file.write(line) #写入临时文件
if not found and append_on_not_exists:
file.write('\n' + to_str)
r_open.close()
file.seek(0)

content = file.read() #读取临时文件中的所有内容

if os.path.exists(file_name):
os.remove(file_name)

w_open = open(file_name,'w')
w_open.write(content) #将临时文件中的内容写入原文件
w_open.close()

file.close() #关闭临时文件,同时也会自动删掉临时文件
else:
print "file %s not found" % file_name

使用方式

在要使用property工具的python文件中导入property.py文件即可使用
示例(test.py):

1
2
3
4
5
6
7
8
9
10
#!/usr/bin/python
# -*- coding: utf-8 -*-

import property

file_path = '/Users/billy/Desktop/bak/test.properties' #要操作的properties文件的路径
props = property.parse(file_path) #读取文件
props.put('key_a', 'value_a') #修改/添加key=value
print props.get('key_a') #根据key读取value
print "props.has_key('key_a')=" + str(props.has_key('key_a')) #判断是否包含该key1

测试效果:
测试代码运行效果
注意,操作的目标文件要存在,否则报错:
找不到文件

参考文档

Python实用脚本(1):读取Properties文件

请作者喝咖啡~