Skip to main content

python toml configuration library

Project description

version-badge coverage-badge

conficus is a python toml configuration wrapper. providing some extra type coercions (e.g. str -> Path) easier access and section inheritance.

conficus python 3.6+.

Installation

Install conficus with pip.

pip install conficus

Quick Start

Basic usage

>>>
>>> import conficus
>>>

Configurations can be loaded directly from a string variable or read via file path string or Path object:

>>> config = conficus.load('/Users/mgemmill/config.ini', toml=True)
>>>

conficus will also read a path from an environment variable:

>>> config = conficus.load('ENV_VAR_CONFIG_PATH')
>>>

Easier Selection

Accessing nested sections is made easier with chained selectors:

>>> # regular dictionary access:
...
>>> config['app']['debug']
True
>>>
>>> # chained selector access:
...
>>> config['app.debug']
True

Inheritance

Inheritance pushes parent values down to any child section:

# config.ini

[app]
debug = true

[email]
_inherit = 0
host = "smtp.mailhub.com"
port = 2525
sender = "emailerdude@mailhub.com"

[email.alert]
to = ["alert-handler@service.com"]
subject = "THIS IS AN ALERT"
body = "Alerting!"

It is turned on via the inheritance option:

>>> config = conficus.load("config.ini", inheritance=True)

Sub-sections will now contain parent values:

>>> alert_config = config["email.alert"]
>>> alert_config["host"]
>>> "smtp.mailhub.com"
>>> alert_config["subject"]
>>> "THIS IS AN ALERT"

Inheritence can be controled per section via the _inherit option. _inherit = 0 will block the section from inheriting parent values. _inherit = 1 would only allow inheritance from the sections immediate parent; _inherit = 2 would allow both the immediate parent and grandparent inheritance.

_inherit values are stripped from the resulting configuration dictionary.

Additional Conversion Options

In addition to toml’s standard type conversions, conficus has two builtin conversion options and also allows for adding custom conversions.

Conversions only work with string values.

Path Conversions

The pathlib option will convert any toml string value that looks like a path to a python pathlib.Path object:

>>> config = conficus.load("path = '/home/user/.dir'", pathlib=True)
>>> isinstance(config["path"], Path)
>>> True

Decimal Conversions

The decimal option will convert any toml string value that matches \d+\.\d+ to a python Decimal object:

>>> config = conficus.load("number = '12.22'", decimal=True)
>>> isinstance(config["number"], Decimal)
>>> True

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

conficus-0.6.4.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

conficus-0.6.4-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file conficus-0.6.4.tar.gz.

File metadata

  • Download URL: conficus-0.6.4.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.6 Darwin/22.5.0

File hashes

Hashes for conficus-0.6.4.tar.gz
Algorithm Hash digest
SHA256 18f05361412bf54342f8b305162838c048b3b5375102cf1cb932199cba08e8fa
MD5 9a24166ae2aebdc0ffea87a6a967938e
BLAKE2b-256 46c54679be9a21d425aef3c0cc8dc0340e100c8c5dbf6497faffec5492aad442

See more details on using hashes here.

File details

Details for the file conficus-0.6.4-py3-none-any.whl.

File metadata

  • Download URL: conficus-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.6 Darwin/22.5.0

File hashes

Hashes for conficus-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d226447b6ba18b6ee3d1412889f140db85a4daec927bfb44d1940d2de687b810
MD5 2e0f68c211bef4906e32bae65bb537d2
BLAKE2b-256 4800f30097cfd1a78e76fcfa392e35148eb573a96bb278fdf8c2d7ad081d2a71

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