skip to navigation
skip to content

pkgsettings 0.12.0

Python package to ease the configuration of packages

Package Documentation

Goal

The goal of this package is to offer an easy, generic and extendable way of configuring a package.

Installation

$ pip install pkgsettings

Usage

from pkgsettings import Settings

# Create the settings object for your package to use
settings = Settings()

# Now let's define the default settings
settings.configure(hello='World', debug=False)

By calling the configure you actually inject a layer of settings. When requesting a setting it will go through all layers until it finds the requested key.

Now if someone starts using your package it can easily modify the active settings of your package by calling the configure again.

from my_awesome_package.conf import settings

# Lets change the configuration here
settings.configure(debug=True)

Now from within your package you can work with the settings like so:

from conf import settings

print(settings.debug) # This will print: True
print(settings.hello) # This will print: World

It is also possible to pass an object instead of kwargs. The settings object will call getattr(ur_object, key) An example below:

class MySettings(object):
    def __init__(self):
        self.debug = True

settings = Settings()
settings.configure(MySettings())
print(settings.debug) # This will print: True

More advanced usage

The settings object can also be used as context manager:

with settings(debug=True):
    print(settings.debug) # This will print: True

print(settings.debug) # This will print: False

Additionally you can also use this as a decorator:

@settings(debug=True)
def go()
    print(settings.debug) # This will print: True

go()

print(settings.debug) # This will print: False

Prefixed Settings

If a group of settings share a common prefix, you can make use of the PrefixedSettings class and pass the desired prefix as an argument, together with the main settings instance. All attributes will be automatically prefixed when accessed.

from pkgsettings import PrefixedSettings, Settings

# First create the settings object for your package to use
settings = Settings()

# Suppose some of your settings are all prefixed with 'FOO'
settings.configure(FOO_a='a', FOO_b='b', c='c', debug=False)

# Create a PrefixedSettings instance with the desired prefix
foo_settings = PrefixedSettings(settings, 'FOO_')

foo_settings.a # This will print: a
foo_settings.b # This will print: b

foo_settings.c # This will raise an AttributeError
 
File Type Py Version Uploaded on Size
pkgsettings-0.12.0.tar.gz (md5) Source 2017-08-15 12KB