class AiocastConfig(Config):
"""Aiocast configuration"""
default_device = ConfigProperty(
default='',
comment='The default device to use if no device is provided.')
cast_server_port = ConfigProperty(
default=5416, comment='Port for the cast server to use')
def __init__(self):
super().__init__(root_name='aiocast')
class Renderer(Nestable):
retries = ConfigProperty(
default=20,
config_type=int,
comment='Number of times it will try to reconnect '
'when the websocket connection is lost.')
ping = ConfigProperty(
default=False,
config_type=bool,
comment='Enable to send a ping every interval to keep the '
'websocket connected if it didn\'t send data after '
'a delay. Some hosts providers will automatically closes'
'idling connection after a while.')
ping_interval = ConfigProperty(
default=25.0,
config_type=float,
comment='Interval at which to send ping data.')
class Authentication(Nestable):
enable = ConfigProperty(
default=False,
config_type=bool,
)
authenticator = ConfigProperty(
config_type=str,
comment='Path to an instance or subclass of '
'`dazzler.system.auth.Authenticator',
default='')
backend = ConfigProperty(
config_type=str,
comment='Path to an instance or subclass of '
'`dazzler.system.auth.AuthBackend',
default='',
)
class Development(Nestable):
reload = ConfigProperty(
default=False,
config_type=bool,
auto_global=True,
global_name='reload',
comment='Enable hot reload when files used by the application'
' are changed.')
reload_interval = ConfigProperty(
default=0.5,
config_type=float,
comment='Interval at which the reload checks for file changes.')
reload_threshold = ConfigProperty(
default=3.0,
config_type=float,
comment='Time to wait from first detected change '
'to actual reload.')
class ConfigNested(Nestable):
"""docstring_comment"""
nested_str = ConfigProperty(default='nested', comment='nested_comment')
class DoubleNested(Nestable):
"""doubly"""
double = ConfigProperty(default=2.2,
comment='double_comment_nested')
double_nested: DoubleNested = None
class ConfigTest(Config):
"""root_comment"""
config_str = ConfigProperty(comment='comment_string',
config_type=str,
auto_environ=True)
config_str_with_default = ConfigProperty(
default='Default foo bar',
auto_environ=True,
)
config_int = ConfigProperty(default=10, auto_environ=True)
config_float = ConfigProperty(
default=89.99,
comment='comment_float',
auto_environ=True,
)
config_list = ConfigProperty(
default=[1, 2, 3],
auto_environ=True,
)
config_auto_global = ConfigProperty(default=333,
auto_global=True,
comment='comment_auto_global')
class ConfigNested(Nestable):
"""docstring_comment"""
nested_str = ConfigProperty(default='nested', comment='nested_comment')
class DoubleNested(Nestable):
"""doubly"""
double = ConfigProperty(default=2.2,
comment='double_comment_nested')
double_nested: DoubleNested = None
config_nested: ConfigNested = None
class Requirements(Nestable):
prefer_external = ConfigProperty(
default=False,
config_type=bool,
comment='Prefer serving external requirements when available')
external_scripts = ConfigProperty(
default=[],
config_type=list,
comment='List of urls to include as script requirement.',
)
internal_scripts = ConfigProperty(
default=[],
config_type=list,
comment='List of files to include as script requirement.',
)
external_styles = ConfigProperty(
default=[],
config_type=list,
comment='List of urls to include as style requirement.')
internal_styles = ConfigProperty(
default=[],
config_type=list,
comment='List of files to include as script requirement.',
)
class Session(Nestable):
enable = ConfigProperty(config_type=bool, default=True)
backend = ConfigProperty(
comment='Type of session backend to use. Choices: File, Redis',
default='File',
config_type=str,
)
salt = ConfigProperty(config_type=str,
comment='Salt for signing sessions ids.')
cookie_name = ConfigProperty(config_type=str,
comment='Name of the session cookie.',
default='sessionid')
duration = ConfigProperty(
config_type=int,
comment='Maximum duration of a session in seconds. '
'(Default=30 days)',
default=2592000,
)
refresh_after = ConfigProperty(
config_type=int,
comment='Refresh the session when accessed '
'after this number of seconds. (Default=7 days)',
default=604800)
class DazzlerConfig(Config):
"""Dazzler configuration"""
app_title = ConfigProperty(default='Dazzler',
comment='Name of the title of the index.')
host = ConfigProperty(
default='127.0.0.1',
comment='Host address',
auto_global=True,
)
port = ConfigProperty(
default=8150,
comment='Port of the server',
auto_global=True,
)
debug = ConfigProperty(
default=False,
config_type=bool,
auto_global=True,
)
route_prefix = ConfigProperty(
default='',
comment='Route prefix for all dazzler related endpoints.',
)
static_folder = ConfigProperty(
default='static',
comment='Path relative to project folder where files will be served.',
)
static_prefix = ConfigProperty(default='/static',
comment='Prefix for the static route')
secret_key = ConfigProperty(
default='Please change me',
comment='Secret key to use for signing sessions.',
config_type=str,
)
class Session(Nestable):
enable = ConfigProperty(config_type=bool, default=True)
backend = ConfigProperty(
comment='Type of session backend to use. Choices: File, Redis',
default='File',
config_type=str,
)
salt = ConfigProperty(config_type=str,
comment='Salt for signing sessions ids.')
cookie_name = ConfigProperty(config_type=str,
comment='Name of the session cookie.',
default='sessionid')
duration = ConfigProperty(
config_type=int,
comment='Maximum duration of a session in seconds. '
'(Default=30 days)',
default=2592000,
)
refresh_after = ConfigProperty(
config_type=int,
comment='Refresh the session when accessed '
'after this number of seconds. (Default=7 days)',
default=604800)
session: Session
class Requirements(Nestable):
prefer_external = ConfigProperty(
default=False,
config_type=bool,
comment='Prefer serving external requirements when available')
external_scripts = ConfigProperty(
default=[],
config_type=list,
comment='List of urls to include as script requirement.',
)
internal_scripts = ConfigProperty(
default=[],
config_type=list,
comment='List of files to include as script requirement.',
)
external_styles = ConfigProperty(
default=[],
config_type=list,
comment='List of urls to include as style requirement.')
internal_styles = ConfigProperty(
default=[],
config_type=list,
comment='List of files to include as script requirement.',
)
requirements: Requirements
class Renderer(Nestable):
retries = ConfigProperty(
default=20,
config_type=int,
comment='Number of times it will try to reconnect '
'when the websocket connection is lost.')
ping = ConfigProperty(
default=False,
config_type=bool,
comment='Enable to send a ping every interval to keep the '
'websocket connected if it didn\'t send data after '
'a delay. Some hosts providers will automatically closes'
'idling connection after a while.')
ping_interval = ConfigProperty(
default=25.0,
config_type=float,
comment='Interval at which to send ping data.')
renderer: Renderer
class Authentication(Nestable):
enable = ConfigProperty(
default=False,
config_type=bool,
)
authenticator = ConfigProperty(
config_type=str,
comment='Path to an instance or subclass of '
'`dazzler.system.auth.Authenticator',
default='')
backend = ConfigProperty(
config_type=str,
comment='Path to an instance or subclass of '
'`dazzler.system.auth.AuthBackend',
default='',
)
authentication: Authentication
class Development(Nestable):
reload = ConfigProperty(
default=False,
config_type=bool,
auto_global=True,
global_name='reload',
comment='Enable hot reload when files used by the application'
' are changed.')
reload_interval = ConfigProperty(
default=0.5,
config_type=float,
comment='Interval at which the reload checks for file changes.')
reload_threshold = ConfigProperty(
default=3.0,
config_type=float,
comment='Time to wait from first detected change '
'to actual reload.')
development: Development
def __init__(self):
super().__init__(root_name='dazzler', config_format=ConfigFormat.TOML)
class DoubleNested(Nestable):
"""doubly"""
double = ConfigProperty(default=2.2,
comment='double_comment_nested')
class Conf(Config):
nest_list = ConfigProperty(config_type=list)
class Conf(Config):
boolean_cfg = ConfigProperty(config_type=bool,
default=True,
comment='less than 40')
class Conf(Config):
config_str_no_default_or_comment = ConfigProperty(config_type=str)