Skip to main content

A supercharged dict used as configuration

Project description

Documentation

https://configdict.readthedocs.io

Installation

$ pip install configdict

CheckedDict

A dictionary based on a default prototype. A CheckedDict can only define key:value pairs which are already present in the default. It is possible to define a docstring for each key and different restrictions for the values regarding possible values, ranges and type. A CheckedDict is useful for configuration settings.

ConfigDict

Based on CheckedDict, a ConfigDict is a persistent, unique dictionary. It is saved under the config folder determined by the OS and it is updated with each modification. It is useful for implementing configuration of a module / library / app, where there is a default/initial state and the user needs to be able to configure global settings which must be persisted between sessions (similar to the settings in an application)

Example

config = ConfigDict("myproj.subproj")
config.addKey("keyA", 10, doc="documentaion of keyA")
config.addKey("keyB", 0.5, range=(0, 1))
config.addKey("keyC", "blue", choices=("blue", "red"),
              doc="documentation of keyC")
config.load()

Alternatively, a ConfigDict can be created all at once:

config = ConfigDict("myapp",
    default = {
        'font-size': 10.0,
        'font-family': "Monospace",
        'port' : 9100,
    },
    validator = {
        'font-size::range' : (8, 24),
        'port::range' : (9000, 65000),
        'font-family::choices' : {'Roboto', 'Monospace'},
    },
    docs = {
        'port': 'The port number to listen to',
        'font-size': 'The size of the font, in pixels'
    }
)

This will create the dictionary and load any persisted version. Any saved modifications will override the default values. Whenever the user changes any value (via config[key] = newvalue) the dictionary will be saved.

In all other respects a ConfigDict behaves like a normal dictionary.

Project details


Download files

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

Source Distribution

configdict-2.12.0.tar.gz (36.6 kB view details)

Uploaded Source

Built Distribution

configdict-2.12.0-py3-none-any.whl (33.4 kB view details)

Uploaded Python 3

File details

Details for the file configdict-2.12.0.tar.gz.

File metadata

  • Download URL: configdict-2.12.0.tar.gz
  • Upload date:
  • Size: 36.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.8

File hashes

Hashes for configdict-2.12.0.tar.gz
Algorithm Hash digest
SHA256 1425bc7b539a1a23b115bdec6aa458919ff32077caea765e677dd28970856c73
MD5 7cdd51d0591bcc4e97179de86f97dabf
BLAKE2b-256 dad51ac9d5a5af548461dc877d7bc3068afba2ce025dc57e6f8a53fae2c9525a

See more details on using hashes here.

File details

Details for the file configdict-2.12.0-py3-none-any.whl.

File metadata

File hashes

Hashes for configdict-2.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 976df3001a3cbe0d10029771352c7533bacef32079eaa0bee7a31a94472aff44
MD5 15deacf2dca776182ba6f8e073f9efe8
BLAKE2b-256 2e135feed7c3b088d5c8749cba47318abef2a893aa8ec93b6d8d256195ab4760

See more details on using hashes here.

Supported by

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