~bzr-pqm/bzr/bzr.dev

:Version: ConfigObj 4.5.2

:Date: 2008/02/24

:Development: `SVN Repository`_

.. _SVN Repository: http://svn.pythonutils.python-hosting.com

 

 

    

    - including automatic type checking/conversion

    - repeated sections

    - and allowing default values

 

* When writing out config files, ConfigObj preserves all comments and the order of members and sections

* Many useful methods and options for working with configuration files (like the 'reload' method)

* Full Unicode support

 

The current version is **4.5.2**, dated 24th February 2008. ConfigObj 4 is

now stable. We still expect to pick up a few bugs along the way though [#]_.

    This also contains validate.py_  and `this document`_.

*configobj.zip* also contains `this document`_.

 

* You can view `this document`_ online at the `ConfigObj Homepage`_.

 

 

Development Version

-------------------

 

It is sometimes possible to get the latest *development version* of ConfigObj

from the `Subversion Repository <http://svn.pythonutils.python-hosting.com/trunk/pythonutils/>`_.

 

.. _configobj.zip: http://www.voidspace.org.uk/cgi-bin/voidspace/downman.py?file=configobj-4.5.2.zip

.. _Voidspace Python Projects: http://www.voidspace.org.uk/python/index.shtml

 

 

 

ConfigObj in the Real World

===========================

    

**ConfigObj** is widely used. Projects using it include:

 

* `Bazaar <http://bazaar-ng.org>`_.

 

    Bazaar is a Python distributed {acro;VCS;Version Control System}.

    ConfigObj is used to read ``bazaar.conf`` and ``branches.conf``.

 

* `Turbogears <http://www.turbogears.org/>`_

 

    Turbogears is a web application framework.

 

* `Chandler <http://chandler.osafoundation.org/>`_

 

   A Python and `wxPython <http://www.wxpython.org>`_ 

   {acro;PIM;Personal Information Manager}, being developed by the 

   `OSAFoundation <http://www.osafoundation.org/>`_.

 

* `matplotlib <http://matplotlib.sourceforge.net/>`_

 

        A 2D plotting library.

 

* `IPython <http://ipython.scipy.org/moin/>`_

 

    IPython is an enhanced interactive Python shell. IPython uses ConfigObj in a module called 'TConfig' that combines it with enthought `Traits <http://code.enthought.com/traits/>`_: `tconfig <http://ipython.scipy.org/ipython/ipython/browser/ipython/branches/saw/sandbox/tconfig>`_.

    

* `Elisa - the Fluendo Mediacenter <http://elisa.fluendo.com/>`_    

    

    Elisa is an open source cross-platform media center solution designed to be simple for people not particularly familiar with computers.

 

 

 

 

 

 

* A list of lines. Any trailing newlines will be removed from the lines. The

* A ``StringIO`` instance or file object, or any object with a ``read`` method.

  The ``filename`` attribute of your ConfigObj will be ``None`` [#]_.

 

        

        If ``list_values = False`` then single line values are not quoted or

        unquoted when reading and writing.

    Changing this value affects whether single line values will be quoted or 

    not when writing.

    when values are fetched. See the `String Interpolation`_ section for more details.

* 'indent_type': ``'    '``

    Indentation is not significant; it can however be present in the input and

    output config. Any combination of tabs and spaces may be used: the string

    will be repeated for each level of indentation. Typical values are: ``''``

    (no indentation), ``'    '`` (indentation with four spaces, the default),

    ``'\t'`` (indentation with one tab).

    four spaces.

* 'encoding': ``None``

 

    By default **ConfigObj** does not decode the file/strings you pass it into

    Unicode [#]_. If you want your config file as Unicode (keys and members)

    you need to provide an encoding to decode the file with. This encoding will

    also be used to encode the config file when writing.

    

    You can change the encoding attribute at any time.

    

    Any characters in your strings that can't be encoded with the specified

    encoding will raise a ``UnicodeEncodeError``.

    

    .. note::

    

        ``UTF16`` encoded files will automatically be detected and decoded,

        even if ``encoding`` is ``None``.

        

        This is because it is a 16-bit encoding, and ConfigObj will mangle it

        (split characters on byte boundaries) if it parses it without decoding.

 

* 'default_encoding': ``None``

 

    When using the ``write`` method, **ConfigObj** uses the ``encoding``

    attribute to encode the Unicode strings. If any members (or keys) have

    been set as byte strings instead of Unicode, these must first be decoded

    to Unicode before outputting in the specified encoding.

 

    ``default_encoding``, if specified, is the encoding used to decode byte

    strings in the **ConfigObj** before writing. If this is ``None``, then

    the Python default encoding (``sys.defaultencoding`` - usually ASCII) is

    used.

    

    For most Western European users, a value of ``latin-1`` is sensible.

    

    ``default_encoding`` is *only* used if an ``encoding`` is specified.

    

    Any characters in byte-strings that can't be decoded using the

    ``default_encoding`` will raise a ``UnicodeDecodeError``.

 

* 'unrepr': ``False``

 

    The ``unrepr`` option reads and writes files in a different mode. This

    allows you to store and retrieve the basic Python data-types using config

    files.

    

    This uses Python syntax for lists and quoting. See `unrepr mode`_ for the

    full details.

 

* 'write_empty_values': ``False`` 

 

    If ``write_empty_values`` is ``True``, empty strings are written as

    empty values. See `Empty Values`_ for more details.

 

 

In addition, the following `Section Methods`_ may be useful :

 

* 'restore_default'

* 'restore_defaults'

* 'walk'

* 'merge'

* 'dict'

* 'as_bool'

* 'as_float'

* 'as_int'

 

Read about Sections_ for details of all the methods.

 

.. hint::

 

    The *merge* method of sections is a recursive update.

    

    You can use this to merge sections, or even whole ConfigObjs, into each

    other.

    

    You would typically use this to create a default ConfigObj and then merge

    in user settings. This way users only need to specify values that are

    different from the default. You can use configspecs and validation to

    achieve the same thing of course.

    

* 'reset'

* 'reload'

 

::

 

    write(file_object=None)

 

This method writes the current ConfigObj and takes a single, optional argument

[#]_.

 

If you pass in a file like object to the ``write`` method, the config file will

be written to this. (The only method of this object that is used is its

``write`` method, so a ``StringIO`` instance, or any other file like object

will work.)

 

Otherwise, the behaviour of this method depends on the ``filename`` attribute

of the ConfigObj.

 

``filename``

    ConfigObj will write the configuration to the file specified.

 

::

 

    validate(validator, preserve_errors=False, copy=False)

 

The validate method uses the `validate 

<http://www.voidspace.org.uk/python/validate.html>`__ module to do the

validation.

    

conversion as well it can abstract away the config file altogether and present

    The system of configspecs can seem confusing at first, but is actually

    quite simple and powerful. For a concrete example of how to use it, you may

    find this blog entry helpful :

    `Transforming Values with ConfigObj <http://www.voidspace.org.uk/python/weblog/arch_d7_2006_03_04.shtml#e257>`_.

 

 

The ``copy`` parameter fills in missing values from the configspec (default

values), *without* marking the values as defaults. It also causes comments to

be copied from the configspec into the config file. This allows you to use a

configspec to create default config files. (Normally default values aren't

written out by the ``write`` method.)

 

As of ConfigObj 4.3.0 you can also pass in a ConfigObj instance as your

configspec. This is especially useful if you need to specify the encoding of

your configspec file. When you read your configspec file, you *must* specify

``list_values=False``.

 

.. raw:: html

 

    {+coloring}

    from configobj import ConfigObj

    configspec = ConfigObj(configspecfilename, encoding='UTF8',

                           list_values=False)

    config = ConfigObj(filename, configspec=configspec)

    {-coloring}

By default, the validate method either returns ``True`` (everything passed) 

or a dictionary of ``True``/``False`` representing pass/fail. The dictionary 

follows the structure of the ConfigObj.

The ``validate`` method takes an optional keyword argument ``preserve_errors``.

If you set this to ``True``, instead of getting ``False`` for failed checks you

get the actual error object from the **validate** module. This usually contains

useful information about why the check failed.

 

See the `flatten_errors`_ function for how to turn your results dictionary into

a useful list of error messages.

 

Even if ``preserve_errors`` is ``True``, missing keys or sections will still be

represented by a ``False`` in the results dictionary.

 

 

The default value can be a list. See `List Values`_ for the way to do this.

 

Writing invalid default values is a *guaranteed* way of confusing your users.

Default values **must** pass the check.

 

 

 

 

Mentioning copy Mode

####################

 

As discussed in `Mentioning Default Values`_, you can use a configspec to

supply default values. These are marked in the ConfigObj instance as defaults,

and *not* written out by the ``write`` mode. This means that your users only

need to supply values that are different from the defaults.

 

This can be inconvenient if you *do* want to write out the default values,

for example to write out a default config file.

 

If you set ``copy=True`` when you call validate, then no values are marked as

defaults. In addition, all comments from the configspec are copied into

your ConfigObj instance. You can then call ``write`` to create your config

file.

    

There is a limitation with this. In order to allow `String Interpolation`_ to work

within configspecs, ``DEFAULT`` sections are not processed by

validation; even in copy mode.

 

 

reload

~~~~~~

 

If a ConfigObj instance was loaded from the filesystem, then this method will reload it. It

will also reuse any configspec you supplied at instantiation (including reloading it from

the filesystem if you passed it in as a filename).

 

If the ConfigObj does not have a filename attribute pointing to a file, then a ``ReloadError`` 

will be raised.

 

 

reset

~~~~~

 

This method takes no arguments and doesn't return anything. It restores a ConfigObj

instance to a freshly created state.

 

 

* list_values

* encoding

* default_encoding

* unrepr

* write_empty_values

* newlines

 

 

interpolation

~~~~~~~~~~~~~

``ConfigParser``. See the `String Interpolation`_ section for full details.

If ``interpolation`` is set to ``False``, then interpolation is *not* done when

 

 

slightly incorrectly as the {acro;BOM;Byte Order Mark}), or the UTF16 BOM, then

this attribute is set to ``True``. Otherwise it is ``False``.

 

If it is set to ``True`` when ``write`` is called then, if ``encoding`` is set

to ``None`` *or* to ``utf_8`` (and variants) a UTF BOM will be written.

 

For UTF16 encodings, a BOM is *always* written.

 

 

 

list_values

~~~~~~~~~~~

 

This attribute is ``True`` or ``False``. If set to ``False`` then values are

not parsed for list values. In addition single line values are not unquoted.

 

This allows you to do your own parsing of values. It exists primarily to

support the reading of the configspec_ - but has other use cases.

 

For example you could use the ``LineParser`` from the

`listquote module <http://www.voidspace.org.uk/python/listquote.html#lineparser>`_ 

to read values for nested lists.

 

Single line values aren't quoted when writing - but multiline values are

handled as normal.

 

.. caution::

 

    Because values aren't quoted, leading or trailing whitespace can be

        lost.

 

    This behaviour was changed in version 4.0.1.

        

        Prior to this, single line values might have been quoted; even with

        ``list_values=False``. This means that files written by **ConfigObj**

        *could* now be incompatible - and need the quotes removing by hand.

 

 

encoding

~~~~~~~~

 

This is the encoding used to encode the output, when you call ``write``. It

must be a valid encoding `recognised by Python <http://docs.python.org/lib/standard-encodings.html>`_.

 

If this value is ``None`` then no encoding is done when ``write`` is called.

 

 

default_encoding

~~~~~~~~~~~~~~~~

 

If encoding is set, any byte-strings in your ConfigObj instance (keys or

members) will first be decoded to Unicode using the encoding specified by the

``default_encoding`` attribute. This ensures that the output is in the encoding

specified.

 

If this value is ``None`` then ``sys.defaultencoding`` is used instead.

 

 

unrepr

~~~~~~

 

Another boolean value. If this is set, then ``repr(value)`` is used to write

values. This writes values in a slightly different way to the normal ConfigObj

file syntax.

 

This preserves basic Python data-types when read back in. See `unrepr mode`_

for more details.

 

 

write_empty_values

~~~~~~~~~~~~~~~~~~

 

Also boolean. If set, values that are an empty string (``''``) are written as

empty values. See `Empty Values`_ for more details.

 

 

newlines

~~~~~~~~

 

When a config file is read, ConfigObj records the type of newline separators in the

file and uses this separator when writing. It defaults to ``None``, and ConfigObj

uses the system default (``os.sep``) if write is called without newlines having

been set.

 

 

    ConfigObj({

    })

.. note::

 

    In ConfigObj 4.3.0 *empty values* became valid syntax. They are read as the

    empty string. There is also an option/attribute (``write_empty_values``) to

    allow the writing of these.

    

    This is mainly to support 'legacy' config files, written from other

    applications. This is documented under `Empty Values`_.

    

    `unrepr mode`_ introduces *another* syntax variation, used for storing

    basic Python datatypes in config files. {sm;:-)}

 

 

 

* default_values

 

    This attribute is a dictionary mapping keys to the default values for the

    keys. By default it is an empty dictionary and is populated when you

    validate the ConfigObj.

 

 

* **dict**

* **rename**

* **merge**

 

    ``merge(indict)``

    

    This method is a *recursive update* method. It allows you to merge two

    config files together.

    

    You would typically use this to create a default ConfigObj and then merge

    in user settings. This way users only need to specify values that are

    different from the default.

    

    For example :

    

    .. raw:: html

    

        {+coloring}

        

        # def_cfg contains your default config settings

        # user_cfg contains the user settings

        cfg = ConfigObj(def_cfg)

        usr = ConfigObj(user_cfg)

        #

        cfg.merge(usr)

        

        """

        cfg now contains a combination of the default settings and the user

        settings.

        

        The user settings will have overwritten any of the default ones.

        """

    

        {-coloring}

    

* **walk**

* **decode**

* **encode**

    implicit decode first. (This method uses ``sys.defaultencoding`` for

    implicit decodes.)

 

* **as_bool**

 

    ``as_bool(key)``

    

    Returns ``True`` if the key contains a string that represents ``True``, or

    is the ``True`` object.

    

    Returns ``False`` if the key contains a string that represents ``False``, 

    or is the ``False`` object. 

 

    Raises a ``ValueError`` if the key contains anything else.

    

    Strings that represent ``True`` are (not case sensitive) : ::

    

        true, yes, on, 1

        

    Strings that represent ``False`` are : ::

    

        false, no, off, 0

    

    .. note::

    

        In ConfigObj 4.1.0, this method was called ``istrue``. That method is

        now deprecated and will issue a warning when used. It will go away

        in a future release.

        

* **as_int**

 

    ``as_int(key)``

    

    This returns the value contained in the specified key as an integer.

    

    It raises a ``ValueError`` if the conversion can't be done.

 

* **as_float**

 

    ``as_float(key)``

    

    This returns the value contained in the specified key as a float.

    

    It raises a ``ValueError`` if the conversion can't be done.

    

* **restore_default**

 

    ``restore_default(key)``

    

    Restore (and return) the default value for the specified key.

    

    This method will only work for a ConfigObj that was created

    with a configspec and has been validated.

    

    If there is no default value for this key, ``KeyError`` is raised.

 

* **restore_defaults**

    

    ``restore_defaults()``

 

    Recursively restore default values to all members

    that have them.

    

    This method will only work for a ConfigObj that was created

    with a configspec and has been validated.

    

    It doesn't delete or modify entries without default values.

 

.. caution::

 

    You can use ``walk`` to transform the names of members of a section

    but you mustn't add or delete members.

 

 

listquote_ module. You could switch off the parsing for list values

Here's a simple example of using ``walk`` to transform names and values. One

usecase of this would be to create a *standard* config file with placeholders

for section and keynames. You can then use walk to create new config files

and change values and member names :

 

.. raw:: html

 

    {+coloring}

 

    # We use 'XXXX' as a placeholder

    config = '''

    XXXXkey1 = XXXXvalue1

    XXXXkey2 = XXXXvalue2

    XXXXkey3 = XXXXvalue3

    [XXXXsection1]

    XXXXkey1 = XXXXvalue1

    XXXXkey2 = XXXXvalue2

    XXXXkey3 = XXXXvalue3

    [XXXXsection2]

    XXXXkey1 = XXXXvalue1

    XXXXkey2 = XXXXvalue2

    XXXXkey3 = XXXXvalue3

        [[XXXXsection1]]

        XXXXkey1 = XXXXvalue1

        XXXXkey2 = XXXXvalue2

        XXXXkey3 = XXXXvalue3

    '''.splitlines()

    cfg = ConfigObj(config)

    #

    def transform(section, key):

        val = section[key]

        newkey = key.replace('XXXX', 'CLIENT1')

        section.rename(key, newkey)

        if isinstance(val, (tuple, list, dict)):

            pass

        else:

            val = val.replace('XXXX', 'CLIENT1')