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

PythonExtensionsCollection/Utils/CUtils.py

@@ -20,7 +20,7 @@
 #
 # XC-CT/ECA3-Queckenstedt
 #
-# 26.01.2022
+# 29.03.2023
 #
 # **************************************************************************************************************
 
@@ -33,95 +33,63 @@ from dotdict import dotdict
 
 def PrettyPrint(oData=None, hOutputFile=None, bToConsole=True, nIndent=0, sPrefix=None, bHexFormat=False):
    """
-|
+Wrapper function to create and use a ``CTypePrint`` object. This wrapper function is responsible for
+printing out the content to console and to a file (depending on input parameter).
 
-**Function:**
+The content itself is prepared by the method ``TypePrint`` of class ``CTypePrint``. This happens ``PrettyPrint`` internally.
 
-**PrettyPrint**
+The idea behind the ``PrettyPrint`` function is to resolve also the content of composite data types and provide for every parameter inside:
 
-   Wrapper function to create and use a ``CTypePrint`` object. This wrapper function is responsible for
-   printing out the content to console and to a file (depending on input parameter).
+* the type
+* the total number of elements inside (e.g. the number of keys inside a dictionary)
+* the counter number of the current element
+* the value
 
-   The content itself is prepared by the method ``TypePrint`` of class ``CTypePrint``. This happens ``PrettyPrint`` internally.
+**Arguments:**
 
-   The idea behind the ``PrettyPrint`` function is to resolve also the content of composite data types and provide for every parameter inside:
+* ``oData``
 
-   * the type
-   * the total number of elements inside (e.g. the number of keys inside a dictionary)
-   * the counter number of the current element
-   * the value
+  / *Condition*: required / *Type*: (*any Python data type*) /
 
-   Example call:
+  A variable of any Python data type.
 
-   ``PrettyPrint(oData)`` (*with oData is a Python variable of any type*)
+* ``hOutputFile``
 
-   The output can e.g. look like this:
+  / *Condition*: optional / *Type*: file handle / *Default*: None /
 
-   .. code:: python
+  If handle is not ``None`` the content is written to this file, otherwise not.
 
-      [DICT] (3/1) > {K1} [STR]  :  'Val1'
-      [DICT] (3/2) > {K2} [LIST] (4/1) > [INT]  :  1
-      [DICT] (3/2) > {K2} [LIST] (4/2) > [STR]  :  'A'
-      [DICT] (3/2) > {K2} [LIST] (4/3) > [INT]  :  2
-      [DICT] (3/2) > {K2} [LIST] (4/4) > [TUPLE] (2/1) > [INT]  :  9
-      [DICT] (3/2) > {K2} [LIST] (4/4) > [TUPLE] (2/2) > [STR]  :  'Z'
-      [DICT] (3/3) > {K3} [INT]  :  5
+* ``bToConsole``
 
-   Every line of output has to be interpreted strictly from left to right.
+  / *Condition*: optional / *Type*: bool / *Default*: True /
 
-   For example the meaning of the fifth line of output
+  If ``True`` the content is written to console, otherwise not.
 
-   ``[DICT] (3/2) > {K2} [LIST] (4/4) > [TUPLE] (2/1) > [INT]  :  9``
+* ``nIndent``
 
-   is:
+  / *Condition*: optional / *Type*: int / *Default*: 0 /
 
-   * The type of input parameter (``oData``) is ``dict``
-   * The dictionary contains 3 keys
-   * The current line gives information about the second key of the dictionary
-   * The name of the second key is 'K2'
-   * The value of the second key is of type ``list``
-   * The list contains 4 elements
-   * The current line gives information about the fourth element of the list
-   * The fourth element of the list is of type ``tuple``
-   * The tuple contains 2 elements
-   * The current line gives information about the first element of the tuple
-   * The first element of the tuple is of type ``int`` and has the value 9
+  Sets the number of additional blanks at the beginning of every line of output (indentation).
 
-   Types are encapsulated in square brackets, counter in round brackets and key names are encapsulated in curly brackets.
+* ``sPrefix``
 
-**Args:**
+  / *Condition*: optional / *Type*: str / *Default*: None /
 
-**oData** (*any Python data type*)
+  Sets a prefix string that is added at the beginning of every line of output.
 
-   A variable of any Python data type.
+* ``bHexFormat``
 
-**hOutputFile** (*handle to a file opened for writing or appending; optional; default None*)
+  / *Condition*: optional / *Type*: bool / *Default*: False /
 
-   If handle is not ``None`` the content is written to this file, otherwise not.
-
-**bToConsole** (*bool; optional; default: True*)
-
-   If ``True`` the content is written to console, otherwise not.
-
-**nIndent** (*int; optional; default: 0*)
-
-   Sets the number of additional blanks at the beginning of every line of output (indentation).
-
-**sPrefix** (*str; optional; default: None*)
-
-   Sets a prefix string that is added at the beginning of every line of output.
-
-**bHexFormat** (*bool; optional; default: False*)
-
-   If ``True`` the output is printed in hexadecimal format (but strings only).
+  If ``True`` the output is printed in hexadecimal format (but valid for strings only).
 
 **Returns:**
 
-**listOutLines** (*list*)
+* ``listOutLines`` (*list*)
 
-   List of lines containing the prepared output
+  / *Type*: list /
 
-|
+  List of lines containing the prepared output
    """
 
    oTypePrint   = CTypePrint()
