Skip to main content

InfoScout GarlicConfig

Project description

CircleCI codecov


GarlicConfig is a framework that makes it easy to write complex configurations with ability to validate them easily.

You can define models by inheriting from ConfigModel:

from garlicconfig import models

class DatabaseConfig(models.ConfigModel):

For properties, you can use ConfigField. There are a set of built-in fields:

  • StringField
  • IntegerField
  • ArrayField
  • ModelField
  • BooleanField

You can also make your own custom ConfigModel and/or ConfigField.

for example:

from garlicconfig import fields
from garlicconfig.exceptions import ValidationError

class EvenIntegerField(IntegerField):

    def validate(self, value):
        if value % 2 != 0:
            raise ValidationError('bad integer')

    def to_model_value(self, value):
        return int(value)

    def to_dict_value(self, value):
        return str(value)

The field class above stores str in the python dictionary representation. However, for the materialized config model, integer is used. It also invalidates unaccepted values, in this case odd values.

for example:

class SomeRandomConfig(ConfigModel):

	value = EvenIntegerField(nullable=False, default=2)

You can use get_dict method on config models to get a python dictionary with basic value types in it. This is handy to cache it in memory, or to use it for serialization.

load_dict will create a new config model from a python dictionary.


You can use the following code to encode/decode configs. The default encoder is Json. However, you can write your own encoder and support other formats as needed.

from garlicconfig import encoder

config = DatabaseConfig()
serialized_string = encoder.encode(config, pretty=True)

# You must provide the config class.
config = encoder.decode(serialized_string, DatabaseConfig)

Merging layers

You merge two configuration layers in order to support inheritance. Python dict will get merged but other values will be overridden.

for example:

from garlicconfig.utils import merge

config_dict1 = {
    'name': 'Peyman',
    'numbers': [1, 2, 3]
    'extra': {
        'has_id': True

config_dict2 = {
    'name': 'Patrick',
    'numbers': [4, 5, 6]
    'extra': {
        'has_degree': True

# this will create a copy of base including config_dict2's data
merge(base=config_dict1, config=config_dict2)

# that will give you the following object.
    'name': 'Patrick',
    'numbers': [4, 5, 6],
    'extra': {
        'has_degree': True,
        'has_id': True

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
garlicconfig-1.0.6-py3-none-any.whl (10.3 kB) Copy SHA256 hash SHA256 Wheel py3 Sep 14, 2018
garlicconfig-1.0.6.tar.gz (8.8 kB) Copy SHA256 hash SHA256 Source None Sep 14, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page