snekcfg is a minimalist wrapper over
configparser that offers
a more streamlined user experience.
Expected options and their types are predefined to prevent errors and minimize repetitive logic within your codebase. This allows for simple, direct access to your configuration within your program without worrying about typos or type conversion.
example.py
import snekcfg
cfg = snekcfg.Config('example.cfg')
sct = cfg.section('server')
# the default value is used to automatically type as an int
sct.define('port', 8080)
# or, you can be explicit
sct.define('host', default='127.0.0.1', type=str)
# some common types like set[str] are already built-in,
# but here is an example of adding a codec for a new type.
# *type* can be a type object, or just a string like 'str_set'
cfg.register_type(
type=set[str],
encode=lambda v: ','.join(v),
decode=lambda v: set(v.split(',')))
# sections can be accessed using dot notation (one level deep)
cfg.define('users.whitelist', default=set(), type=set[str])
# update values with dot notation
users = {'graham', 'john', 'terryg', 'eric', 'terryj', 'michael'}
cfg['users.whitelist'].update(users)
# or through the section
cfg.section('server')['port'] = 1337
# write to 'example.cfg'
cfg.write()
# let's tweak the config file externally
with open('example.cfg', 'r+') as f:
s = f.read()
f.seek(0)
f.write(s.replace('1337', '1234'))
# read from 'example.cfg'
cfg.read()
# types are preserved
assert cfg['server.port'] == 1234
assert cfg['users.whitelist'] == users, usersexample.cfg
[server]
host = 127.0.0.1
port = 1337
[users]
whitelist = eric,graham,michael,john,terryg,terryj
