feat: added support for toml config

Author: ErikBjare

aw_core/__about__.py

@@ -2,15 +2,21 @@
 # https://github.com/pypa/pipfile/blob/master/pipfile/__about__.py
 
 __all__ = [
-    "__title__", "__summary__", "__uri__", "__version__", "__author__",
-    "__email__", "__license__", "__copyright__",
+    "__title__",
+    "__summary__",
+    "__uri__",
+    "__version__",
+    "__author__",
+    "__email__",
+    "__license__",
+    "__copyright__",
 ]
 
 __title__ = "aw-core"
 __summary__ = "Core library for ActivityWatch"
 __uri__ = "https://github.com/ActivityWatch/aw-core"
 
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 __author__ = "Erik Bjäreholt, Johan Bjäreholt"
 __email__ = "erik@bjareho.lt, johan@bjareho.lt"

aw_core/config.py

@@ -1,12 +1,83 @@
 import os
 import logging
+from typing import Any, Dict, Union
 from configparser import ConfigParser
 
+from deprecation import deprecated
+import tomlkit
+
 from aw_core import dirs
+from aw_core.__about__ import __version__
 
 logger = logging.getLogger(__name__)
 
 
+def _merge(a: dict, b: dict, path=None):
+    """
+    Recursively merges b into a, with b taking precedence.
+
+    From: https://stackoverflow.com/a/7205107/965332
+    """
+    if path is None:
+        path = []
+    for key in b:
+        if key in a:
+            if isinstance(a[key], dict) and isinstance(b[key], dict):
+                _merge(a[key], b[key], path + [str(key)])
+            elif a[key] == b[key]:
+                pass  # same leaf value
+            else:
+                a[key] = b[key]
+        else:
+            a[key] = b[key]
+    return a
+
+
+def _comment_out_toml(s: str):
+    return "\n".join(["#" + line for line in s.split("\n")])
+
+
+def load_config_toml(
+    appname: str, default_config: str
+) -> Union[dict, tomlkit.container.Container]:
+    config_dir = dirs.get_config_dir(appname)
+    config_file_path = os.path.join(config_dir, "{}.toml".format(appname))
+
+    # Run early to ensure input is valid toml before writing
+    default_config_toml = tomlkit.parse(default_config)
+
+    # Override defaults from existing config file
+    if os.path.isfile(config_file_path):
+        with open(config_file_path, "r") as f:
+            config = f.read()
+        config_toml = tomlkit.parse(config)
+    else:
+        # TODO: If file doesn't exist, write with commented-out default config
+        with open(config_file_path, "w") as f:
+            f.write(_comment_out_toml(default_config))
+        config_toml = dict()
+
+    config = _merge(default_config_toml, config_toml)
+
+    return config
+
+
+def save_config_toml(appname: str, config: str) -> None:
+    # Check that passed config string is valid toml
+    assert tomlkit.parse(config)
+
+    config_dir = dirs.get_config_dir(appname)
+    config_file_path = os.path.join(config_dir, "{}.toml".format(appname))
+
+    with open(config_file_path, "w") as f:
+        f.write(config)
+
+
+@deprecated(
+    details="Use the load_config_toml function instead",
+    deprecated_in="0.4.2",
+    current_version=__version__,
+)
 def load_config(appname, default_config):
     """
     Take the defaults, and if a config file exists, use the settings specified
@@ -15,11 +86,11 @@ def load_config(appname, default_config):
     config = default_config
 
     config_dir = dirs.get_config_dir(appname)
-    config_file_path = os.path.join(config_dir, "{}.ini".format(appname))
+    config_file_path = os.path.join(config_dir, "{}.toml".format(appname))
 
     # Override defaults from existing config file
     if os.path.isfile(config_file_path):
-        with open(config_file_path, 'r') as f:
+        with open(config_file_path, "r") as f:
             config.read_file(f)
 
     # Overwrite current config file (necessary in case new default would be added)
@@ -28,8 +99,13 @@ def load_config(appname, default_config):
     return config
 
 
+@deprecated(
+    details="Use the save_config_toml function instead",
+    deprecated_in="0.4.2",
+    current_version=__version__,
+)
 def save_config(appname, config):
     config_dir = dirs.get_config_dir(appname)
     config_file_path = os.path.join(config_dir, "{}.ini".format(appname))
-    with open(config_file_path, 'w') as f:
+    with open(config_file_path, "w") as f:
         config.write(f)

poetry.lock

@@ -25,6 +25,8 @@ python-json-logger = "^0.1.11"
 TakeTheTime = "^0.3.1"
 pymongo = {version = "^3.10.0", optional = true}
 strict-rfc3339 = "^0.7"
+tomlkit = "^0.6.0"
+deprecation = "^2.0.7"
 
 [tool.poetry.dev-dependencies]
 pytest = "^5.3.2"

pyproject.toml

@@ -1,31 +1,83 @@
-import unittest
 import shutil
 from configparser import ConfigParser
 
+import pytest
+import deprecation
+
 from aw_core import dirs
-from aw_core.config import load_config, save_config
+from aw_core.config import load_config, save_config, load_config_toml, save_config_toml
+
+appname = "aw-core-test"
+section = "section"
+config_dir = dirs.get_config_dir(appname)
+
+default_config_str = f"""# A default config file, with comments!
+[{section}]
+somestring = "Hello World!"    # A comment
+somevalue = 12.3               # Another comment
+somearray = ["asd", 123]"""
+
+
+@pytest.fixture(autouse=True)
+def clean_config():
+    # Remove test config file if it already exists
+    shutil.rmtree(config_dir, ignore_errors=True)
+
+    # Rerun get_config dir to create config directory
+    dirs.get_config_dir(appname)
 
-def test_create():
-    appname = "aw-core-test"
-    section = "section"
-    config_dir = dirs.get_config_dir(appname)
+    yield
 
     # Remove test config file if it already exists
     shutil.rmtree(config_dir)
 
+
+def test_config_defaults():
+    # Load non-existing config (will create a out-commented default config file)
+    config = load_config_toml(appname, default_config_str)
+
+    # Check that load_config used defaults
+    assert config[section]["somestring"] == "Hello World!"
+    assert config[section]["somevalue"] == 12.3
+    assert config[section]["somearray"] == ["asd", 123]
+
+
+def test_config_no_defaults():
+    # Write defaults to file
+    save_config_toml(appname, default_config_str)
+
+    # Load written defaults without defaults
+    config = load_config_toml(appname, "")
+    assert config[section]["somestring"] == "Hello World!"
+    assert config[section]["somevalue"] == 12.3
+    assert config[section]["somearray"] == ["asd", 123]
+
+
+def test_config_override():
+    # Create a minimal config file with one overridden value
+    config = """[section]
+somevalue = 1000.1"""
+    save_config_toml(appname, config)
+
+    # Open non-default config file and verify that values are correct
+    config = load_config_toml(appname, default_config_str)
+    assert config[section]["somevalue"] == 1000.1
+
+
+@deprecation.fail_if_not_removed
+def test_config_ini():
     # Create default config
     default_config = ConfigParser()
-    default_config[section] = {
-        "somestring": "Hello World!",
-        "somevalue": 12.3
-    }
+    default_config[section] = {"somestring": "Hello World!", "somevalue": 12.3}
 
     # Load non-existing config (will create a default config file)
     config = load_config(appname, default_config)
 
     # Check that current config file is same as default config file
     assert config[section]["somestring"] == default_config[section]["somestring"]
-    assert config[section].getfloat("somevalue") == default_config[section].getfloat("somevalue")
+    assert config[section].getfloat("somevalue") == default_config[section].getfloat(
+        "somevalue"
+    )
 
     # Modify and save config file
     config[section]["somevalue"] = "1000.1"
@@ -34,7 +86,6 @@ def test_create():
     # Open non-default config file and verify that values are correct
     new_config = load_config(appname, default_config)
     assert new_config[section]["somestring"] == config[section]["somestring"]
-    assert new_config[section].getfloat("somevalue") == config[section].getfloat("somevalue")
-
-    # Remove test config file
-    shutil.rmtree(config_dir)
+    assert new_config[section].getfloat("somevalue") == config[section].getfloat(
+        "somevalue"
+    )