Skip to main content

Python (Cython) based implementation of ConfigParser based on POSIX and stdlib functions.

Project description

Pipeline status Coverage report https://badge.fury.io/py/configparserc.svg

Python (Cython) based implementation of ConfigParser based on POSIX and stdlib functions. Wrapped via Cython, uses POSIX stat and libc stdio functions for read file.

Support converting values in formats:

  • StrType - force convert to string all values (defaults too).
  • IntType - convert values to integer (include suffixes ‘K’, ‘M’ and ‘G’ multiples of 1000).
  • BytesSizeType - convert values to integer size of bytes (include suffixes ‘K’, ‘M’ and ‘G’ multiples of 1024).
  • BoolType - convert ‘False’, ‘false’, ‘True’ and ‘true’ to valid Python bool type.
  • IntSecondsType - convert time to seconds. Uses ‘pytimeparse’ python package.
  • ListType - convert separated by symbol (default is comma) string to list of values.
  • JsonType - convert json value to python value.

Usage

Install package in your environment:

pip install configparserc

Example code for parse ini-config:

import os
from configparserc import config, tools


class MainSection(config.AppendSection):
    """
    Simple section where:
    *  some_int_key has int value;
    *  some_bool_key has int value;
    *  some_list_key has semicolon separated list value;
    *  some_other_key has int value in bytes.

    and all values appends or override defaults.
    """
    type_some_int_key = config.IntType()
    type_some_bool_key = config.BoolType()
    type_some_list_key = config.ListType(separator=';')
    type_some_other_key = config.ListType(separator=';')


config = config.ConfigParserC(
    # Override section class for section `main`
    section_overload={'main': MainSection},
    # Set deafults for all sections.
    section_defaults={
        'main': {
            'some_int_key': "123",
            'some_bool_key': "false",
            'some_list_key': "a;c;d"
        }
    },
    # Allow to use values from environment
    # via "{ENVIRONMENT_VAR}" values.
    format_kwargs=os.environ.copy()
)

config.parse_files(['/path/to/ini/config', '/other/path/to/ini/config'])
config.parse_text('''
[main]
# Support comments
; in different ini formats.
int_key = 1234
''')

config_as_dict = config.all()

Authors

Author:
Sergey Klyuykov <onegreyonewhite@mail.ru>
Contributor(s):
Kirill Bychkov <kirill970528@yandex.ru>

License

The ConfigParserC Project (https://gitlab.com/onegreyonewhite/configparserc) Copyright (C) 2019-2020 Sergey Klyuykov

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Download files

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

Files for configparserc, version 1.2.9
Filename, size File type Python version Upload date Hashes
Filename, size configparserc-1.2.9.tar.gz (186.9 kB) File type Source Python version None Upload date Hashes View
Filename, size configparserc-1.2.9-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.whl (185.0 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size configparserc-1.2.9-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.whl (184.6 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size configparserc-1.2.9-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl (190.7 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size configparserc-1.2.9-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl (194.6 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size configparserc-1.2.9-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.whl (195.2 kB) File type Wheel Python version cp36 Upload date Hashes View

Supported by

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