PythonExtensionsCollection 0.14.0__py3-none-any.whl → 0.15.1__py3-none-any.whl

PythonExtensionsCollection/Comparison/CComparison.py

@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

PythonExtensionsCollection/Comparison/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

PythonExtensionsCollection/File/CFile.py

@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

PythonExtensionsCollection/File/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

PythonExtensionsCollection/Folder/CFolder.py

@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

PythonExtensionsCollection/Folder/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

PythonExtensionsCollection/String/CString.py

@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -20,12 +20,12 @@
 #
 # XC-CT/ECA3-Queckenstedt
 #
-# 14.11.2022
+# 19.10.2023
 #
 # **************************************************************************************************************
 
 # -- import standard Python modules
-import os, ntpath, re
+import os, ntpath, platform, re
 
 # **************************************************************************************************************
 
@@ -47,7 +47,8 @@ Normalizes local paths, paths to local network resources and internet addresses
 
   / *Condition*: required / *Type*: str /
 
-  The path to be normalized
+  The path to be normalized. Paths can start with environment variables. Accepted are notations for both Windows
+  (``%ENVVAR%``) and Linux (``${ENVVAR}``). Under Windows also the Linux notation will be resolved.
 
 * ``bWin``
 
@@ -94,10 +95,6 @@ Normalizes local paths, paths to local network resources and internet addresses
 
       if sPath is not None:
 
-         # -- expand Windows environment variables
-         if bExpandEnvVars is True:
-            sPath = os.path.expandvars(sPath)
-
          # - remove leading and trailing horizontal space
          sPath = sPath.strip(" \t\r\n")
 
@@ -115,6 +112,20 @@ Normalizes local paths, paths to local network resources and internet addresses
          # - remove trailing slash or backslash (maybe at end of path to folder)
          sPath = sPath.rstrip("/\\")
 
+         # -- expand environment variables
+         if bExpandEnvVars is True:
+            sPattern_envvar = r"^\$\{(\w+?)\}" # check for Linux notation (shall be usable also under Windows)
+            regex_envvar    = re.compile(sPattern_envvar)
+            sPlatformSystem = platform.system()
+            sPathModified = sPath
+            for sEnvVar in regex_envvar.findall(sPath):
+               sSearch = "${" + sEnvVar + "}"
+               if sPlatformSystem == "Windows":
+                  sReplace = "%" + sEnvVar + "%"
+                  sPathModified = sPathModified.replace(sSearch, sReplace)
+            # eof for sEnvVar in regex_envvar.findall(sPath):
+            sPath = os.path.expandvars(sPathModified)
+
          # --------------------------------------------------------------------------------------------------------------
          # consider internet addresses and local network resources
          # --------------------------------------------------------------------------------------------------------------
@@ -480,7 +491,7 @@ while walking through the file system.
 
   / *Condition*: required / *Type*: str /
 
-  The input string that has to be investigated. 
+  The input string that has to be investigated.
 
 * ``bCaseSensitive``
 

PythonExtensionsCollection/String/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

PythonExtensionsCollection/Utils/CUtils.py

@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -20,13 +20,18 @@
 #
 # XC-CT/ECA3-Queckenstedt
 #
-# 29.03.2023
+# 30.05.2023
 #
 # **************************************************************************************************************
 
 # -- import standard Python modules
+import os, sys, subprocess
 from dotdict import dotdict
 
+from PythonExtensionsCollection.String.CString import CString
+from PythonExtensionsCollection.File.CFile import CFile
+
+
 # **************************************************************************************************************
 # wrapper
 # **************************************************************************************************************
@@ -288,7 +293,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) is dotdict) or (str(type(oData)) == "<class 'robot.utils.dotdict.DotDict'>") or (str(type(oData)) == "<class 'RobotFramework_TestsuitesManagement.Config.CConfig.dotdict'>") ):
+      elif ( (type(oData) is dotdict) or (str(type(oData)) == "<class 'robot.utils.dotdict.DotDict'>") ):
          nNrOfElements = len(oData)
          if nNrOfElements == 0:
             # -- indicate empty dot dictionary
@@ -325,5 +330,121 @@ The method ``TypePrint`` computes details about the input variable ``oData``.
 
 # eof class CTypePrint():
 
