cfgparse

This project has been renamed iniparse to avoid being confused with another project
of the same name on SourceForge. Its new home is: http://code.google.com/p/iniparse/

cfgparse is a Python module that provides mechanisms for managing configuration information. It is backward compatible with ConfigParser, in addition to having the following features:

• Preserves structure of INI files: Order of sections & options, indentation (to some extent), comments, and blank lines are preserved when data is updated.
• More convenient than ConfigParser: Values can be accessed using dotted notation, or using container syntax (cfg[key]).
• Backward compatibility: Backward compatible implementations of ConfigParser, RawConfigParser, and SafeConfigParser are included that are API-compatible with the Python standard library. They pass all the unit tests in Python-2.3.4.
• Extensible: It is possible to add other configuration formats, and to convert between different formats (as long as the data models are compatible).

Latest version: cfgparse-0.1.tar.gz

Here is an illustration of typical usage:

• Read an INI file:

      >>> from cfgparser.iniparser import ini_namespace
      >>> cfg = ini_namespace(file('options.ini'))
  

  Or, alternatively:

      >>> from cfgparser.compat import ConfigParser
      >>> cfgpr = ConfigParser()
      >>> cfgpr.read('options.ini')
  

• Access/Modify data:

      >>> print cfg.playlist.expand_playlist
      True
      >>> print cfg.ui.width
      150
      >>> cfg.ui.width = 200
      >>> print cfg['ui']['width']      # alternative access method
      200
  

  If you are using cfgparser.compat.ConfigParser, you can continue using get/set methods to access/update values. Alternatively, you can access the underlying namespace object using cfgpr.data:

      >>> print cfgpr.data.playlist.expand_playlist
      True
      >>> print cfgpr.data.ui.width
      150
      >>> cfgpr.data.ui.width = 200
      >>> cfgpr.set('ui', 'width', 175)   # can also use get/set methods
      >>> print cfgpr.get('ui', 'width')  # for compatiability
      175
  

• Print data:

      >>> print cfg
      [playlist]
      expand_playlist = True
  
      [ui]
      display_clock = True
      display_qlength = True
      width = 150
  

• A non-INI example:

      >>> from cfgparser.config import basic_namespace
      >>> n = basic_namespace()
      >>> n.x = 7
      >>> n.name.first = 'paramjit'
      >>> n.name.last = 'oberoi'
      >>> n.x
      7
      >>> n.name.first
      'paramjit'
      >>> print n
      name.first = paramjit
      name.last = oberoi
      x = 7
  

  Convert to INI:

      >>> from cfgparser.iniparser import ini_namespace
      >>> i = ini_namespace()
      >>> del n.x               # since INI doesn't support top-level values
      >>> i.import_namespace(n)
      >>> print i
      [name]
      first = paramjit
      last = oberoi
  

• Interpolation is only possible using the compatibility interface
• Documentation is incomplete

For more information, see the automatically generated API documentation. Please send your bug reports, suggestions, comments, etc., to Paramjit Oberoi <param@cs.wisc.edu>.