lyrpy 2024.0.4__py3-none-any.whl → 2025.0.2__py3-none-any.whl

SRC/lyrpy/LUParserINI.py

@@ -0,0 +1,376 @@
+"""LUParserINI.py"""
+# -*- coding: UTF-8 -*-
+__annotations__ = """
+ =======================================================
+ Copyright (c) 2023-2024
+ Author:
+     Lisitsin Y.R.
+ Project:
+     LU_PY
+     Python (LU)
+ Module:
+     LUParserINI.py
+
+ =======================================================
+"""
+
+#------------------------------------------
+# БИБЛИОТЕКИ python
+#------------------------------------------
+import configparser
+import logging
+
+#------------------------------------------
+# БИБЛИОТЕКИ сторонние
+#------------------------------------------
+
+#------------------------------------------
+# БИБЛИОТЕКА LU
+#------------------------------------------
+import lyrpy.LULog as LULog
+import lyrpy.LUConst as LUConst
+import lyrpy.LUFile as LUFile
+import lyrpy.LUos as LUos
+import lyrpy.LUStrDecode as LUStrDecode
+import lyrpy.LUStrUtils as LUStrUtils
+
+class TINIFile (configparser.ConfigParser):
+    """TINIFile"""
+    luClassName = 'TINIFile'
+
+    #--------------------------------------------------
+    # constructor
+    #--------------------------------------------------
+    """
+    class configparser.ConfigParser (
+        defaults=None,
+        dict_type=dict,
+        allow_no_value=False,
+        delimiters=('=', ':'),
+        comment_prefixes=('#', ';'),
+        inline_comment_prefixes=None,
+        strict=True,
+        empty_lines_in_values=True,
+        default_section=configparser.DEFAULTSECT,
+        interpolation=BasicInterpolation(),
+        converters={}
+        )
+    """
+    @staticmethod
+    def __GetINIFileName (AFileName: str) -> str:
+        """__GetINIFileName"""
+    #beginfunction
+        LResult = ''
+        P = LUFile.ExtractFileDir (AFileName)
+        F = LUFile.ExtractFileName (AFileName)
+        E = LUFile.ExtractFileExt (AFileName)
+        if E == '':
+            F = F + '.ini'
+        #endif
+        if P == '':
+            LWinDir = LUos.GetEnvVar (LUos.cWINDIR)
+            LPath = [LUos.GetCurrentDir (), LWinDir]
+
+            LList = LUFile.SearchFileDirs (LPath, F, '', '', False)
+            if len(LList) > 0:
+                LResult = LList[0]
+            #endif
+            if LResult == '':
+                LResult = LUFile.IncludeTrailingBackslash (LWinDir) + F
+            #endif
+        else:
+            LResult = LUFile.ExpandFileName (AFileName)
+        #endif
+        return LResult
+    #endfunction
+
+    def __init__ (self, empty_lines_in_values=True, **kwargs):      # allow_no_value=True
+        """Constructor"""
+    #beginfunction
+        super ().__init__ (empty_lines_in_values=True, **kwargs)
+        self.__FSectionName: str = ''
+        self.__FOptionName: str = ''
+        self.__FOptionValue: str = ''
+        self.__FChangedFileINI: bool = False
+        self.__FFileNameINI: str = ''
+    #endfunction
+
+    #--------------------------------------------------
+    # destructor
+    #--------------------------------------------------
+    def __del__ (self):
+        """destructor"""
+    #beginfunction
+        LClassName = self.__class__.__name__
+        # s = '{} уничтожен'.format (LClassName)
+        # LULog.LoggerTOOLS_AddLevel (LULog.DEBUGTEXT, s)
+        #print (s)
+    #endfunction
+
+    #--------------------------------------------------
+    # @property ConfigParser
+    #--------------------------------------------------
+    # getter
+    @property
+    def ConfigParser(self) -> configparser.ConfigParser:
+    #beginfunction
+        return self
+    #endfunction
+
+    #--------------------------------------------------
+    # @property Sections
+    #--------------------------------------------------
+    # getter
+    @property
+    def Sections(self):
+    #beginfunction
+        return self.sections()
+    #endfunction
+
+    #--------------------------------------------------
+    # @property Options
+    #--------------------------------------------------
+    # getter
+    @property
+    def Options(self):
+    #beginfunction
+        return self.options(self.SectionName)
+    #endfunction
+
+    #--------------------------------------------------
+    # @property SectionName
+    #--------------------------------------------------
+    # getter
+    @property
+    def SectionName(self):
+    #beginfunction
+        return self.__FSectionName
+    #endfunction
+    # setter
+    @SectionName.setter
+    def SectionName (self, AValue: str):
+    #beginfunction
+        self.__FSectionName = AValue
+    #endfunction
+
+    #--------------------------------------------------
+    # @property OptionName
+    #--------------------------------------------------
+    # getter
+    @property
+    def OptionName(self):
+    #beginfunction
+        return self.__FOptionName
+    #endfunction
+    # setter
+    @OptionName.setter
+    def OptionName (self, AValue: str):
+    #beginfunction
+        self.__FOptionName = AValue
+    #endfunction
+
+    #--------------------------------------------------
+    # @property OptionValue
+    #--------------------------------------------------
+    # getter
+    @property
+    def OptionValue(self):
+    #beginfunction
+        self.__FOptionValue = self.get(self.SectionName, self.OptionName)
+        return self.__FOptionValue
+    #endfunction
+    # setter
+    @OptionValue.setter
+    def OptionValue (self, AValue: str):
+    #beginfunction
+        self.__FOptionValue = AValue
+        self.set(self.SectionName, self.OptionName, AValue)
+    #endfunction
+
+    #--------------------------------------------------
+    # @property FileNameINI
+    #--------------------------------------------------
+    # getter
+    @property
+    def FileNameINI(self):
+    #beginfunction
+        return self.__FFileNameINI
+    #endfunction
+    # setter
+    @FileNameINI.setter
+    def FileNameINI (self, AValue: str):
+    #beginfunction
+        LFullFileName = self.__GetINIFileName (AValue)
+        if not LUFile.FileExists (LFullFileName):
+            LFullFileName = LUFile.ExpandFileName (LUFile.ExtractFileName(AValue))
+            LUFile.CreateTextFile (LFullFileName, '', LUStrDecode.cCP1251)
+        self.__FFileNameINI = LFullFileName
+        self.__OpenFileINI ()
+        self.ChangedFileINI = False
+    #endfunction
+
+    #--------------------------------------------------
+    # @property ChangedFileINI
+    #--------------------------------------------------
+    # getter
+    @property
+    def ChangedFileINI(self):
+    #beginfunction
+        return self.__FChangedFileINI
+    #endfunction
+    # setter
+    @ChangedFileINI.setter
+    def ChangedFileINI (self, AValue: bool):
+    #beginfunction
+        self.__FChangedFileINI = AValue
+    #endfunction
+
+    def __OpenFileINI (self):
+        """__OpenFileINI"""
+    #beginfunction
+        self.read (self.FileNameINI)
+    #endfunction
+
+    def IsSection (self, ASectionName: str) -> bool:
+        """IsSection"""
+    #beginfunction
+        return self.has_section(ASectionName)
+    #endfunction
+
+    def IsOption (self, ASectionName: str, AOption: str) -> bool:
+        """IsOption"""
+    #beginfunction
+        return self.has_option(ASectionName, AOption)
+    #endfunction
+
+    def UpdateFileINI (self):
+        """UpdateFileINI"""
+    #beginfunction
+        if self.ChangedFileINI:
+            with open (self.FileNameINI, 'w', encoding = LUStrDecode.cCP1251) as LFileINI:
+                self.write (LFileINI)
+            #endwith
+            self.__OpenFileINI ()
+        #endif
+    #endfunction
+
+    def RefreashOption (self):
+        """RefreashOption"""
+    #beginfunction
+        self.__OpenFileINI ()
+    #endfunction
+
+    def GetOption (self, ASectionName: str, AOptionName: str, AValueDefault):
+        """GetOption"""
+    #beginfunction
+        if self.has_section(ASectionName):
+            if type(AValueDefault) == int:
+                try:
+                    i = self.getint (ASectionName, AOptionName)
+                except:
+                    i = AValueDefault
+                #endtry
+                return i
+            elif type(AValueDefault) == bool:
+                s = self.get(ASectionName, AOptionName)
+                return LUStrUtils.strtobool(s)
+            elif type(AValueDefault) == float:
+                try:
+                    f = self.getfloat (ASectionName, AOptionName)
+                except:
+                    f = AValueDefault
+                #endtry
+                return f
+            else:
+                s = self.get(ASectionName, AOptionName)
+                return s
+            #endif
+        else:
+            return AValueDefault
+        #endif
+    #endfunction
+
+    def SetOption (self, ASectionName: str, AOptionName: str, AValue):
+        """SetOption"""
+    #beginfunction
+        if not self.has_section(ASectionName):
+            self.add_section (ASectionName)
+        #endif
+        s = ''
+        if type(AValue) == int:
+            try:
+                s = str (AValue)
+                self.ChangedFileINI = True
+            except:
+                self.ChangedFileINI = False
+            #endtry
+        elif type(AValue) == bool:
+            s = LUStrUtils.booltostr (AValue)
+            self.ChangedFileINI = True
+        elif type(AValue) == float:
+            try:
+                s = str (AValue)
+                self.ChangedFileINI = True
+            except:
+                self.ChangedFileINI = False
+            #endtry
+        else:
+            s = AValue
+            self.ChangedFileINI = True
+        #endif
+        if self.ChangedFileINI:
+            self.set (ASectionName, AOptionName, s)
+            self.UpdateFileINI ()
+        #endif
+    #endfunction
+
+    def DeleteSection (self, ASectionName: str):
+        """DeleteSection"""
+    #beginfunction
+        if self.IsSection (ASectionName):
+            self.remove_section(ASectionName)
+            self.UpdateFileINI ()
+        #endif
+        self.ChangedFileINI = True
+    #endfunction
+
+    def DeleteOption (self, ASectionName: str, AOptionName: str):
+        """DeleteOption"""
+    #beginfunction
+        if self.IsOption (ASectionName, AOptionName):
+            self.remove_option(ASectionName, AOptionName)
+            self.UpdateFileINI ()
+        #endif
+        self.ChangedFileINI = True
+    #endfunction
+
+#endclass
+
+#---------------------------------------------------------
+# CreateTINIFile
+#---------------------------------------------------------
+def CreateTINIFile () -> TINIFile:
+    """CreateTINIFile"""
+#beginfunction
+    return TINIFile ()
+#endfunction
+
+GINIFile = CreateTINIFile ()
+
+#---------------------------------------------------------
+# main
+#---------------------------------------------------------
+def main ():
+#beginfunction
+    ...
+#endfunction
+
+#------------------------------------------
+#
+#------------------------------------------
+#beginmodule
+if __name__ == "__main__":
+    main()
+#endif
+
+#endmodule