Add INI, XML, TOML and fix testing

Author: monokrome

README.md

@@ -62,8 +62,10 @@ Along with being fully configurable to support any arbitrary data source you'd
 like, the following types of data can immediately be used as configuration formats
 upon installation of prefer:
 
-- JSON
+- JSON (with comments)
 - YAML
+- TOML
+- INI
 
 
 Why asyncronous?

prefer/configuration_spec.py

@@ -113,3 +113,8 @@ def test_get_returns_none_for_unset_nested_identifier():
     )
     result = subject.get("level1.nonexistent")
     assert result is None
+
+
+def test_configuration_using_with_invalid_type_returns_empty():
+    result = configuration.Configuration.using("invalid_string")
+    assert result.context == {}

prefer/formatters/defaults.py

@@ -1,4 +1,6 @@
 defaults = [
     "prefer.formatters.json:JSONFormatter",
     "prefer.formatters.yaml:YAMLFormatter",
+    "prefer.formatters.ini:INIFormatter",
+    "prefer.formatters.xml:XMLFormatter",
 ]

prefer/formatters/ini.py

@@ -0,0 +1,27 @@
+import configparser
+import io
+import typing
+
+from prefer.formatters import formatter
+
+
+class INIFormatter(formatter.Formatter):
+    @staticmethod
+    def provides(identifier: str) -> bool:
+        return identifier.endswith(".ini") or identifier.endswith(".cfg")
+
+    async def serialize(self, source: typing.Dict[str, typing.Any]) -> str:
+        config = configparser.ConfigParser()
+        for section, values in source.items():
+            config[section] = values
+        output = io.StringIO()
+        config.write(output)
+        return output.getvalue()
+
+    async def deserialize(self, source: str) -> typing.Dict[str, typing.Any]:
+        config = configparser.ConfigParser()
+        config.read_string(source)
+        result: typing.Dict[str, typing.Any] = {
+            section: dict(config[section]) for section in config.sections()
+        }
+        return result

prefer/formatters/ini_spec.py

@@ -0,0 +1,36 @@
+import pytest
+
+from prefer.formatters import ini
+
+INI_DATA = """[mock_config]
+name = Bailey
+
+"""
+REAL_DATA = {"mock_config": {"name": "Bailey"}}
+
+formatter = ini.INIFormatter()
+
+
+@pytest.mark.asyncio
+async def test_ini_formatter_provides_expected_file_extensions():
+    assert ini.INIFormatter.provides("test.ini") is True
+    assert ini.INIFormatter.provides("test.cfg") is True
+
+
+@pytest.mark.asyncio
+async def test_ini_formatter_does_not_provide_unexpected_file_extensions():
+    assert ini.INIFormatter.provides("test.json") is False
+    assert ini.INIFormatter.provides("test.yaml") is False
+
+
+@pytest.mark.asyncio
+async def test_ini_formatter_serializes_to_ini():
+    result = await formatter.serialize(REAL_DATA)
+    assert "[mock_config]" in result
+    assert "name = Bailey" in result
+
+
+@pytest.mark.asyncio
+async def test_ini_formatter_deserializes_from_ini():
+    result = await formatter.deserialize(INI_DATA)
+    assert result == REAL_DATA

prefer/formatters/json.py

@@ -1,17 +1,19 @@
-import json
 import typing
 
+import json5
+
 from prefer.formatters import formatter
 
 
 class JSONFormatter(formatter.Formatter):
     @staticmethod
     def provides(identifier: str) -> bool:
-        return identifier.endswith(".json")
+        return identifier.endswith(".json") or identifier.endswith(".json5")
 
     async def serialize(self, source: typing.Dict[str, typing.Any]) -> str:
-        return json.dumps(source)
+        result: str = json5.dumps(source, quote_keys=True)
+        return result
 
     async def deserialize(self, source: str) -> typing.Dict[str, typing.Any]:
-        result: typing.Dict[str, typing.Any] = json.loads(source)
+        result: typing.Dict[str, typing.Any] = json5.loads(source)
         return result

prefer/formatters/json_spec.py

@@ -13,6 +13,7 @@
 @pytest.mark.asyncio
 async def test_json_native_formatter_provides_expected_file_extensions():
     assert json.JSONFormatter.provides("test.json") is True
+    assert json.JSONFormatter.provides("test.json5") is True
 
 
 @pytest.mark.asyncio

prefer/formatters/xml.py

@@ -0,0 +1,23 @@
+import typing
+import xml.etree.ElementTree as ET
+
+import xmljson
+
+from prefer.formatters import formatter
+
+
+class XMLFormatter(formatter.Formatter):
+    @staticmethod
+    def provides(identifier: str) -> bool:
+        return identifier.endswith(".xml")
+
+    async def serialize(self, source: typing.Dict[str, typing.Any]) -> str:
+        elem = xmljson.badgerfish.etree(source)
+        if isinstance(elem, list):
+            elem = elem[0]
+        return ET.tostring(elem, encoding="unicode")
+
+    async def deserialize(self, source: str) -> typing.Dict[str, typing.Any]:
+        elem = ET.fromstring(source)
+        result: typing.Dict[str, typing.Any] = xmljson.badgerfish.data(elem)
+        return result

prefer/formatters/xml_spec.py

@@ -0,0 +1,33 @@
+import pytest
+
+from prefer.formatters import xml
+
+XML_DATA = "<root><name>Bailey</name></root>"
+REAL_DATA = {"root": {"name": {"$": "Bailey"}}}
+
+formatter = xml.XMLFormatter()
+
+
+@pytest.mark.asyncio
+async def test_xml_formatter_provides_expected_file_extensions():
+    assert xml.XMLFormatter.provides("test.xml") is True
+
+
+@pytest.mark.asyncio
+async def test_xml_formatter_does_not_provide_unexpected_file_extensions():
+    assert xml.XMLFormatter.provides("test.json") is False
+    assert xml.XMLFormatter.provides("test.yaml") is False
+
+
+@pytest.mark.asyncio
+async def test_xml_formatter_serializes_to_xml():
+    result = await formatter.serialize(REAL_DATA)
+    assert "<root>" in result
+    assert "<name>Bailey</name>" in result
+
+
+@pytest.mark.asyncio
+async def test_xml_formatter_deserializes_from_xml():
+    result = await formatter.deserialize(XML_DATA)
+    assert "root" in result
+    assert "name" in result["root"]

pyproject.toml

@@ -26,6 +26,7 @@ classifiers = [
 dependencies = [
     "PyYAML>=5.1",
     "xmljson>=0.2.0",
+    "json5>=0.9.0",
 ]
 
 [project.optional-dependencies]
@@ -67,6 +68,10 @@ exclude = [
     ".*_spec\\.py$",
 ]
 
+[[tool.mypy.overrides]]
+module = "xmljson"
+ignore_missing_imports = true
+
 [tool.ruff]
 line-length = 79
 target-version = "py38"
@@ -84,15 +89,7 @@ source = ["prefer"]
 omit = ["*/tests/*", "*/__pycache__/*", "*_spec.py"]
 
 [tool.coverage.report]
-exclude_lines = [
-    "pragma: no cover",
-    "def __repr__",
-    "raise AssertionError",
-    "raise NotImplementedError",
-    "if __name__ == .__main__.:",
-    "if typing.TYPE_CHECKING:",
-]
-fail_under = 99
+fail_under = 100
 show_missing = true
 
 [tool.coverage.html]