tailhook/trafaret-config


A small wrapper around trafaret and yaml that does nice error reporting (python)

http://trafaret-config.readthedocs.io/

License: Other

Language: Python


Trafaret Config

Status: Stable
Documentation: http://trafaret-config.readthedocs.io/

This is a wrapper that loads yaml and checks config using trafaret while keeping track of actual lines of file where error has happened. Additionally, it can pretty print the error.

Basic Usage:

import argparse
import trafaret
from trafaret_config import commandline

TRAFARET = trafaret.Dict({'x': trafaret.String()})

def main():
    ap = argparse.ArgumentParser()
    commandline.standard_argparse_options(ap, default_config='config.yaml')
    #
    # define your command-line arguments here
    #
    options = ap.parse_args()
    config = commandline.config_from_options(options, TRAFARET)
    pprint.pprint(config)

Example output when there is an error in config (from a example.py which has better trafaret than example above):

bad.yaml:3: smtp.port: value can't be converted to int
  -> 'unknown'
bad.yaml:4: smtp.ssl_port: value can't be converted to int
  -> 'NaN'
bad.yaml:5: port: value can't be converted to int
  -> '???'

Help looks like this:

usage: example.py [-h] [-c CONFIG] [--print-config] [--print-config-vars] [-C]

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Configuration file (default: 'config.yaml')
  --print-config        Print config as it is read after parsing and exit
  --print-config-vars   Print variables used in configuration file
  -C, --check-config    Check configuration and exit

Since trafaret-config 2.0 environment variables in the config are replaced by default, this means that config like this:

url: http://${HOST}:$PORT/

Will get HOST and PORT variables insert from the environment, and if variable does not exist, you will get the following error:

config.yaml:2: variable 'PORT' not found
  -> 'http://${HOST}:$PORT/'

Low-level interface, without relying on argparse:

import sys
import trafaret
from trafaret_config import ConfigError, read_and_validate

TRAFARET = trafaret.Dict({'x': trafaret.String()})

try:
    config = read_and_validate('config.yaml', TRAFARET)
except ConfigError as e:
    e.output()
    sys.exit(1)

Installation

pip install trafaret-config==2.0.2

License

Licensed under either of

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Project Statistics

Sourcerank 8
Repository Size 86.9 KB
Stars 30
Forks 4
Watchers 7
Open issues 0
Dependencies 2
Contributors 4
Tags 10
Created
Last updated
Last pushed

Top Contributors See all

Paul Colomiets Denis Kataev Andrew Svetlov Jan Vlčinský

Packages Referencing this Repo

trafaret-config
A configuration library for python using trafaret and yaml
Latest release 2.0.2 - Updated - 30 stars

Recent Tags See all

v2.0.2 September 13, 2018
v2.0.1 July 07, 2018
v2.0.1b2 July 07, 2018
v2.0.1b1 July 07, 2018
v2.0.0 July 07, 2018
v2.0.0-beta.2 July 07, 2018
v2.0.0-beta.1 July 07, 2018
v1.0.1 December 03, 2016
v1.0.0 November 12, 2016
v0.1.0 September 24, 2016

Something wrong with this page? Make a suggestion

Last synced: 2018-09-13 12:44:41 UTC

Login to resync this repository