python-sdk-remote 0.0.145__py3-none-any.whl → 0.0.146__py3-none-any.whl

python_sdk_remote/constants.py

@@ -17,3 +17,4 @@ OBJECT_TO_INSERT_TEST = {
     'testing_framework': LoggerComponentEnum.testingFramework.pytest.value,
     'developer_email': 'sahar.g@circ.zone'
 }
+

python_sdk_remote/constants_src_mini_logger.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+class LogMessageSeverity(Enum):
+    Debug = 100
+    Verbose = 200
+    Init = 300
+    Info = 500
+    Warning = 600
+    Error = 700
+    Critical = 800
+    Exception = 900
+class StartEndEnum(Enum):
+    Start = 400
+    End = 402

python_sdk_remote/http_response.py

@@ -11,7 +11,7 @@ AUTHORIZATION_KEY = 'authorization'
 AUTHORIZATION_PREFIX = 'Bearer '
 
 
-# TODO Align those methods with typescript-sdk https://github.com/circles-zone/typescript-sdk-remote-typescript-package/blob/dev/typescript-sdk/src/utils/index.ts
+# TODO Align those methods with typescript-sdk https://github.com/circles-zone/typescript-sdk-remote-typescript-package/blob/dev/typescript-sdk/src/utils/index.ts  # noqa: E501
 # TODO Shall we create also createInternalServerErrorHttpResponse(), createOkHttpResponse() like we have in TypeScript?
 
 # TODO: add handler wrapper?
@@ -104,7 +104,7 @@ def get_user_jwt_from_event(event: dict) -> str:
 def create_return_http_headers() -> dict:
     logger.start()
     # Adding "Access-Control-Allow-Origin" : "*" to take care of CORS from localhost
