diff options
Diffstat (limited to 'python-yamldataclassconfig.spec')
| -rw-r--r-- | python-yamldataclassconfig.spec | 809 |
1 files changed, 809 insertions, 0 deletions
diff --git a/python-yamldataclassconfig.spec b/python-yamldataclassconfig.spec new file mode 100644 index 0000000..a87a453 --- /dev/null +++ b/python-yamldataclassconfig.spec @@ -0,0 +1,809 @@ +%global _empty_manifest_terminate_build 0 +Name: python-yamldataclassconfig +Version: 1.5.0 +Release: 1 +Summary: This project helps you to import config file writen by YAML to Python data class. +License: MIT License +URL: https://github.com/yukihiko-shinoda/yaml-dataclass-config +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/1f/18/1d111bfca52fdfba9f83bb01e2c914a3859dd985fb19110f8f5c0e997a72/yamldataclassconfig-1.5.0.tar.gz +BuildArch: noarch + +Requires: python3-dataclasses-json +Requires: python3-pyyaml + +%description +# YAML Data Class Config + +[](https://github.com/yukihiko-shinoda/yaml-dataclass-config/actions?query=workflow%3ATest) +[](https://codeclimate.com/github/yukihiko-shinoda/yaml-dataclass-config/test_coverage) +[](https://codeclimate.com/github/yukihiko-shinoda/yaml-dataclass-config/maintainability) +[](https://codeclimate.com/github/yukihiko-shinoda/yaml-dataclass-config) +[](https://pyup.io/repos/github/yukihiko-shinoda/yaml-dataclass-config/) +[](https://pypi.org/project/yamldataclassconfig/) +[](https://pypi.org/project/yamldataclassconfig/) +[](http://twitter.com/share?text=YAML%20Data%20Class%20Config&url=https://pypi.org/project/yamldataclassconfig/&hashtags=python) + +This project helps you to import config file writen by YAML to +Python [Data Classes](https://docs.python.org/3/library/dataclasses.html). + +## 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](https://docs.python.org/3/library/dataclasses.html) 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 + +```console +pip install yamldataclassconfig +``` + +### 2. Prepare config YAML file + +Put `config.yml` +YAML Data class Config loads `config.yml` on Python execution directory by default. + +```yaml +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` + +```python +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` + +```python +from myproduct.config import Config + +CONFIG: Config = Config() +``` + +### 5. Call load before reference config value + +```python +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() +``` + +<!-- markdownlint-disable no-trailing-punctuation --> +## How do I... +<!-- markdownlint-enable no-trailing-punctuation --> + +<!-- markdownlint-disable no-trailing-punctuation --> +### Fix path to yaml file independent on the Python execution directory? +<!-- markdownlint-enable no-trailing-punctuation --> + +override `FILE_PATH` property. + +Ex: + +```python +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') +``` + +<!-- markdownlint-disable no-trailing-punctuation --> +### Switch target YAML config file to the one for unit testing? +<!-- markdownlint-enable no-trailing-punctuation --> + +When setup on unit testing, you can call `Config.load()` with argument. + +Case when unittest: + +```python +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: + +```python +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""" +``` + +<!-- markdownlint-disable no-trailing-punctuation --> +### Use path to YAML config file as same as production when test? +<!-- markdownlint-enable no-trailing-punctuation --> + +[fixturefilehandler](https://pypi.org/project/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: + +```python +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: + +```python +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""" +``` + + + + +%package -n python3-yamldataclassconfig +Summary: This project helps you to import config file writen by YAML to Python data class. +Provides: python-yamldataclassconfig +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-yamldataclassconfig +# YAML Data Class Config + +[](https://github.com/yukihiko-shinoda/yaml-dataclass-config/actions?query=workflow%3ATest) +[](https://codeclimate.com/github/yukihiko-shinoda/yaml-dataclass-config/test_coverage) +[](https://codeclimate.com/github/yukihiko-shinoda/yaml-dataclass-config/maintainability) +[](https://codeclimate.com/github/yukihiko-shinoda/yaml-dataclass-config) +[](https://pyup.io/repos/github/yukihiko-shinoda/yaml-dataclass-config/) +[](https://pypi.org/project/yamldataclassconfig/) +[](https://pypi.org/project/yamldataclassconfig/) +[](http://twitter.com/share?text=YAML%20Data%20Class%20Config&url=https://pypi.org/project/yamldataclassconfig/&hashtags=python) + +This project helps you to import config file writen by YAML to +Python [Data Classes](https://docs.python.org/3/library/dataclasses.html). + +## 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](https://docs.python.org/3/library/dataclasses.html) 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 + +```console +pip install yamldataclassconfig +``` + +### 2. Prepare config YAML file + +Put `config.yml` +YAML Data class Config loads `config.yml` on Python execution directory by default. + +```yaml +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` + +```python +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` + +```python +from myproduct.config import Config + +CONFIG: Config = Config() +``` + +### 5. Call load before reference config value + +```python +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() +``` + +<!-- markdownlint-disable no-trailing-punctuation --> +## How do I... +<!-- markdownlint-enable no-trailing-punctuation --> + +<!-- markdownlint-disable no-trailing-punctuation --> +### Fix path to yaml file independent on the Python execution directory? +<!-- markdownlint-enable no-trailing-punctuation --> + +override `FILE_PATH` property. + +Ex: + +```python +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') +``` + +<!-- markdownlint-disable no-trailing-punctuation --> +### Switch target YAML config file to the one for unit testing? +<!-- markdownlint-enable no-trailing-punctuation --> + +When setup on unit testing, you can call `Config.load()` with argument. + +Case when unittest: + +```python +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: + +```python +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""" +``` + +<!-- markdownlint-disable no-trailing-punctuation --> +### Use path to YAML config file as same as production when test? +<!-- markdownlint-enable no-trailing-punctuation --> + +[fixturefilehandler](https://pypi.org/project/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: + +```python +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: + +```python +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""" +``` + + + + +%package help +Summary: Development documents and examples for yamldataclassconfig +Provides: python3-yamldataclassconfig-doc +%description help +# YAML Data Class Config + +[](https://github.com/yukihiko-shinoda/yaml-dataclass-config/actions?query=workflow%3ATest) +[](https://codeclimate.com/github/yukihiko-shinoda/yaml-dataclass-config/test_coverage) +[](https://codeclimate.com/github/yukihiko-shinoda/yaml-dataclass-config/maintainability) +[](https://codeclimate.com/github/yukihiko-shinoda/yaml-dataclass-config) +[](https://pyup.io/repos/github/yukihiko-shinoda/yaml-dataclass-config/) +[](https://pypi.org/project/yamldataclassconfig/) +[](https://pypi.org/project/yamldataclassconfig/) +[](http://twitter.com/share?text=YAML%20Data%20Class%20Config&url=https://pypi.org/project/yamldataclassconfig/&hashtags=python) + +This project helps you to import config file writen by YAML to +Python [Data Classes](https://docs.python.org/3/library/dataclasses.html). + +## 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](https://docs.python.org/3/library/dataclasses.html) 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 + +```console +pip install yamldataclassconfig +``` + +### 2. Prepare config YAML file + +Put `config.yml` +YAML Data class Config loads `config.yml` on Python execution directory by default. + +```yaml +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` + +```python +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` + +```python +from myproduct.config import Config + +CONFIG: Config = Config() +``` + +### 5. Call load before reference config value + +```python +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() +``` + +<!-- markdownlint-disable no-trailing-punctuation --> +## How do I... +<!-- markdownlint-enable no-trailing-punctuation --> + +<!-- markdownlint-disable no-trailing-punctuation --> +### Fix path to yaml file independent on the Python execution directory? +<!-- markdownlint-enable no-trailing-punctuation --> + +override `FILE_PATH` property. + +Ex: + +```python +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') +``` + +<!-- markdownlint-disable no-trailing-punctuation --> +### Switch target YAML config file to the one for unit testing? +<!-- markdownlint-enable no-trailing-punctuation --> + +When setup on unit testing, you can call `Config.load()` with argument. + +Case when unittest: + +```python +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: + +```python +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""" +``` + +<!-- markdownlint-disable no-trailing-punctuation --> +### Use path to YAML config file as same as production when test? +<!-- markdownlint-enable no-trailing-punctuation --> + +[fixturefilehandler](https://pypi.org/project/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: + +```python +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: + +```python +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""" +``` + + + + +%prep +%autosetup -n yamldataclassconfig-1.5.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-yamldataclassconfig -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.5.0-1 +- Package Spec generated |