Skip to main content

This project helps you to import config file writen by YAML to Python data class.

Project description

YAML Data Class Config

Test Test Coverage Maintainability Code Climate technical debt Updates PyPI - Python Version PyPI - Downloads Twitter URL

This project helps you to import config file writen by YAML to Python Data Classes.

Advantage

  1. Type safe import from YAML to Data Classes
  2. Global access and easy unit testing

1. Type safe import from YAML to Data classes

When using pyyaml to import YAML, values be dict and list objects. Using dict or list object will cause such confuses:

  • Reference non exist properties for unexpected instance type
  • Typo of index or key name

To prevent these confuse, one of good way is to use object as model, and python has a good module Data Classes for this purpose.

2. Global access and easy unit testing

You will want to refer config as global because it's troublesome to pass config value as argument over and over like a bucket brigade.

However, when unit testing, if YAML file was loaded automatically on importing global definition, you will face problem that you can't replace config YAML file with the one for unit testing. YAML Data Class Config can divide timings between definition global instance and loading YAML file so you can replace YAML file for unit testing.

Quickstart

1. Install

pip install yamldataclassconfig

2. Prepare config YAML file

Put config.yml YAML Data class Config loads config.yml on Python execution directory by default.

property_a: 1
property_b: '2'
part_config:
  property_c: '2019-06-25 13:33:30'

3. Create config class

Anywhere is OK, for example, I prefer to place on myproduct/config.py

from dataclasses import dataclass, field
from datetime import datetime
from dataclasses_json import DataClassJsonMixin
from marshmallow import fields
from yamldataclassconfig.config import YamlDataClassConfig


@dataclass
class PartConfig(DataClassJsonMixin):
    property_c: datetime = field(metadata={'dataclasses_json': {
        'encoder': datetime.isoformat,
        'decoder': datetime.fromisoformat,
        'mm_field': fields.DateTime(format='iso')
    }})


@dataclass
class Config(YamlDataClassConfig):
    property_a: int = None
    property_b: str = None
    part_config: PartConfig = field(
        default=None,
        metadata={'dataclasses_json': {'mm_field': PartConfig}}
    )

4. Define as global

Also, anywhere is OK, for example, I prefer to place on myproduct/__init__.py

from myproduct.config import Config

CONFIG: Config = Config()

5. Call load before reference config value

from myproduct import CONFIG


def main():
    CONFIG.load()
    print(CONFIG.property_a)
    print(CONFIG.property_b)
    print(CONFIG.part_config.property_c)


if __name__ == '__main__':
    main()

How do I...

Fix path to yaml file independent on the Python execution directory?

override FILE_PATH property.

Ex:

from dataclasses import dataclass
from pathlib import Path

from yamldataclassconfig import create_file_path_field
from yamldataclassconfig.config import YamlDataClassConfig


@dataclass
class Config(YamlDataClassConfig):
    some_property: str = None
    # ...

    FILE_PATH: Path = create_file_path_field(Path(__file__).parent.parent / 'config.yml')

Switch target YAML config file to the one for unit testing?

When setup on unit testing, you can call Config.load() with argument.

Case when unittest:

from pathlib import Path
import unittest

from yourproduct import CONFIG

class ConfigurableTestCase(unittest.TestCase):
    def setUp(self):
        CONFIG.load(Path('path/to/yaml'))

Case when pytest:

from pathlib import Path
import pytest

from yourproduct import CONFIG

@pytest.fixture
def yaml_config():
    CONFIG.load(Path('path/to/yaml'))
    yield

def test_something(yaml_config):
    """test something"""

Use path to YAML config file as same as production when test?

fixturefilehandler can replace config.yml with tests/config.yml.dist easily. Please call all DeployerFactory.create with YamlConfigFilePathBuilder instance argument to create ConfigDeployer. Then, set target directory which config.yml should be placed into path_target_directory.

Case when unittest:

from pathlib import Path
import unittest
from fixturefilehandler.factories import DeployerFactory
from fixturefilehandler.file_paths import YamlConfigFilePathBuilder

from yourproduct import CONFIG


ConfigDeployer = DeployerFactory.create(YamlConfigFilePathBuilder(path_target_directory=Path(__file__).parent.parent))


class ConfigurableTestCase(unittest.TestCase):
    def setUp(self):
        ConfigDeployer.setup()
        CONFIG.load()

    def doCleanups(self):
        ConfigDeployer.teardown()

Case when pytest:

from pathlib import Path
import pytest
from fixturefilehandler.factories import DeployerFactory
from fixturefilehandler.file_paths import YamlConfigFilePathBuilder

from yourproduct import CONFIG


ConfigDeployer = DeployerFactory.create(YamlConfigFilePathBuilder(path_target_directory=Path(__file__).parent.parent))


@pytest.fixture
def yaml_config():
    ConfigDeployer.setup()
    CONFIG.load()
    yield
    ConfigDeployer.teardown()


def test_something(yaml_config):
    """test something"""

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 yamldataclassconfig, version 1.5.0
Filename, size File type Python version Upload date Hashes
Filename, size yamldataclassconfig-1.5.0.tar.gz (12.9 kB) File type Source Python version None Upload date Hashes View
Filename, size yamldataclassconfig-1.5.0-py3-none-any.whl (12.9 kB) File type Wheel Python version py3 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