@@ -149,8 +117,19 @@ def PrettyPrint(oData=None, hOutputFile=None, bToConsole=True, nIndent=0, sPrefi
 # --------------------------------------------------------------------------------------------------------------
 # TM***
 
-class CTypePrint():
+class CTypePrint(object):
+   """
+The class ``CTypePrint`` provides a method (``TypePrint``) to compute the following data:
+
+* the type
+* the total number of elements inside (e.g. the number of keys inside a dictionary)
+* the counter number of the current element
+* the value
+
+of simple and composite data types.
 
+The call of this method is encapsulated within the function ``PrettyPrint`` inside this module.
+   """
    def __init__(self):
       self.listGlobalPrefixes = []
       self.listOutLines       = []
@@ -168,6 +147,31 @@ class CTypePrint():
       return sStringHex
 
    def TypePrint(self, oData=None, bHexFormat=False):
+      """
+The method ``TypePrint`` computes details about the input variable ``oData``.
+
+**Arguments:**
+
+* ``oData``
+
+  / *Condition*: required / *Type*: any Python data type /
+
+  Python variable of any data type.
+
+* ``bHexFormat``
+
+  / *Condition*: optional / *Type*: bool / *Default*: False /
+
+  If ``True`` the output is provide in hexadecimal format.
+
+**Returns:**
+
+* ``listOutLines``
+
+  / *Type*: list /
+
+  List of lines containing the resolved content of ``oData``.
+      """
 
       if oData is None:
          sLocalPrefix = "[NONE]"
@@ -175,25 +179,25 @@ class CTypePrint():
          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)
@@ -202,7 +206,7 @@ class CTypePrint():
          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
@@ -222,7 +226,7 @@ class CTypePrint():
                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
@@ -242,7 +246,7 @@ class CTypePrint():
                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
@@ -262,7 +266,7 @@ class CTypePrint():
                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
@@ -284,8 +288,7 @@ class CTypePrint():
                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/Utils/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
+#  Copyright 2020-2022 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 Car Multimedia GmbH
+#  Copyright 2020-2022 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

@@ -0,0 +1,23 @@
+# **************************************************************************************************************
+#
+#  Copyright 2020-2022 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 obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+# **************************************************************************************************************
+#
+# Version and date of PythonExtensionsCollection
+#
+VERSION      = "0.13.0"
+VERSION_DATE = "03.04.2023"
+

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

@@ -1,10 +1,12 @@
 Metadata-Version: 2.1
 Name: PythonExtensionsCollection
-Version: 0.2.0
-Summary: This package provides a collection of additional Python functions
+Version: 0.13.0
+Summary: Additional Python functions
 Home-page: https://github.com/test-fullautomation/python-extensions-collection
 Author: Holger Queckenstedt
 Author-email: Holger.Queckenstedt@de.bosch.com
