Easy access to `~/.config`
Project description
XDGConfig
Easy access to ~/.config.
Usage
from xdgconfig import JsonConfig
# Instanciate the JsonConfig object
# If you'd rather use a different format, there also are config classes
# for TOML, YAML, INI (configparser), and XML.
# This will save your configuration under `~/.config/PROG/config
config = JsonConfig('PROG', autosave=True)
config['foo'] = 'bar' # Save a value to the config
# Access the value later on
print(config['foo'])
# It behaves like a collections.defaultdict as well
config['oof']['bar'] = 'baz'
# Prints {'oof': {'bar': 'baz'}, 'foo': 'bar'}
print(config)
Custom serializers
You can add custom serializers support by using a Mixin class, as well as
a serializer class which must have a dumps and a loads method, which will
be used to store and load data from the config file. The data is always
represented as a python dict object, but you can serialize any data you want
inside of it.
Look at the following example for an implementation guide.
from typing import Any, Dict
from xdgconfig import Config
class MySerializer:
def dumps(data: Dict[str, Any]) -> str:
return '\n'.join(f'{k}:{v}' for k, v in data.items())
def loads(contents: str) -> Dict[str, Any]:
return dict(s.split(':') for s in contents.split('\n'))
class MySerializerMixin:
SERIALIZER = MySerializer
class MyConfig(MySerializerMixin, Config):
...
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
xdgconfig-0.0.4.tar.gz
(8.8 kB
view hashes)
Built Distribution
xdgconfig-0.0.4-py3-none-any.whl
(13.9 kB
view hashes)
Close
Hashes for xdgconfig-0.0.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9035709bde44be57cee3ab0c5fc4f8ecd107794618e11c5d96d98c5bb3432088 |
|
| MD5 | bff733f90c0dd061edcb48847c92bec8 |
|
| BLAKE2b-256 | 92d05d4f69a67ac15d37233a82095f29da7c02c01e06eee6793a945583c1dc6a |
