yaml config supported 🤔

README.md

@@ -1,6 +1,6 @@
 # pyconf
 
-Configuration for Humans
+Configuration for Humans in ***Python3***.
 
 **pyconf** is an INI/py/yml configuration parsing package, written for humans.
 
@@ -36,6 +36,16 @@ print(c['path'])
 # some_path
 ```
 
+yaml config file
+---
+
+```python
+import pyconf
+c = pyconf.load('tests/sample.yml', config_class=pyconf.YamlConfig)
+print(c['path'])
+# some_path
+```
+
 Tests
 =====
 
@@ -44,11 +54,17 @@ Run the tests with
 ```bash
 python -m tests.test_ini_configs
 python -m tests.test_py_configs
+python -m tests.test_yaml_configs
 ```
 
 History
 ===
 
+0.1.1
+---
+
+1. support the yaml config file
+
 0.1.0
 ---
 

pyconf/__init__.py

@@ -16,11 +16,12 @@
 """
 
 __title__ = 'pyconf'
-__version__ = '0.1.0'
+__version__ = '0.1.1'
 __author__ = 'Kevin Du'
 __license__ = 'MIT'
 
 from .ini_config import IniConfig
 from .py_config import PyConfig
+from .yml_config import YamlConfig
 from .base_config import BaseConfig, Section
 from .api import load

pyconf/api.py

@@ -1,15 +1,16 @@
 from .ini_config import IniConfig
 from .py_config import PyConfig
+from .yml_config import YamlConfig
 
 
-support_configs = (IniConfig, PyConfig)
+support_configs = (IniConfig, PyConfig, YamlConfig)
 
 
 def load(config_file, config_class=IniConfig):
  """Constructs and returns a :class:`Config <Config>` instance.
 
  :param config_file: configuration file to be parsed
- :param ext: configuration extension
+ :param config_class: configuration extension
 
  Usage::
 

pyconf/ini_config.py

@@ -21,7 +21,6 @@ def load(self, config_file):
  """Parse an INI configuration file.
 
  :param config_file: configuration file to be loaded.
- :param silent: set to ``True`` if you want silent failure for missing files.
  """
 
  current_section = None

pyconf/yml_config.py

@@ -0,0 +1,10 @@
+import yaml
+from .py_config import PyConfig
+
+
+class YamlConfig(PyConfig):
+
+ def load(self, config_file):
+ with open(config_file) as config:
+ config_obj = yaml.load(config)
+ self._add_section_recursive(config_obj, self.sections['root'])

requirements.txt

@@ -0,0 +1,2 @@
+certifi==2018.1.18
+PyYAML==3.12

setup.py

@@ -5,7 +5,7 @@
 try:
  readme = open('README.md').read()
 except:
- readme = 'pyconf: Configuration for Humans. Support ini config file, python config file'
+ readme = 'pyconf: Configuration for Humans. Support ini config file, python config file, yaml config file'
 
 setup(
  name=pyconf.__title__,

tests/sample.yml

@@ -0,0 +1,20 @@
+path: some_path
+hosts: ["example.com", "http://bing.com", "ssh.com:23", "www.qwe.asd"]
+
+section: {
+ "attr1": 7.1,
+ "attr2": 42,
+ "foo": 123
+}
+
+section2: {
+ "inner_section": {
+ "test_section": {
+ 1: 2
+ },
+ "two": 2,
+ },
+ "attr1": 7.1,
+ "attr2": 42,
+ "foo": 123
+}

tests/test_yaml_configs.py

@@ -0,0 +1,47 @@
+import unittest
+
+from pyconf import api, YamlConfig, Section
+from typing import Sequence
+
+
+class TestPyConfig(unittest.TestCase):
+
+ def setUp(self):
+ self.sample_config_filename = 'tests/sample.yml'
+ self.missing_config_filename = 'missing.yml'
+
+ def test_load_general(self):
+ """Check if a valid config file is parsed correctly"""
+
+ self.assertIsInstance(api.load(self.sample_config_filename, config_class=YamlConfig), YamlConfig)
+
+ def test_load_missing_file(self):
+ """Check if the correct exception in raised when a missing config file is attempted to parse"""
+
+ with self.assertRaises(FileNotFoundError):
+ api.load(self.missing_config_filename)
+
+ def test_load_check_types(self):
+ """Check automatic float, integer, and boolean value conversion"""
+ config_data = api.load(self.sample_config_filename, config_class=YamlConfig)
+ self.assertIsInstance(config_data['path'], str)
+ self.assertIsInstance(config_data['hosts'], Sequence)
+ self.assertIsInstance(config_data['hosts'][0], str)
+
+ self.assertIsInstance(config_data['section'], Section)
+ self.assertIsInstance(config_data['section']['attr1'], float)
+ self.assertIsInstance(config_data['section']['attr2'], int)
+ self.assertIsInstance(config_data['section']['foo'], int)
+
+ self.assertIsInstance(config_data['section2'], Section)
+ self.assertIsInstance(config_data['section2']['attr1'], float)
+ self.assertIsInstance(config_data['section2']['attr2'], int)
+ self.assertIsInstance(config_data['section2']['foo'], int)
+ self.assertIsInstance(config_data['section2']['inner_section'], Section)
+ self.assertIsInstance(config_data['section2']['inner_section']['two'], int)
+ self.assertIsInstance(config_data['section2']['inner_section']['test_section'], Section)
+ self.assertIsInstance(config_data['section2']['inner_section']['test_section'][1], int)
+
+
+if __name__ == '__main__':
+ unittest.main()