spread-confiture 0.17.3rc1

Requirements

This project requires pyyaml to parse yaml files.

Template file

A template file is a file that describes the fields that we want to check when parsing a configuration file. It is also written in yaml, with the following scheme:

foo:
    bar: ""
    foobar:
        foo: ""
        bar: ""

bar: ""

A configuration file is consistant relatively to the template file if every required field specified by the template are set. Note that the configuration can also set other fields that are not specified by the template.

Create a Confiture object

To create a Confiture object relatively to a given template file:

from confiture import Confiture
# conf pour confiture ou configration ?
conf = Confiture("examples/templates/confiture.yaml")

Parse a configuration file

Once the Confiture object is created, we can test yaml configuration files:

# Simple test
conf.check("examples/config/blueberry_ok.yaml")
# Test et récupération du contenu du fichier sous forme de dictionnaire
config = conf.check_and_get("examples/config/blueberry_ok.yaml")

If the configuration file is not consistant with the template, a ConfigFileError exception is raised.

Code

from confiture import Confiture, ConfigFileError

print "[*] loading template"
confiture = Confiture("examples/templates/confiture.yaml")
print "[*] checking required files for blueberry"
try:
    confiture.check("examples/config/blueberry_ok.yaml")
    print "[*] blueberry file is correct"
except ConfigFileError as e:
    print e.message
print "[*] checking required files for banana"
try:
    confiture.check("examples/config/banana_ko.yaml")
    print "[*] banana file is correct"
except ConfigFileError as e:
    print e.message

Output

(confiture) > python ./example.py
[*] loading template
[*] checking required files for blueberry
[*] blueberry file is correct
[*] checking required files for banana
*** fruit field not found -- aborting