Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Universal configuration file parser

Project description

Cinco Config

Build Status Coverage Status

Next generation universal configuration file parser. The config file structure is defined programmatically and expressively, no need to create classes and inheritance.

Let's get right to it:

import getpass
from cincoconfig import *

# first, define the configuration's schema -- the fields available that
# customize the application's or library's behavior
schema = Schema()
schema.mode = ApplicationModeField(default='production')

# nested configurations are built on the fly
# http is now a subconfig
schema.http.port = PortField(default=8080, required=True)

# each field has its own validation rules that are run anytime the config
# value is loaded from disk or modified by the user.
# here, this field only accepts IPv4 network addresses and the user is
# required to define this field in the configuration file.
schema.http.address = IPv4AddressField(default='', required=True)

schema.http.ssl.enabled = BoolField(default=False)
schema.http.ssl.cafile = FilenameField()
schema.http.ssl.keyfile = FilenameField()
schema.http.ssl.certfile = FilenameField() = HostnameField(allow_ipv4=True, required=True, default='localhost')
schema.db.port = PortField(default=27017, required=True) = StringField(default='my_app', required=True)
schema.db.user = StringField(default='admin')

# some configuration values are sensitive, such as credentials, so
# cincoconfig provides config value encryption when the value is
# saved to disk via the SecureField
schema.db.password = SecureField()

# get a field programmatically
print(schema['']) # >>>

# once a schema is defined, build the actual configuration object
# that can load config files from disk and interact with the values
config = schema()

# print the http port
print(config.http.port) # >>> 8080

# print the http port programmatically
print(config['http.port']) # >>> 8080

config.db.password = getpass.getpass("Enter Password: ") # < 'password'

# set a config value manually
if config.mode == 'production': = + '_production'

print(config.dumps(format='json', pretty=True).decode())
# {
#   "mode": "production",
#   "http": {
#     "port": 8080,
#     "address": ""
#     "ssl": {
#       "enabled": false
#     }
#   },
#   "db": {
#     "host": "localhost",
#     "port": 27017,
#     "name": "my_app_production",
#     "user": "admin",
#     "password": {
#       "method": "best",
#       "ciphertext": "<ciphertext>"
#     }
#   }
# }

Override Configuration with Command Line Arguments (argparse)

schema = Schema()
schema.mode = ApplicationModeField(default='production', modes=['production', 'debug'])
schema.http.port = PortField(default=8080, required=True)
schema.http.address = IPv4AddressField(default='', required=True)

config = schema()

import argparse
from .config import config

parser = argparse.ArgumentParser()

parser.add_argument('-H', '--host', action='store', dest='http.address')
parser.add_argument('-p', '--port', action='store', type=int, dest='http.port')
parser.add_argument('-d', '--debug', action='store_const', const='debug', dest='mode')
parser.add_argument('-c', '--config', action='store')

args = parser.parse_args()
if args.config:
    config.load(args.config, format='json')

config.cmdline_args_override(args, ignore=['config'])

Project details

Download files

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

Files for cincoconfig, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size cincoconfig-0.4.0-py3-none-any.whl (36.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cincoconfig-0.4.0.tar.gz (37.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page