Differences between revisions 11 and 12
Revision 11 as of 2014-05-12 12:01:02
Size: 3833
Editor: Strijker
Revision 12 as of 2016-04-11 04:17:05
Size: 3833
Editor: bignose
Comment: Use standard white space for readability.
Deletions are marked like this. Additions are marked like this.
Line 13: Line 13:
FavoriteColor=Green FavoriteColor = Green
Line 55: Line 55:
>>>Name = ConfigSectionMap("SectionOne")['name']
>>>Age = ConfigSectionMap("SectionOne")['age']
>>>print "Hello %s. You are %s years old." % (Name, Age)
>>> Name = ConfigSectionMap("SectionOne")['name']
>>> Age = ConfigSectionMap("SectionOne")['age']
>>> print "Hello %s. You are %s years old." % (Name, Age)
Line 65: Line 65:
>>>single = Config.getboolean("SectionOne", "single")
>>> single = Config.getboolean("SectionOne", "single")
>>> single
Line 97: Line 97:
Param1:  Hello
Param2:  World
Param1: Hello
Param2: World
Line 101: Line 101:
Param1:  ${SectionOne:Param1} ${SectionOne:Param2} Param1: ${SectionOne:Param1} ${SectionOne:Param2}
Line 104: Line 104:
Alpha:   One
Bravo:   Two
Alpha: One
Bravo: Two

Basic configparser usage

These are some examples on using ConfigParser, assuming the following INI file...

Status: Single
Name: Derek
Value: Yes
Age: 30
Single: True

FavoriteColor = Green
FamilyName: Johnson

Route: 66

>>> import ConfigParser
>>> Config = ConfigParser.ConfigParser()
>>> Config
<ConfigParser.ConfigParser instance at 0x00BA9B20>
>>> Config.read("c:\\tomorrow.ini")
>>> Config.sections()
['Others', 'SectionThree', 'SectionOne', 'SectionTwo']

Explanation: We first import the configparser, tell it to read the file, and get a listing of the sections. Sections are listed in square brackets [].

Next, we are going to get some settings, after defining a helper function.

The Function:

def ConfigSectionMap(section):
    dict1 = {}
    options = Config.options(section)
    for option in options:
            dict1[option] = Config.get(section, option)
            if dict1[option] == -1:
                DebugPrint("skip: %s" % option)
            print("exception on %s!" % option)
            dict1[option] = None
    return dict1

Now the code:

>>> Name = ConfigSectionMap("SectionOne")['name']
>>> Age = ConfigSectionMap("SectionOne")['age']
>>> print "Hello %s. You are %s years old." % (Name, Age)
Hello Derek. You are 30 years old.

This works great most of the time, but what about the "Value: Yes" and "Single: True" values? Those are booleans. They can be either True or False, Yes or No, 1 or 0, on or off. To read a boolean value, you use:  Config.getboolean(section, option)  Example, continuing from above:

>>> single = Config.getboolean("SectionOne", "single")
>>> single

You can also use getint(section, option) to get a number as an int. This may be easier to use than int(Config.get(section, option)) There is also getfloat which is used the same as getint, but, as you guessed, returns a float instead of an int.

Notes on reading an INI file

lines beginning with a semicolon ';' a pound sign '#' or the letters 'REM' (uppercase or lowercase) will be ignored. You may use these for comments if you want. You cannot put a comment on an option line. It will only be treated as a comment if it is at the beginning of the line!

Writing an INI file

When you write to an INI file, you will wipe out all comments.

Assuming the config file doesn't exist yet, this is the code to create one:

# lets create that config file for next time...
cfgfile = open("c:\\next.ini",'w')

# add the settings to the structure of the file, and lets write it out...
Config.set('Person','Age', 50)

Advanced configparser usage


Using ExtendedInterpolation one can make use of cross-chapter flexible parameter values. For instance, using the following ini file:

Param1: Hello
Param2: World

Param1: ${SectionOne:Param1} ${SectionOne:Param2}

Alpha: One
Bravo: Two
Charlie: ${Alpha} Mississippi

By setting _interpolation to ExtendedInterpolation() the values become dynamic.

>>> import configparser
>>> settings = configparser.ConfigParser()
>>> settings._interpolation = configparser.ExtendedInterpolation()
>>> settings.read('settings.ini')
>>> settings.sections()
['SectionOne', 'SectionTwo', 'SectionThree']
>>> settings.get('SectionTwo', 'Param1')
'Hello World'
>>> settings.get('SectionThree', 'Charlie')
'One Mississippi'


ConfigParserExamples (last edited 2016-04-11 04:17:05 by bignose)

Unable to edit the page? See the FrontPage for instructions.