每周一题——读写配置文件。

limodou

to sakulagi:

你的程序写法与我的确不同。有一点建议：property在New Style Class 是有特殊用法的，它是一个内置(built-in)方法，最好不用它用为类名。另外你测试的最后一行多了一个';'号

limodou

下面是我根据sakulagi的思路改写的程序：

#! /usr/bin/python

import os
import sys

class Ini:
    """ Assume that property file is "ARG=VALUE" format and no space is allowed on either side of \"=\" """
    def __init__(self, pfile):
        self.items = {}
   
        for line in file(pfile):
            line = line.strip()
            if not line: continue
            if line.startswith('#'): continue
            key, value = line.split('=', 1)
            self.items[key.strip()] = value.strip()
   
    def getdict(self):
        return self.items


if __name__ == "__main__":
    print "Self Test Begin"
    # Generate the test file
    if len(sys.argv) == 1:
        os.system("echo # Comment >; test.properties"
        os.system("echo LOCK=true >;>; test.properties"
        os.system("echo TEST.config.1=234 >;>; test.properties"
        pf = Ini("test.properties";
    else:
        pf = Ini(sys.argv[1])
    print pf.getdict()

这里最后我的生成test.properties与原程序不同，因为发现在里面的双引号也输出到文件中去了，因此我去掉了。

wolfg

我的，呵呵，别笑话。
ini文件的格式参照了这里 http://en.wikipedia.org/wiki/Ini_file
也参考了Python的ConfigParser模块的文档

IniFileParser.py

1. 
   
2. #!C:\Python24\python.exe
   
3. 
   
4. import re
   
5. import string
   
6. 
   
7. NoSectionException = 'NoSectionException'
   
8. NoKeyException = 'NoKeyException'
   
9. 
   
10. class IniFileParser:
    
11.     '''parse ini file described in http://en.wikipedia.org/wiki/Ini_file. no functions for write, only read. :)'''
    
12.     def __init__(self):
    
13.         self.section_obj = dict()
    
14. 
    
15.     def load(self, filename):
    
16.         f = open(filename, 'r')
    
17.         while 1:
    
18.             line = f.readline()
    
19.             if not line: break
    
20.             line = line.strip('\n')
    
21.             line = line.strip()
    
22.             # skip comments
    
23.             if line == "" or line.startswith(';') or line.startswith('#'):
    
24.                 continue
    
25.             match_section = re.compile(r'^\[([\w\s\.]*)\]$').match(line)
    
26.             if match_section:   # section name line
    
27.                 line = match_section.group(1) # get section name
    
28.                 sec_keys = dict()
    
29.                 self.section_obj[line] = sec_keys
    
30.             else:               # key=value line
    
31.                 re_comment = re.compile(r'[;#].*')
    
32.                 line = re_comment.sub('', line) # remove comments in line
    
33.                 [key, value] = map(string.strip, line.split('=', 1))
    
34.                 sec_keys[key] = value
    
35.                
    
36.         f.close()
    
37. 
    
38.     def sections(self):
    
39.         result = self.section_obj.keys()
    
40.         result.sort()
    
41.         return result
    
42. 
    
43.     def has_section(self, section):
    
44.         return section in self.section_obj.keys()
    
45. 
    
46.     def keys(self, section):
    
47.         if not self.has_section(section): raise NoSectionException
    
48.         result = self.section_obj[section].keys()
    
49.         result.sort()
    
50.         return result
    
51. 
    
52.     def has_key(self, section, key):
    
53.         return self.section_obj[section].has_key(key)
    
54. 
    
55.     def get_value(self, section, key):
    
56.         if not self.has_section(section): raise NoSectionException
    
57.         if not self.has_key(section, key): raise NoKeyException
    
58.         return self.section_obj[section][key]
    

复制代码

Unit Test: TestIniFileParser.py

1. 
   
2. #!C:\Python24\python.exe
   
3. 
   
4. import unittest
   
5. from IniFileParser import *
   
6. 
   
7. class TestIniFileParser(unittest.TestCase):
   
8.     def setUp(self):
   
9.         self.ini = IniFileParser()
   
10.         self.ini.load('test.ini')
    
11. 
    
12.     def testsections(self):
    
13.         self.assertEqual(self.ini.sections(), ['section1', 'section2'])
    
14. 
    
15.     def testhassections(self):
    
16.         self.assertTrue(self.ini.has_section('section1'))
    
17.         self.assertTrue(self.ini.has_section('section2'))
    
18.         self.assertFalse(self.ini.has_section('section3'))
    
19. 
    
20.     def testkeys(self):
    
21.         self.assertEqual(self.ini.keys('section1'), ['var1', 'var2'])
    
22.         self.assertEqual(self.ini.keys('section2'), ['var1', 'var2'])
    
23.         self.assertRaises(NoSectionException, self.ini.keys, 'section3')
    
24. 
    
25.     def testhaskey(self):
    
26.         self.assertTrue(self.ini.has_key('section1', 'var1'))
    
27.         self.assertTrue(self.ini.has_key('section1', 'var2'))
    
28.         self.assertTrue(self.ini.has_key('section2', 'var1'))
    
29.         self.assertTrue(self.ini.has_key('section2', 'var2'))
    
30. 
    
31.     def testgetvalue(self):
    
32.         self.assertEqual(self.ini.get_value('section1', 'var1'), 'foo')
    
33.         self.assertEqual(self.ini.get_value('section1', 'var2'), 'doodle')
    
34.         self.assertEqual(self.ini.get_value('section2', 'var1'), 'baz')
    
35.         self.assertEqual(self.ini.get_value('section2', 'var2'), 'shoodle')
    
36.         self.assertRaises(NoSectionException, self.ini.get_value, 'section3', 'var1')
    
37.         self.assertRaises(NoKeyException, self.ini.get_value, 'section1', 'var3')
    
38. 
    
39. if __name__ == '__main__':
    
40.     #unittest.main()
    
41.     suite = unittest.makeSuite(TestIniFileParser)
    
42.     unittest.TextTestRunner(verbosity=2).run(suite)
    

复制代码

ini file for test: test.ini

[section1]

; some comment on section1
var1 = foo
var2 = doodle ; some comment on section1.var2

[section2]

# some comment on section2
var1 = baz # some comment on section2.var1
var2 = shoodle

# [section3]
# var1 = bar
; var2 =

sakulagi

原帖由 "limodou" 发表：
to sakulagi:

你的程序写法与我的确不同。有一点建议：property在New Style Class 是有特殊用法的，它是一个内置(built-in)方法，最好不用它用为类名。另外你测试的最后一行多了一个';'号

我也猜这么好听的名字一定有人用过了，呵呵

分号是因为我是一直写Java程序的 ，所以习惯了

sakulagi

原帖由 "limodou" 发表：
print pf.getdict()

这里最后我的生成test.properties与原程序不同，因为发现在里面的双引号也输出到文件中去了，因此我去掉了。

还是用循环看着简洁。我本来想练习一下map()，结果不会写lambda函数，最后越写感觉越诡秘。嘿嘿

sakulagi

[quote]原帖由 "wolfg"][/quote 发表：
相比之下俺写的果然简陋，嘿嘿。

依赛特小子

什么是自测试代码?不理解自测的功能?

xichen

Python 的两个用于单元测试的标准模块：unittest和doctest。这些模块扩展了用来确认函数内部的先置条件和后置条件的内置 assert 语句的能力。
由于模块是被import的，那么需要在直接运行该模块的时候检查必须的环境是否具备,并运行一段测试代码确保程序无错误.
一般采用

if __name__ == "__main__":
    测试代码
这样的方法.

hardcorn

学习

xichen

只是我的看法而已，其实各位写的都有自己的特色。

config.py，这个是模块

1. # -*- coding: cp936 -*-
   
2. 
   
3. """
   
4. 本程序为MIT授权
   
5. 作者：梅劲松
   
6. """
   
7. 
   
8. """
   
9. The MIT License
   
10. 
    
11. Copyright (c) 2005 stephen.cn@gmail.com
    
12. 
    
13. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
    
14. 
    
15. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
    
16. 
    
17. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    
18. 
    
19. 
    
20. Read config module.
    
21. 
    
22. """
    
23. 
    
24. __all__ = ['read_config']
    
25. __version__ = '1.0'
    
26. 
    
27. def read(file=''):
    
28.     '''File name. String'''
    
29.     if file=='':
    
30.         return ('不能打开配置文件，请检查目录中是否有%s这个文件。\n' % file)
    
31.     else:
    
32.         config = get(file)
    
33.         if not config:
    
34.             return ('不能打开配置文件，请检查目录中是否有%s这个文件。\n' % file)
    
35.         else:
    
36.             return config
    
37.             
    
38. def get(file):
    
39.     try:
    
40.             fd = open(file)
    
41.     except:
    
42.             return None
    
43.     lines = fd.readlines()
    
44.     config = {}
    
45.     for i in lines:
    
46.             i = i.strip()
    
47.             if i.find('=') < 0:
    
48.                     continue
    
49.             if i[0] == '#':
    
50.                     continue
    
51.             var, value = i.split('=',1)
    
52.             var = var.strip()
    
53.             value = value.split('=')
    
54.             config[var] = value
    
55.     return config
    
56. 
    
57. 
    
58. def _test():
    
59.     import doctest, config
    
60.     return doctest.testmod(config)
    
61. 
    
62. 
    
63. if __name__ == "__main__":
    
64.     _test()
    

复制代码

然后还有test.txt这个用来测试的文件

1. 
   
2. name=梅劲松
   
3. age=32
   
4. sex=男
   
5. iq=傻瓜

复制代码

然后测试方式为在msdos方式下：

1. 
   
2. D:\>;python config.py -v
   
3. Running config.__doc__
   
4. 0 of 0 examples failed in config.__doc__
   
5. Running config._test.__doc__
   
6. 0 of 0 examples failed in config._test.__doc__
   
7. Running config.get.__doc__
   
8. 0 of 0 examples failed in config.get.__doc__
   
9. Running config.read.__doc__
   
10. 0 of 0 examples failed in config.read.__doc__
    
11. 4 items had no tests:
    
12.     config
    
13.     config._test
    
14.     config.get
    
15.     config.read
    
16. 0 tests in 4 items.
    
17. 0 passed and 0 failed.
    
18. Test passed.
    
19. 
    
20. D:\>;

复制代码

使用方法为

1. 
   
2. D:\>;python
   
3. Python 2.3.3 (#51, Dec 18 2003, 20:22:39) [MSC v.1200 32 bit (Intel)] on win32
   
4. Type "help", "copyright", "credits" or "license" for more information.
   
5. >;>;>; import config
   
6. >;>;>; conf=config.read('test.txt')
   
7. >;>;>; conf['ai']
   
8. ['\xc9\xb5\xb9\xcf']
   
9. >;>;>;
   

复制代码

欢迎大家指正。