robotframework-extensions-collection 0.10.0__py3-none-any.whl

RobotframeworkExtensions/Collection.py

@@ -0,0 +1,212 @@
+# **************************************************************************************************************
+#
+#  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.
+#
+# **************************************************************************************************************
+#
+# Collection.py
+#
+# XC-CT/ECA3-Queckenstedt
+#
+# --------------------------------------------------------------------------------------------------------------
+#
+# 06.04.2023
+#
+# --------------------------------------------------------------------------------------------------------------
+
+"""
+The Collection module is the interface between the PythonExtensionsCollection and the Robot Framework.
+
+This library containing the keyword definitions, can be imported in the following way:
+
+.. code::
+
+   Library    RobotframeworkExtensions.Collection    WITH NAME    rf.extensions
+
+"""
+
+# -- import standard Python modules
+import pickle, os, time, random
+
+# -- import Robotframework API
+from robot.api.deco import keyword, library # required when using @keyword, @library decorators
+from robot.libraries.BuiltIn import BuiltIn
+
+# -- import own Python modules
+from PythonExtensionsCollection.Utils.CUtils import *
+from PythonExtensionsCollection.String.CString import CString
+
+from RobotframeworkExtensions.version import VERSION
+from RobotframeworkExtensions.version import VERSION_DATE
+
+# --------------------------------------------------------------------------------------------------------------
+
+sThisModuleName    = "Collection.py"
+sThisModuleVersion = VERSION
+sThisModuleDate    = VERSION_DATE
+sThisModule        = sThisModuleName + " v. " + sThisModuleVersion + " / " + sThisModuleDate
+
+# --------------------------------------------------------------------------------------------------------------
+# 
+@library
+class Collection(object):
+    """Module main class
+    """
+
+    ROBOT_AUTO_KEYWORDS   = False # only decorated methods are keywords
+    ROBOT_LIBRARY_VERSION = sThisModuleVersion
+    ROBOT_LIBRARY_SCOPE   = 'GLOBAL'
+
+    # --------------------------------------------------------------------------------------------------------------
+    #TM***
+
+    def __init__(self, sThisModule=sThisModule):
+        self.sThisModule = sThisModule # in case of debugging
+
+    def __del__(self):
+        pass
+
+    # --------------------------------------------------------------------------------------------------------------
+    #TM***
+    
+    @keyword
+    def pretty_print(self, oData=None, sPrefix=None):
+       """
+The ``pretty_print`` keyword logs the content of parameters of any Python data type (input: ``oData``).
+
+Simple data types are logged directly. Composite data types are resolved before.
+
+The output contains for every 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 trace level for output is ``INFO``.
+
+The output is also returned as list of strings.
+
+**Arguments:**
+
+* ``oData``
+
+  / *Condition*: required / *Type*: any Python type /
+
+  Data to be pretty printed
+
+* ``sPrefix``
+
+  / *Condition*: optional / *Type*: str / *Default*: None /
+
+  If not ``None``, this prefix string is added to every output line.
+
+**Returns:**
+
+* ``listOutLines`` (*list*)
+
+  / *Type*: list /
+
+  List of strings containing the resolved data structure of ``oData`` (same content as printed to console).
+       """
+
+       # BuiltIn().log(f"This is {self.sThisModule}", "INFO") # debug
+
+       oTypePrint   = CTypePrint()
+       listOutLines = oTypePrint.TypePrint(oData)
+
+       if sPrefix is None:
+          for sLine in listOutLines:
+             BuiltIn().log(sLine, "INFO")
+             BuiltIn().log_to_console(sLine)
+          return listOutLines
+       else:
+          listOutLinesNew = []
+          for sLine in listOutLines:
+             sLine = f"{sPrefix} : {sLine}"
+             BuiltIn().log(sLine, "INFO")
+             BuiltIn().log_to_console(sLine)
+             listOutLinesNew.append(sLine)
+          return listOutLinesNew
+
+    # eof def pretty_print(self, oData=None, sPrefix=None):
+
+    # --------------------------------------------------------------------------------------------------------------
+    #TM***
+
+    @keyword
+    def normalize_path(self, sPath=None, bWin=False, sReferencePathAbs=None, bConsiderBlanks=False, bExpandEnvVars=True, bMask=True):
+       """
+The ``normalize_path`` keyword normalizes local paths, paths to local network resources and internet addresses
+
+**Arguments:**
+
+* ``sPath``
+
+  / *Condition*: required / *Type*: str /
+
+  The path to be normalized
+
+* ``bWin``
+
+  / *Condition*: optional / *Type*: bool / *Default*: False /
+
+  If ``True`` then the returned path contains masked backslashes as separator, otherwise slashes
+
+* ``sReferencePathAbs``
+
+  / *Condition*: optional / *Type*: str / *Default*: None /
+
+  In case of ``sPath`` is relative and ``sReferencePathAbs`` (expected to be absolute) is given, then
+  the returned absolute path is a join of both input paths
+
+* ``bConsiderBlanks``
+
+  / *Condition*: optional / *Type*: bool / *Default*: False /
+
+  If ``True`` then the returned path is encapsulated in quotes - in case of the path contains blanks
+
+* ``bExpandEnvVars``
+
+  / *Condition*: optional / *Type*: bool / *Default*: True /
+
+  If ``True`` then in the returned path environment variables are resolved, otherwise not.
+
+* ``bMask``
+
+  / *Condition*: optional / *Type*: bool / *Default*: True (requires ``bWin=True``) /
+
+  If ``bWin`` is ``True`` and ``bMask`` is ``True`` then the returned path contains masked backslashes as separator.
+
+  If ``bWin`` is ``True`` and ``bMask`` is ``False`` then the returned path contains single backslashes only - this might be
+  required for applications, that are not able to handle masked backslashes.
+
+  In case of ``bWin`` is ``False`` ``bMask`` has no effect.
+
+**Returns:**
+
+* ``sPath``
+
+  / *Type*: str /
+
+  The normalized path (is ``None`` in case of ``sPath`` is ``None``)
+       """
+       sPath = CString.NormalizePath(sPath, bWin, sReferencePathAbs, bConsiderBlanks, bExpandEnvVars, bMask)
+       return sPath
+
+    # --------------------------------------------------------------------------------------------------------------
+
+# eof class Collection(object):
+