-    # TODO Do we need to add those? In which cases? try  adding crossDomain: true, to the request, 'Access-Control-Allow-Credentials': true to header
+    # TODO Do we need to add those? In which cases? try  adding crossDomain: true, to the request, 'Access-Control-Allow-Credentials': true to header  # noqa: E501
     return_http_headers = {
         "Content-Type": "application/json",
         "Access-Control-Allow-Origin": "*",

python_sdk_remote/mini_logger.py

@@ -1,22 +1,29 @@
 import logging
 import os
 import sys
-
+from enum import Enum
+import inspect
+from src.constants_src_mini_logger import LogMessageSeverity, StartEndEnum
+ 
+# TODO LOGGER_MINIMAL_SEVERITY_DEFAULT
 LOGGER_MINIMUM_SEVERITY = os.getenv("LOGGER_MINIMUM_SEVERITY", "INFO").upper()
 # logging expects NOTSET/DEBUG/INFO/WARNING/ERROR/FATAL/CRITICAL
 if LOGGER_MINIMUM_SEVERITY.isdigit():
+    # TODO logger_minimal_severity_default_value
     logger_minimum_severity = int(LOGGER_MINIMUM_SEVERITY)
-    # Values from Logger.MessageSeverity
-    if logger_minimum_severity < 400:
-        LOGGER_MINIMUM_SEVERITY = "DEBUG"
-    elif logger_minimum_severity < 600:
-        LOGGER_MINIMUM_SEVERITY = "INFO"
-    elif logger_minimum_severity < 700:
-        LOGGER_MINIMUM_SEVERITY = "WARNING"
-    elif logger_minimum_severity < 800:
-        LOGGER_MINIMUM_SEVERITY = "ERROR"
+    # TODO Change Magic Numbers and use the values from Logger.MessageSeverity
+    if logger_minimum_severity < LogMessageSeverity.Start.value:
+        # TODO LOGGER_MINIMAL_SEVERITY_DEFAULT_NAME =
+        # TODO Change "DEBUG", "INFO", "WARNING" ... into enum values from Logger.LogMessageSeverity
+        LOGGER_MINIMUM_SEVERITY = LogMessageSeverity.Debug
+    elif logger_minimum_severity < LogMessageSeverity.Warning.value:
+        LOGGER_MINIMUM_SEVERITY = LogMessageSeverity.Info
+    elif logger_minimum_severity < LogMessageSeverity.Error.value:
+        LOGGER_MINIMUM_SEVERITY = LogMessageSeverity.Warning
+    elif logger_minimum_severity < LogMessageSeverity.Critical.value:
+        LOGGER_MINIMUM_SEVERITY = LogMessageSeverity.Error
     else:
-        LOGGER_MINIMUM_SEVERITY = "CRITICAL"
+        LOGGER_MINIMUM_SEVERITY = LogMessageSeverity.Critical
 
 logging.basicConfig(level=LOGGER_MINIMUM_SEVERITY, stream=sys.stdout,
                     format="%(asctime)s - %(message)s")
@@ -27,98 +34,105 @@ class MiniLogger:
     # TODO Can we so one generic function call by all
 
     @staticmethod
-    def start(message: str = "", object: dict = None):
+    def _log(level: LogMessageSeverity, start_or_end: StartEndEnum = None, log_message: str = None, **kwargs):
         """
-        Print a log message with the current time.
+        Private method to unify all log methods
 
         Parameters:
-            message (str): The message to be printed.
-            object (dict): The object to be printed.
+            level (MessageSeverity): log level
+            log_message (str): The message to be printed.
         """
+        object = kwargs.get("object")
+        method_name = level.name.lower()
+        method = getattr(logger, method_name)
+        if not start_or_end:
+            action_name = level.name
+        else:
+            action_name = start_or_end.name
+        stk = inspect.stack()[2]
+        function = stk.function
+        line = stk.lineno
         if object is None:
-            logger.debug(f"START - {message}")
+            method(f"Function: {function}, Line: {line}; {action_name} - {log_message}")
         else:
-            logger.debug(f"START - {message} - {object}")
+            method(f"Function: {function}, Line: {line}; {action_name} - {log_message} - {object}")
+        
 
     @staticmethod
-    def end(message: str = "", object: dict = None):
+    # TODO Add a new file called align_logger_and_minilogger_test.py, which makes sure the signature of all methods of MiniLogger and Logger are the same and we can change from MiniLogger to Logger and vice versa by changing only one line in our code. If we should change the signatures, we should make them backward compatible.
+    def start(log_message: str = None, **kwargs):
         """
         Print a log message with the current time.
 
         Parameters:
-            message (str): The message to be printed.
+            log_message (str): The message to be printed.
         """
-        if object is None:
-            logger.debug(f"END - {message}")
-        else:
-            logger.debug(f"END - {message} - {object}")
+        MiniLogger._log(LogMessageSeverity.Debug, StartEndEnum.Start, log_message, **kwargs)
 
     @staticmethod
-    def debug(message: str = "", object: dict = None):
+    def end(log_message: str = None, **kwargs):
         """
         Print a log message with the current time.
 
         Parameters:
-            message (str): The message to be printed.
-            object (dict): The object to be printed.
+            log_message (str): The message to be printed.
         """
-        if object is None:
-            logger.debug(f"DEBUG - {message}")
-        else:
-            logger.debug(f"DEBUG {message} - {object}")
+        MiniLogger._log(LogMessageSeverity.Debug, StartEndEnum.End, log_message, **kwargs)
 
+    # TODO convert all those methods (debug, info, warning, error) into one unified private method
+    # TODO Add to the unified private method print of the name of method, version 
+    # and line number of the calling function/method to the mini_logger methods
     @staticmethod
-    def info(message: str = "", object: dict = None):
+    def debug(log_message: str = None, **kwargs):
         """
         Print a log message with the current time.
 
         Parameters:
-            message (str): The message to be printed.
-            object (dict): The object to be printed.
+            log_message (str): The message to be printed.
         """
-        if object is None:
-            logger.info(f"INFO - {message}")
-        else:
-            logger.info(f"INFO {message} - {object}")
+        MiniLogger._log(LogMessageSeverity.Debug, log_message=log_message, **kwargs)
 
     @staticmethod
-    def warning(message: str = "", object: dict = None):
+    def info(log_message: str = None, **kwargs):
         """
         Print a log message with the current time.
 
         Parameters:
-            message (str): The message to be printed.
-            object (dict): The object to be printed.
+            log_message (str): The message to be printed.
+        """
+        MiniLogger._log(LogMessageSeverity.Info, log_message=log_message, **kwargs)
+
+    @staticmethod
+    def warning(log_message: str = None, **kwargs):
+        """
+        Print a log message with the current time.
+
+        Parameters:
+            log_message (str): The message to be printed.
         """
         # TODO Add the source of the message - We should add the object or atleast some parts of it
-        if object is None:
-            logger.warning(f"WARNING - {message}")
-        else:
-            logger.warning(f"WARNING {message} - {object}")
+        MiniLogger._log(LogMessageSeverity.Warning, log_message=log_message, **kwargs)
+
 
     @staticmethod
-    def error(message: str = "", object: dict = None):
+    def error(log_message: str = None, **kwargs):
         """
         Print a log error message with the current time.
 
         Parameters:
-            message (str): The message to be printed.
-            object (dict): The object to be printed.
+            log_message (str): The message to be printed.
         """
-        if object is None:
-            logger.error(f"ERROR - {message}")
-        else:
-            logger.error(f"ERROR - {message} - {object}")
+        MiniLogger._log(LogMessageSeverity.Error, log_message=log_message, **kwargs)
 
     @staticmethod
-    def exception(message: str = "", object: Exception or dict = None):
+    def exception(log_message: str = None, **kwargs):
         """
         Print a log error message with the current time.
 
         Parameters:
-            message (str): The message to be printed.
-            object (dict / Exception): The object / Exception to be printed.
+            log_message (str): The message to be printed.
         """
+        object = kwargs.get("object")
         if isinstance(object, Exception):
             exception = object
         elif isinstance(object, dict):
@@ -127,6 +141,6 @@ class MiniLogger:
             exception = None
 
         if object is None:
-            logger.exception(f"EXCEPTION - {message}")
+            logger.exception(f"EXCEPTION - {log_message}")
         else:
-            logger.exception(f"EXCEPTION- {message} - {object}", exc_info=exception)
+            logger.exception(f"EXCEPTION- {log_message} - {object}", exc_info=exception)

python_sdk_remote/utilities.py

@@ -279,42 +279,53 @@ def is_datetime_in_datetime_range(check_datetime: datetime, datetime_range: (dat
     return is_datetime_in_datetime_range_result
 
 
-def get_brand_name() -> str:
-    get_brand_name_result = our_get_env("BRAND_NAME")
+def get_brand_name(raise_if_not_found: bool = True,
+                   raise_if_empty: bool = False) -> str:
+    get_brand_name_result = our_get_env("BRAND_NAME",
+                                        raise_if_not_found=raise_if_not_found,
+                                        raise_if_empty=raise_if_empty)
     return get_brand_name_result
 
 
-def get_environment_name() -> str:
-    environment_name = our_get_env("ENVIRONMENT_NAME")
+def get_environment_name(raise_if_not_found: bool = True,
+                         raise_if_empty: bool = False) -> str:
+    environment_name = our_get_env("ENVIRONMENT_NAME",
+                                   raise_if_not_found=raise_if_not_found,
+                                   raise_if_empty=raise_if_empty)
     EnvironmentName(environment_name)  # if invalid, raises ValueError: x is not a valid EnvironmentName
     return environment_name
 
 
 def our_get_env(key: str, default: str = None, raise_if_not_found: bool = True,
                 raise_if_empty: bool = False) -> str:
-    logger.start(object={"key": key, "default": default, "raise_if_not_found": raise_if_not_found,
+    logger.start(object={"key": key, "default": default,
+                         "raise_if_not_found": raise_if_not_found,
                          "raise_if_empty": raise_if_empty})
     env_var = os.getenv(key, default)
+    # TODO: "default is None" is always False
     if ((raise_if_not_found and key not in os.environ and default is None)
             or (raise_if_empty and not env_var and not default)):
-        raise Exception(f"Environment variable {key} not found - please check your .env file")
+        raise Exception(f"Environment variable {key} not found - please check your .env file")  # noqa: E501
     logger.end(object={"env_var": env_var})
     return env_var
 
 
-# TODO As only the database package uses those, let's move those three to the database package
-def get_sql_hostname() -> str:
-    get_sql_hostname_result = our_get_env("RDS_HOSTNAME")
+# TODO As only the database package uses those, let's move those three to the database package  # noqa: E501
+def get_sql_hostname(raise_if_not_found: bool = True, raise_if_empty: bool = False) -> str:
+    get_sql_hostname_result = our_get_env("RDS_HOSTNAME",
+                                          raise_if_empty=raise_if_empty)
     return get_sql_hostname_result
 
 
-def get_sql_username() -> str:
-    get_sql_username_result = our_get_env("RDS_USERNAME")
+def get_sql_username(raise_if_empty: bool = False) -> str:
+    get_sql_username_result = our_get_env("RDS_USERNAME",
+                                          raise_if_empty=raise_if_empty)
     return get_sql_username_result
 
 
-def get_sql_password() -> str:
-    get_sql_password_result = our_get_env("RDS_PASSWORD")
+def get_sql_password(raise_if_empty: bool = False) -> str:
+    get_sql_password_result = our_get_env("RDS_PASSWORD",
+                                          raise_if_empty=raise_if_empty)
     return get_sql_password_result
 
 
@@ -405,7 +416,7 @@ def validate_arguments(args: dict) -> None:
     :return: True if all arguments are not None or '', False otherwise
     """
     for arg, value in args.items():
-        if not arg:
+        if not value:
             raise ValueError(f"Argument {arg} is cannot be empty (got {value})")
 
 

{python_sdk_remote-0.0.145.dist-info → python_sdk_remote-0.0.146.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sdk-remote
-Version: 0.0.145
+Version: 0.0.146
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles

python_sdk_remote-0.0.146.dist-info/RECORD

@@ -0,0 +1,16 @@
+python_sdk_remote/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_sdk_remote/constants.py,sha256=Zg4_KOlTkbqdKwua3oTe_64QyYvK_mhA6KnriQMBIPo,752
+python_sdk_remote/constants_src_mini_logger.py,sha256=ukaPhopFSxnLeQwyHa4VUi3TACh4QuKn77JtSK8Z1Tg,247
+python_sdk_remote/http_response.py,sha256=5_h9xOtUhsMzxUiLT4wkYBpL0StA7XYtaqKF4esGwis,6370
+python_sdk_remote/is_test_data.py,sha256=zbUz-Juj7vOPG9TtIttMIBWFxbsOs4-TuR1RYfGNkp4,92
+python_sdk_remote/item.py,sha256=6DQs1nBKbEmnHjE50vZtkMr14ECS_9b8cvE7ItPAbhE,322
+python_sdk_remote/mini_logger.py,sha256=MYrtOQ5CkO_Rg2eQkSj6eGfJQDca_YiYBReJrOA7oNo,5662
+python_sdk_remote/our_object.py,sha256=Db3_CbM4e1VtDU97VDesnBNMXNuYvnuDL7QqHv4MgJo,4618
+python_sdk_remote/unified_json.py,sha256=zk4Lo9t9MSHXW8UKdo50YCYmFv5FgTsmHf6l2AWqLWU,961
+python_sdk_remote/utilities.py,sha256=4xwiZ6dvHBFnG4LGFKoY-Sey8h5-jLOT9BcGGA9KyNY,16754
+python_sdk_remote/valid_json_versions.py,sha256=-ZU65JYI6gTEfK8o6gu9Dmm9SQmwzj5pDbEXiyUbBhQ,138
+python_sdk_remote/validate_environment.py,sha256=nzCHZDw56G56ekrTQT3gG48utjsU4VCwQi9dVsBDas0,2268
+python_sdk_remote-0.0.146.dist-info/METADATA,sha256=rwIDxp7njWNgwWW57PAnBT_diDdptBdqUp3VEVXrTjk,729
+python_sdk_remote-0.0.146.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python_sdk_remote-0.0.146.dist-info/top_level.txt,sha256=JTpEq_svPlI5hTlPq30Ne-NkR-u5464gjVDP2U74PvE,18
+python_sdk_remote-0.0.146.dist-info/RECORD,,

python_sdk_remote-0.0.145.dist-info/RECORD

@@ -1,15 +0,0 @@
-python_sdk_remote/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-python_sdk_remote/constants.py,sha256=0bg3t_4wzZLWFapseENer7qSx3NvniEF5n0H8AZ2G38,751
-python_sdk_remote/http_response.py,sha256=eu8wF85zLqIuT5LhgCRb4fnYP5T91R92qJmejXZcgY8,6342
-python_sdk_remote/is_test_data.py,sha256=zbUz-Juj7vOPG9TtIttMIBWFxbsOs4-TuR1RYfGNkp4,92
-python_sdk_remote/item.py,sha256=6DQs1nBKbEmnHjE50vZtkMr14ECS_9b8cvE7ItPAbhE,322
-python_sdk_remote/mini_logger.py,sha256=vzkrSSebDWbrgWlO1QyLuB-IJ4mIgvBxlxOMKQgAi1Y,4232
-python_sdk_remote/our_object.py,sha256=Db3_CbM4e1VtDU97VDesnBNMXNuYvnuDL7QqHv4MgJo,4618
-python_sdk_remote/unified_json.py,sha256=zk4Lo9t9MSHXW8UKdo50YCYmFv5FgTsmHf6l2AWqLWU,961
-python_sdk_remote/utilities.py,sha256=JB_LQoRGDlNktbr4twg1CAGSus7d2NC_Npcpl-WR0Eo,15861
-python_sdk_remote/valid_json_versions.py,sha256=-ZU65JYI6gTEfK8o6gu9Dmm9SQmwzj5pDbEXiyUbBhQ,138
-python_sdk_remote/validate_environment.py,sha256=nzCHZDw56G56ekrTQT3gG48utjsU4VCwQi9dVsBDas0,2268
-python_sdk_remote-0.0.145.dist-info/METADATA,sha256=OcPX_fOGobxPy9Mp_UMTW9sVgUK24k3YIqhpSPQNJTU,729
-python_sdk_remote-0.0.145.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-python_sdk_remote-0.0.145.dist-info/top_level.txt,sha256=JTpEq_svPlI5hTlPq30Ne-NkR-u5464gjVDP2U74PvE,18
-python_sdk_remote-0.0.145.dist-info/RECORD,,