Skip to main content

An ini parser/serializer in Python

Project description


An ini format parser and serializer for Python.

Sections are treated as nested dictionaries. Items before the first heading are saved on the object directly.


Consider an ini-file config.ini that looks like this:

; this comment is being ignored
scope = global

user = dbuser
password = dbpassword
database = use_this_database

datadir = /var/lib/data
array[] = first value
array[] = second value
array[] = third value

You can read, manipulate and write the ini-file like so:

import ini

config = ini.parse(open('config.ini').read())

config['scope'] = 'local'
config['database']['database'] = 'use_another_database'
config['paths']['default']['tmpdir'] = '/tmp'
del config['paths']['default']['datadir']
config['paths']['default']['array'].append('fourth value')

with open('config_modified.ini', 'w+') as f:
    f.write(ini.stringify(config, {'section': 'section'}))

This will result in a file called config_modified.ini being written to the filesystem with the following content:

scope = local

user = dbuser
password = dbpassword
database = use_another_database

array[] = first value
array[] = second value
array[] = third value
array[] = fourth value
tmpdir = /tmp



Decode the ini-style formatted inistring into a nested object.


Alias for decode(inistring)

encode(object, [options])

Encode the object object into an ini-style formatted string. If the optional parameter section is given, then all top-level properties of the object are put into this section and the section-string is prepended to all sub-sections, see the usage example above.

The options object may contain the following:

  • section A string which will be the first section in the encoded ini data. Defaults to none.
  • whitespace Boolean to specify whether to put whitespace around the = character. By default, whitespace is omitted, to be friendly to some persnickety old parsers that don't tolerate it well. But some find that it's more human-readable and pretty with the whitespace.

If a string options is passed in, then it is assumed to be the section value.

stringify(object, [options])

Alias for encode(object, [options])


Escapes the string val such that it is safe to be used as a key or value in an ini-file. Basically escapes quotes. For example'"unsafe string"')

would result in

"\"unsafe string\""


Unescapes the string val

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ini-parser, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size ini-parser-1.1.0.tar.gz (4.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page