tweak: Application configuration engine¶
Python helper class to ingest and serialize app-specific configuration
Provides a self-contained (no dependencies outside the standard library), Python 2 and 3 compatible configuration manager. Automatically saves and restores your application’s configuration in your user home directory. Uses JSON or (optionally) YAML for serialization. Supports dict-like methods and access semantics.
Installation¶
If your package does not permit dependency management, you can copy the Config
class directly into your
application from https://github.com/kislyuk/tweak/blob/master/tweak/__init__.py. Otherwise:
pip install tweak
Synopsis¶
from tweak import Config
config = Config()
config.host, config.port = "example.com", 9000
config.nested_config = {}
config.nested_config.foo = True
After restarting your application:
config = Config()
print(config)
>>> {'host': 'example.com', 'port': 9000, 'nested_config': {'foo': True}}
Using an argparse.Namespace
object returned by argparse.parse_args()
:
parser = argparse.ArgumentParser()
...
args = parser.parse_args()
if args.foo is not None:
config.foo = args.foo
elif "foo" not in config:
raise Exception("foo unconfigured")
config.update(vars(args))
Using YAML:
config = Config(use_yaml=True)
...
Pass Config(save_on_exit=False)
to disable automatic configuration saving on Python shutdown (this is useful if you
only want to read the config, never write it, or if you want to call config.save()
manually). Pass
Config(autosave=True)
to make save()
run any time an assignment happens to a config object.
Authors¶
- Andrey Kislyuk