p3lib 1.1.83__py3-none-any.whl → 1.1.85__py3-none-any.whl

p3lib/pconfig.py

@@ -338,49 +338,6 @@ class ConfigManager(object):
                     configPath = configPath.strip()
 
         return join( configPath, cfgFilename )
-
-    @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.")
-        
-        # 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')
-
-        else:
-            configFilename = progName
-
-        return configFilename
     
     def __init__(self, uio, cfgFilename, defaultConfig, addDotToFilename=True, encrypt=False, cfgPath=None):
         """@brief Constructor
@@ -518,16 +475,25 @@ class ConfigManager(object):
             loadedConfig = self._getDict()
             #Get list of all the keys from the config file loaded.
             loadedConfigKeys = loadedConfig.keys()
+
             #Get the default config
             self._configDict = copy.deepcopy( self._defaultConfig )
-            #Ensure that the config we use has all the values from the file we just loaded and any other values
-            #not in the config file loaded but defined in the default config are set to default values.
-            for key in loadedConfigKeys:
-                if key in self._configDict:
-                    self._configDict[key] = loadedConfig[key]
-                    self._debug("{} = {}".format(key, self._configDict[key]))
-                else:
-                    self._debug("----------> DROPPED FROM CONFIG: {} = {}".format(key, loadedConfig[key]))
+            defaultConfigKeys = self._configDict.keys()
+
+            # Config parameters may be added or dropped over time. We use the default config to
+            # check for parameters that should be added/removed.
+
+            # Add any missing keys to the loaded config from the default config.
+            for defaultKey in defaultConfigKeys:
+                if defaultKey not in loadedConfigKeys:
+                    self._configDict[defaultKey] = self._defaultConfig[defaultKey]
+                    self._debug("----------> DEFAULT VALUE ADDED: {} = {}".format(defaultKey, self._configDict[defaultKey]))
+
+            # If some keys have been dropped from the config, remove them.
+            for loadedConfigKey in loadedConfigKeys:
+                if loadedConfigKey not in defaultConfigKeys:
+                    self._debug("----------> DROPPED FROM CONFIG: {} = {}".format(loadedConfigKey, self._configDict[loadedConfigKey]))
+                    self._configDict.pop(loadedConfigKey, None)
 
         self._info("Loaded config from %s" % (self._cfgFile) )
 
@@ -782,3 +748,69 @@ class ConfigAttrDetails(object):
         self.minValue       =   minValue    #Only used for numbers
         self.maxValue       =   maxValue    #Only used for numbers
         self.allowEmpty     =   allowEmpty  #Only used for strings
+
+class DotConfigManager(ConfigManager):
+    """@brief This extends the previous ConfigManager and stores config under the ~/.config folder
+              rather than in the home folder (~) using a filename prefixed with the . character.
+              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."""
+
+    @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.")
+        
+        # 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')
+
+        else:
+            configFilename = progName
+
+        return configFilename
+        
+    def __init__(self, defaultConfig, uio=None, encrypt=False):
+        """@brief Constructor
+           @param defaultConfig A default config instance containing all the default key-value pairs.
+           @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.
+                          This is not secure but assuming the private key has not been compromised it's
+                          probably the best we can do. 
+                          !!! 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)
+        # Ensure the config file is present and loaded into the internal dict.
+        self.load()
+
+

{p3lib-1.1.83.dist-info → p3lib-1.1.85.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.83
+Version: 1.1.85
 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.83.dist-info → p3lib-1.1.85.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=S0qcWiiTA8Kz3bIja41NTHJdqGS6lI5iklHb-dCAtTc,32336
+p3lib/pconfig.py,sha256=qMBYkHZx0OV4M40aRNhlKQSlem8J8av70IEHgR47lU4,34377
 p3lib/ssh.py,sha256=klqQ9YuqU8GwPVPHrAJeEs5PI5hgoYiXflq2kIGG3as,39509
 p3lib/table_plot.py,sha256=RPncwVlGUkkx5Fw0dHQedXo0TSPlTi__VrJBDzaMsuI,32116
 p3lib/uio.py,sha256=Aaxc99XiE3d2f9vLjaN-bZsckoNxay5t0ujdK6PXGrw,23265
-p3lib-1.1.83.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.83.dist-info/METADATA,sha256=sdLtW4qN9ORZQ_qgptOfxTBUYdxLdFlx_Z6PbewTpc0,918
-p3lib-1.1.83.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-p3lib-1.1.83.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.83.dist-info/RECORD,,
+p3lib-1.1.85.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.85.dist-info/METADATA,sha256=BFEIT34YJ8Db6qzehXyQhcnTtwE6cRBzr_Fdw6hh05A,918
+p3lib-1.1.85.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+p3lib-1.1.85.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.85.dist-info/RECORD,,