+
+# --------------------------------------------------------------------------------------------------------------
+# TM***
+
+class CUtils(object):
+   """The class ``CUtils`` contains useful methods.
+   """
+
+   def GetInstalledPackages(sOutputFile=None):
+      """The method ``GetInstalledPackages`` computes a list of all installed Python packages.
+The list is returned as list of tuples containing the name and the version of the package.
+
+It is also possible to let the method dump the list to a text file.
+
+**Arguments:**
+
+* ``sOutputFile``
+
+  / *Condition*: optional / *Type*: string / *Default*: None /
+
+  Path and name of a file to dump the package list to.
+
+**Returns:**
+
+* ``listofTuplesPackages``
+
+  / *Type*: list /
+
+  List of tuples containing the name and the version of the package.
+
+* ``bSuccess``
+
+  / *Type*: bool /
+
+  Indicates if the computation of the method was successful or not.
+
+* ``sResult``
+
+  / *Type*: str /
+
+  The result of the computation of the method.
+      """
+
+      sMethod  = "GetInstalledPackages"
+      bSuccess = None
+      sResult  = "UNKNOWN"
+
+      listofTuplesPackages = []
+
+      sFreezeData = None
+      try:
+         sFreezeData = subprocess.check_output([sys.executable, '-m', 'pip', 'freeze'], encoding="utf-8", text=True)
+      except Exception as reason:
+         bSuccess = None
+         sResult  = str(reason)
+         sResult  = CString.FormatResult(sMethod, bSuccess, sResult)
+         return listofTuplesPackages, bSuccess, sResult
+
+      if sFreezeData is None:
+         bSuccess = None
+         sResult  = "sFreezeData is None"
+         sResult  = CString.FormatResult(sMethod, bSuccess, sResult)
+         return listofTuplesPackages, bSuccess, sResult
+
+      sFreezeData = str(sFreezeData) # to make the content 'split()' save
+
+      for sPackage in sFreezeData.split():
+         sName    = None
+         sVersion = None
+         listParts = sPackage.split('==')
+         if len(listParts) != 2:
+            sName    = sPackage
+            sVersion = "UNKNOWN"
+            # but I really would not expect this
+         else:
+            sName    = listParts[0]
+            sVersion = listParts[1]
+         listofTuplesPackages.append((sName, sVersion))
+      # eof for sPackage in sFreezeData.split():
+
+      nNrOfPackages = len(listofTuplesPackages)
+
+      if sOutputFile is not None:
+         sOutputFile = CString.NormalizePath(sOutputFile)
+         sParentDirectory = os.path.dirname(sOutputFile)
+         if not os.path.isdir(sParentDirectory):
+            bSuccess = False
+            sResult  = f"The folder to store the output file does not exist: '{sParentDirectory}'"
+            return listofTuplesPackages, bSuccess, sResult
+
+         oFile = CFile(sOutputFile)
+         for tuplePackage in listofTuplesPackages:
+            sName    = tuplePackage[0]
+            sVersion = tuplePackage[1]
+            sOut = sName.rjust(40) + " = " + sVersion
+            bSuccess, sResult = oFile.Write(sOut)
+         del oFile
+
+      # eof if sOutputFile is not None:
+
+      bSuccess = True
+      sResult  = f"Identified {nNrOfPackages} packages."
+
+      return listofTuplesPackages, bSuccess, sResult
+
+   # eof def GetInstalledPackages(sOutputFile=None):
+
+   # --------------------------------------------------------------------------------------------------------------
+   #TM***
+
+   # - make the methods static
+
+   GetInstalledPackages = staticmethod(GetInstalledPackages)
+
+# eof class CUtils(object):
+
 # **************************************************************************************************************
 

PythonExtensionsCollection/Utils/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

PythonExtensionsCollection/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

PythonExtensionsCollection/version.py

@@ -1,6 +1,6 @@
 # **************************************************************************************************************
 #
-#  Copyright 2020-2022 Robert Bosch GmbH
+#  Copyright 2020-2023 Robert Bosch GmbH
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -18,6 +18,6 @@
 #
 # Version and date of PythonExtensionsCollection
 #
