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 內容及示例截圖如下:
View Code
本章節就基礎讀取及寫入配置檔案進行具體的說明。
基礎讀取配置檔案
- -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() 函式。
1 # !/usr/bin/env python 2 # -*- coding:utf-8 -*- 3 4 import ConfigParser 5 import os 6 7 os.chdir("D:\\Python_config") 8 9 cf = ConfigParser.ConfigParser() 10 11 # cf.read("test.ini") 12 cf.read("test.conf") 13 14 #return all section 15 secs = cf.sections() 16 print 'sections:', secs, type(secs) 17 opts = cf.options("db") 18 print 'options:', opts, type(opts) 19 kvs = cf.items("db") 20 print 'db:', kvs 21 22 #read by type 23 db_host = cf.get("db", "db_host") 24 db_port = cf.getint("db", "db_port") 25 db_user = cf.get("db", "db_user") 26 db_pass = cf.get("db", "db_pass") 27 28 #read int 29 threads = cf.getint("concurrent", "thread") 30 processors = cf.getint("concurrent", "processor") 31 print "db_host:", db_host 32 print "db_port:", db_port 33 print "db_user:", db_user 34 print "db_pass:", db_pass 35 print "thread:", threads 36 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將內容寫入配置檔案 ConfigParser2
- -remove_section(section) 刪除某個 section
- -remove_option(section, option) 刪除某個 section 下的 option
需要配合檔案讀寫函式來寫入檔案,示例程式碼如下
1 import ConfigParser 2 import os 3 4 os.chdir("D:\\Python_config") 5 6 cf = ConfigParser.ConfigParser() 7 8 # add section / set option & key 9 cf.add_section("test") 10 cf.set("test", "count", 1) 11 cf.add_section("test1") 12 cf.set("test1", "name", "aaa") 13 14 # write to file 15 with open("test2.ini","w+") as f: 16 cf.write(f)
寫入的檔案如:
修改類似寫入,注意一定要 read 原檔案!
1 import ConfigParser 2 import os 3 4 os.chdir("D:\\Python_config") 5 6 cf = ConfigParser.ConfigParser() 7 8 # modify cf, be sure to read! 9 cf.read("test2.ini") 10 cf.set("test", "count", 2) # set to modify 11 cf.remove_option("test1", "name") 12 13 # write to file 14 with open("test2.ini","w+") as f: 15 cf.write(f)
上述程式碼執行後: [test] 下 count 的值為2; [test1] 下的 name 鍵值被刪除,若需要刪除整個 [test1] section,使用 cf.remove_section("test1")