CTX-4793: Moved functions related code to top-level module "functions" and added documentation

Author: Vuk Manojlovic

coretex/functions.py

@@ -0,0 +1,46 @@
+from typing import Optional, Any, Dict
+
+
+def badRequest(error: str) -> Dict[str, Any]:
+    """
+        Creates a json object for bad request
+
+        Parameters
+        ----------
+        error : str
+            Error message
+
+        Returns
+        -------
+        dict -> Json object for bad request
+    """
+
+    return {
+        "code": 400,
+        "body": {
+            "error": error
+        }
+    }
+
+
+def success(data: Optional[Any] = None) -> Dict[str, Any]:
+    """
+        Creates a json object for successful request
+
+        Parameters
+        ----------
+        data : Optional[Any]
+            Response data
+
+        Returns
+        -------
+        dict -> Json object for successful request
+    """
+
+    if data is None:
+        data = {}
+
+    return {
+        "code": 200,
+        "body": data
+    }

coretex/networking/__init__.py

@@ -22,4 +22,3 @@
 from .request_type import RequestType
 from .chunk_upload_session import ChunkUploadSession, MAX_CHUNK_SIZE
 from .file_data import FileData
-from .utils import badRequest, success

coretex/networking/utils.py

@@ -66,22 +66,3 @@ def logRequestFailure(endpoint: str, response: NetworkResponse) -> None:
             logging.getLogger("coretexpylib").debug(f"\tResponse: {responseJson}")
     except (ValueError, TypeError):
         logging.getLogger("coretexpylib").debug(f"\tResponse: {response.getContent()!r}")
-
-
-def badRequest(error: str) -> Dict[str, Any]:
-    return {
-        "code": 400,
-        "body": {
-            "error": error
-        }
-    }
-
-
-def success(data: Optional[Any] = None) -> Dict[str, Any]:
-    if data is None:
-        data = {}
-
-    return {
-        "code": 200,
-        "body": data
-    }