-VERSION      = "0.14.0"
-VERSION_DATE = "05.05.2023"
+VERSION      = "0.15.1"
+VERSION_DATE = "19.10.2023"
 

{PythonExtensionsCollection-0.14.0.dist-info → PythonExtensionsCollection-0.15.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PythonExtensionsCollection
-Version: 0.14.0
+Version: 0.15.1
 Summary: Additional Python functions
 Home-page: https://github.com/test-fullautomation/python-extensions-collection
 Author: Holger Queckenstedt
@@ -21,9 +21,8 @@ Requires-Dist: dotdict
 Package Description
 ===================
 
-The **PythonExtensionsCollection** package extends the functionality of
-Python by some useful functions that are not available in Python
-immediately.
+The **PythonExtensionsCollection** extends the functionality of Python
+by some useful functions that are not available in Python immediately.
 
 How to install
 --------------
@@ -42,22 +41,59 @@ ways.
 
 2.  Installation via GitHub (recommended for developers)
 
-    Clone the **python-extensions-collection** repository to your
-    machine.
+    -   Clone the **python-extensions-collection** repository to your
+        machine.
 
-    ``` {.}
-    git clone https://github.com/test-fullautomation/python-extensions-collection.git
-    ```
+        ``` {.}
+        git clone https://github.com/test-fullautomation/python-extensions-collection.git
+        ```
 
-    [PythonExtensionsCollection in
-    GitHub](https://github.com/test-fullautomation/python-extensions-collection)
+        [PythonExtensionsCollection in
+        GitHub](https://github.com/test-fullautomation/python-extensions-collection)
 
-    Use the following command to install the
-    **PythonExtensionsCollection**:
+    -   Install dependencies
 
-    ``` {.}
-    setup.py install
-    ```
+        **PythonExtensionsCollection** requires some additional Python
+        libraries. Before you install the cloned repository sources you
+        have to install the dependencies manually. The names of all
+        related packages you can find in the file `requirements.txt` in
+        the repository root folder. Use pip to install them:
+
+        ``` {.}
+        pip install -r ./requirements.txt
+        ```
+
+        Additionally install **LaTeX** (recommended: TeX Live). This is
+        used to render the documentation.
+
+    -   Configure dependencies
+
+        The installation of **PythonExtensionsCollection** includes to
+        generate the documentation in PDF format. This is done by an
+        application called **GenPackageDoc**, that is part of the
+        installation dependencies (see `requirements.txt`).
+
+        **GenPackageDoc** uses **LaTeX** to generate the documentation
+        in PDF format. Therefore **GenPackageDoc** needs to know where
+        to find **LaTeX**. This is defined in the **GenPackageDoc**
+        configuration file
+
+        ``` {.}
+        packagedoc\packagedoc_config.json
+        ```
+
+        Before you start the installation you have to introduce the
+        following environment variable, that is used in
+        `packagedoc_config.json`:
+
+        -   `GENDOC_LATEXPATH` : path to `pdflatex` executable
+
+    -   Use the following command to install the
+        **PythonExtensionsCollection**:
+
+        ``` {.}
+        setup.py install
+        ```
 
 Package Documentation
 ---------------------
@@ -92,7 +128,7 @@ Contributors
 License
 -------
 
-Copyright 2020-2022 Robert Bosch GmbH
+Copyright 2020-2023 Robert Bosch GmbH
 
 Licensed under the Apache License, Version 2.0 (the \"License\"); you
 may not use this file except in compliance with the License. You may

PythonExtensionsCollection-0.15.1.dist-info/RECORD

@@ -0,0 +1,18 @@
+PythonExtensionsCollection/PythonExtensionsCollection.pdf,sha256=jX_yZLHxyixRqoUkmBAZilWhwc4aeGpJB8rSzOw-fJ8,286711
+PythonExtensionsCollection/__init__.py,sha256=YKDTJjDsnQkr5X-gjjO8opwKUVKm6kc8sIUpURYMk48,596
+PythonExtensionsCollection/version.py,sha256=mCVk09gvDXhYgM4Cn5luDuiWWMpD2aqVA7ZjYKdA7kk,932
+PythonExtensionsCollection/Comparison/CComparison.py,sha256=MfA1JX7DVUtPPyFNINGmcG5c_euB1foW5X1CSXGJwZM,12552
+PythonExtensionsCollection/Comparison/__init__.py,sha256=YKDTJjDsnQkr5X-gjjO8opwKUVKm6kc8sIUpURYMk48,596
+PythonExtensionsCollection/File/CFile.py,sha256=5idGq3H35azgmB-lFHNDFmdUKUzSln0J7narq7u6fJw,36382
+PythonExtensionsCollection/File/__init__.py,sha256=YKDTJjDsnQkr5X-gjjO8opwKUVKm6kc8sIUpURYMk48,596
+PythonExtensionsCollection/Folder/CFolder.py,sha256=3a-KXyUoeUwVtH4Bhb9EMP1r3btUI1cnbtQAd5bFNfQ,15985
+PythonExtensionsCollection/Folder/__init__.py,sha256=YKDTJjDsnQkr5X-gjjO8opwKUVKm6kc8sIUpURYMk48,596
+PythonExtensionsCollection/String/CString.py,sha256=oIb8MeZoEdF8KrDPNhnj0o3K4HR6lO9ZEN9gVv8FwzU,38423
+PythonExtensionsCollection/String/__init__.py,sha256=YKDTJjDsnQkr5X-gjjO8opwKUVKm6kc8sIUpURYMk48,596
+PythonExtensionsCollection/Utils/CUtils.py,sha256=l8u_MYKLAwFvA9jQnoKSiMwDJ2JeJAZj76MzmoT4bQ4,15438
+PythonExtensionsCollection/Utils/__init__.py,sha256=YKDTJjDsnQkr5X-gjjO8opwKUVKm6kc8sIUpURYMk48,596
+PythonExtensionsCollection-0.15.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+PythonExtensionsCollection-0.15.1.dist-info/METADATA,sha256=22ftGaKHI_KoqZsB864pFyUuBTGim1w1g7sQZNnKnW8,4643
+PythonExtensionsCollection-0.15.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+PythonExtensionsCollection-0.15.1.dist-info/top_level.txt,sha256=xv5w-C3GQkdbxctBNzEqPfWvpJ1kpAaHBe3TEdGcozQ,27
+PythonExtensionsCollection-0.15.1.dist-info/RECORD,,

{PythonExtensionsCollection-0.14.0.dist-info → PythonExtensionsCollection-0.15.1.dist-info}/WHEEL

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

PythonExtensionsCollection-0.14.0.dist-info/RECORD

@@ -1,18 +0,0 @@
-PythonExtensionsCollection/PythonExtensionsCollection.pdf,sha256=ngU8amGGVFTc1RfGYzPsZJjlrTnujpwZaTRKPkVxO9c,275407
-PythonExtensionsCollection/__init__.py,sha256=hr5YI0Et3k8uubFLR_hLILpLtqgnJvEYil0neGoKXhA,596
-PythonExtensionsCollection/version.py,sha256=H0-uXWqTQ2z-mHvg5TRWv7LPKCLGJJNQwtHRDlDXVec,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
-PythonExtensionsCollection/Folder/CFolder.py,sha256=WUMITkZnpPNdxGPZraPsmxe0IzGmlZBbeEwiKv4AR7o,15985
-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=bwYFsIMC-kwlrzPutmqTd7C4XoQXiKLLxI7vD_TXIgk,11926
-PythonExtensionsCollection/Utils/__init__.py,sha256=hr5YI0Et3k8uubFLR_hLILpLtqgnJvEYil0neGoKXhA,596
-PythonExtensionsCollection-0.14.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-PythonExtensionsCollection-0.14.0.dist-info/METADATA,sha256=wiAELBSU0MJfR8tupyjK1mvaozcecrYFFJcIg4eaaXE,3211
-PythonExtensionsCollection-0.14.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-PythonExtensionsCollection-0.14.0.dist-info/top_level.txt,sha256=xv5w-C3GQkdbxctBNzEqPfWvpJ1kpAaHBe3TEdGcozQ,27
-PythonExtensionsCollection-0.14.0.dist-info/RECORD,,