def get_config(config_file):
if not os.path.exists(config_file):
raise IOError("the configuration file %r does not exist\n" %
config_file)
cfg, cfg_files_read = read_config(config_file)
dget = cfg.dget
config = {}
# reading the global environ first
global_env = dict(os.environ.items())
local_env = dict()
# update environments with [env] section
if 'env' in cfg.sections():
local_env.update(dict(cfg.items('env')))
global_env.update(local_env)
# always set the cfg environment
cfg.set_env(global_env)
# main circus options
config['check_delay'] = dget('circus', 'check_delay', 5., float)
config['endpoint'] = dget('circus', 'endpoint', DEFAULT_ENDPOINT_DEALER)
config['endpoint_owner'] = dget('circus', 'endpoint_owner', None, str)
config['pubsub_endpoint'] = dget('circus', 'pubsub_endpoint',
DEFAULT_ENDPOINT_SUB)
config['multicast_endpoint'] = dget('circus', 'multicast_endpoint',
DEFAULT_ENDPOINT_MULTICAST)
config['stats_endpoint'] = dget('circus', 'stats_endpoint', None)
config['statsd'] = dget('circus', 'statsd', False, bool)
config['umask'] = dget('circus', 'umask', None)
if config['umask']:
config['umask'] = int(config['umask'], 8)
if config['stats_endpoint'] is None:
config['stats_endpoint'] = DEFAULT_ENDPOINT_STATS
elif not config['statsd']:
warnings.warn("You defined a stats_endpoint without "
"setting up statsd to True.",
DeprecationWarning)
config['statsd'] = True
config['warmup_delay'] = dget('circus', 'warmup_delay', 0, int)
config['httpd'] = dget('circus', 'httpd', False, bool)
config['httpd_host'] = dget('circus', 'httpd_host', 'localhost', str)
config['httpd_port'] = dget('circus', 'httpd_port', 8080, int)
config['debug'] = dget('circus', 'debug', False, bool)
config['debug_gc'] = dget('circus', 'debug_gc', False, bool)
config['pidfile'] = dget('circus', 'pidfile')
config['loglevel'] = dget('circus', 'loglevel')
config['logoutput'] = dget('circus', 'logoutput')
config['loggerconfig'] = dget('circus', 'loggerconfig', None)
config['fqdn_prefix'] = dget('circus', 'fqdn_prefix', None, str)
# Initialize watchers, plugins & sockets to manage
watchers = []
plugins = []
sockets = []
for section in cfg.sections():
if section.startswith("socket:"):
sock = dict(cfg.items(section))
sock['name'] = section.split("socket:")[-1].lower()
sock['so_reuseport'] = dget(section, "so_reuseport", False, bool)
sock['replace'] = dget(section, "replace", False, bool)
sockets.append(sock)
if section.startswith("plugin:"):
plugin = dict(cfg.items(section))
plugin['name'] = section
if 'priority' in plugin:
plugin['priority'] = int(plugin['priority'])
plugins.append(plugin)
if section.startswith("watcher:"):
watcher = watcher_defaults()
watcher['name'] = section.split("watcher:", 1)[1]
# create watcher options
for opt, val in cfg.items(section, noreplace=True):
if opt in ('cmd', 'args', 'working_dir', 'uid', 'gid'):
watcher[opt] = val
elif opt == 'numprocesses':
watcher['numprocesses'] = dget(section, 'numprocesses', 1,
int)
elif opt == 'warmup_delay':
watcher['warmup_delay'] = dget(section, 'warmup_delay', 0,
int)
elif opt == 'executable':
watcher['executable'] = dget(section, 'executable', None,
str)
# default bool to False
elif opt in ('shell', 'send_hup', 'stop_children',
'close_child_stderr', 'use_sockets', 'singleton',
'copy_env', 'copy_path', 'close_child_stdout'):
watcher[opt] = dget(section, opt, False, bool)
elif opt == 'stop_signal':
watcher['stop_signal'] = to_signum(val)
elif opt == 'max_retry':
watcher['max_retry'] = dget(section, "max_retry", 5, int)
elif opt == 'graceful_timeout':
watcher['graceful_timeout'] = dget(
section, "graceful_timeout", 30, int)
elif opt.startswith('stderr_stream') or \
opt.startswith('stdout_stream'):
stream_name, stream_opt = opt.split(".", 1)
watcher[stream_name][stream_opt] = val
elif opt.startswith('rlimit_'):
limit = opt[7:]
watcher['rlimits'][limit] = int(val)
elif opt == 'priority':
watcher['priority'] = dget(section, "priority", 0, int)
elif opt.startswith('hooks.'):
hook_name = opt[len('hooks.'):]
val = [elmt.strip() for elmt in val.split(',', 1)]
if len(val) == 1:
val.append(False)
else:
val[1] = to_bool(val[1])
watcher['hooks'][hook_name] = val
# default bool to True
elif opt in ('check_flapping', 'respawn', 'autostart'):
watcher[opt] = dget(section, opt, True, bool)
else:
# freeform
watcher[opt] = val
if watcher['copy_env']:
watcher['env'] = dict(global_env)
else:
watcher['env'] = dict(local_env)
watchers.append(watcher)
# making sure we return consistent lists
sort_by_field(watchers)
sort_by_field(plugins)
sort_by_field(sockets)
# Second pass to make sure env sections apply to all watchers.
def _extend(target, source):
for name, value in source:
if name in target:
continue
target[name] = value
def _expand_vars(target, key, env):
if isinstance(target[key], str):
target[key] = replace_gnu_args(target[key], env=env)
elif isinstance(target[key], dict):
for k in target[key].keys():
_expand_vars(target[key], k, env)
def _expand_section(section, env, exclude=None):
if exclude is None:
exclude = ('name', 'env')
for option in section.keys():
if option in exclude:
continue
_expand_vars(section, option, env)
# build environment for watcher sections
for section in cfg.sections():
if section.startswith('env:'):
section_elements = section.split("env:", 1)[1]
watcher_patterns = [s.strip() for s in section_elements.split(',')]
env_items = dict(cfg.items(section, noreplace=True))
for pattern in watcher_patterns:
match = [w for w in watchers if fnmatch(w['name'], pattern)]
for watcher in match:
watcher['env'].update(env_items)
# expand environment for watcher sections
for watcher in watchers:
env = dict(global_env)
env.update(watcher['env'])
_expand_section(watcher, env)
config['watchers'] = watchers
config['plugins'] = plugins
config['sockets'] = sockets
return config
def get_config(config_file):
if not os.path.exists(config_file):
raise IOError("the configuration file %r does not exist\n" %
config_file)
cfg, cfg_files_read = read_config(config_file)
dget = cfg.dget
config = {}
# reading the global environ first
global_env = dict(os.environ.items())
local_env = dict()
# update environments with [env] section
if 'env' in cfg.sections():
local_env.update(dict(cfg.items('env')))
global_env.update(local_env)
# always set the cfg environment
cfg.set_env(global_env)
# main circus options
config['check_delay'] = dget('circus', 'check_delay', 5., float)
config['endpoint'] = dget('circus', 'endpoint', DEFAULT_ENDPOINT_DEALER)
config['endpoint_owner'] = dget('circus', 'endpoint_owner', None, str)
config['pubsub_endpoint'] = dget('circus', 'pubsub_endpoint',
DEFAULT_ENDPOINT_SUB)
config['multicast_endpoint'] = dget('circus', 'multicast_endpoint',
DEFAULT_ENDPOINT_MULTICAST)
config['stats_endpoint'] = dget('circus', 'stats_endpoint', None)
config['statsd'] = dget('circus', 'statsd', False, bool)
config['umask'] = dget('circus', 'umask', None)
if config['umask']:
config['umask'] = int(config['umask'], 8)
if config['stats_endpoint'] is None:
config['stats_endpoint'] = DEFAULT_ENDPOINT_STATS
elif not config['statsd']:
warnings.warn(
"You defined a stats_endpoint without "
"setting up statsd to True.", DeprecationWarning)
config['statsd'] = True
config['warmup_delay'] = dget('circus', 'warmup_delay', 0, int)
config['httpd'] = dget('circus', 'httpd', False, bool)
config['httpd_host'] = dget('circus', 'httpd_host', 'localhost', str)
config['httpd_port'] = dget('circus', 'httpd_port', 8080, int)
config['debug'] = dget('circus', 'debug', False, bool)
config['debug_gc'] = dget('circus', 'debug_gc', False, bool)
config['pidfile'] = dget('circus', 'pidfile')
config['loglevel'] = dget('circus', 'loglevel')
config['logoutput'] = dget('circus', 'logoutput')
config['loggerconfig'] = dget('circus', 'loggerconfig', None)
config['fqdn_prefix'] = dget('circus', 'fqdn_prefix', None, str)
config['papa_endpoint'] = dget('circus', 'fqdn_prefix', None, str)
# Initialize watchers, plugins & sockets to manage
watchers = []
plugins = []
sockets = []
for section in cfg.sections():
if section.startswith("socket:"):
sock = dict(cfg.items(section))
sock['name'] = section.split("socket:")[-1].lower()
sock['so_reuseport'] = dget(section, "so_reuseport", False, bool)
sock['replace'] = dget(section, "replace", False, bool)
sockets.append(sock)
if section.startswith("plugin:"):
plugin = dict(cfg.items(section))
plugin['name'] = section
if 'priority' in plugin:
plugin['priority'] = int(plugin['priority'])
plugins.append(plugin)
if section.startswith("watcher:"):
watcher = watcher_defaults()
watcher['name'] = section.split("watcher:", 1)[1]
# create watcher options
for opt, val in cfg.items(section, noreplace=True):
if opt in ('cmd', 'args', 'working_dir', 'uid', 'gid'):
watcher[opt] = val
elif opt == 'numprocesses':
watcher['numprocesses'] = dget(section, 'numprocesses', 1,
int)
elif opt == 'warmup_delay':
watcher['warmup_delay'] = dget(section, 'warmup_delay', 0,
int)
elif opt == 'executable':
watcher['executable'] = dget(section, 'executable', None,
str)
# default bool to False
elif opt in ('shell', 'send_hup', 'stop_children',
'close_child_stderr', 'use_sockets', 'singleton',
'copy_env', 'copy_path', 'close_child_stdout'):
watcher[opt] = dget(section, opt, False, bool)
elif opt == 'stop_signal':
watcher['stop_signal'] = to_signum(val)
elif opt == 'max_retry':
watcher['max_retry'] = dget(section, "max_retry", 5, int)
elif opt == 'graceful_timeout':
watcher['graceful_timeout'] = dget(section,
"graceful_timeout", 30,
int)
elif opt.startswith('stderr_stream') or \
opt.startswith('stdout_stream'):
stream_name, stream_opt = opt.split(".", 1)
watcher[stream_name][stream_opt] = val
elif opt.startswith('rlimit_'):
limit = opt[7:]
watcher['rlimits'][limit] = rlimit_value(val)
elif opt == 'priority':
watcher['priority'] = dget(section, "priority", 0, int)
elif opt == 'use_papa' and dget(section, 'use_papa', False,
bool):
if papa:
watcher['use_papa'] = True
else:
warnings.warn(
"Config file says use_papa but the papa "
"module is missing.", ImportWarning)
elif opt.startswith('hooks.'):
hook_name = opt[len('hooks.'):]
val = [elmt.strip() for elmt in val.split(',', 1)]
if len(val) == 1:
val.append(False)
else:
val[1] = to_bool(val[1])
watcher['hooks'][hook_name] = val
# default bool to True
elif opt in ('check_flapping', 'respawn', 'autostart'):
watcher[opt] = dget(section, opt, True, bool)
else:
# freeform
watcher[opt] = val
if watcher['copy_env']:
watcher['env'] = dict(global_env)
else:
watcher['env'] = dict(local_env)
watchers.append(watcher)
# making sure we return consistent lists
sort_by_field(watchers)
sort_by_field(plugins)
sort_by_field(sockets)
# Second pass to make sure env sections apply to all watchers.
def _extend(target, source):
for name, value in source:
if name in target:
continue
target[name] = value
def _expand_vars(target, key, env):
if isinstance(target[key], str):
target[key] = replace_gnu_args(target[key], env=env)
elif isinstance(target[key], dict):
for k in target[key].keys():
_expand_vars(target[key], k, env)
def _expand_section(section, env, exclude=None):
if exclude is None:
exclude = ('name', 'env')
for option in section.keys():
if option in exclude:
continue
_expand_vars(section, option, env)
# build environment for watcher sections
for section in cfg.sections():
if section.startswith('env:'):
section_elements = section.split("env:", 1)[1]
watcher_patterns = [s.strip() for s in section_elements.split(',')]
env_items = dict(cfg.items(section, noreplace=True))
for pattern in watcher_patterns:
match = [w for w in watchers if fnmatch(w['name'], pattern)]
for watcher in match:
watcher['env'].update(env_items)
# expand environment for watcher sections
for watcher in watchers:
env = dict(global_env)
env.update(watcher['env'])
_expand_section(watcher, env)
config['watchers'] = watchers
config['plugins'] = plugins
config['sockets'] = sockets
return config