p3lib 1.1.86__py3-none-any.whl → 1.1.88__py3-none-any.whl

p3lib/pconfig.py

@@ -495,7 +495,7 @@ class ConfigManager(object):
                     self._debug("----------> DROPPED FROM CONFIG: {} = {}".format(loadedConfigKey, loadedConfig[loadedConfigKey]))
                     loadedConfig.pop(loadedConfigKey, None)
 
-        self._configDict = loadedConfig
+            self._configDict = loadedConfig
         self._info("Loaded config from %s" % (self._cfgFile) )
 
     def inputFloat(self, key, prompt, minValue=UNSET_VALUE, maxValue=UNSET_VALUE):
@@ -756,6 +756,8 @@ class DotConfigManager(ConfigManager):
               The ~/.config folder holds either a single config file of the startup python filename.
               The ./config folder can contain another python module folder which contains the config
               file. E.G for this example app the ~/.config/examples/pconfig_example.cfg folder is used."""
+    DEFAULT_CONFIG = None       # This must be overridden in a subclass to define the configuration parameters and values.
+    KEY_EDIT_ORDER_LIST = None
 
     @staticmethod
     def GetDefaultConfigFilename():
@@ -800,9 +802,10 @@ class DotConfigManager(ConfigManager):
 
         return configFilename
         
-    def __init__(self, defaultConfig, uio=None, encrypt=False):
+    def __init__(self, defaultConfig, keyEditOrderList=None, uio=None, encrypt=False):
         """@brief Constructor
            @param defaultConfig A default config instance containing all the default key-value pairs.
+           @param keyEditOrderList A list of all the dict keys in the order that the caller wishes them to be displayed top the user.
            @param uio A UIO (User Input Output) instance. May be set to None if no user messages are required.
            @param encrypt If True then data will be encrypted in the saved files.
                           The encryption uses part of the the local SSH RSA private key.
@@ -811,7 +814,33 @@ class DotConfigManager(ConfigManager):
                           !!! Therefore if encrypt is set True then the an ssh key must be present !!!
                           ||| in the ~/.ssh folder named id_rsa.                                   !!!"""
         super().__init__(uio, DotConfigManager.GetDefaultConfigFilename(), defaultConfig, encrypt=encrypt)
+        self._keyEditOrderList = keyEditOrderList
         # Ensure the config file is present and loaded into the internal dict.
         self.load()
 
+    def show(self):
+        """@brief A helper method to show the dictionary config to the user.
+           @return A dictionary mapping the attribute ID's (keys) to dictionary keys (values)."""
+        maxKeyLen=10
+        # If the caller wants to present the parameters to the user in a partiular order
+        if self._keyEditOrderList:
+            keys = self._keyEditOrderList
+            defaultKeys = list(self._configDict.keys())
+            for defaultKey in defaultKeys:
+                if defaultKey not in keys:
+                    raise Exception(f"BUG: DotConfigManager: {defaultKey} key is missing from the keyEditOrderList.")
+        # Present the parameters to the user in any order.
+        else:
+            keys = list(self._configDict.keys())
 
+        for key in keys:
+            if len(key) > maxKeyLen:
+                maxKeyLen = len(key)
+        self._info("ID  PARAMETER"+" "*(maxKeyLen-8)+" VALUE")
+        id=1
+        idKeyDict = {}
+        for key in keys:
+            idKeyDict[id]=key
+            self._info("{:<3d} {:<{}} {}".format(id, key, maxKeyLen+1, self._configDict[key]))
+            id=id+1
+        return idKeyDict

{p3lib-1.1.86.dist-info → p3lib-1.1.88.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.86
+Version: 1.1.88
 Summary: A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.
 Home-page: https://github.com/pjaos/p3lib
 Author: Paul Austen

{p3lib-1.1.86.dist-info → p3lib-1.1.88.dist-info}/RECORD

@@ -11,12 +11,12 @@ p3lib/mqtt_rpc.py,sha256=6LmFA1kR4HSJs9eWbOJORRHNY01L_lHWjvtE2fmY8P8,10511
 p3lib/netif.py,sha256=3QV5OGdHhELIf4MBj6mx5MNCtVeZ7JXoNEkeu4KzCaE,9796
 p3lib/netplotly.py,sha256=PMDx-w1jtRVW6Od5u_kuKbBxNpTS_Y88mMF60puMxLM,9363
 p3lib/ngt.py,sha256=rXA-6zQkfeOupZ-3Q-k3-1DvbKYIi2TCtLKgUb0waWY,37726
-p3lib/pconfig.py,sha256=g9Qk-tSjxtSuEfLbvIvR1SHC7x7BHxp1evT2IFfk05I,34407
+p3lib/pconfig.py,sha256=ODSIkP902uaSeGj98U4V3-2obZR2fuFAxv_X0j2TvPc,35929
 p3lib/ssh.py,sha256=klqQ9YuqU8GwPVPHrAJeEs5PI5hgoYiXflq2kIGG3as,39509
 p3lib/table_plot.py,sha256=RPncwVlGUkkx5Fw0dHQedXo0TSPlTi__VrJBDzaMsuI,32116
 p3lib/uio.py,sha256=Aaxc99XiE3d2f9vLjaN-bZsckoNxay5t0ujdK6PXGrw,23265
-p3lib-1.1.86.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.86.dist-info/METADATA,sha256=viCrPzOCPwdWFfXg31oL2Q84MpF3bxesV2951yIULjA,918
-p3lib-1.1.86.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-p3lib-1.1.86.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.86.dist-info/RECORD,,
+p3lib-1.1.88.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.88.dist-info/METADATA,sha256=Kib55jvHxBRhAlPWpgc7-Y0ZY1j-zmvE2uq2-8rYvkE,918
+p3lib-1.1.88.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+p3lib-1.1.88.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.88.dist-info/RECORD,,