How to Use the ConfigParser module in Python

This article mainly introduces the use of the ConfigParser module in Python. The ConfigParser module is mainly used to read and write the configuration module. For more information, see 1. Read the configuration file.

-Read (filename) directly reads the INI File Content

-Sections () obtains all sections and returns them as a list.

-Options (section): obtain all options of this section.

-Items (section) obtains all key-value pairs of this section.

-Get (section, option): get the option value in section. The return value is of the string type.

-Getint (section, option) gets the option value in the section, returns the int type, and the corresponding getboolean () and getfloat () functions.

2. Basic write configuration file

-Add_section (section): Add a new section.

-Set (section, option, value) to set the option in section. You must call write to write the content to the configuration file.

3. Basic example

test.conf[sec_a] a_key1 = 20 a_key2 = 10   [sec_b] b_key1 = 121 b_key2 = b_value2 b_key3 = $r b_key4 = 127.0.0.1

parse_test_conf.pyimport ConfigParser cf = ConfigParser.ConfigParser() #read config cf.read("test.conf") # return all section secs = cf.sections() print 'sections:', secs   opts = cf.options("sec_a") print 'options:', opts   kvs = cf.items("sec_a") print 'sec_a:', kvs   #read by type str_val = cf.get("sec_a", "a_key1") int_val = cf.getint("sec_a", "a_key2")   print "value for sec_a's a_key1:", str_val print "value for sec_a's a_key2:", int_val   #write config #update value cf.set("sec_b", "b_key3", "new-$r") #set a new value cf.set("sec_b", "b_newkey", "new-value") #create a new section cf.add_section('a_new_section') cf.set('a_new_section', 'new_key', 'new_value')   #write back to configure file cf.write(open("test.conf", "w"))

Terminal output:

sections: ['sec_b', 'sec_a'] options: ['a_key1', 'a_key2'] sec_a: [('a_key1', "i'm value"), ('a_key2', '22')] value for sec_a's a_key1: i'm value value for sec_a's a_key2: 22

Updated test. conf

[sec_b] b_newkey = new-value b_key4 = 127.0.0.1 b_key1 = 121 b_key2 = b_value2 b_key3 = new-$r   [sec_a] a_key1 = i'm value a_key2 = 22   [a_new_section] new_key = new_value

4. The ConfigParser Module of Python defines three classes to operate the INI file.. RawConfigParser, ConfigParser, and SafeConfigParser. RawCnfigParser is the most basic INI File Reading Class. ConfigParser and SafeConfigParser support parsing the % (value) s variable.

Set the configuration file test2.conf

[portal] url = http://%(host)s:%(port)s/Portal host = localhost port = 8080

Use RawConfigParser:

import ConfigParser  cf = ConfigParser.RawConfigParser()  print "use RawConfigParser() read" cf.read("test2.conf") print cf.get("portal", "url")  print "use RawConfigParser() write" cf.set("portal", "url2", "%(host)s:%(port)s") print cf.get("portal", "url2")

Terminal output:

use RawConfigParser() read http://%(host)s:%(port)s/Portal use RawConfigParser() write %(host)s:%(port)s

Use ConfigParser instead:

import ConfigParser  cf = ConfigParser.ConfigParser()  print "use ConfigParser() read" cf.read("test2.conf") print cf.get("portal", "url")  print "use ConfigParser() write" cf.set("portal", "url2", "%(host)s:%(port)s") print cf.get("portal", "url2")

Terminal output:

use ConfigParser() read http://localhost:8080/Portal use ConfigParser() write localhost:8080

Use SafeConfigParser instead:

import ConfigParser  cf = ConfigParser.SafeConfigParser()  print "use SafeConfigParser() read" cf.read("test2.conf") print cf.get("portal", "url")  print "use SateConfigParser() write" cf.set("portal", "url2", "%(host)s:%(port)s") print cf.get("portal", "url2")

Terminal output (same effect as ConfigParser ):

use SafeConfigParser() read http://localhost:8080/Portal use SateConfigParser() write localhost:8080