typerconf 2.2__tar.gz → 2.3__tar.gz

{typerconf-2.2 → typerconf-2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: typerconf
-Version: 2.2
+Version: 2.3
 Summary: Library to read and write configs using API and CLI with Typer
 Home-page: https://github.com/dbosk/typerconf
 License: MIT

{typerconf-2.2 → typerconf-2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "typerconf"
-version = "2.2"
+version = "2.3"
 description = "Library to read and write configs using API and CLI with Typer"
 authors = ["Daniel Bosk <daniel@bosk.se>"]
 license = "MIT"

{typerconf-2.2 → typerconf-2.3}/src/typerconf/__init__.py

@@ -16,7 +16,7 @@ dirs = appdirs.AppDirs(basename)
 class Config:
   """Navigates nested JSON structures by dot-separated addressing."""
 
-  def __init__(self, json_data={},
+  def __init__(self, json_data=None,
                      conf_file=None):
     """
     Constructs a config object to navigate from JSON data `json_data`.
@@ -30,7 +30,10 @@ class Config:
 
     To not enable write back, load file contents with the `.read_config` method.
     """
-    self.__data = json_data
+    if not json_data:
+      self.__data = {}
+    else:
+      self.__data = json_data
     if isinstance(conf_file, io.IOBase):
       try:
         self.__conf_file = conf_file.name

{typerconf-2.2 → typerconf-2.3}/src/typerconf/init.nw

@@ -123,14 +123,17 @@ Both work with these dot-separated addresses.
 class Config:
   """Navigates nested JSON structures by dot-separated addressing."""
 
-  def __init__(self, json_data={},
+  def __init__(self, json_data=None,
                      <<Config constructor args>>):
     """
     Constructs a config object to navigate from JSON data `json_data`.
 
     <<Config constructor args doc>>
     """
-    self.__data = json_data
+    if not json_data:
+      self.__data = {}
+    else:
+      self.__data = json_data
     <<Config attributes>>
 
   <<Config methods for get and set>>
@@ -138,7 +141,27 @@ class Config:
   <<Config methods for reading from and writing to file>>
 @
 
-We will use the following test data for the test functions.
+We want to test the constructor.
+<<test functions>>=
+def test_constructor():
+  test_key = "courses"
+  test_value = "test"
+
+  conf = Config(json_data={test_key: test_value})
+  assert test_key in conf.get()
+
+  assert test_key not in Config(json_data={}).get()
+  assert test_key not in Config().get()
+
+  conf = Config()
+  conf.set(test_key, test_value)
+  assert conf.get(test_key) == test_value
+
+  assert test_key not in Config().get()
+@
+
+We will use the following test data for the test functions in the remainder of 
+the text.
 <<test functions>>=
 test_data = {
   "courses": {
@@ -278,6 +301,16 @@ def test_set_path_list():
   assert gotten_value == value
 @
 
+We also want to test short paths.
+<<test functions>>=
+def test_set_short_path():
+  value = "Test Tester"
+  path = "contact"
+  conf.set(path, value)
+
+  assert conf.get(path) == value
+@
+
 When we want to remove a node, the pythonic way is to simply try to remove it.
 If it doesn't exist, we silently fail.
 The reasoning is as follows: the goal is to remove something; if it doesn't 
@@ -306,6 +339,19 @@ def test_set_path_remove():
     assert False
 @
 
+We also want to remove from a longer path.
+<<test functions>>=
+def test_set_path_list():
+  path = "courses.prgx22.TAs"
+  conf.set(path, None)
+  try:
+    conf.get(path)
+  except KeyError:
+    assert True
+  else:
+    assert False
+@
+
 We want to traverse the tree, we want to go to the immediate parent of the leaf 
 that we want to set a value for (or delete).
 We iterate through the path.
@@ -754,12 +800,14 @@ written to the file.
 <<test functions>>=
 def test_writeback_constructor():
   with tempfile.NamedTemporaryFile("w") as tmp_conf_file:
-    tmp_conf_file_name = "/tmp/writeback" #tmp_conf_file.name
+    tmp_conf_file_name = tmp_conf_file.name
     path = "the.path"
     first_value = "1st"
     second_value = "2nd"
 
     initial_conf = Config()
+    assert initial_conf.get() == {}
+
     initial_conf.set(path, first_value)
     initial_conf.write_config(tmp_conf_file_name)
 
@@ -768,6 +816,8 @@ def test_writeback_constructor():
     conf.set(path, second_value)
 
     last_conf = Config()
+    assert last_conf.get() == {}
+
     last_conf.read_config(tmp_conf_file_name)
     assert last_conf.get(path) == second_value
 <<test imports>>=
@@ -921,6 +971,8 @@ if values == "":
   values = None
 @
 
+\subsection{Testing the config command}
+
 Let's test this command.
 We'll set up the testing.
 <<test functions>>=
@@ -936,7 +988,7 @@ Let's look at the actual tests.
 <<run tests on [[cli]]>>=
 # set example data
 result = runner.invoke(cli,
-                        ["courses.datintro22.url", "--set", "https://..."])
+                       ["courses.datintro22.url", "--set", "https://..."])
 assert result.exit_code == 0
 
 # try access nonexisting
@@ -949,7 +1001,7 @@ assert "courses.datintro22.url = https://..." in result.stdout
 
 # clear config
 result = runner.invoke(cli,
-                        ["courses", "--set", None])
+                       ["courses", "--set", ""])
 assert result.exit_code == 0
 
 # check that it's cleared
@@ -972,6 +1024,26 @@ def test_cli_not_default_conf():
   <<run tests on [[cli]]>>
 @
 
+We'll do another round of tests, but this time for shorter paths.
+<<test functions>>=
+def test_short_paths():
+  result = runner.invoke(cli, ["contact"])
+  assert result.exit_code != 0
+
+  result = runner.invoke(cli,
+                        ["contact", "--set", "me"])
+  assert result.exit_code == 0
+
+  result = runner.invoke(cli, ["contact"])
+  assert "contact = me" in result.stdout
+
+  result = runner.invoke(cli,
+                        ["contact", "--set", ""])
+  assert result.exit_code == 0
+
+  result = runner.invoke(cli, ["contact"])
+  assert result.exit_code != 0
+@
 
 \subsection{Autocompleting the path}