Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ajatkj/typed_configparser
A fully typed configparser built on top of configparser
https://github.com/ajatkj/typed_configparser
Last synced: 13 days ago
JSON representation
A fully typed configparser built on top of configparser
- Host: GitHub
- URL: https://github.com/ajatkj/typed_configparser
- Owner: ajatkj
- License: mit
- Created: 2024-01-22T11:33:44.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-09T05:36:42.000Z (8 months ago)
- Last Synced: 2024-09-09T09:59:55.066Z (2 months ago)
- Language: Python
- Size: 65.4 KB
- Stars: 23
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# typed-configparser
typed-configparser is an extension of the standard configparser module with support for typed configurations using dataclasses.
It leverages Python's type hints and dataclasses to provide a convenient way of parsing and validating configuration files.
## Features
✓ Fully typed.
✓ Use dataclasses to parse the configuration file.
✓ Support for almost all python built-in data types - `int`, `float`, `str`, `list`, `tuple`, `dict` and complex data types using `Union` and `Optional`.
✓ Supports almost all features of dataclasses including field level init flag, **post_init** method, InitVars and more.
✓ Built on top of `configparser`, hence retains all functionalities of `configparser`.
✓ Support for optional values (optional values are automatically set to `None` if not provided).
✓ Smarter defaults (see below).
## Installation
You can install `typed_configparser` using `pip`:
```sh
pip install typed-configparser
```
## Usage
`examples/basic.py`
```py3
# This is a complete example and should work as is
from typing import List
from typed_configparser import ConfigParser
from dataclasses import dataclass
@dataclass
class BASIC:
option1: int
option2: str
option3: float
option4: List[str]
config = """
[BASIC]
option1 = 10
option2 = value2
option3 = 5.2
option4 = [foo,bar]
"""
parser = ConfigParser()
parser.read_string(config)
section = parser.parse_section(using_dataclass=BASIC)
print(section)
```
```py3
BASIC(option1=10, option2=value2, option3=5.2, option4=['foo', 'bar'])
```
`examples/unions_and_optionals.py`
```py3
# This is a complete example and should work as is
from typing import List, Union, Optional, Dict, Tuple
from typed_configparser import ConfigParser
from dataclasses import dataclass, field
@dataclass
class DEFAULT_EXAMPLE:
option1: int
option2: Union[List[Tuple[str, str]], List[int]]
option3: Dict[str, str] = field(default_factory=lambda: {"default_key": "default_value"})
option4: Optional[float] = None
config = """
[DEFAULT]
option1 = 20
option2 = default_value2
[MY_SECTION_1]
option2 = [10,20]
option4 = 5.2
[MY_SECTION_2]
option2 = [(value2a, value2b), (value2c, value2b), (value2c, value2d)]
option3 = {key: value}
option4 = none
"""
parser = ConfigParser()
parser.read_string(config)
my_section_1 = parser.parse_section(using_dataclass=DEFAULT_EXAMPLE, section_name="MY_SECTION_1")
my_section_2 = parser.parse_section(using_dataclass=DEFAULT_EXAMPLE, section_name="MY_SECTION_2")
print(my_section_1)
print(my_section_2)
```
```py3
DEFAULT_EXAMPLE(option1=20, option2=[10, 20], option3={'default_key': 'default_value'}, option4=5.2)
DEFAULT_EXAMPLE(option1=20, option2=[('value2a', 'value2b'), ('value2c', 'value2b'), ('value2c', 'value2d')], option3={'key': 'value'}, option4=None)
```
Check `example` directory for more examples.
## Defaults
- `configparser` includes sensible defaults options which allows you to declare a `[DEFAULT]` section in the config file for fallback values.
- `typed_configparser` goes a step further and allows you to set a final (last) level of defaults at dataclass level.
# License
[MIT License](./LICENSE)
# Contribution
If you are interested in contributing to typed_configparser, please take a look at the [contributing guidelines](./CONTRIBUTING.md).