From abc4bdfd439674ee99eb203ad2d7424705a33f98 Mon Sep 17 00:00:00 2001
From: Aaron LI <aaronly.me@outlook.com>
Date: Thu, 3 Nov 2016 21:27:17 +0800
Subject: configs/manager.py: getn(): remove par. "sep"; handle exception

* Remove the optional parameter "sep", therefore the key must be
  "/"-separated or a list of keys.
* Add exception handling and raise "KeyError" if the input key is
  invalid (i.e., specifies a non-exist option).
* Update comments and docstring.
---
 fg21sim/configs/manager.py | 28 ++++++++++++++++------------
 1 file changed, 16 insertions(+), 12 deletions(-)

(limited to 'fg21sim')

diff --git a/fg21sim/configs/manager.py b/fg21sim/configs/manager.py
index ff950bb..2252e61 100644
--- a/fg21sim/configs/manager.py
+++ b/fg21sim/configs/manager.py
@@ -14,6 +14,7 @@ import sys
 import logging
 from logging import FileHandler, StreamHandler
 from functools import reduce
+import operator
 import pkg_resources
 
 from configobj import ConfigObj, ConfigObjError, flatten_errors
@@ -188,42 +189,45 @@ class ConfigManager:
             config = self._config
         return config.get(key, fallback)
 
-    def getn(self, key, sep="/", from_default=False):
+    def getn(self, key, from_default=False):
         """Get the config value from the nested dictionary configs using
-        a list of keys or a "sep"-separated keys strings.
+        a list of keys or a "sep"-separated keys string.
 
         Parameters
         ----------
         key : str, or list[str]
-            List of keys or a string separated by a specific character
-            (e.g., "/") to specify the item in the ``self._config``, which
+            List of keys or a string of keys separated by a the ``/``
+            character to specify the item in the ``self._config``, which
             is a nested dictionary.
             e.g., ``["section1", "key2"]``, ``"section1/key2"``
-        sep : str (len=1), optional
-            If the above "keys" is a string, then this parameter specify
-            the character used to separate the multi-level keys.
-            This parameter should be a string of length 1 (i.e., a character).
         from_default : bool, optional
             If True, get the config option value from the *default*
             configurations, other than the configurations merged with user
             configurations (default).
 
+        Raises
+        ------
+        KeyError :
+            The input key specifies a non-exist config option.
+
         References
         ----------
         - Stackoverflow: Checking a Dictionary using a dot notation string
           https://stackoverflow.com/q/12414821/4856091
+          https://stackoverflow.com/a/12414913/4856091
         """
-        if len(sep) != 1:
-            raise ValueError("Invalid parameter 'sep': %s" % sep)
         if isinstance(key, str):
-            key = key.split(sep)
+            key = key.split("/")
         #
         if from_default:
             config = self._config_default
         else:
             config = self._config
         #
-        return reduce(dict.get, key, config)
+        try:
+            return reduce(operator.getitem, key, config)
+        except (KeyError, TypeError):
+            raise KeyError("%s: invalid key")
 
     def get_path(self, key):
         """Return the absolute path of the file/directory specified by the
-- 
cgit v1.2.2