+License: UNKNOWN
+Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
@@ -14,56 +16,58 @@ Classifier: Topic :: Software Development
 Requires-Python: >=3.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: sphinx
-Requires-Dist: pypandoc
-Requires-Dist: colorama
-
-> Licensed under the Apache License, Version 2.0 (the \"License\"); you
-> may not use this file except in compliance with the License. You may
-> obtain a copy of the License at
->
-> <http://www.apache.org/licenses/LICENSE-2.0>
->
-> Unless required by applicable law or agreed to in writing, software
-> distributed under the License is distributed on an \"AS IS\" BASIS,
-> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-> implied. See the License for the specific language governing
-> permissions and limitations under the License.
-
-# Package Description
-
-## Getting Started
-
-The Python Extensions Collection package extends the functionality of
+Requires-Dist: dotdict
+
+Package Description
+===================
+
+The **PythonExtensionsCollection** package extends the functionality of
 Python by some useful functions that are not available in Python
 immediately.
 
-## How to install
+How to install
+--------------
+
+The **PythonExtensionsCollection** can be installed in two different
+ways.
+
+1.  Installation via PyPi (recommended for users)
+
+    ``` {.}
+    pip install PythonExtensionsCollection
+    ```
+
+    [PythonExtensionsCollection in
+    PyPi](https://pypi.org/project/PythonExtensionsCollection/)
+
+2.  Installation via GitHub (recommended for developers)
 
-Firstly clone the **python-extensions-collection** repository to your
-machine.
+    Clone the **python-extensions-collection** repository to your
+    machine.
 
-[Python Extensions
-Collection](https://github.com/test-fullautomation/python-extensions-collection)
+    ``` {.}
+    git clone https://github.com/test-fullautomation/python-extensions-collection.git
+    ```
 
-Use the following two common commands to build or install this package:
+    [PythonExtensionsCollection in
+    GitHub](https://github.com/test-fullautomation/python-extensions-collection)
 
-``` 
-setup.py build      will build the package underneath 'build/'
-setup.py install    will install the package
-```
+    Use the following command to install the
+    **PythonExtensionsCollection**:
 
-After the build processes is completed, the package is located in
-\'build/\', and the generated package documentation is located in
-\'doc/\_build/\'.
+    ``` {.}
+    setup.py install
+    ```
 
-## Package Documentation
+Package Documentation
+---------------------
 
-A detailed documentation of the Python Extensions Collection package can
-be found here:
-[Python-Extensions-Collection.pdf](https://github.com/test-fullautomation/python-extensions-collection/blob/develop/doc/_build/latex/Python-Extensions-Collection.pdf)
+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
+Feedback
+--------
 
 To give us a feedback, you can send an email to [Thomas
 Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
@@ -71,15 +75,22 @@ Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
 In case you want to report a bug or request any interesting feature,
 please don\'t hesitate to raise a ticket.
 
-## Maintainers
+Maintainers
+-----------
+
+[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
 
 [Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
 
-## Contributors
+Contributors
+------------
 
 [Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
 
-## License
+[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
+
+License
+-------
 
 Copyright 2020-2022 Robert Bosch GmbH
 
@@ -95,3 +106,5 @@ distributed under the License is distributed on an \"AS IS\" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
+
+

PythonExtensionsCollection-0.13.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+PythonExtensionsCollection/PythonExtensionsCollection.pdf,sha256=H1EVoh3wU2adU7jFvtq0xCrac2Nik2FvMYNjBojLtE4,281523
+PythonExtensionsCollection/__init__.py,sha256=hr5YI0Et3k8uubFLR_hLILpLtqgnJvEYil0neGoKXhA,596
+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
+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.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.2.0.dist-info → PythonExtensionsCollection-0.13.0.dist-info}/WHEEL

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

PythonExtensionsCollection/doc/.buildinfo

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 06fe9f6b84babba8d64db1044dd8c6c9
-tags: 645f666f9bcd5a90fca523b33c5a78b7