Skip to main content

python class configuration tools useful in python projects.

Project description

Description

Python class configuration tools in reflective and distributed concerns.

License Development Status Latest release Supported Python versions Supported Python implementations Download format Build status Code test coverage Downloads Documentation Status Code Health

Installation

pip install b3j0f.conf

Features

This library provides a set of class configuration tools in order to ease development of systems based on configuration resources such as files, DB documents, etc. in a reflexive context.

Configuration process is in 2 steps:

  • inject configuration resources (file, DB documents, etc.) in a Configurable class (with specific drivers which allows the Configurable class to be agnostic from configuration languages such as ini, json, xml, etc.),

  • let the configurable class read properties from such configuration resources and apply values on a dedicated class which may be a associated to a business code. This last process can be automatically or manually thanks to the the apply_reconfiguration method.

Configuration

The sub-module b3j0f.conf.params provides Configuration class in order to inject configuration resources in a Configurable class.

Configuration resources respect two levels of configuration such as the ini configuration model. Both levels are respectively:

  • Category: permits to define a set of parameters unique by name.

  • Parameter: couple of property name and value.

And all categories/options are embedded in a Configuration class.

Configuration and Categories are like dictionaries where key values are inner element names. Therefore, Parameter names are unique per Categories, and Category/Parameter names are unique per Configuration.

Parameter Overriding

In a dynamic and complex way, one Configurable class can be bound to several Categories and Parameters. The choice is predetermined by the class itself. That means that one Configurable class can use several configuration resources and all/some/none Categories/Parameters in those resources. In such a way, the order is important because it permits to keep only last parameter values when parameters have the same name.

This overriding is respected by default with Configurable class inheritance. That means a sub class which adds a resource after its parent class resources indicates than all parameters in the final resources will override parameters in the parent class resources where names are the sames.

Configurable

A Configurable class is provided in the b3j0f.conf.configurable.core module. It permits to get parameters from a configuration resources.

Driver

Drivers are the mean to parse configuration resources, such as files, etc. By default, conf drivers are able to parse json/ini files. Those last use a relative path given by the environment variable B3J0F_CONF_DIR or ~/etc if not given.

Configurable Registry

A Configurable registry is provided in the b3j0f.conf.configurable.registry. It allows to use several Configurable classes once at a time.

Examples

Bind the configuration file ~/etc/myclass.conf to a business class MyClass (the relative path ~/etc can be change thanks to the environment variable B3J0F_CONF_DIR).

Configuration file

The configuration file contains a category named MYCLASS containing the parameter myattr equals myvalue.

[MYCLASS]
myattr=myvalue

With inheritance

from b3j0f.conf.configurable import Configurable
from b3j0f.conf.configurable.decorator import conf_paths, add_category

MYCATEGORY = 'MYCLASS'  # MyClass configuration category
MYCONF = 'myclass.conf'  # MyClass configuration file

# define the configurable business class
@add_category(MYCATEGORY)  # set configuration file category
@conf_paths(MYCONF)  # set conf path
class MyClass(Configurable): pass

# instantiate the business class
myclass = MyClass()

# check if myattr equals 'myvalue'
assert myclass.myattr == 'myvalue'

Without inheritance

from b3j0f.conf.configurable import Configurable

MYCATEGORY = 'MYCLASS'  # MyClass configuration category
MYCONF = 'myclass.conf'  # MyClass configuration file

# instantiate a business class
class MyClass(object): pass
myclass = MyClass()

# apply configuration to the business class
Configurable(
    to_configure=myclass,
    conf_paths=MYCONF,
    unified_category=MYCATEGORY
)

# check if myattr equals 'myvalue'
assert myclass.myattr == 'myvalue'

Perspectives

  • wait feedbacks during 6 months before passing it to a stable version.

  • Cython implementation.

Donation

I'm grateful for gifts, but don't have a specific funding goal.

Project details


Download files

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

Source Distributions

b3j0f.conf-0.1.6.zip (51.7 kB view hashes)

Uploaded Source

b3j0f.conf-0.1.6.tar.gz (22.7 kB view hashes)

Uploaded Source

Built Distribution

b3j0f.conf-0.1.6-py2.py3-none-any.whl (47.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page