p3lib 1.1.87__py3-none-any.whl → 1.1.89__py3-none-any.whl

p3lib/pconfig.py

@@ -756,53 +756,45 @@ 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():
         """@brief Get the default name of the config file for this app. This will be the program name
-                  (file that started up initially) without the .py extension. On Linux systems this 
-                  will reside in the ~/.config folder. If the ~/.config does not exist an attempt to 
-                  create it is made. If the ~/.config folder cannot be created then the config file 
-                  will be as detailed above but will be prefixed by a . character and will reside
-                  in the users home folder."""
-        progName = sys.argv[0]
-        if progName.endswith('.py'):
-            progName = progName[0:-3]
-
-        folder = '.config'
-        homePath = os.path.expanduser("~")
-        configFolder = os.path.join(homePath, folder)
-
-        if not os.path.isdir(homePath):
-            raise Exception(f"{homePath} HOME path does not exist.")
+                  (file that started up initially) without the .py extension. A .cfg extension is added
+                  and it will be found in the ~/.config folder."""
+         dotConfigFolder = '.config'
+         homePath = os.path.expanduser("~")
+         configFolder = os.path.join(homePath, dotConfigFolder)
+
+         if not os.path.isdir(homePath):
+             raise Exception(f"{homePath} HOME path does not exist.")
         
-        # Create the ~/.config folder if it does not exist
-        if not os.path.isdir(configFolder):
-            # Create the ~/.config folder
-            os.makedir(configFolder)
-
-        # Note that we assume that addDotToFilename in the ConfigManager constructor is set True
-        # as this will prefix the filename with the . character.
-        if os.path.isdir(configFolder):
-            extraFolders = os.path.dirname(progName)
-            configFolder = os.path.join(configFolder, extraFolders)
-            if not os.path.isdir(configFolder):
-                os.makedirs(configFolder)
-            if not os.path.isdir(configFolder):
-                raise Exception(f"Failed to create the {configFolder} folder.")
-            
-            configFolder = "config"
-            configFolder = os.path.join(configFolder, extraFolders)
-            configFilename = os.path.join(configFolder, os.path.basename(progName) + '.cfg')
+         # Create the ~/.config folder if it does not exist
+         if not os.path.isdir(configFolder):
+             # Create the ~/.config folder
+             os.makedir(configFolder)
 
-        else:
-            configFilename = progName
+         progName = sys.argv[0]
+         if progName.endswith('.py'):
+             progName = progName[0:-3]
+         progName = os.path.basename(progName).strip()
 
-        return configFilename
-        
-    def __init__(self, defaultConfig, uio=None, encrypt=False):
+         # Note that we assume that addDotToFilename in the ConfigManager constructor is set True
+         # as this will prefix the filename with the . character.
+         if os.path.isdir(configFolder):
+             configFilename = os.path.join(".config", progName + ".cfg")
+
+         else:
+             raise Exception(f"Failed to create the {configFolder} folder.")
+
+         return configFilename
+
+    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 +803,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.87.dist-info → p3lib-1.1.89.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.87
+Version: 1.1.89
 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.87.dist-info → p3lib-1.1.89.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=NsGp-bc25NlUfLpStJhdG4-sQHxJDqmtaEmg_BcyBBI,34411
+p3lib/pconfig.py,sha256=KLKS3G6Xc2qgDoDCe1bWHqrl13RwrCXL7j80TWaIZWg,35296
 p3lib/ssh.py,sha256=klqQ9YuqU8GwPVPHrAJeEs5PI5hgoYiXflq2kIGG3as,39509
 p3lib/table_plot.py,sha256=RPncwVlGUkkx5Fw0dHQedXo0TSPlTi__VrJBDzaMsuI,32116
 p3lib/uio.py,sha256=Aaxc99XiE3d2f9vLjaN-bZsckoNxay5t0ujdK6PXGrw,23265
-p3lib-1.1.87.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.87.dist-info/METADATA,sha256=i38gGvBnf1PpiBnTzv5qqtcvJnUpI8sLo36QrXOoLcM,918
-p3lib-1.1.87.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-p3lib-1.1.87.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.87.dist-info/RECORD,,
+p3lib-1.1.89.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.89.dist-info/METADATA,sha256=MavcK6Pe6ORhP_GNX2WZ7mNcVMbLgKA7J3KSAFGR_N4,918
+p3lib-1.1.89.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+p3lib-1.1.89.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.89.dist-info/RECORD,,