Spruce-settings is a Python library for application settings.
Some applications require certain settings to exist before they are launched. Some applications require the ability to save certain settings so that they persist after termination. It is desirable to access both persistent and runtime settings via a uniform interface. This package provides objects that satisfy these requirements.
Settings may be stored in a variety of ways. Windows uses a system registry. OS X uses XML preferences files. Many Unix applications use INI-style configuration (conf) files. It is desirable to store some settings in a database. For now, this module implements only the conf file method, but it provides enough abstraction to allow for other methods to be implemented as needed.
import spruce.settings as _settings settings = _settings.Settings(organization='myorg', application='myapp') with settings.open(), settings.ingroup('db'): dbserver = settings.value('server', required=True) dbport = settings.intvalue('port') db_entity_tables = settings.listvalue('entity_tables')
import spruce.settings as _settings settings = _settings.Settings(organization='myorg', application='myapp') with settings.open(): with settings.ingroup('dbconn'): dbserver = settings.value('server', required=True) dbport = settings.intvalue('port') with settings.ingroup('dbtables'): db_entity_tables = settings.listvalue('entity_tables')
from collections import namedtuple as _namedtuple import spruce.settings as _settings class User(_namedtuple('User', ('name', 'password'))): @classmethod def from_settings(cls, settings, group=None, name_key='name', password_key='password'): with settings.ingroup(group): name = settings.value(name_key, required=True) password = settings.value(password_key, required=True) return cls(name=name, password=password) settings = _settings.Settings(organization='myorg', application='myapp') with settings.open(): user = User.from_settings(settings, 'user')
Settings may be specified for the entire system or per user. This scope is called the base scope.
Settings are specific to organizations, applications, or subsystems, which are collectively called component scopes. Subsystems are grouped by the applications to which they belong. Applications are grouped by the organizations that produce them.
Each setting is a (key, value) pair. A key is a non-empty string that identifies the setting uniquely per application. A value is any string (or any object that can be represented as a string).
Keys are case-sensitive.
Keys can be grouped; for example, Book/Color and Book/PageCount are both part of the Book group, and some storage formats (such as conf) may reflect this by writing Color and PageCount entries together in a Book section.
Groups can be nested.
The primary location is the unique location determined by the combination of format, base scope, organization, application, and subsystem specified when creating a Settings object.
When settings are written, they are always written to the primary location.
When a setting is queried, the primary location is searched first. If it is not found there, the fallback mechanism is triggered. First, greater component scopes are searched. If the setting is not found there and the base scope is user, then the original component scope is searched in the system base scope, followed by the greater component scopes in system.
Settings formats specify where and how settings are stored. Each format defines the file path at which settings are stored for a given scope and how to read and write settings in those 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|
|Spruce_settings-0.2.2-py2.7.egg (19.2 kB) Copy SHA256 hash SHA256||Egg||2.7||Jan 24, 2014|
|Spruce_settings-0.2.2-py27-none-any.whl (25.1 kB) Copy SHA256 hash SHA256||Wheel||2.7||Jan 24, 2014|
|Spruce-settings-0.2.2.tar.gz (33.3 kB) Copy SHA256 hash SHA256||Source||None||Jan 24, 2014|