Skip to main content

Updated configparser from stdlib for earlier Pythons.

Project description

https://img.shields.io/pypi/v/configparser.svg https://img.shields.io/pypi/pyversions/configparser.svg tests Code style: Black https://readthedocs.org/projects/configparser/badge/?version=latest https://img.shields.io/badge/skeleton-2022-informational https://tidelift.com/badges/package/pypi/configparser

This package is a backport of the refreshed and enhanced ConfigParser from later Python versions. To use the backport instead of the built-in version, simply import it explicitly as a backport:

from backports import configparser

To use the backport on Python 2 and the built-in version on Python 3, use the standard invocation:

import configparser

For detailed documentation consult the vanilla version at http://docs.python.org/3/library/configparser.html.

Why you’ll love configparser

Whereas almost completely compatible with its older brother, configparser sports a bunch of interesting new features:

  • full mapping protocol access (more info):

    >>> parser = ConfigParser()
    >>> parser.read_string("""
    [DEFAULT]
    location = upper left
    visible = yes
    editable = no
    color = blue
    
    [main]
    title = Main Menu
    color = green
    
    [options]
    title = Options
    """)
    >>> parser['main']['color']
    'green'
    >>> parser['main']['editable']
    'no'
    >>> section = parser['options']
    >>> section['title']
    'Options'
    >>> section['title'] = 'Options (editable: %(editable)s)'
    >>> section['title']
    'Options (editable: no)'
  • there’s now one default ConfigParser class, which basically is the old SafeConfigParser with a bunch of tweaks which make it more predictable for users. Don’t need interpolation? Simply use ConfigParser(interpolation=None), no need to use a distinct RawConfigParser anymore.

  • the parser is highly customizable upon instantiation supporting things like changing option delimiters, comment characters, the name of the DEFAULT section, the interpolation syntax, etc.

  • you can easily create your own interpolation syntax but there are two powerful implementations built-in (more info):

    • the classic %(string-like)s syntax (called BasicInterpolation)

    • a new ${buildout:like} syntax (called ExtendedInterpolation)

  • fallback values may be specified in getters (more info):

    >>> config.get('closet', 'monster',
    ...            fallback='No such things as monsters')
    'No such things as monsters'
  • ConfigParser objects can now read data directly from strings and from dictionaries. That means importing configuration from JSON or specifying default values for the whole configuration (multiple sections) is now a single line of code. Same goes for copying data from another ConfigParser instance, thanks to its mapping protocol support.

  • many smaller tweaks, updates and fixes

A few words about Unicode

configparser comes from Python 3 and as such it works well with Unicode. The library is generally cleaned up in terms of internal data storage and reading/writing files. There are a couple of incompatibilities with the old ConfigParser due to that. However, the work required to migrate is well worth it as it shows the issues that would likely come up during migration of your project to Python 3.

The design assumes that Unicode strings are used whenever possible [1]. That gives you the certainty that what’s stored in a configuration object is text. Once your configuration is read, the rest of your application doesn’t have to deal with encoding issues. All you have is text [2]. The only two phases when you should explicitly state encoding is when you either read from an external source (e.g. a file) or write back.

Versioning

This project uses semver to communicate the impact of various releases while periodically syncing with the upstream implementation in CPython. The history serves as a reference indicating which versions incorporate which upstream functionality.

Prior to the 4.0.0 release, another scheme was used to associate the CPython and backports releases.

Maintenance

This backport was originally authored by Łukasz Langa, the current vanilla configparser maintainer for CPython and is currently maintained by Jason R. Coombs:

For Enterprise

Available as part of the Tidelift Subscription.

This project and the maintainers of thousands of other packages are working with Tidelift to deliver one enterprise subscription that covers all of the open source you use.

Learn more.

Security Contact

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Conversion Process

This section is technical and should bother you only if you are wondering how this backport is produced. If the implementation details of this backport are not important for you, feel free to ignore the following content.

The project takes the following branching approach:

  • The 3.x branch holds unchanged files synchronized from the upstream CPython repository. The synchronization is currently done by manually copying the required files and stating from which CPython changeset they come.

  • The main branch holds a version of the 3.x code with some tweaks that make it compatible with older Pythons. Code on this branch must work on all supported Python versions. Test with tox or in CI.

The process works like this:

  1. In the 3.x branch, run pip-run -- sync-upstream.py, which downloads the latest stable release of Python and copies the relevant files from there into their new locations and then commits those changes with a nice reference to the relevant upstream commit hash.

  2. Check for new names in __all__ and update imports in configparser.py accordingly. Commit.

  3. Merge the new commit to main. Run tests. Commit.

  4. Make any compatibility changes on main. Run tests. Commit.

  5. Update the docs and release the new version.

Footnotes

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

configparser-5.3.0.tar.gz (67.7 kB view details)

Uploaded Source

Built Distribution

configparser-5.3.0-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

Details for the file configparser-5.3.0.tar.gz.

File metadata

  • Download URL: configparser-5.3.0.tar.gz
  • Upload date:
  • Size: 67.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0rc1

File hashes

Hashes for configparser-5.3.0.tar.gz
Algorithm Hash digest
SHA256 8be267824b541c09b08db124917f48ab525a6c3e837011f3130781a224c57090
MD5 5bfe86017e5f06efc87cc13c498d9206
BLAKE2b-256 4bc03a47084aca7a940ed1334f89ed2e67bcb42168c4f40c486e267fe71e7aa0

See more details on using hashes here.

File details

Details for the file configparser-5.3.0-py3-none-any.whl.

File metadata

  • Download URL: configparser-5.3.0-py3-none-any.whl
  • Upload date:
  • Size: 19.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0rc1

File hashes

Hashes for configparser-5.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b065779fd93c6bf4cee42202fa4351b4bb842e96a3fb469440e484517a49b9fa
MD5 245313ffc6ecf9543a1f0f984585debb
BLAKE2b-256 e07a9d0f52bf4923b2e410c7d6fda472c32d9b728284e89ec99074820226102f

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