Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Parser like ConfigParser but for updating configuration files

Project description

https://travis-ci.org/pyscaffold/configupdater.svg?branch=master ReadTheDocs Coveralls PyPI-Server

ConfigUpdater

The sole purpose of ConfigUpdater is to easily update an INI config file with no changes to the original file except the intended ones. This means comments, the ordering of sections and key/value-pairs as wells as their cases are kept as in the original file. Thus ConfigUpdater provides complementary functionality to Python’s ConfigParser which is primarily meant for reading config files and writing new ones.

Features

The key differences to ConfigParser are:

  • minimal invasive changes in the update configuration file,
  • proper handling of comments,
  • only a single config file can be updated at a time,
  • empty lines in values are not valid,
  • the original case of sections and keys are kept,
  • control over the position of a new section/key

Following features are deliberately not implemented:

  • interpolation of values,
  • propagation of parameters from the default section,
  • conversions of values,
  • passing key/value-pairs with default argument,
  • non-strict mode allowing duplicate sections and keys.

Usage

First install the package with:

pip install configupdater

Now we can simply do:

from configupdater import ConfigUpdater

updater = ConfigUpdater()
updater.read_file('setup.cfg')

which would read the file setup.cfg that is found in many projects.

To change the value of an existing key we can simply do:

updater['metadata']['author'].value = "Alan Turing"

At any point we can print the current state of the configuration file with:

print(updater)

To update the read-in file just call updater.update_file() or updater.write('filename') to write the changed configuration file to another destination. Before actually writing, ConfigUpdater will automatically check that the updated configuration file is still valid by parsing it with the help of ConfigParser.

Many of ConfigParser’s methods still exists and it’s best to look them up in the module reference. Let’s look at some examples.

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.

Notes

ConfigUpdater is mainly developed for PyScaffold.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
ConfigUpdater-0.3.2-py2.py3-none-any.whl (12.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Sep 8, 2018
ConfigUpdater-0.3.2.tar.gz (30.2 kB) Copy SHA256 hash SHA256 Source None Sep 8, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page