Skip to main content

An easy-to-use, powerful configuration module for Python

Project description

https://secure.travis-ci.org/mortbauer/configreader.png?branch=master

There are quite many Configuration Parsers for Python out there, but well, they all kind of suck in there own way. Let me point out what I dislike:

  • configparser: which is the de facto standard, has it’s ini like language, in my opionion quite awful, difficult and limited

  • Configuration through yaml: is beautiful, but how about intergration of simple environment variables or interpolation of already defined values

  • How about just execution a python module, very unsafe (but who cares), but it also pollutes the namespace with all sort of builtins and whatsoever

So I was looking once again and found python-config, which looked really exactly what I wanted, but well, I had my problems with it, since I wanted to have acces to stuff like os.getenv(‘HOME’) and similar, which was not really possible since it was forbidden to call a function, though you could still evaluate stuff and so on. I looke into the source and thought well how can I allow also calling functions? But I realized they are defining there own parsing grammar, which seemed kind of reinventing the wheel since I already knew the ast module.

Finally I wrote a very simple Configuration Parser which lets ast and operator do most of the work. It has of course its own problems, and is hack of half an hour so don’t expect much. For me it is still usefull, and maybe we can improve it.

Usage

As a simple example of what is possible and how to use the module, see the following config file which is by the way completely valid python:

home = os.getenv('HOME')
aster_root = home+"/data/opt/aster"
project = "bikeframe-test"
version = "testing"
# source directory for all files if relative path
srcdir = "."
# output directory for all stuff
outdir = "results"
# input mesh file
meshfile = "mesh.med"
logfile = "asterclient.log"
workdir = "/data/tmp"
# define the studies
calculations = [
    {"name":"main",
      "commandfile": "main.comm",
      "resultfiles":{
            "bikeframe.rmed":80,
            "bikeframe.msh": 81,
            "buckling.rmed": 82,
            "bikeframe.table": 39,
            "bikeframe.resu": 38,
            "buckling.resu": 37,
            },
      "inputfiles":["parameters.py"],
      },
    {"name": "post",
      "commandfile":"post.comm",
      "poursuite": "main",
      "resultfiles":{
        "vmises.table": 40,
        "protocol": "protocol*.rst",
        }
      }]

Suppose we have this saved as profile.conf we could read it like:

import os
from configreader import Config

c = Config(open('profile.conf','r'),namespace={'os.getenv':os.getenv})

which would give as all the values specified and evaluated as a python dict. If we wouldn’t have provided the namespace with os.getenv the parsing would have failed since it only allows functions mapped in the namespace, so you have completele fine grained possibility on what to allow. As input the Config class expects any file like object which is an object with a read method.

Testing

There are a few simple test cases in tests use best py.test to run them.

Project details


Download files

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

Source Distribution

configreader-0.0.6.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

configreader-0.0.6-py2-none-any.whl (6.9 kB view details)

Uploaded Python 2

File details

Details for the file configreader-0.0.6.tar.gz.

File metadata

File hashes

Hashes for configreader-0.0.6.tar.gz
Algorithm Hash digest
SHA256 d1fcd6a539135137b15440574a68ec1545db8b823675282d2b1c28818e40b4e4
MD5 8462b1d46734321158393111ec9ddcca
BLAKE2b-256 22eb2b4fdbdd2cb026329368d2102fc41968dd318846dc83603dd43fb8f3433c

See more details on using hashes here.

File details

Details for the file configreader-0.0.6-py2-none-any.whl.

File metadata

File hashes

Hashes for configreader-0.0.6-py2-none-any.whl
Algorithm Hash digest
SHA256 b67a96fa7f3cf08c7e6bafa8f3694b42cacb30cb246646f7a09e97b483a26063
MD5 f88f8223756d6b42e051d409ed78dc6b
BLAKE2b-256 587231ddf74227900847cb23b6222b6be1ba0787e4b9863dd3a665c4e9c67a27

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page