def __init__(
self,
definition_source=None,
values_source_list=None,
argv_source=None,
#use_config_files=True,
use_auto_help=True,
use_admin_controls=True,
quit_after_admin=True,
options_banned_from_help=None,
app_name='',
app_version='',
app_description='',
config_pathname='.',
config_optional=True,
):
"""create and initialize a configman object.
parameters:
definition_source - a namespace or list of namespaces from which
configman is to fetch the definitions of the
configuration parameters.
values_source_list - (optional) a hierarchical list of sources for
values for the configuration parameters.
As values are copied from these sources,
conficting values are resolved with sources
on the right getting preference over sources on
the left.
argv_source - if the values_source_list contains a commandline
source, this value is an alternative source for
actual command line arguments. Useful for testing or
preprocessing command line arguments.
use_auto_help - set to True if configman is to automatically set up
help output for command line invocations.
use_admin_controls - configman can add command line flags that it
interprets independently of the app defined
arguments. True enables this capability, while,
False supresses it.
quit_after_admin - if True and admin controls are enabled and used,
call sys.exit to end the app. This is useful to
stop the app from running if all that was done
was to write a config file or stop after help.
options_banned_from_help - a list of strings that will censor the
output of help to prevent specified
options from being listed in the help
output. This is useful for hiding debug
or secret command line arguments.
app_name - assigns a name to the app. This is used in help output
and as a default basename for config files.
app_version - assigns a version for the app used help output.
app_description - assigns a description for the app to be used in
the help output.
config_pathname - a hard coded path to the directory of or the full
path and name of the configuration file.
config_optional - a boolean indicating if a missing default config
file is optional. Note: this is only for the
default config file. If a config file is specified
on the commandline, it _must_ exsist."""
# instead of allowing mutables as default keyword argument values...
if definition_source is None:
definition_source_list = []
elif (isinstance(definition_source, collections.Sequence)
and not isinstance(definition_source, basestring)):
definition_source_list = list(definition_source)
else:
definition_source_list = [definition_source]
if argv_source is None:
self.argv_source = sys.argv[1:]
self.app_invocation_name = sys.argv[0]
else:
self.argv_source = argv_source
self.app_invocation_name = app_name
if options_banned_from_help is None:
options_banned_from_help = ['application']
self.config_pathname = config_pathname
self.config_optional = config_optional
self.app_name = app_name
self.app_version = app_version
self.app_description = app_description
self.args = [] # extra commandline arguments that are not switches
# will be stored here.
self._config = None # eventual container for DOM-like config object
self.option_definitions = Namespace()
self.definition_source_list = definition_source_list
if values_source_list is None:
# nothing set, assume defaults
if use_admin_controls:
values_source_list = (cm.ConfigFileFutureProxy, cm.environment,
cm.command_line)
else:
values_source_list = (cm.environment, cm.command_line)
admin_tasks_done = False
self.admin_controls_list = [
'help', 'admin.conf', 'admin.dump_conf', 'admin.print_conf',
'admin.migration', 'admin.strict'
]
self.options_banned_from_help = options_banned_from_help
if use_auto_help:
self._setup_auto_help()
if use_admin_controls:
admin_options = self._setup_admin_options(values_source_list)
self.definition_source_list.append(admin_options)
# iterate through the option definitions to create the nested dict
# hierarchy of all the options called 'option_definitions'
for a_definition_source in self.definition_source_list:
try:
safe_copy_of_def_source = a_definition_source.safe_copy()
except AttributeError:
# apparently, the definition source was not in the form of a
# Namespace object. This isn't a show stopper, but we don't
# know how to make a copy of this object safely: we know from
# experience that the stock copy.copy method leads to grief
# as many sub-objects within an option definition source can
# not be copied that way (classes, for example).
# The only action we can take is to trust and continue with the
# original copy of the definition source.
safe_copy_of_def_source = a_definition_source
def_sources.setup_definitions(safe_copy_of_def_source,
self.option_definitions)
if use_admin_controls:
# the name of the config file needs to be loaded from the command
# line prior to processing the rest of the command line options.
config_filename = \
value_sources.config_filename_from_commandline(self)
if (config_filename
and cm.ConfigFileFutureProxy in values_source_list):
self.option_definitions.admin.conf.default = config_filename
self.values_source_list = value_sources.wrap(values_source_list, self)
known_keys = self._overlay_expand()
self._check_for_mismatches(known_keys)
# the app_name, app_version and app_description are to come from
# if 'application' option if it is present. If it is not present,
# get the app_name,et al, from parameters passed into the constructor.
# if those are empty, set app_name, et al, to empty strings
try:
app_option = self._get_option('application')
self.app_name = getattr(app_option.value, 'app_name', '')
self.app_version = getattr(app_option.value, 'app_version', '')
self.app_description = getattr(app_option.value, 'app_description',
'')
except exc.NotAnOptionError:
# there is no 'application' option, continue to use the
# 'app_name' from the parameters passed in, if they exist.
pass
if use_auto_help and self._get_option('help').value:
self.output_summary()
admin_tasks_done = True
if use_admin_controls and self._get_option('admin.print_conf').value:
self.print_conf()
admin_tasks_done = True
if use_admin_controls and self._get_option('admin.dump_conf').value:
self.dump_conf()
admin_tasks_done = True
if quit_after_admin and admin_tasks_done:
sys.exit()
def __init__(
self,
definition_source=None,
values_source_list=None,
argv_source=None,
# use_config_files=True,
use_auto_help=True,
use_admin_controls=True,
quit_after_admin=True,
options_banned_from_help=None,
app_name="",
app_version="",
app_description="",
config_pathname=".",
):
"""create and initialize a configman object.
parameters:
definition_source - a namespace or list of namespaces from which
configman is to fetch the definitions of the
configuration parameters.
values_source_list - (optional) a hierarchical list of sources for
values for the configuration parameters.
As values are copied from these sources,
conficting values are resolved with sources
on the right getting preference over sources on
the left.
argv_source - if the values_source_list contains a commandline
source, this value is an alternative source for
actual command line arguments. Useful for testing or
preprocessing command line arguments.
use_auto_help - set to True if configman is to automatically set up
help output for command line invocations.
use_admin_controls - configman can add command line flags that it
interprets independently of the app defined
arguments. True enables this capability, while,
False supresses it.
quit_after_admin - if True and admin controls are enabled and used,
call sys.exit to end the app. This is useful to
stop the app from running if all that was done
was to write a config file or stop after help.
options_banned_from_help - a list of strings that will censor the
output of help to prevent specified
options from being listed in the help
output. This is useful for hiding debug
or secret command line arguments.
app_name - assigns a name to the app. This is used in help output
and as a default basename for config files.
app_version - assigns a version for the app used help output.
app_description - assigns a description for the app to be used in
the help output.
config_pathname - a hard coded path to the directory of or the full
path and name of the configuration file."""
# instead of allowing mutables as default keyword argument values...
if definition_source is None:
definition_source_list = []
elif isinstance(definition_source, collections.Sequence) and not isinstance(definition_source, basestring):
definition_source_list = list(definition_source)
else:
definition_source_list = [definition_source]
if argv_source is None:
argv_source = sys.argv[1:]
if options_banned_from_help is None:
options_banned_from_help = ["admin.application"]
self.config_pathname = config_pathname
self.app_name = app_name
self.app_version = app_version
self.app_description = app_description
self.args = [] # extra commandline arguments that are not switches
# will be stored here.
self._config = None # eventual container for DOM-like config object
self.argv_source = argv_source
self.option_definitions = Namespace()
self.definition_source_list = definition_source_list
if values_source_list is None:
# nothing set, assume defaults
if use_admin_controls:
values_source_list = (cm.ConfigFileFutureProxy, cm.environment, cm.command_line)
else:
values_source_list = (cm.environment, cm.command_line)
admin_tasks_done = False
self.admin_controls_list = ["help", "admin.conf", "admin.dump_conf", "admin.print_conf", "admin.application"]
self.options_banned_from_help = options_banned_from_help
if use_auto_help:
self._setup_auto_help()
if use_admin_controls:
admin_options = self._setup_admin_options(values_source_list)
self.definition_source_list.append(admin_options)
# iterate through the option definitions to create the nested dict
# hierarchy of all the options called 'option_definitions'
for a_definition_source in self.definition_source_list:
def_sources.setup_definitions(a_definition_source, self.option_definitions)
if use_admin_controls:
# some admin options need to be loaded from the command line
# prior to processing the rest of the command line options.
admin_options = value_sources.get_admin_options_from_command_line(self)
# integrate the admin_options with 'option_definitions'
self._overlay_value_sources_recurse(source=admin_options, ignore_mismatches=True)
self.values_source_list = value_sources.wrap(values_source_list, self)
# first pass to get classes & config path - ignore bad options
self._overlay_value_sources(ignore_mismatches=True)
# walk tree expanding class options
self._walk_expanding_class_options()
# the app_name, app_version and app_description are to come from
# if 'admin.application' option if it is present. If it is not present,
# get the app_name,et al, from parameters passed into the constructor.
# if those are empty, set app_name, et al, to empty strings
try:
app_option = self._get_option("admin.application")
self.app_name = getattr(app_option.value, "app_name", "")
self.app_version = getattr(app_option.value, "app_version", "")
self.app_description = getattr(app_option.value, "app_description", "")
except exc.NotAnOptionError:
# there is no 'admin.application' option, continue to use the
# 'app_name' from the parameters passed in, if they exist.
pass
# second pass to include config file values - ignore bad options
self._overlay_value_sources(ignore_mismatches=True)
# walk tree expanding class options
self._walk_expanding_class_options()
# third pass to get values - complain about bad options
self._overlay_value_sources(ignore_mismatches=False)
if use_auto_help and self._get_option("help").value:
self.output_summary()
admin_tasks_done = True
if use_admin_controls and self._get_option("admin.print_conf").value:
self.print_conf()
admin_tasks_done = True
if use_admin_controls and self._get_option("admin.dump_conf").value:
self.dump_conf()
admin_tasks_done = True
if quit_after_admin and admin_tasks_done:
sys.exit()
def __init__(self,
definition_source=None,
values_source_list=None,
argv_source=None,
#use_config_files=True,
use_auto_help=True,
use_admin_controls=True,
quit_after_admin=True,
options_banned_from_help=None,
app_name='',
app_version='',
app_description='',
config_pathname='.',
config_optional=True,
):
"""create and initialize a configman object.
parameters:
definition_source - a namespace or list of namespaces from which
configman is to fetch the definitions of the
configuration parameters.
values_source_list - (optional) a hierarchical list of sources for
values for the configuration parameters.
As values are copied from these sources,
conficting values are resolved with sources
on the right getting preference over sources on
the left.
argv_source - if the values_source_list contains a commandline
source, this value is an alternative source for
actual command line arguments. Useful for testing or
preprocessing command line arguments.
use_auto_help - set to True if configman is to automatically set up
help output for command line invocations.
use_admin_controls - configman can add command line flags that it
interprets independently of the app defined
arguments. True enables this capability, while,
False supresses it.
quit_after_admin - if True and admin controls are enabled and used,
call sys.exit to end the app. This is useful to
stop the app from running if all that was done
was to write a config file or stop after help.
options_banned_from_help - a list of strings that will censor the
output of help to prevent specified
options from being listed in the help
output. This is useful for hiding debug
or secret command line arguments.
app_name - assigns a name to the app. This is used in help output
and as a default basename for config files.
app_version - assigns a version for the app used help output.
app_description - assigns a description for the app to be used in
the help output.
config_pathname - a hard coded path to the directory of or the full
path and name of the configuration file.
config_optional - a boolean indicating if a missing default config
file is optional. Note: this is only for the
default config file. If a config file is specified
on the commandline, it _must_ exsist."""
# instead of allowing mutables as default keyword argument values...
if definition_source is None:
definition_source_list = []
elif (isinstance(definition_source, collections.Sequence) and
not isinstance(definition_source, basestring)):
definition_source_list = list(definition_source)
else:
definition_source_list = [definition_source]
if argv_source is None:
self.argv_source = sys.argv[1:]
self.app_invocation_name = sys.argv[0]
else:
self.argv_source = argv_source
self.app_invocation_name = app_name
if options_banned_from_help is None:
options_banned_from_help = ['application']
self.config_pathname = config_pathname
self.config_optional = config_optional
self.app_name = app_name
self.app_version = app_version
self.app_description = app_description
self.args = [] # extra commandline arguments that are not switches
# will be stored here.
self._config = None # eventual container for DOM-like config object
self.option_definitions = Namespace()
self.definition_source_list = definition_source_list
if values_source_list is None:
# nothing set, assume defaults
if use_admin_controls:
values_source_list = (cm.ConfigFileFutureProxy,
cm.environment,
cm.command_line)
else:
values_source_list = (cm.environment,
cm.command_line)
admin_tasks_done = False
self.admin_controls_list = ['help',
'admin.conf',
'admin.dump_conf',
'admin.print_conf',
'admin.migration',
'admin.strict'
]
self.options_banned_from_help = options_banned_from_help
if use_auto_help:
self._setup_auto_help()
if use_admin_controls:
admin_options = self._setup_admin_options(values_source_list)
self.definition_source_list.append(admin_options)
# iterate through the option definitions to create the nested dict
# hierarchy of all the options called 'option_definitions'
for a_definition_source in self.definition_source_list:
try:
safe_copy_of_def_source = a_definition_source.safe_copy()
except AttributeError:
# apparently, the definition source was not in the form of a
# Namespace object. This isn't a show stopper, but we don't
# know how to make a copy of this object safely: we know from
# experience that the stock copy.copy method leads to grief
# as many sub-objects within an option definition source can
# not be copied that way (classes, for example).
# The only action we can take is to trust and continue with the
# original copy of the definition source.
safe_copy_of_def_source = a_definition_source
def_sources.setup_definitions(safe_copy_of_def_source,
self.option_definitions)
if use_admin_controls:
# the name of the config file needs to be loaded from the command
# line prior to processing the rest of the command line options.
config_filename = \
value_sources.config_filename_from_commandline(self)
if (
config_filename
and cm.ConfigFileFutureProxy in values_source_list
):
self.option_definitions.admin.conf.default = config_filename
self.values_source_list = value_sources.wrap(
values_source_list,
self
)
known_keys = self._overlay_expand()
self._check_for_mismatches(known_keys)
# the app_name, app_version and app_description are to come from
# if 'application' option if it is present. If it is not present,
# get the app_name,et al, from parameters passed into the constructor.
# if those are empty, set app_name, et al, to empty strings
try:
app_option = self._get_option('application')
self.app_name = getattr(app_option.value, 'app_name', '')
self.app_version = getattr(app_option.value, 'app_version', '')
self.app_description = getattr(app_option.value,
'app_description', '')
except exc.NotAnOptionError:
# there is no 'application' option, continue to use the
# 'app_name' from the parameters passed in, if they exist.
pass
if use_auto_help and self._get_option('help').value:
self.output_summary()
admin_tasks_done = True
if use_admin_controls and self._get_option('admin.print_conf').value:
self.print_conf()
admin_tasks_done = True
if use_admin_controls and self._get_option('admin.dump_conf').value:
self.dump_conf()
admin_tasks_done = True
if quit_after_admin and admin_tasks_done:
sys.exit()
def __init__(
self,
definition_source=None,
values_source_list=None,
argv_source=None,
#use_config_files=True,
use_auto_help=True,
use_admin_controls=True,
quit_after_admin=True,
options_banned_from_help=None,
app_name='',
app_version='',
app_description='',
config_pathname='.',
):
"""create and initialize a configman object.
parameters:
definition_source - a namespace or list of namespaces from which
configman is to fetch the definitions of the
configuration parameters.
values_source_list - (optional) a hierarchical list of sources for
values for the configuration parameters.
As values are copied from these sources,
conficting values are resolved with sources
on the right getting preference over sources on
the left.
argv_source - if the values_source_list contains a commandline
source, this value is an alternative source for
actual command line arguments. Useful for testing or
preprocessing command line arguments.
use_auto_help - set to True if configman is to automatically set up
help output for command line invocations.
use_admin_controls - configman can add command line flags that it
interprets independently of the app defined
arguments. True enables this capability, while,
False supresses it.
quit_after_admin - if True and admin controls are enabled and used,
call sys.exit to end the app. This is useful to
stop the app from running if all that was done
was to write a config file or stop after help.
options_banned_from_help - a list of strings that will censor the
output of help to prevent specified
options from being listed in the help
output. This is useful for hiding debug
or secret command line arguments.
app_name - assigns a name to the app. This is used in help output
and as a default basename for config files.
app_version - assigns a version for the app used help output.
app_description - assigns a description for the app to be used in
the help output.
config_pathname - a hard coded path to the directory of or the full
path and name of the configuration file."""
# instead of allowing mutables as default keyword argument values...
if definition_source is None:
definition_source_list = []
elif (isinstance(definition_source, collections.Sequence)
and not isinstance(definition_source, basestring)):
definition_source_list = list(definition_source)
else:
definition_source_list = [definition_source]
if argv_source is None:
argv_source = sys.argv[1:]
if options_banned_from_help is None:
options_banned_from_help = ['admin.application']
self.config_pathname = config_pathname
self.app_name = app_name
self.app_version = app_version
self.app_description = app_description
self.args = [] # extra commandline arguments that are not switches
# will be stored here.
self._config = None # eventual container for DOM-like config object
self.argv_source = argv_source
self.option_definitions = Namespace()
self.definition_source_list = definition_source_list
if values_source_list is None:
# nothing set, assume defaults
if use_admin_controls:
values_source_list = (cm.ConfigFileFutureProxy, cm.environment,
cm.command_line)
else:
values_source_list = (cm.environment, cm.command_line)
admin_tasks_done = False
self.admin_controls_list = [
'help', 'admin.conf', 'admin.dump_conf', 'admin.print_conf',
'admin.application'
]
self.options_banned_from_help = options_banned_from_help
if use_auto_help:
self._setup_auto_help()
if use_admin_controls:
admin_options = self._setup_admin_options(values_source_list)
self.definition_source_list.append(admin_options)
# iterate through the option definitions to create the nested dict
# hierarchy of all the options called 'option_definitions'
for a_definition_source in self.definition_source_list:
def_sources.setup_definitions(a_definition_source,
self.option_definitions)
if use_admin_controls:
# some admin options need to be loaded from the command line
# prior to processing the rest of the command line options.
admin_options = value_sources.get_admin_options_from_command_line(
self)
# integrate the admin_options with 'option_definitions'
self._overlay_value_sources_recurse(source=admin_options,
ignore_mismatches=True)
self.values_source_list = value_sources.wrap(values_source_list, self)
# first pass to get classes & config path - ignore bad options
self._overlay_value_sources(ignore_mismatches=True)
# walk tree expanding class options
self._walk_expanding_class_options()
# the app_name, app_version and app_description are to come from
# if 'admin.application' option if it is present. If it is not present,
# get the app_name,et al, from parameters passed into the constructor.
# if those are empty, set app_name, et al, to empty strings
try:
app_option = self._get_option('admin.application')
self.app_name = getattr(app_option.value, 'app_name', '')
self.app_version = getattr(app_option.value, 'app_version', '')
self.app_description = getattr(app_option.value, 'app_description',
'')
except exc.NotAnOptionError:
# there is no 'admin.application' option, continue to use the
# 'app_name' from the parameters passed in, if they exist.
pass
# second pass to include config file values - ignore bad options
self._overlay_value_sources(ignore_mismatches=True)
# walk tree expanding class options
self._walk_expanding_class_options()
# third pass to get values - complain about bad options
self._overlay_value_sources(ignore_mismatches=False)
if use_auto_help and self._get_option('help').value:
self.output_summary()
admin_tasks_done = True
if (use_admin_controls and self._get_option('admin.print_conf').value):
self.print_conf()
admin_tasks_done = True
if (use_admin_controls and self._get_option('admin.dump_conf').value):
self.dump_conf()
admin_tasks_done = True
if quit_after_admin and admin_tasks_done:
sys.exit()
