/usr/lib/python2.7/dist-packages/configglue/glue.py is in python-configglue 1.1.2-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 | ###############################################################################
#
# configglue -- glue for your apps' configuration
#
# A library for simple, DRY configuration of applications
#
# (C) 2009--2013 by Canonical Ltd.
# by John R. Lenton <john.lenton@canonical.com>
# and Ricardo Kirkner <ricardo.kirkner@canonical.com>
#
# Released under the BSD License (see the file LICENSE)
#
# For bug reports, support, and new releases: http://launchpad.net/configglue
#
###############################################################################
import os
import sys
from optparse import OptionParser
from collections import namedtuple
from ._compat import NoSectionError, NoOptionError
from .parser import SchemaConfigParser
__all__ = [
'configglue',
'schemaconfigglue',
]
SchemaGlue = namedtuple("SchemaGlue",
"schema_parser option_parser options args")
def schemaconfigglue(parser, op=None, argv=None):
"""Glue an OptionParser with a SchemaConfigParser.
The OptionParser is populated with options and defaults taken from the
SchemaConfigParser.
"""
def long_name(option):
if option.section.name == '__main__':
return option.name
return option.section.name + '_' + option.name
def opt_name(option):
return long_name(option).replace('-', '_')
if op is None:
op = OptionParser()
if argv is None:
argv = sys.argv[1:]
schema = parser.schema
for section in schema.sections():
if section.name == '__main__':
og = op
else:
og = op.add_option_group(section.name)
for option in section.options():
kwargs = {}
if option.help:
kwargs['help'] = option.help
try:
kwargs['default'] = parser.get(section.name, option.name)
except (NoSectionError, NoOptionError):
pass
kwargs['action'] = option.action
args = ['--' + long_name(option)]
if option.short_name:
# prepend the option's short name
args.insert(0, '-' + option.short_name)
og.add_option(*args, **kwargs)
options, args = op.parse_args(argv)
def set_value(section, option, value):
# if value is not of the right type, cast it
if not option.validate(value):
kwargs = {}
if option.require_parser:
kwargs['parser'] = parser
value = option.parse(value, **kwargs)
parser.set(section.name, option.name, value)
for section in schema.sections():
for option in section.options():
op_value = getattr(options, opt_name(option))
try:
parser_value = parser.get(section.name, option.name)
except (NoSectionError, NoOptionError):
parser_value = None
env_value = os.environ.get("CONFIGGLUE_{0}".format(
long_name(option).upper()))
# 1. op value != parser value
# 2. op value == parser value != env value
# 3. op value == parser value == env value or not env value
# if option is fatal, op_value will be None, so skip this case too
if op_value != parser_value and not option.fatal:
set_value(section, option, op_value)
elif env_value is not None and env_value != parser_value:
set_value(section, option, env_value)
return op, options, args
def configglue(schema_class, configs, op=None, validate=False):
"""Parse configuration files using a provided schema.
The standard workflow for configglue is to instantiate a schema class,
feed it with some config files, and validate the parser state afterwards.
This utility function executes this standard worfklow so you don't have
to repeat yourself.
"""
scp = SchemaConfigParser(schema_class())
scp.read(configs)
parser, opts, args = schemaconfigglue(scp, op=op)
if validate or getattr(opts, 'validate', False):
is_valid, reasons = scp.is_valid(report=True)
if not is_valid:
parser.error('\n'.join(reasons))
return SchemaGlue(scp, parser, opts, args)
|