# Copyright (C) 2009-2013 Lars Wirzenius
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
from __future__ import print_function # unicode_literals
try:
from configparser import ConfigParser
except ImportError: # pragma: no cover
from ConfigParser import ConfigParser
import optparse
import os
import re
import sys
import yaml
try:
import xdg.BaseDirectory
except ImportError: # pragma: no cover
xdg_is_available = False
else: # pragma: no cover
xdg_is_available = True
import cliapp
from cliapp.genman import ManpageGenerator
# hack in a 'unicode' type for Python 2 v 3 compatibility
if sys.version_info > (3, ): # pragma: no cover
unicode = str # pylint: disable=redefined-builtin
log_group_name = 'Logging'
config_group_name = 'Configuration files and settings'
perf_group_name = 'Peformance'
default_group_names = [
log_group_name,
config_group_name,
perf_group_name,
]
class UnknownConfigVariable(cliapp.AppException):
def __init__(self, filename, name):
msg = '%s: Unknown configuration variable %s' % (filename, name)
cliapp.AppException.__init__(self, msg)
def __str__(self): # pragma: no cover
return self.msg
class MalformedYamlConfig(cliapp.AppException): # pragma: no cover
def __init__(self, msg):
cliapp.AppException.__init__(self, msg)
def __str__(self): # pragma: no cover
return self.msg
class Setting(object):
action = 'store'
type = 'string'
nargs = 1
choices = None
def __init__(self, names, default, help_text, metavar=None, group=None,
hidden=False):
self.names = names
self.set_value(default)
self.help = help_text
self.metavar = metavar or self.default_metavar()
self.group = group
self.hidden = hidden
def default_metavar(self):
return None
def get_value(self):
return self._string_value
def set_value(self, value):
self._string_value = value
def call_get_value(self):
return self.get_value()
def call_set_value(self, value):
self.set_value(value)
value = property(call_get_value, call_set_value)
def has_value(self):
return self.value is not None
def parse_value(self, string):
self.value = string
def format(self): # pragma: no cover
return str(self.value)
class StringSetting(Setting):
def default_metavar(self):
return self.names[0].upper()
class StringListSetting(Setting):
action = 'append'
def __init__(self, names, default, help_text, metavar=None, group=None,
hidden=False):
Setting.__init__(
self, names, [], help_text, metavar=metavar, group=group,
hidden=hidden)
self.default = default
self._strings = self.default or []
self.using_default_value = True
def default_metavar(self):
return self.names[0].upper()
def get_value(self):
return self._strings
def set_value(self, strings):
if type(strings) != list:
self._strings = [strings]
else:
self._strings = strings
self.using_default_value = False
def has_value(self):
return self.value != []
def parse_value(self, string):
values = []
value = ''
inside_quote = False
for c in string:
if c == '"':
inside_quote = not inside_quote
elif c == ',' and not inside_quote:
values.append(value)
value = ''
else:
value += c
if value:
values.append(value)
self.value = [v.strip() for v in values]
def format(self): # pragma: no cover
values = ['"%s"' % v if ',' in v else v for v in self.value]
return ', '.join(values)
class ChoiceSetting(Setting):
type = 'choice'
def __init__(self, names, choices, help_text, metavar=None, group=None,
hidden=False):
Setting.__init__(
self, names, choices[0], help_text, metavar=metavar, group=group,
hidden=hidden)
self.choices = choices
def default_metavar(self):
return self.names[0].upper()
class BooleanSetting(Setting):
action = 'store_true'
nargs = None
type = None
_trues = ['yes', 'on', '1', 'true']
_false = 'no'
def get_value(self):
return self._string_value.lower() in self._trues
def set_value(self, value):
def is_true():
if value is True or value is False:
return value
if type(value) in [str, unicode]:
return value.lower() in self._trues
return value
if is_true():
self._string_value = self._trues[0]
else:
self._string_value = self._false
class ByteSizeSetting(Setting):
def parse_human_size(self, size):
'''Parse a size using suffix into plain bytes.'''
m = re.match(r'''(?P<number>\d+(\.\d+)?) \s*
(?P<unit>k|ki|m|mi|g|gi|t|ti)? b? \s*$''',
size.lower(), flags=re.X)
if not m:
return 0
else:
number = float(m.group('number'))
unit = m.group('unit')
units = {
'k': 10 ** 3,
'm': 10 ** 6,
'g': 10 ** 9,
't': 10 ** 12,
'ki': 2 ** 10,
'mi': 2 ** 20,
'gi': 2 ** 30,
'ti': 2 ** 40,
}
return int(number * units.get(unit, 1))
def default_metavar(self):
return 'SIZE'
def get_value(self):
return int(self._string_value)
def set_value(self, value):
if type(value) in [str, unicode]:
value = self.parse_human_size(value)
self._string_value = str(value)
class IntegerSetting(Setting):
type = 'int'
def default_metavar(self):
return self.names[0].upper()
def get_value(self):
return int(self._string_value)
def set_value(self, value):
self._string_value = str(value)
class FormatHelpParagraphs(optparse.IndentedHelpFormatter):
def _format_text(self, text): # pragma: no cover
'''Like the default, except handle paragraphs.'''
fmt = cliapp.TextFormat(width=self.width)
formatted = fmt.format(text)
return formatted.rstrip('\n')
class Settings(object):
'''Settings for a cliapp application.
You probably don't need to create a settings object yourself,
since ``cliapp.Application`` does it for you.
Settings are read from configuration files, and parsed from the
command line. Every setting has a type, name, and help text,
and may have a default value as well.
For example::
settings.boolean(['verbose', 'v'], 'show what is going on')
This would create a new setting, ``verbose``, with a shorter alias
``v``. On the command line, the options ``--verbose`` and
``-v`` would work equally well. There can be any number of aliases.
The help text is shown if the user uses ``--help`` or
``--generate-manpage``.
You can use the ``metavar`` keyword argument to set the name shown
in the generated option lists; the default name is whatever
``optparse`` decides (i.e., name of option).
Use ``load_configs`` to read configuration files, and
``parse_args`` to parse command line arguments.
The current value of a setting can be accessed by indexing
the settings class::
settings['verbose']
The list of configuration files for the appliation is stored
in ``config_files``. Add or remove from the list if you wish.
The files need to exist: those that don't are silently ignored.
'''
def __init__(self, progname, version, usage=None, description=None,
epilog=None):
self._settingses = dict()
self._all_config_data = {}
self._canonical_names = list()
self.version = version
self.progname = progname
self.usage = usage
self.description = description
self.epilog = epilog
self._add_default_settings()
self._config_files = None
self._required_config_files = []
self._cp = ConfigParser()
def _add_default_settings(self):
self.string(['output'],
'write output to FILE, instead of standard output',
metavar='FILE')
self.string(['log'],
'write log entries to FILE (default is to not write log '
'files at all); use "syslog" to log to system log, '
'"stderr" to log to the standard error output, '
'or "none" to disable logging',
metavar='FILE', group=log_group_name)
self.choice(['log-level'],
['debug', 'info', 'warning', 'error', 'critical', 'fatal'],
'log at LEVEL, one of debug, info, warning, '
'error, critical, fatal (default: %default)',
metavar='LEVEL', group=log_group_name)
self.bytesize(['log-max'],
'rotate logs larger than SIZE, '
'zero for never (default: %default)',
metavar='SIZE', default=0, group=log_group_name)
self.integer(['log-keep'], 'keep last N logs (%default)',
metavar='N', default=10, group=log_group_name)
self.string(['log-mode'],
'set permissions of new log files to MODE (octal; '
'default %default)',
metavar='MODE', default='0600', group=log_group_name)
self.choice(['dump-memory-profile'],
['simple', 'none'],
'make memory profiling dumps using METHOD, which is one '
'of: none, or simple (no meliae support anymore)'
'(default: %default)',
metavar='METHOD',
group=perf_group_name)
self.integer(['memory-dump-interval'],
'make memory profiling dumps at least SECONDS apart',
metavar='SECONDS',
default=300,
group=perf_group_name)
def _add_setting(self, setting):
'''Add a setting to self._cp.'''
self._canonical_names.append(setting.names[0])
for name in setting.names:
self._settingses[name] = setting
def string(self, names, help_text, default='', **kwargs):
'''Add a setting with a string value.'''
self._add_setting(StringSetting(names, default, help_text, **kwargs))
def string_list(self, names, help_text, default=None, **kwargs):
'''Add a setting which have multiple string values.
An example would be an option that can be given multiple times
on the command line, e.g., "--exclude=foo --exclude=bar".
'''
self._add_setting(StringListSetting(names, default or [], help_text,
**kwargs))
def choice(self, names, possibilities, help_text, **kwargs):
'''Add a setting which chooses from list of acceptable values.
An example would be an option to set debugging level to be
one of a set of accepted names: debug, info, warning, etc.
The default value is the first possibility.
'''
self._add_setting(
ChoiceSetting(names, possibilities, help_text, **kwargs))
def boolean(self, names, help_text, default=False, **kwargs):
'''Add a setting with a boolean value.'''
self._add_setting(BooleanSetting(names, default, help_text, **kwargs))
def bytesize(self, names, help_text, default=0, **kwargs):
'''Add a setting with a size in bytes.
The user can use suffixes for kilo/mega/giga/tera/kibi/mibi/gibi/tibi.
'''
self._add_setting(ByteSizeSetting(names, default, help_text, **kwargs))
def integer(self, names, help_text, default=0, **kwargs):
'''Add an integer setting.'''
self._add_setting(IntegerSetting(names, default, help_text, **kwargs))
def __getitem__(self, name):
return self._settingses[name].value
def __setitem__(self, name, value):
self._settingses[name].value = value
def __contains__(self, name):
return name in self._settingses
def __iter__(self):
'''Iterate over canonical settings names.'''
for name in self._canonical_names:
yield name
def keys(self):
'''Return canonical settings names.'''
return self._canonical_names[:]
def require(self, *setting_names):
'''Raise exception if a setting has not been set.
Option must have a value, and a default value is OK.
'''
messages = []
for name in setting_names:
if not self._settingses[name].has_value():
messages.append(
'Setting %s has no value, but one is required' % name)
if len(messages) > 0:
raise cliapp.AppException('\n'.join(messages))
def _option_names(self, names):
'''Turn setting names into option names.
Names with a single letter are short options, and get prefixed
with one dash. The rest get prefixed with two dashes.
'''
return ['--%s' % name if len(name) > 1 else '-%s' % name
for name in names]
def _destname(self, name):
name = '_'.join(name.split('-'))
return name
def build_parser(self, configs_only=False, arg_synopsis=None,
cmd_synopsis=None, deferred_last=None, all_options=False):
'''Build OptionParser for parsing command line.'''
# Call a callback function unless we're in configs_only mode.
def maybe(func):
return (lambda *args: None) if configs_only else func
# Maintain lists of callback function calls that are deferred.
# We call them ourselves rather than have OptionParser call them
# directly so that we can do things like --dump-config only
# after the whole command line is parsed.
def defer_last(func): # pragma: no cover
def callback(*args):
deferred_last.append(lambda: func(*args))
return callback
# Create the command line parser.
def getit(x):
if x is None or type(x) in [str, unicode]:
return x
else:
return x()
usage = getit(self.usage)
description = getit(self.description)
p = optparse.OptionParser(prog=self.progname, version=self.version,
formatter=FormatHelpParagraphs(),
usage=usage,
description=description,
epilog=self.epilog)
# Create all OptionGroup objects. This way, the user code can
# add settings to built-in option groups.
group_names = set(default_group_names)
for name in self._canonical_names:
s = self._settingses[name]
if s.group is not None:
group_names.add(s.group)
group_names = sorted(group_names)
option_groups = {}
for name in group_names:
group = optparse.OptionGroup(p, name)
p.add_option_group(group)
option_groups[name] = group
config_group = option_groups[config_group_name]
# Helper to add an option and add a reference to the Setting
# object it is created from (or None). This allows manpage
# generation to recognize when --foo and --no-foo come from
# the same setting.
def add_option_to_group(setting, group, *args, **kwargs):
option = group.add_option(*args, **kwargs)
option.from_setting = setting
return option
# Return help text, unless setting/option is hidden, in which
# case return optparse.SUPPRESS_HELP.
def help_text(text, hidden): # pragma: no cover
if all_options or not hidden:
return text
else:
return optparse.SUPPRESS_HELP
# Add --dump-setting-names.
def dump_setting_names(*args): # pragma: no cover
for name in self._canonical_names:
sys.stdout.write('%s\n' % name)
sys.exit(0)
add_option_to_group(
None, config_group,
'--dump-setting-names',
action='callback',
nargs=0,
callback=defer_last(maybe(dump_setting_names)),
help=help_text('write out all names of settings and quit', False))
# Add --dump-config.
def call_dump_config(*args): # pragma: no cover
self.dump_config(sys.stdout)
sys.exit(0)
add_option_to_group(
None, config_group,
'--dump-config',
action='callback',
nargs=0,
callback=defer_last(maybe(call_dump_config)),
help='write out the entire current configuration')
# Add --no-default-configs.
def reset_configs(option, opt_str, value, parser):
self.config_files = []
self._required_config_files = []
add_option_to_group(
None, config_group,
'--no-default-configs',
action='callback',
nargs=0,
callback=reset_configs,
help='clear list of configuration files to read')
# Add --config.
def append_to_configs(option, opt_str, value, parser):
self.config_files.append(value)
self._required_config_files.append(value)
add_option_to_group(
None, config_group,
'--config',
action='callback',
nargs=1,
type='string',
callback=append_to_configs,
help='add FILE to config files',
metavar='FILE')
# Add --list-config-files.
def list_config_files(*args): # pragma: no cover
for filename in self.config_files:
print(filename)
sys.exit(0)
add_option_to_group(
None, config_group,
'--list-config-files',
action='callback',
nargs=0,
callback=defer_last(maybe(list_config_files)),
help=help_text('list all possible config files', False))
# Add --generate-manpage.
self._arg_synopsis = arg_synopsis
self._cmd_synopsis = cmd_synopsis
add_option_to_group(
None, p,
'--generate-manpage',
action='callback',
nargs=1,
type='string',
callback=maybe(self._generate_manpage),
help=help_text('fill in manual page TEMPLATE', False),
metavar='TEMPLATE')
# Add --help-all.
def help_all(*args): # pragma: no cover
pp = self.build_parser(
configs_only=configs_only,
arg_synopsis=arg_synopsis,
cmd_synopsis=cmd_synopsis,
all_options=True)
sys.stdout.write(pp.format_help())
sys.exit(0)
add_option_to_group(
None, config_group,
'--help-all',
action='callback',
help='show all options',
callback=defer_last(maybe(help_all)))
# Add other options, from the user-defined and built-in
# settingses.
def set_value(option, opt_str, value, parser, setting):
if setting.action == 'append':
if setting.using_default_value:
setting.value = [value]
else:
setting.value += [value]
elif setting.action == 'store_true':
setting.value = True
else:
assert setting.action == 'store'
setting.value = value
def set_false(option, opt_str, value, parser, setting):
setting.value = False
def add_option(obj, s):
option_names = self._option_names(s.names)
add_option_to_group(
s, obj, *option_names,
action='callback',
callback=maybe(set_value),
callback_args=(s,),
type=s.type,
nargs=s.nargs,
choices=s.choices,
help=help_text(s.help, s.hidden),
metavar=s.metavar)
def add_negation_option(obj, s):
option_names = self._option_names(s.names)
long_names = [x for x in option_names if x.startswith('--')]
neg_names = ['--no-' + x[2:] for x in long_names]
unused_names = [x for x in neg_names
if x[2:] not in self._settingses]
add_option_to_group(
s, obj, *unused_names,
action='callback',
callback=maybe(set_false),
callback_args=(s,),
type=s.type,
help=help_text('opposite of %s' % option_names[0], s.hidden))
# Add options for every setting.
for name in self._canonical_names:
s = self._settingses[name]
if s.group is None:
obj = p
else:
obj = option_groups[s.group]
add_option(obj, s)
if type(s) is BooleanSetting:
add_negation_option(obj, s)
p.set_defaults(**{self._destname(name): s.value})
return p
def parse_args(self, args, parser=None, suppress_errors=False,
configs_only=False, arg_synopsis=None,
cmd_synopsis=None, compute_setting_values=None,
all_options=False):
'''Parse the command line.
Return list of non-option arguments. ``args`` would usually
be ``sys.argv[1:]``.
'''
deferred_last = []
p = parser or self.build_parser(configs_only=configs_only,
arg_synopsis=arg_synopsis,
cmd_synopsis=cmd_synopsis,
deferred_last=deferred_last,
all_options=all_options)
if suppress_errors:
p.error = lambda msg: sys.exit(1)
_, args = p.parse_args(args)
if compute_setting_values: # pragma: no cover
compute_setting_values(self)
for callback in deferred_last: # pragma: no cover
callback()
return args
@property
def default_config_files(self):
'''Return list of default config files to read.
The names of the files are dependent on the name of the program,
as set in the progname attribute.
The files may or may not exist.
'''
configs = []
configs.append('/etc/%s.conf' % self.progname)
configs.append('/etc/%s.yaml' % self.progname)
configs += self.listconfs('/etc/%s' % self.progname)
configs.append(os.path.expanduser('~/.%s.conf' % self.progname))
configs.append(os.path.expanduser('~/.%s.yaml' % self.progname))
configs += self.listconfs(
os.path.expanduser('~/.config/%s' % self.progname))
# See <http://standards.freedesktop.org/basedir-spec/>. We
# support these if the xdg library is available. We always
# support the hardcoded locations so that people's config
# files don't get ignored just because the xdg library gets
# installed.
if xdg_is_available: # pragma: no cover
for dirname in reversed(xdg.BaseDirectory.xdg_config_dirs):
pathname = os.path.join(dirname, self.progname)
for location in self.listconfs(pathname):
if location not in configs:
configs.append(location)
return configs
def listconfs(self, dirname, listdir=os.listdir):
'''Return list of pathnames to config files in dirname.
Config files are expected to have names ending in '.conf' or
'.yaml'.
If dirname does not exist or is not a directory, return empty
list.
'''
if not os.path.isdir(dirname):
return []
basenames = listdir(dirname)
basenames.sort(key=lambda s: [ord(c) for c in s])
return [os.path.join(dirname, x)
for x in basenames
if x.endswith('.conf') or x.endswith('.yaml')]
def _get_config_files(self):
if self._config_files is None:
self._config_files = self.default_config_files
return self._config_files
def _set_config_files(self, config_files):
self._config_files = config_files
config_files = property(_get_config_files, _set_config_files)
def set_from_raw_string(self, pathname, name, raw_string):
'''Set value of a setting from a raw, unparsed string value.'''
if name not in self._settingses:
raise UnknownConfigVariable(pathname, name)
s = self._settingses[name]
s.parse_value(raw_string)
return s
def load_configs(self, open_file=open):
'''Load all config files in self.config_files.
Silently ignore files that do not exist.
'''
self._all_config_data = {}
for pathname in self.config_files:
try:
f = open_file(pathname)
if pathname.endswith('.yaml'):
self._read_yaml(pathname, f)
else:
self._read_ini(pathname, f)
f.close()
except IOError: # pragma: no cover
if pathname in self._required_config_files:
raise
def _read_ini(self, pathname, f):
cp = ConfigParser()
cp.add_section('config')
cp.readfp(f)
for name in cp.options('config'):
value = cp.get('config', name)
s = self.set_from_raw_string(pathname, name, value)
if hasattr(s, 'using_default_value'):
s.using_default_value = True
for section in [s for s in cp.sections() if s != 'config']:
if section not in self._all_config_data:
self._all_config_data[section] = {}
section_data = self._all_config_data[section]
for option in cp.options(section):
section_data[option] = cp.get(section, option)
def _read_yaml(self, pathname, f):
obj = yaml.safe_load(f)
self._check_yaml(pathname, obj)
config = obj.get('config') or {}
for name, value in list(config.items()):
if name not in self._settingses:
raise UnknownConfigVariable(pathname, name)
s = self._settingses[name]
s.set_value(value)
if hasattr(s, 'using_default_value'):
s.using_default_value = True
for section in [s for s in obj if s != 'config']:
if section not in self._all_config_data:
self._all_config_data[section] = {}
section_data = self._all_config_data[section]
for option in obj[section]:
section_data[option] = obj[section][option]
def _check_yaml(self, pathname, obj): # pragma: no cover
if not isinstance(obj, dict):
raise cliapp.MalformedYamlConfig(
'Configuration file %s does not specify a key/value mapping' %
pathname)
if 'config' not in obj:
raise cliapp.MalformedYamlConfig(
'Configuration file %s does not have a "config" key' %
pathname)
def _generate_manpage(self, o, dummy, value, p): # pragma: no cover
template = open(value).read()
generator = ManpageGenerator(template, p, self._arg_synopsis,
self._cmd_synopsis)
sys.stdout.write(generator.format_template())
sys.exit(0)
def as_cp(self):
'''Return a ConfigParser instance with current values of settings.
Any sections outside of ``[config]`` are preserved as is. This
lets the application use those as it wishes, and assign any
meanings it desires to the section names.
'''
cp = ConfigParser()
cp.add_section('config')
for name in self._canonical_names:
cp.set('config', name, self._settingses[name].format())
for section in self._all_config_data:
if section != 'config':
cp.add_section(section)
for option, value in self._all_config_data[section].items():
cp.set(section, option, value)
return cp
def dump_config(self, output): # pragma: no cover
cp = self.as_cp()
cp.write(output)