RobotframeworkExtensions/__init__.py

@@ -0,0 +1,13 @@
+#  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.

RobotframeworkExtensions/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 RobotframeworkExtensions
+#
+VERSION      = "0.10.0"
+VERSION_DATE = "06.04.2023"
+

robotframework_extensions_collection-0.10.0.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

robotframework_extensions_collection-0.10.0.dist-info/METADATA

@@ -0,0 +1,147 @@
+Metadata-Version: 2.1
+Name: robotframework-extensions-collection
+Version: 0.10.0
+Summary: Additional Robot Framework keywords
+Home-page: https://github.com/test-fullautomation/robotframework-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
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PythonExtensionsCollection
+Requires-Dist: robotframework
+
+Package Description
+===================
+
+The **RobotframeworkExtensions** extend the functionality of the Robot
+Framework by some useful keywords.
+
+How to install
+--------------
+
+The **RobotframeworkExtensions** can be installed in two different ways.
+
+1.  Installation via PyPi (recommended for users)
+
+    ``` {.}
+    pip install RobotframeworkExtensions
+    ```
+
+    [RobotframeworkExtensions in
+    PyPi](https://pypi.org/project/RobotframeworkExtensions/)
+
+2.  Installation via GitHub (recommended for developers)
+
+    -   Clone the **robotframework-extensions-collection** repository to
+        your machine.
+
+        ``` {.}
+        git clone https://github.com/test-fullautomation/robotframework-extensions-collection.git
+        ```
+
+        [RobotframeworkExtensions in
+        GitHub](https://github.com/test-fullautomation/robotframework-extensions-collection)
+
+    -   Install dependencies
+
+        **RobotframeworkExtensions** 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 **RobotframeworkExtensions** 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
+        **RobotframeworkExtensions**:
+
+        ``` {.}
+        setup.py install
+        ```
+
+Package Documentation
+---------------------
+
+A detailed documentation of the **RobotframeworkExtensions** can be
+found here:
+
+[RobotframeworkExtensions.pdf](https://github.com/test-fullautomation/robotframework-extensions-collection/blob/develop/RobotframeworkExtensions/RobotframeworkExtensions.pdf)
+
+Feedback
+--------
+
+To give us a feedback, you can send an email to [Thomas
+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
+-----------
+
+[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
+
+[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
+
+Contributors
+------------
+
+[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
+
+[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
+
+License
+-------
+
+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
+
+> [![License: Apache
+> v2](https://img.shields.io/pypi/l/robotframework.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+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.
+
+

robotframework_extensions_collection-0.10.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+RobotframeworkExtensions/Collection.py,sha256=03esMpLIP88WTrXcu4UOT_GJDIub7rOw6AUeo3fjb5M,6826
+RobotframeworkExtensions/RobotframeworkExtensions.pdf,sha256=uk7_ZiID7bbCM5c9CW1WU39hVc4MtTH-dbjdWYn__3s,174139
+RobotframeworkExtensions/__init__.py,sha256=hr5YI0Et3k8uubFLR_hLILpLtqgnJvEYil0neGoKXhA,596
+RobotframeworkExtensions/version.py,sha256=agtFV0oVHgVsW1Cedir24ep9OZJbfvAcOkw_E03WxNE,930
+robotframework_extensions_collection-0.10.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+robotframework_extensions_collection-0.10.0.dist-info/METADATA,sha256=N964PVP19f82lU4OsMomWJIkVVGGNPTEv2Oyu5W2RPk,4691
+robotframework_extensions_collection-0.10.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+robotframework_extensions_collection-0.10.0.dist-info/top_level.txt,sha256=u6UazvCXL6yUY-oMpMUXnw8TkpWS3_ed77lmG3rWuro,25
+robotframework_extensions_collection-0.10.0.dist-info/RECORD,,

robotframework_extensions_collection-0.10.0.dist-info/WHEEL

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

robotframework_extensions_collection-0.10.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+RobotframeworkExtensions