Skip to main content

A simplified interface to ConfigParser using dot notion with data type / comment support.

Project description


A simplified interface to ConfigParser using dot notion with data type / comment support.

Feature Summary

  • Simple access to config using dot notion and iterators
  • Full compatibility with ConfigParser ini formats (as that is used as the backend)
  • Data type support by intelligently guessing the data types based on value on read.
  • Multiple config source input (read from string, file pointer, file, or list of them)
  • Full comment support / retention on save
  • Lazy reading of config sources for performance (only read when a config value is accessed)

Quick Start Tutorial

To install:

pip install localconfig

Let’s say we have a script named program with the following config in ~/.config/program:

[Web Server]
# Server host
host =

# Server port
port = 8080

# Debug logging
debug = off

To read the config, simply do:

from localconfig import config

start_server(, config.web_server.port, config.web_server.debug)

# Or use get method:
# start_server(config.get('Web Server', 'host'),
#              config.get('Web Server', 'port'),
#              config.get('web_server', 'debug'))  # Yes, 'web_server' also works here!
# Or if the config is in docstring, read from it:
# Or if the config file is elsewhere:
#'/etc/path/to/config.ini')  # Non-existing file is ignored
# Or read from a list of sources
#['string config', file_path, file_pointer, io.StringIO('config')])
# Or create another instance for another config:
# from localconfig import LocalConfig
# config2 = LocalConfig('/etc/path/to/another/config.ini')

Configs are read in the order they are called using, but the config file passed to the LocalConfig() constructor (defaults to ~/.config/$script_name) will be read last before the first access to config values, which allows us to read configs from various locations, like default configs from a string that is checked in with the code, while allowing them to be overrriden from the config file that is passed to the constructor.

Now, let’s do some inspection:

# Iterate over sections and their keys/values
for section in config:
  print(section)                   # Web Server

  for key, value in config.items(section):
    print(key, value, type(value)) # host <type 'str'>
                                   # port 8080 <type 'int'>
                                   # debug False <type 'bool'>

sections = list(config)            # ['Web Server']

# Iterate over keys/values
for key, value in config.web_server:
  print(key, value, type(value))    # Same output as above config.items()

items = list(config.web_server)    # [('host', ''), ('port', 8080), ('debug', False)]
items = dict(config.web_server)    # {'host': '', 'port': 8080, 'debug': False}

# Check if a section or key is set - any non-existing section or key defaults to None.
if config.web_server or config.no_such_section:

if config.web_server and (config.web_server.port or config.web_server.no_such_key):

To add a section and set a value:

config.add_section('App Server', comment='Settings for application server') = 'localhost'

# Use `set` if you want to set a comment
config.set('App Server', 'port', 9090, comment='App server port')

# Set value for the DEFAULT section (default value for all other sections)
config.env = 'prod'

To write the config:

# Or simply get the config as a string:
# config_str = str(config)
# Or save to a different location:

If we open ~/.config/program now, we would see:


env = prod

[Web Server]

# Server host
host =

# Server port
port = 8080

# Debug logging
debug = off

# Settings for application server
[App Server]

host = localhost

# App server port
port = 9090

Supported Data Types

Data type is guessed based on the value and converted on read.

The following types are supported:

Type Example Value
int 1
float 2.0
bool true false yes no on off (case insensitive)
None none (case insensitive)
str Any other value not matched by above

Project details

Download files

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

Files for localconfig, version 1.1.3
Filename, size File type Python version Upload date Hashes
Filename, size localconfig-1.1.3-py3-none-any.whl (7.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size localconfig-1.1.3.tar.gz (17.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page