Documentation tool chain switched to GenPackageDoc

JsonPreprocessor/CJsonPreprocessor.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.
@@ -58,16 +58,21 @@ class CSyntaxType():
     (re.VERBOSE | re.MULTILINE | re.DOTALL))
 
 class CPythonJSONDecoder(json.JSONDecoder):
-    """ Add below python values when scanning json data
+    """
+Some keywords are different in Python and Json
+
+.. table:: Python vs. Json keywords
+   :widths: auto
 
-    +---------------+-------------------+
-    | True          | True              |
-    +---------------+-------------------+
-    | False         | False             |
-    +---------------+-------------------+
-    | None          | None              |
-    +---------------+-------------------+
+   =======  =======
+   Python   Json
+   =======  =======
+   True     true
+   False    false
+   None     null
+   =======  =======
     """
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.scan_once = self.custom_scan_once
@@ -123,24 +128,26 @@ def custom_scan_once(self, string, idx):
 
 class CJsonPreprocessor():
     '''
-    CJsonPreprocessor helps to handle configuration file as json format:
-        - Allow comment within json file
-        - Allow import json file within json file
+CJsonPreprocessor helps to handle configuration file as json format:
+
+- Allow comment within json file
+- Allow import json file within json file
     '''
     def __init__(self, syntax=CSyntaxType.json, currentCfg={}):
+        '''
+Method: __processImportFiles this is custom decorder of object_pairs_hook function.
+
+This method helps to import json file which is provided in '[import]' keyword into current json file.
+
+Returns:
+    Dictionary is parsed from json file.
+        '''
         self.lImportedFiles = []
         self.recursive_level = 0
         self.syntax = syntax
         self.currentCfg = currentCfg
         self.lUpdatedParams = []
-
 
-    '''
-    Method: __processImportFiles this is custom decorder of object_pairs_hook function.
-    This method helps to import json file which is provided in '[import]' keyword into current json file.
-    Returns:
-        Dictionary is parsed from json file.
-    '''
     def __processImportFiles(self, input_data):
         out_dict = {}
         for key, value in input_data:
@@ -161,13 +168,13 @@ def __processImportFiles(self, input_data):
                 out_dict[key] = value
         return out_dict
 
-    '''
-    Method: __removeComments loads json config file which allows comments inside
-    Args:
-        jsonFile: string
-    Returns:
-        lJsonData: list, list of string data from jsonFile after removing comment(s).
-    '''
+    # '''
+    # Method: __removeComments loads json config file which allows comments inside
+    # Args:
+        # jsonFile: string
+    # Returns:
+        # lJsonData: list, list of string data from jsonFile after removing comment(s).
+    # '''
     def __removeComments(self, jsonFile):
         jsonPath = ''
         if '/' in jsonFile:
@@ -205,14 +212,14 @@ def __removeComments(self, jsonFile):
                 lJsonData.append(line)
         return lJsonData, jsonPath
 
-    '''
-    private __nestedParamHandler: This method handles the nested variable in param names or value
-                                  in updated json config file.
-    Args:
-        sInputStr: string - param name or value which contains nested variable
-    Returns:
-        sStrHandled: string
-    '''
+    # '''
+    # private __nestedParamHandler: This method handles the nested variable in param names or value
+                                  # in updated json config file.
+    # Args:
+        # sInputStr: string - param name or value which contains nested variable
+    # Returns:
+        # sStrHandled: string
+    # '''
     def __nestedParamHandler(self, sInputStr):
 
         #globals().update(currentCfg)
@@ -271,14 +278,14 @@ def __nestedParamHandler(self, sInputStr):
                 sStrHandled = fullVariable
                 return sStrHandled
 
-    '''
-    private __updateAndReplaceNestedParam: this method replaces all nested params in key and value of Json object
-    Args:
-        oJson: dict
-        currentCfg: dict
-    Returns:
-        oJsonOut: dict
-    '''
+    # '''
+    # private __updateAndReplaceNestedParam: this method replaces all nested params in key and value of Json object
+    # Args:
+        # oJson: dict
+        # currentCfg: dict
+    # Returns:
+        # oJsonOut: dict
+    # '''
     def __updateAndReplaceNestedParam(self, oJson, recursive=False):
 
         if bool(self.currentCfg) and not recursive:
@@ -359,6 +366,7 @@ def jsonLoad(self, jFile, masterFile=True):
 
         Args:
             jFile: string, json file input
+
         Returns:
             oJson: dict
         '''
@@ -392,4 +400,4 @@ def jsonLoad(self, jFile, masterFile=True):
             oJson = self.__updateAndReplaceNestedParam(oJson)
         # oJson['JsonPath'] = jsonPath      # is JsonPath required?
 
-        return oJson
+        return oJson

JsonPreprocessor/__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.

JsonPreprocessor/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 JsonPreprocessor
+#
+VERSION      = "0.1.2"
+VERSION_DATE = "01.07.2022"
+

README.rst

@@ -47,7 +47,7 @@ package documentation is located in 'doc/_build/'.
 Package Documentation
 ---------------------
 
-A detailed documentation of the Json Preprocessor's package can be found here: `Json-Preprocessor.pdf <https://github.com/test-fullautomation/python-jsonpreprocessor/blob/develop/doc/_build/latex/Json-Preprocessor.pdf>`_
+A detailed documentation of the Json Preprocessor's package can be found here: `JsonPreprocessor.pdf <https://github.com/test-fullautomation/python-jsonpreprocessor/blob/develop/JsonPreprocessor/JsonPreprocessor.pdf>`_
 
 Feedback
 --------