Skip to main content

Application configuration via Python logging.config

Project description

https://badge.fury.io/py/Clor.png

Clor

Clor is a tiny wrapper around logging configuration system [1], which allows its reuse for general application configuration. The name was coined this way: “configurator” → “c10r” → “clor”.

Usage

Normally there’s a configuration module (e.g. envconf.py), or a YAML file. Here is a CherryPy example:

base = {
  'global' : {
    'server.socket_host' : '127.0.0.1',
    'server.socket_port' : 8080,
    'server.thread_pool' : 8
  },
  'app' : {
    'api' : {
      '/' : {
        'request.dispatch' : {
          '()' : 'cherrypy._cpdispatch.MethodDispatcher'
        }
      }
    }
  }
}

production = (base, {
  'global' : {
    'server.socket_host' : '0.0.0.0',
    'server.thread_pool' : 16,
    'tools.auth_basic.on'            : True,
    'tools.auth_basic.realm'         : 'App',
    'tools.auth_basic.checkpassword' : 'ext://someapp.password.checker'
  },
})

development = (base, {
  'global' : {
    'server.thread_pool' : None,
  },
  'app' : {
    'api' : {
      '/' : {
        'tools.response_headers.on'      : True,
        'tools.response_headers.headers' : [('Access-Control-Allow-Origin', '*')]
      }
    }
  }
})

A few observations:

  • Nest dictionaries are merged recursively
  • logging’s ext pseudo-protocols
  • logging’s instantiation with () key
  • Keys having None value are removed

Then in your bootstrapping code you can do:

import clor

from . import envconf


config = clor.configure(*getattr(envconf, 'production'))

cherrypy.config.update(config)
cherrypy.tree.mount(ApiApplication(), '/api', config['app']['api'])
[1]https://docs.python.org/3/library/logging.config.html

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 Clor, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size Clor-0.2.1.tar.gz (3.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page