How to exclude DEFAULTs from Python ConfigParser .items()?

Viewed 9374

I'm using ConfigParser to load in data from a configuration file as follows:

test.conf:

[myfiles]
fileone: %(datadir)s/somefile.foo
filetwo: %(datadir)s/nudderfile.foo

load.py:

import ConfigParser

config = ConfigParser.ConfigParser({'datadir': '/tmp'})
config.read('test.conf')

print config.items('myfiles')
print config.get('myfiles', 'datadir')

Output:

$ python load.py 
[('datadir', '/tmp'), ('filetwo', '/tmp/nudderfile.foo'), ('fileone', '/tmp/somefile.foo')]
/tmp

I'm surprised that the defaults for variable substitution ('datadir', '/tmp') are showing up as part of the .items() and .get() returns, as if they were values in the configuration file. Is this behavior expected? Any work arounds, so that I can simply iterate .items() without getting the default dictionary values in there, but still using the magic interpolation?

Reference: http://docs.python.org/library/configparser.html

Thanks!

Update: It's been pointed out that this is the expected behavior: defaults are just like any other name/value pair in the configuration file. Similarly, the name/value pairs in the configuration file are also available for "magic interpolation", so if I define:

foo: bar
zap: %(foo)snowl

I'll get [... ('zap': 'barnowl')]

That's pretty neat, but I'm still wondering if I can accomplish what I want to accomplish: iterate over the name/value pairs in my configuration files, with interpolation of variables, without the defaults.

My specific scenario is this: I wanted to initialize the config object with something like {basedir: '/foo/bar'}, as the absolute paths to certain files varies by installation. Then I need to pass that config object around to and have various other classes iterate through the files. I don't want every class that reads the configuration to have to know that it was initialized with certain defaults and that it should ignore them, as they are not actual files. Is this possible? Any way to hide the defaults from .item() and .get() but still have interpolation? Thanks!

5 Answers

I’ve made an account for the express purpose of answering this question. It seemed to be a top hit on Google when I was searching.

I dug into the source of ConfigParser to find what I think is a simple and efficient solution.

There’s a keyword argument to the RawConfigParser class (which ConfigParser inherits) called default_section. I was able to ignore the DEFAULT section of my config by instantiating with:

from configparser import ConfigParser

parser = ConfigParser(default_section=None)

I hope this can help someone else as well.

Try this:

config = ConfigParser.ConfigParser({'blahblahblah': 'blah'})
config.read('test.conf')

The blahblahblah key will also appear in items, not because it's a template in the .ini file, but because you specified it as a default. This is how ConfigParser treats defaults: if it can't find them in the file, it assigns their default values.

So it appears to me you have a simple confusion of concepts here.

The following should give you only the key/value pairs in the myfiles section without also listing out those in DEFAULT:

list(set(config.items('myfiles'))-set(config.items('DEFAULT')))
Related