ConfigUpdater 1.1.1

Adding and removing options

Let’s say we have the following configuration in a string:

cfg = """
[metadata]
author = Ada Lovelace
summary = The Analytical Engine
"""

We can add an license option, i.e. a key/value pair, in the same way we would do with ConfigParser:

updater = ConfigUpdater()
updater.read_string(cfg)
updater['metadata']['license'] = 'MIT'

A simple print(updater) will give show you that the new option was appended to the end:

[metadata]
author = Ada Lovelace
summary = The Analytical Engine
license = MIT

Since the license is really important to us let’s say we want to add it before the summary and even add a short comment before it:

updater = ConfigUpdater()
updater.read_string(cfg)
(updater['metadata']['summary'].add_before
                               .comment("Ada would have loved MIT")
                               .option('license', 'MIT'))

which would result in:

[metadata]
author = Ada Lovelace
# Ada would have loved MIT
license = MIT
summary = Analytical Engine calculating the Bernoulli numbers

Using add_after would give the same result and looks like:

updater = ConfigUpdater()
updater.read_string(cfg)
(updater['metadata']['author'].add_after
                              .comment("Ada would have loved MIT")
                              .option('license', 'MIT'))

Let’s say we want to rename summary to the more common description:

updater = ConfigUpdater()
updater.read_string(cfg)
updater['metadata']['summary'].key = 'description'

If we wanted no summary at all, we could just do del updater['metadata']['summary'].

Adding and removing sections

Adding and remove sections just works like adding and removing options but on a higher level. Sticking to our Ada Lovelace example, let’s say we want to add a section options just before metadata with a comment and two new lines to separate it from metadata:

updater = ConfigUpdater()
updater.read_string(cfg)
(updater['metadata'].add_before
                    .comment("Some specific project options")
                    .section("options")
                    .space(2))

As expected, this results in:

# Some specific project options
[options]

[metadata]
author = Ada Lovelace
summary = The Analytical Engine

We could now fill the new section with options like we learnt before. If we wanted to rename an existing section we could do this with the help of the name attribute:

updater['metadata'].name = 'MetaData'

Sometimes it might be useful to inject a new section not in a programmatic way but more declarative. Let’s assume we have thus defined our new section in a multi-line string:

sphinx_sect_str = """
[build_sphinx]
source_dir = docs
build_dir = docs/_build
"""

With the help of two ConfigUpdater objects we can easily inject this section into our example:

sphinx = ConfigUpdater()
sphinx.read_string(sphinx_sect_str)
sphinx_sect = sphinx['build_sphinx']

updater = ConfigUpdater()
updater.read_string(cfg)

(updater['metadata'].add_after
                    .space()
                    .section(sphinx_sect))

This results in:

[metadata]
author = Ada Lovelace
summary = The Analytical Engine

[build_sphinx]
source_dir = docs
build_dir = docs/_build

For more examples on how the API of ConfigUpdater works it’s best to take a look into the unit tests and read the references.