def test_dict_with_all_keys_prefixed_with_at_symbol_is_treated_as_item_meta():
config = Config({
'enabled': {
'@default': False,
},
'db': {
'user': '******',
'name': {
'@help': 'Name of the database'
},
'@help': 'db configuration', # This should be ignored for now
},
})
paths = set(path for path, _ in config.iter_items(recursive=True, key='str_path'))
assert 'enabled' in paths
assert 'enabled.@default' not in paths
assert 'db' not in paths
assert 'db.@help' not in paths
assert 'db.user' in paths
assert 'db.name' in paths
assert 'db.name.@help' not in paths
assert config.enabled.default is False
assert config.db.name.help == 'Name of the database'
# Make sure it still behaves like a bool
config.enabled.value = 'yes'
assert config.enabled.value is True
# Name is excluded because it has no value
assert config.db.dump_values() == {'user': '******'}
config.db.name.value = 'testdb'
assert config.db.dump_values() == {'user': '******', 'name': 'testdb'}
def test_json_reads_and_writes_preserve_order(tmpdir):
config = Config(collections.OrderedDict([
('a', 'aaa'),
('b', 'bbb'),
('c', 'ccc'),
('x', 'xxx'),
('y', 'yyy'),
('z', 'zzz'),
('m', 'mmm'),
('n', 'nnn'),
]))
config_json = tmpdir.join('config.json').strpath
config.json.dump(config_json, with_defaults=True)
config2 = Config()
config2.json.load(config_json, as_defaults=True)
item_names = list(item.name for _, item in config2.iter_items())
assert item_names == ['a', 'b', 'c', 'x', 'y', 'z', 'm', 'n']
def test_nested_config():
"""
This demonstrates how an application config can be created from multiple
sections (which in turn can be created from others).
"""
# Declaration of a config section may be a plain dictionary
db_config = {
'host': 'localhost',
'user': '******',
'password': '******',
}
# Or, it may be an already functional instance of Config
server_config = Config({
'port': 8080,
})
#
# All these sections can be combined into one config:
#
config = Config({
'db': db_config,
'server': server_config,
'greeting':
'Hello', # and you can have plain config items next to sections
})
# You can load values
assert config.greeting.value == 'Hello'
# Your original schemas are safe -- db_config dictionary won't be changed
config.db.user.value = 'root'
assert config.db.user.value == 'root'
assert db_config['user'] == 'admin'
# You can also change values by reading them from a dictionary.
# Unknown names will be ignored unless you pass as_defaults=True
# but in that case you will overwrite any previously existing items.
config.load_values({
'greeting': 'Good morning!',
'comments': {
'enabled': False
}
})
assert config.greeting.value == 'Good morning!'
assert 'comments' not in config
# You can check if config value is the default value
assert not config.db.user.is_default
assert config.server.port.is_default
# Or if it has any value at all
assert config.server.port.has_value
# Iterate over all items (recursively)
all = dict(config.iter_items(recursive=True))
assert all[('db', 'host')] is config.db.host
assert all[('server', 'port')] is config.server.port
# Export all values
config_dict = config.dump_values()
assert config_dict['db'] == {
'host': 'localhost',
'user': '******',
'password': '******'
}
# Each section is a Config instance too, so you can export those separately too:
assert config.server.dump_values() == config_dict['server']
# You can reset individual items to their default values
assert config.db.user.value == 'root'
config.db.user.reset()
assert config.db.user.value == 'admin'
# Or sections
config.db.user.value = 'root_again'
assert config.db.user.value == 'root_again'
config.db.reset()
assert config.db.user.value == 'admin'
# Or you can reset all configuration and you can make sure all values match defaults
assert not config.is_default
config.reset()
assert config.is_default
def test_simple_config():
# Initialisation of a config manager
config = Config({
'greeting': 'Hello, world!',
'threads': 1,
'throttling_enabled': False,
})
# Attribute-based and key-based access to config items
assert config.greeting is config['greeting']
# Every config item is an instance of Item
assert isinstance(config.greeting, Item)
# Value and other attribute access on Item
assert config.greeting.value == 'Hello, world!'
assert config.threads.value == 1
assert config.threads.type == Types.int
assert config.throttling_enabled.value is False
assert config.throttling_enabled.type == Types.bool
# If you are working with items which don't have default values, you can use .get() method
# which accepts fallback value:
assert config.greeting.get() == 'Hello, world!'
assert config.greeting.get('Hey!') == 'Hello, world!'
# Can check if a config item is managed by the manager
assert 'greeting' in config
assert 'warning' not in config
# Can change values
config.greeting.value = 'Good evening!'
assert config.greeting.value == 'Good evening!'
# Can inspect default value
assert config.greeting.default == 'Hello, world!'
# Can export all values to a dictionary
assert config.dump_values() == {
'greeting': 'Good evening!',
'threads': 1,
'throttling_enabled': False,
}
# Can iterate over all items
items = dict(config.iter_items(recursive=True))
assert len(items) == 3
assert items[('greeting', )] is config.greeting
assert items[('threads', )] is config.threads
assert items[('throttling_enabled', )] is config.throttling_enabled
# Requesting unknown config raises NotFound
with pytest.raises(NotFound):
assert not config.other_things
# Cannot change item value incorrectly
with pytest.raises(TypeError):
config.greeting = 'Bye!'
with pytest.raises(TypeError):
config['greeting'] = 'Bye!'
