style: normalize indentation and improve code style
- convert tabs to 4-space indentation
- add docstrings to modules and classes
- remove unused import (copy)
- use explicit object inheritance
- use 'while True' over 'while 1'
- use 'while args' over 'while len(args)'
- use '{}' over 'dict()'
- consistent string formatting
- Python 2/3 compatible Queue import
This commit is contained in:
Username
164
comboparse.py
164
comboparse.py
@@ -1,74 +1,110 @@
|
||||
#!/usr/bin/env python2
|
||||
# -*- coding: utf-8 -*-
|
||||
"""Combined config file and argument parser."""
|
||||
|
||||
from ConfigParser import SafeConfigParser, NoOptionError
|
||||
from argparse import ArgumentParser
|
||||
import sys
|
||||
|
||||
class _Dummy():
|
||||
pass
|
||||
|
||||
class _Dummy(object):
|
||||
"""Placeholder for config sections."""
|
||||
pass
|
||||
|
||||
|
||||
class ComboParser(object):
|
||||
def __init__(self, ini):
|
||||
self.items = []
|
||||
self.cparser = SafeConfigParser()
|
||||
self.aparser = ArgumentParser()
|
||||
self.ini = ini
|
||||
self.items = []
|
||||
self.loaded = False
|
||||
"""Parse configuration from INI file and command-line arguments.
|
||||
|
||||
def add_item(self, section, name, type, default, desc, required):
|
||||
def str2bool(val):
|
||||
return val in ['True', 'true', '1', 'yes']
|
||||
self.items.append({
|
||||
'section':section,
|
||||
'name':name,
|
||||
'type':type,
|
||||
'default':default,
|
||||
'required':required,
|
||||
})
|
||||
self.aparser.add_argument(
|
||||
'--%s.%s'%(section, name),
|
||||
help='%s, default: (%s)'%(desc, str(default)),
|
||||
type=type if type is not bool else str2bool,
|
||||
default=None,
|
||||
required=False
|
||||
)
|
||||
def load(self):
|
||||
if self.loaded: return
|
||||
self.loaded = True
|
||||
Command-line arguments override INI file values.
|
||||
"""
|
||||
|
||||
try:
|
||||
self.cparser.read(self.ini)
|
||||
except Exception:
|
||||
pass # config file missing or unreadable, use defaults
|
||||
args = self.aparser.parse_args()
|
||||
for item in self.items:
|
||||
try:
|
||||
obj = getattr(self, item['section'])
|
||||
except AttributeError:
|
||||
setattr(self, item['section'], _Dummy())
|
||||
obj = getattr(self, item['section'])
|
||||
def __init__(self, ini):
|
||||
self.items = []
|
||||
self.cparser = SafeConfigParser()
|
||||
self.aparser = ArgumentParser()
|
||||
self.ini = ini
|
||||
self.loaded = False
|
||||
self.args = None
|
||||
|
||||
setattr(obj, item['name'], item['default'])
|
||||
inner = getattr(obj, item['name'])
|
||||
def add_item(self, section, name, type, default, desc, required):
|
||||
"""Add a configuration item."""
|
||||
def str2bool(val):
|
||||
return val.lower() in ('true', '1', 'yes')
|
||||
|
||||
item['found'] = True
|
||||
try:
|
||||
if item['type'] is bool : inner = self.cparser.getboolean(item['section'], item['name'])
|
||||
elif item['type'] is float: inner = self.cparser.getfloat(item['section'], item['name'])
|
||||
elif item['type'] is int : inner = self.cparser.getint(item['section'], item['name'])
|
||||
elif item['type'] is str : inner = self.cparser.get(item['section'], item['name'])
|
||||
except NoOptionError:
|
||||
item['found'] = False
|
||||
try:
|
||||
arg = getattr(args, '%s.%s'%(item['section'], item['name']))
|
||||
if arg is not None:
|
||||
inner = arg
|
||||
item['found'] = True
|
||||
except AttributeError:
|
||||
pass # arg not provided on command line
|
||||
if not item['found']:
|
||||
if item['required']:
|
||||
sys.stderr.write('error: required config item "%s" not found in section "%s" of "%s"!\n'%(item['name'], item['section'], self.ini))
|
||||
sys.exit(1)
|
||||
else:
|
||||
sys.stderr.write('warning: assigned default value of "%s" to "%s.%s"\n'%(str(item['default']), item['section'], item['name']))
|
||||
setattr(obj, item['name'], inner)
|
||||
self.items.append({
|
||||
'section': section,
|
||||
'name': name,
|
||||
'type': type,
|
||||
'default': default,
|
||||
'required': required,
|
||||
})
|
||||
self.aparser.add_argument(
|
||||
'--%s.%s' % (section, name),
|
||||
help='%s (default: %s)' % (desc, default),
|
||||
type=type if type is not bool else str2bool,
|
||||
default=None,
|
||||
required=False
|
||||
)
|
||||
|
||||
def load(self):
|
||||
"""Load configuration from file and command-line."""
|
||||
if self.loaded:
|
||||
return
|
||||
self.loaded = True
|
||||
|
||||
try:
|
||||
self.cparser.read(self.ini)
|
||||
except Exception:
|
||||
pass # Config file missing or unreadable, use defaults
|
||||
|
||||
self.args = self.aparser.parse_args()
|
||||
|
||||
for item in self.items:
|
||||
section = item['section']
|
||||
name = item['name']
|
||||
|
||||
# Ensure section object exists
|
||||
if not hasattr(self, section):
|
||||
setattr(self, section, _Dummy())
|
||||
obj = getattr(self, section)
|
||||
|
||||
# Start with default value
|
||||
value = item['default']
|
||||
found = False
|
||||
|
||||
# Try to read from config file
|
||||
try:
|
||||
if item['type'] is bool:
|
||||
value = self.cparser.getboolean(section, name)
|
||||
elif item['type'] is float:
|
||||
value = self.cparser.getfloat(section, name)
|
||||
elif item['type'] is int:
|
||||
value = self.cparser.getint(section, name)
|
||||
elif item['type'] is str:
|
||||
value = self.cparser.get(section, name)
|
||||
found = True
|
||||
except NoOptionError:
|
||||
pass
|
||||
|
||||
# Command-line overrides config file
|
||||
arg_name = '%s.%s' % (section, name)
|
||||
arg_value = getattr(self.args, arg_name, None)
|
||||
if arg_value is not None:
|
||||
value = arg_value
|
||||
found = True
|
||||
|
||||
# Handle missing required items
|
||||
if not found:
|
||||
if item['required']:
|
||||
sys.stderr.write(
|
||||
'error: required config item "%s" not found in section "%s" of "%s"\n'
|
||||
% (name, section, self.ini)
|
||||
)
|
||||
sys.exit(1)
|
||||
else:
|
||||
sys.stderr.write(
|
||||
'warning: assigned default value of "%s" to "%s.%s"\n'
|
||||
% (item['default'], section, name)
|
||||
)
|
||||
|
||||
setattr(obj, name, value)
|
||||
|
||||
Reference in New Issue
Block a user