PythonExtensionsCollection 0.11.0__py3-none-any.whl → 0.13.0__py3-none-any.whl

PythonExtensionsCollection/Comparison/CComparison.py

@@ -20,7 +20,7 @@
 #
 # XC-CT/ECA3-Queckenstedt
 #
-# 08.11.2022
+# 03.04.2023
 #
 # **************************************************************************************************************
 
@@ -43,13 +43,11 @@ or based on an extract (made with regular expressions) to ensure that only relev
 
    def __init__(self):
       self.__bSkipBlankLines = True
-      self.__bToScreen       = False # content of files will be printed to screen (debug)
-   # eof def __init__(self):
 
    # --------------------------------------------------------------------------------------------------------------
    #TM***
 
-   def Compare(self, sFile_1=None, sFile_2=None, sPatternFile=None):
+   def Compare(self, sFile_1=None, sFile_2=None, sPatternFile=None, sIgnorePatternFile=None, bDebug=False):
       """
 Compares two files. While reading in all files empty lines are skipped.
 
@@ -74,13 +72,20 @@ Compares two files. While reading in all files empty lines are skipped.
   Pattern file containing a set of regular expressions (line by line). The regular expressions are used to make
   an extract of both input files. In this case the extracts are compared (instead of the original file content).
 
+* ``sIgnorePatternFile``
+
+  / *Condition*: optional / *Type*: str  / *Default*: None /
+
+  Pattern file containing a set of strings (**not** regular expressuions; line by line). Every line containing one
+  of the strings, is skipped.
+
 **Returns:**
 
 * ``bIdentical``
 
   / *Type*: bool /
 
-  Indicates if the two input files have the same content or not.
+  Indicates if the two input files (or their extracts) have the same content or not.
 
 * ``bSuccess``
 
@@ -142,23 +147,44 @@ Compares two files. While reading in all files empty lines are skipped.
             sResult  = f"The file '{sPatternFile}' does not exist"
             sResult  = CString.FormatResult(sMethod, bSuccess, sResult)
             return bIdentical, bSuccess, sResult
+      # eof if sPatternFile is not None:
+
+      sIgnorePatterns    = None
+      listIgnorePatterns = None
 
-      if self.__bToScreen is True:
+      if sIgnorePatternFile is not None:
+         # (optional)
+         sIgnorePatternFile = CString.NormalizePath(sIgnorePatternFile)
+         if os.path.isfile(sIgnorePatternFile) is False:
+            bSuccess = False
+            sResult  = f"The file '{sIgnorePatternFile}' does not exist"
+            sResult  = CString.FormatResult(sMethod, bSuccess, sResult)
+            return bIdentical, bSuccess, sResult
+         oIgnorePatternFile = CFile(sIgnorePatternFile)
+         listIgnorePatterns, bSuccess, sResult = oIgnorePatternFile.ReadLines()
+         del oIgnorePatternFile
+         if bSuccess is not True:
+            return bIdentical, bSuccess, CString.FormatResult(sMethod, bSuccess, sResult)
+         if listIgnorePatterns is not None:
+            sIgnorePatterns = ";".join(listIgnorePatterns)
+      # eof if sIgnorePatternFile is not None:
+
+      if bDebug is True:
          print()
          print("[FILE 1]")
       oFile_1 = CFile(sFile_1)
-      listLines_1, bSuccess, sResult = oFile_1.ReadLines(bSkipBlankLines=self.__bSkipBlankLines, bLStrip=True, bRStrip=True, bToScreen=self.__bToScreen)
+      listLines_1, bSuccess, sResult = oFile_1.ReadLines(bSkipBlankLines=self.__bSkipBlankLines, sContainsNot=sIgnorePatterns, bLStrip=True, bRStrip=True, bToScreen=bDebug)
       del oFile_1
       if bSuccess is False:
          del listLines_1
          sResult = CString.FormatResult(sMethod, bSuccess, sResult)
          return bIdentical, bSuccess, sResult
 
-      if self.__bToScreen is True:
+      if bDebug is True:
          print()
          print("[FILE 2]")
       oFile_2 = CFile(sFile_2)
-      listLines_2, bSuccess, sResult = oFile_2.ReadLines(bSkipBlankLines=self.__bSkipBlankLines, bLStrip=True, bRStrip=True, bToScreen=self.__bToScreen)
+      listLines_2, bSuccess, sResult = oFile_2.ReadLines(bSkipBlankLines=self.__bSkipBlankLines, sContainsNot=sIgnorePatterns, bLStrip=True, bRStrip=True, bToScreen=bDebug)
       del oFile_2
       if bSuccess is False:
          del listLines_1
@@ -166,19 +192,20 @@ Compares two files. While reading in all files empty lines are skipped.
          sResult = CString.FormatResult(sMethod, bSuccess, sResult)
          return bIdentical, bSuccess, sResult
 
-      # -- check number of lines
-      nNrOfLines_1 = len(listLines_1)
-      nNrOfLines_2 = len(listLines_2)
-      if nNrOfLines_1 != nNrOfLines_2:
-         del listLines_1
-         del listLines_2
-         bIdentical = False
-         bSuccess   = True
-         sResult    = f"The files contain different number of lines (file 1: {nNrOfLines_1} lines, file 2: {nNrOfLines_2} lines"
-         return bIdentical, bSuccess, sResult
-
       if sPatternFile is None:
          # no pattern given => compare the original version of the files
+
+         # -- check number of lines
+         nNrOfLines_1 = len(listLines_1)
+         nNrOfLines_2 = len(listLines_2)
+         if nNrOfLines_1 != nNrOfLines_2:
+            del listLines_1
+            del listLines_2
+            bIdentical = False
+            bSuccess   = True
+            sResult    = f"The files contain different number of lines (file 1: {nNrOfLines_1} lines, file 2: {nNrOfLines_2} lines"
+            return bIdentical, bSuccess, sResult
+
          for nIndex, sLine_1 in enumerate(listLines_1):
             sLine_2 = listLines_2[nIndex]
             if sLine_1 != sLine_2:
@@ -189,12 +216,12 @@ Compares two files. While reading in all files empty lines are skipped.
                sResult    = f"Found deviating lines\n(1) '{sLine_1}'\n(2) '{sLine_2}'"
                return bIdentical, bSuccess, sResult
       else:
-         if self.__bToScreen is True:
+         if bDebug is True:
             print()
             print("[PATTERN]")
          # -- read pattern for comparison of files
          oPatternFile = CFile(sPatternFile)
-         listPatterns, bSuccess, sResult = oPatternFile.ReadLines(bSkipBlankLines=True, bLStrip=True, bRStrip=True, bToScreen=self.__bToScreen)
+         listPatterns, bSuccess, sResult = oPatternFile.ReadLines(bSkipBlankLines=True, bLStrip=True, bRStrip=True, bToScreen=bDebug)
          del oPatternFile
          if bSuccess is False:
             del listPatterns
@@ -208,20 +235,36 @@ Compares two files. While reading in all files empty lines are skipped.
          # -- apply pattern to content of file 1
          listSubsetLines_1 = []
          for sLine in listLines_1:
+            listLineParts_1 = []
             for RegEx in listRegEx:
                listPositions = RegEx.findall(sLine)
                if len(listPositions) > 0:
-                  listSubsetLines_1.append(listPositions[0])
+                  for position in listPositions:
+                     if isinstance(position, (tuple, list)):
+                        for subposition in position:
+                           listLineParts_1.append(subposition)
+                     else:
+                        listLineParts_1.append(position)
+                  sLineNew_1 = " || ".join(listLineParts_1)
+                  listSubsetLines_1.append(sLineNew_1)
                   break # for RegEx in listRegEx:
          # eof for sLine in listLines_1:
          del listLines_1
          # -- apply pattern to content of file 2
          listSubsetLines_2 = []
          for sLine in listLines_2:
+            listLineParts_2 = []
             for RegEx in listRegEx:
                listPositions = RegEx.findall(sLine)
                if len(listPositions) > 0:
-                  listSubsetLines_2.append(listPositions[0])
+                  for position in listPositions:
+                     if isinstance(position, (tuple, list)):
+                        for subposition in position:
+                           listLineParts_2.append(subposition)
+                     else:
+                        listLineParts_2.append(position)
+                  sLineNew_2 = " || ".join(listLineParts_2)
+                  listSubsetLines_2.append(sLineNew_2)
                   break # for RegEx in listRegEx:
          # eof for sLine in listLines_2:
          del listLines_2
@@ -231,6 +274,17 @@ Compares two files. While reading in all files empty lines are skipped.
          nNrOfSubsetLines_1 = len(listSubsetLines_1)
          nNrOfSubsetLines_2 = len(listSubsetLines_2)
          if nNrOfSubsetLines_1 != nNrOfSubsetLines_2:
+            print()
+            print(120*"-")
+            print("[SUBSET 1]")
+            sSubset1 = "\n".join(listSubsetLines_1)
+            print(f"{sSubset1}")
+            print(120*"-")
+            print("[SUBSET 2]")
+            sSubset2 = "\n".join(listSubsetLines_2)
+            print(f"{sSubset2}")
+            print(120*"-")
+            print()
             del listSubsetLines_1
             del listSubsetLines_2
             bIdentical = False
@@ -244,6 +298,18 @@ Compares two files. While reading in all files empty lines are skipped.
             if sLine_1 != sLine_2:
                del listSubsetLines_1
                del listSubsetLines_2
+               if bDebug is True:
+                  print()
+                  print(120*"-")
+                  print("[SUBSET 1]")
+                  sSubset1 = "\n".join(listSubsetLines_1)
+                  print(f"{sSubset1}")
+                  print(120*"-")
+                  print("[SUBSET 2]")
+                  sSubset2 = "\n".join(listSubsetLines_2)
+                  print(f"{sSubset2}")
+                  print(120*"-")
+                  print()
                bIdentical = False
                bSuccess   = True
                sResult    = f"Found deviating lines\n(1) '{sLine_1}'\n(2) '{sLine_2}'"

PythonExtensionsCollection/Utils/CUtils.py

@@ -20,7 +20,7 @@
 #
 # XC-CT/ECA3-Queckenstedt
 #
-# 15.11.2022
+# 29.03.2023
 #
 # **************************************************************************************************************
 
@@ -179,25 +179,25 @@ The method ``TypePrint`` computes details about the input variable ``oData``.
          sOut = sGlobalPrefix + " " + sLocalPrefix + "  :  " + str(oData)
          self.listOutLines.append(sOut.strip())
 
-      elif type(oData) == int:
+      elif type(oData) is int:
          sLocalPrefix = "[INT]"
          sGlobalPrefix = " ".join(self.listGlobalPrefixes)
          sOut = sGlobalPrefix + " " + sLocalPrefix + "  :  " + str(oData)
          self.listOutLines.append(sOut.strip())
 
-      elif type(oData) == float:
+      elif type(oData) is float:
          sLocalPrefix = "[FLOAT]"
          sGlobalPrefix = " ".join(self.listGlobalPrefixes)
          sOut = sGlobalPrefix + " " + sLocalPrefix + "  :  " + str(oData)
          self.listOutLines.append(sOut.strip())
 
-      elif type(oData) == bool:
+      elif type(oData) is bool:
          sLocalPrefix = "[BOOL]"
          sGlobalPrefix = " ".join(self.listGlobalPrefixes)
          sOut = sGlobalPrefix + " " + sLocalPrefix + "  :  " + str(oData)
          self.listOutLines.append(sOut.strip())
 
-      elif type(oData) == str:
+      elif type(oData) is str:
          sLocalPrefix = "[STR]"
          sGlobalPrefix = " ".join(self.listGlobalPrefixes)
          sData = str(oData)
@@ -206,7 +206,7 @@ The method ``TypePrint`` computes details about the input variable ``oData``.
          sOut = sGlobalPrefix + " " + sLocalPrefix + "  :  '" + sData + "'"
          self.listOutLines.append(sOut.strip())
 
-      elif type(oData) == list:
+      elif type(oData) is list:
          nNrOfElements = len(oData)
          if nNrOfElements == 0:
             # -- indicate empty list
@@ -226,7 +226,7 @@ The method ``TypePrint`` computes details about the input variable ``oData``.
                del self.listGlobalPrefixes[-1]      # remove prefix count
             del self.listGlobalPrefixes[-1]         # remove prefix name
 
-      elif type(oData) == tuple:
+      elif type(oData) is tuple:
          nNrOfElements = len(oData)
          if nNrOfElements == 0:
             # -- indicate empty tuple
@@ -246,7 +246,7 @@ The method ``TypePrint`` computes details about the input variable ``oData``.
                del self.listGlobalPrefixes[-1]      # remove prefix count
             del self.listGlobalPrefixes[-1]         # remove prefix name
 
-      elif type(oData) == set:
+      elif type(oData) is set:
          nNrOfElements = len(oData)
          if nNrOfElements == 0:
             # -- indicate empty set
@@ -266,7 +266,7 @@ The method ``TypePrint`` computes details about the input variable ``oData``.
                del self.listGlobalPrefixes[-1]      # remove prefix count
             del self.listGlobalPrefixes[-1]         # remove prefix name
 
-      elif type(oData) == dict:
+      elif type(oData) is dict:
          nNrOfElements = len(oData)
          if nNrOfElements == 0:
             # -- indicate empty dictionary
@@ -288,8 +288,7 @@ The method ``TypePrint`` computes details about the input variable ``oData``.
                del self.listGlobalPrefixes[-1]    # remove prefix count
             del self.listGlobalPrefixes[-1]       # remove prefix name
 
-      # elif type(oData) == dotdict:
-      elif ( (type(oData) == dotdict) or (str(type(oData)) == "<class 'robot.utils.dotdict.DotDict'>") ):
+      elif ( (type(oData) is dotdict) or (str(type(oData)) == "<class 'robot.utils.dotdict.DotDict'>") or (str(type(oData)) == "<class 'RobotFramework_TestsuitesManagement.Config.CConfig.dotdict'>") ):
          nNrOfElements = len(oData)
          if nNrOfElements == 0:
             # -- indicate empty dot dictionary

PythonExtensionsCollection/version.py

@@ -18,6 +18,6 @@
 #
 # Version and date of PythonExtensionsCollection
 #
-VERSION      = "0.11.0"
-VERSION_DATE = "15.11.2022"
+VERSION      = "0.13.0"
+VERSION_DATE = "03.04.2023"
 

{PythonExtensionsCollection-0.11.0.dist-info → PythonExtensionsCollection-0.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PythonExtensionsCollection
-Version: 0.11.0
+Version: 0.13.0
 Summary: Additional Python functions
 Home-page: https://github.com/test-fullautomation/python-extensions-collection
 Author: Holger Queckenstedt
@@ -16,38 +16,54 @@ Classifier: Topic :: Software Development
 Requires-Python: >=3.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pypandoc
-Requires-Dist: colorama
-Requires-Dist: GenPackageDoc
+Requires-Dist: dotdict
 
 Package Description
 ===================
 
-The *Python Extensions Collection* package extends the functionality of
+The **PythonExtensionsCollection** package extends the functionality of
 Python by some useful functions that are not available in Python
 immediately.
 
 How to install
 --------------
 
-Firstly clone the **python-extensions-collection** repository to your
-machine.
+The **PythonExtensionsCollection** can be installed in two different
+ways.
 
-``` {.sourceCode .}
-git clone https://github.com/test-fullautomation/python-extensions-collection.git
-```
+1.  Installation via PyPi (recommended for users)
 
-Use the following command to install this package:
+    ``` {.}
+    pip install PythonExtensionsCollection
+    ```
 
-``` {.sourceCode .}
-setup.py install
-```
+    [PythonExtensionsCollection in
+    PyPi](https://pypi.org/project/PythonExtensionsCollection/)
+
+2.  Installation via GitHub (recommended for developers)
+
+    Clone the **python-extensions-collection** repository to your
+    machine.
+
+    ``` {.}
+    git clone https://github.com/test-fullautomation/python-extensions-collection.git
+    ```
+
+    [PythonExtensionsCollection in
+    GitHub](https://github.com/test-fullautomation/python-extensions-collection)
+
+    Use the following command to install the
+    **PythonExtensionsCollection**:
+
+    ``` {.}
+    setup.py install
+    ```
 
 Package Documentation
 ---------------------
 
-A detailed documentation of the *Python Extensions Collection* package
-can be found here:
+A detailed documentation of the **PythonExtensionsCollection** can be
+found here:
 [PythonExtensionsCollection.pdf](https://github.com/test-fullautomation/python-extensions-collection/blob/develop/PythonExtensionsCollection/PythonExtensionsCollection.pdf)
 
 Feedback

{PythonExtensionsCollection-0.11.0.dist-info → PythonExtensionsCollection-0.13.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-PythonExtensionsCollection/PythonExtensionsCollection.pdf,sha256=qKC30ANLBnfa-yvs3HKaiM4UrfoeAJsFLA_d6TtHpuo,280861
+PythonExtensionsCollection/PythonExtensionsCollection.pdf,sha256=H1EVoh3wU2adU7jFvtq0xCrac2Nik2FvMYNjBojLtE4,281523
 PythonExtensionsCollection/__init__.py,sha256=hr5YI0Et3k8uubFLR_hLILpLtqgnJvEYil0neGoKXhA,596
-PythonExtensionsCollection/version.py,sha256=7ZRtPov2AMZsawAtF4VQLqqefGQWaH_k2er1E7fwJWA,932
-PythonExtensionsCollection/Comparison/CComparison.py,sha256=6RVxbZ_IqxSDgu-TB1PpIunblgTv51yLToN18jspliM,9779
+PythonExtensionsCollection/version.py,sha256=w9Xlc1o3uKY2FoynLeHuH5Ii8jBKW7c_eTtfPTThFTQ,932
+PythonExtensionsCollection/Comparison/CComparison.py,sha256=QS9ianplFbS8aN1oT8ax2kgh1TT6lE1djQhljJqloCQ,12552
 PythonExtensionsCollection/Comparison/__init__.py,sha256=hr5YI0Et3k8uubFLR_hLILpLtqgnJvEYil0neGoKXhA,596
 PythonExtensionsCollection/File/CFile.py,sha256=vLEmVnYowxqLilEtQmPuomUBiyABEtnUu5XFZW27skU,36382
 PythonExtensionsCollection/File/__init__.py,sha256=hr5YI0Et3k8uubFLR_hLILpLtqgnJvEYil0neGoKXhA,596
@@ -9,10 +9,10 @@ PythonExtensionsCollection/Folder/CFolder.py,sha256=WUMITkZnpPNdxGPZraPsmxe0IzGm
 PythonExtensionsCollection/Folder/__init__.py,sha256=hr5YI0Et3k8uubFLR_hLILpLtqgnJvEYil0neGoKXhA,596
 PythonExtensionsCollection/String/CString.py,sha256=iJxfMW5NwJ5Mc9sFqHMWrNMTfH2KgAzPj19Mask4cig,37642
 PythonExtensionsCollection/String/__init__.py,sha256=hr5YI0Et3k8uubFLR_hLILpLtqgnJvEYil0neGoKXhA,596
-PythonExtensionsCollection/Utils/CUtils.py,sha256=EDJYc7h9c4U237IlfZNqJOss3EfJ4XS0AX9ydyrd-Ag,11867
+PythonExtensionsCollection/Utils/CUtils.py,sha256=bwYFsIMC-kwlrzPutmqTd7C4XoQXiKLLxI7vD_TXIgk,11926
 PythonExtensionsCollection/Utils/__init__.py,sha256=hr5YI0Et3k8uubFLR_hLILpLtqgnJvEYil0neGoKXhA,596
-PythonExtensionsCollection-0.11.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-PythonExtensionsCollection-0.11.0.dist-info/METADATA,sha256=IjLKpJpYTf69Jy7oAnD6e3QSUfjVE-ithjmWt8789rg,2777
-PythonExtensionsCollection-0.11.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-PythonExtensionsCollection-0.11.0.dist-info/top_level.txt,sha256=xv5w-C3GQkdbxctBNzEqPfWvpJ1kpAaHBe3TEdGcozQ,27
-PythonExtensionsCollection-0.11.0.dist-info/RECORD,,
+PythonExtensionsCollection-0.13.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+PythonExtensionsCollection-0.13.0.dist-info/METADATA,sha256=WTzPez6NAEOSrtfnjKOrsw4YntvYx_duhi92EUQvYZQ,3211
+PythonExtensionsCollection-0.13.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+PythonExtensionsCollection-0.13.0.dist-info/top_level.txt,sha256=xv5w-C3GQkdbxctBNzEqPfWvpJ1kpAaHBe3TEdGcozQ,27
+PythonExtensionsCollection-0.13.0.dist-info/RECORD,,

{PythonExtensionsCollection-0.11.0.dist-info → PythonExtensionsCollection-0.13.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.38.4)
+Generator: bdist_wheel (0.40.0)
 Root-Is-Purelib: true
 Tag: py3-none-any