Python 讀取寫入配置文件 —— ConfigParser

Python 讀取寫入配置文件 —— ConfigParser

 

　　Python 讀取寫入配置文件很方便，可使用內置的 configparser 模塊；可查看源碼，如博主本機地址： “C:/python27/lib/configparser.py”

Configuration file parser.
 
A setup file consists of sections, lead by a "[section]" header,
and followed by "name: value" entries, with continuations and such in
the style of RFC 822.

　　該模塊支持讀取類似如上格式的配置文件，如 windows 下的 .conf 及 .ini 文件等。

　　本章節使用如下的配置文件作為示例，可在 D 盤下新建 Pyhton_config 文件夾，創建兩個文件 test.config  及 test.ini  內容及示例截圖如下：

[db]
db_port = 3306
db_user = root
db_host = 127.0.0.1
db_pass = xgmtest

[concurrent]
processor = 20
thread = 10

　　

　　本章節就基礎讀取及寫入配置文件進行具體的說明。

 

 　　基礎讀取配置文件

 

• -read(filename)               直接讀取文件內容
• -sections()                      得到所有的section，並以列表的形式返回
• -options(section)            得到該section的所有option
• -items(section)                得到該section的所有鍵值對
• -get(section,option)        得到section中option的值，返回為string類型
• -getint(section,option)    得到section中option的值，返回為int類型，還有相應的getboolean()和getfloat() 函數。

 

# !/usr/bin/env python
# -*- coding:utf-8 -*-  

import ConfigParser
import os

os.chdir("D:\\Python_config")

cf = ConfigParser.ConfigParser()

# cf.read("test.ini")
cf.read("test.conf")

#return all section
secs = cf.sections()
print 'sections:', secs, type(secs)
opts = cf.options("db")
print 'options:', opts, type(opts)
kvs = cf.items("db")
print 'db:', kvs

#read by type
db_host = cf.get("db", "db_host")
db_port = cf.getint("db", "db_port")
db_user = cf.get("db", "db_user")
db_pass = cf.get("db", "db_pass")

#read int
threads = cf.getint("concurrent", "thread")
processors = cf.getint("concurrent", "processor")
print "db_host:", db_host
print "db_port:", db_port
print "db_user:", db_user
print "db_pass:", db_pass
print "thread:", threads
print "processor:", processors

　　　　示例代碼詳見上方，解析如下：

　　　　需要實例化為 ConfigParser 對象  cf = ConfigParser.ConfigParser() ；讀取文件  cf.read("test.conf") 

　　　　      secs = cf.sections()  獲取sections，返回list  

　　　　       opts = cf.options("db")  獲取db section下的 options，返回list  

　　　　 kvs = cf.items("db")  獲取db section 下的所有鍵值對，返回list 如下，每個list元素為鍵值對元組

　　　　

 

　　　　通常情況下，我們已知 section 及 option，需取出對應值，讀取方式如下：

#read by type
db_host = cf.get("db", "db_host")
db_port = cf.getint("db", "db_port")
db_user = cf.get("db", "db_user")
db_pass = cf.get("db", "db_pass")

 

　　　　cf.get(...) 返回的會是 str 類型， getint 則返回int類型　　　　

 

 

 　　基礎寫入配置文件

 

• -write(fp)                                                           將config對象寫入至某個 .init 格式的文件  Write an .ini-format representation of the configuration state.
  
• -add_section(section)                                    添加一個新的section
• -set( section, option, value                      對section中的option進行設置，需要調用write將內容寫入配置文件

   1 import ConfigParser
   2 import os
   3 
   4 os.chdir("D:\\Python_config")
   5 
   6 cf = ConfigParser.ConfigParser()
   7 
   8 cf.add_section("test")
   9 cf.set("test", "count", 1)
  10 cf.add_section("test1")
  11 cf.set("test1", "name", "aaa")
  12 
  13 #modify one value and write to file
  14 with open("test2.ini","w+") as f:
  15     cf.write(f)

• -remove_section(section)                             刪除某個 section
• -remove_option(section, option)                 刪除某個 section 下的 option

 

　　　　需要配合文件讀寫函數來寫入文件，示例代碼如下

import ConfigParser
import os

os.chdir("D:\\Python_config")

cf = ConfigParser.ConfigParser()

# add section / set option & key
cf.add_section("test")
cf.set("test", "count", 1)
cf.add_section("test1")
cf.set("test1", "name", "aaa")

# write to file
with open("test2.ini","w+") as f:
    cf.write(f)

　　　　寫入的文件如：

 

　　　　修改類似寫入，注意一定要 read 原文件！

import ConfigParser
import os

os.chdir("D:\\Python_config")

cf = ConfigParser.ConfigParser()

# modify cf, be sure to read!
cf.read("test2.ini")
cf.set("test", "count", 2)            # set to modify
cf.remove_option("test1", "name")

# write to file
with open("test2.ini","w+") as f:
    cf.write(f)

　　　　上述代碼執行后：  [test] 下 count 的值為2； [test1] 下的 name 鍵值被刪除，若需要刪除整個 [test1] section，使用  cf.remove_section("test1")