python-sdk-local 0.0.24__py3-none-any.whl → 0.0.26__py3-none-any.whl

{python_sdk_local-0.0.24.dist-info → python_sdk_local-0.0.26.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-sdk-local
-Version: 0.0.24
+Version: 0.0.26
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles
 Author: Circles

python_sdk_local-0.0.26.dist-info/RECORD

@@ -0,0 +1,12 @@
+sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sdk/src/LoggerOutputEnum.py,sha256=tb7RzL3GpiRIStGtrncFmZ1N4zHM26dhygAW-GxYW9M,244
+sdk/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sdk/src/debug_mode.py,sha256=uC_Lb5D5aMJZ8HWRRiAaPWO5wPkYB52Hk2LWLIAVy9k,3398
+sdk/src/utilities.py,sha256=anOYgkOWd5rWcULERT5YsXgwTI7GmoBuk_ylX46WPGY,2227
+sdk/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sdk/tests/debug_mode_test.py,sha256=yDnlUU0bFgwGtzEf4GWoD2elJWTfdeWbU3TMxcSueuo,5803
+sdk/tests/utilities_test.py,sha256=_LHRhaZWAKXhtcQN1MwSJq2AqpSC0W3n3sQpzwUtKlc,1857
+python_sdk_local-0.0.26.dist-info/METADATA,sha256=k-wwDMGhWzojYwfC3X9b8MuwP16DiuLrHDPf0I3De9c,468
+python_sdk_local-0.0.26.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+python_sdk_local-0.0.26.dist-info/top_level.txt,sha256=JuXS55gRP3EzGKmJgbLfVfUolO3cM_u69k3qvutnBuw,4
+python_sdk_local-0.0.26.dist-info/RECORD,,

sdk/src/LoggerOutputEnum.py

@@ -6,10 +6,10 @@ class LoggerOutputEnum(Enum):
     LoggerOutputEnum
 
     Attributes:
-        CONSOLE
+        Console
         MySQLDatabase
-        Logzio
+        Logz.io
     """
     Console = "Console"
     MySQLDatabase = "MySQLDatabase"
-    Logzio = "Logzio"
+    Logzio = "Logz.io"

sdk/src/debug_mode.py

@@ -5,18 +5,14 @@ from dotenv import load_dotenv
 load_dotenv()
 from logger_local.LoggerComponentEnum import LoggerComponentEnum
 from logger_local.Logger import Logger
+from logger_local.MessageSeverity import MessageSeverity
 sys.path.append(os.getcwd())
 from python_sdk_local.sdk.src.LoggerOutputEnum import LoggerOutputEnum
 
-PYTHON_SDK_LOCAL_COMPONENT_ID = 184
+PYTHON_SDK_LOCAL_COMPONENT_ID = 202
 PYTHON_SDK_LOCAL_COMPONENT_NAME = 'python_sdk_local/src/debug_mode.py'
 LOGGER_CONFIGURATION_JSON = '.logger.json'
-LOGGER_MINIMUM_SEVERITY = os.getenv('LOGGER_MINIMUM_SEVERITY')
-
-if not LOGGER_MINIMUM_SEVERITY:
-    LOGGER_MINIMUM_SEVERITY = 0
-else:
-    LOGGER_MINIMUM_SEVERITY = int(LOGGER_MINIMUM_SEVERITY)
+LOGGER_MINIMUM_SEVERITY = os.getenv('LOGGER_MINIMUM_SEVERITY')    
 
 
 obj = {
@@ -30,37 +26,57 @@ logger = Logger.create_logger(object=obj)
 class DebugMode:
     def __init__(self):
         self.logger_json = {}
+        self.debug_everything = False
         self._init()
 
     def _init(self):
         INIT_METHOD_NAME = "_init()"
         logger.start(INIT_METHOD_NAME)
 
+        global LOGGER_MINIMUM_SEVERITY
+        if not LOGGER_MINIMUM_SEVERITY:
+            LOGGER_MINIMUM_SEVERITY = 0
+        else:
+            if hasattr(MessageSeverity, LOGGER_MINIMUM_SEVERITY):
+                LOGGER_MINIMUM_SEVERITY = MessageSeverity[LOGGER_MINIMUM_SEVERITY].value
+            elif LOGGER_MINIMUM_SEVERITY.isdigit():
+                LOGGER_MINIMUM_SEVERITY = int(LOGGER_MINIMUM_SEVERITY)
+            else:
+                raise Exception("LOGGER_MINIMUM_SEVERITY must be a valid LoggerOutputEnum or a number or None")
+
         try:
             with open(LOGGER_CONFIGURATION_JSON, 'r') as file:
                 self.logger_json = json.load(file)
-        except Exception as e:
-            logger.exception("got exception while reading json from file", object={'exception': e})
+        except FileNotFoundError:
+            self.debug_everything = True
+            logger.info("could not find .logger.json file, debugging everything")
+        except Exception as exception:
+            logger.exception("encounteredthe following error", object={'exception': exception})
             logger.end(INIT_METHOD_NAME)
-            return
-
+            raise
         logger.end(INIT_METHOD_NAME)
 
-    def fetch(self, component_id:str, logger_output: LoggerOutputEnum, severity_level:int):
+    def is_logger_output(self, component_id:str, logger_output: LoggerOutputEnum, severity_level:int)->bool:
+        IS_LOGGER_OUTPUT_METHOD_NAME = "is_logger_output()"
+        logger.start(IS_LOGGER_OUTPUT_METHOD_NAME, object={'component_id': component_id, 'logger_output': str(logger_output), 'severity_level': severity_level})
 
-        severity_level = max(severity_level, LOGGER_MINIMUM_SEVERITY)
-        
-        FETCH_METHOD_NAME = "fetch()"
-        logger.start(FETCH_METHOD_NAME, object={'component_id': component_id, 'logger_output': str(logger_output), 'severity_level': severity_level})
 
+        #Debug everything that has a severity level higher than the minimum required
+        if self.debug_everything:
+            result = severity_level >= LOGGER_MINIMUM_SEVERITY
+            logger.end(IS_LOGGER_OUTPUT_METHOD_NAME, object={'result': result})
+            return result
+        
+        severity_level = max(severity_level, LOGGER_MINIMUM_SEVERITY)
         if component_id in self.logger_json:
             output_info = self.logger_json[component_id]
             if logger_output in output_info:
                 result = severity_level >= output_info[logger_output]
-                logger.end(FETCH_METHOD_NAME, object={'result': result})
+                logger.end(IS_LOGGER_OUTPUT_METHOD_NAME, object={'result': result})
                 return result
-        
 
-        result = False
-        logger.end(FETCH_METHOD_NAME, object={'result': result})
+        # In case the component do not exist in the logger configuration file or the 
+        # logger_output was not specif
+        result = True
+        logger.end(IS_LOGGER_OUTPUT_METHOD_NAME, object={'result': result})
         return result

sdk/src/utilities.py

@@ -41,26 +41,14 @@ def is_list_of_dicts(obj):
     IS_LIST_OF_DICTS_FUNCTION_NAME = "is_list_of_dicts()" 
     logger.start(IS_LIST_OF_DICTS_FUNCTION_NAME,object = {"obj":obj})
     if not isinstance(obj, list):
-        result = False
-        logger.end(IS_LIST_OF_DICTS_FUNCTION_NAME,object =  {"result": result})
-        return result
+        is_list_of_dicts_result = False
+        logger.end(IS_LIST_OF_DICTS_FUNCTION_NAME,object =  {"is_list_of_dicts_result": is_list_of_dicts_result})
+        return is_list_of_dicts_result
     for item in obj:
         if not isinstance(item, dict):
-            result = False
-            logger.end(IS_LIST_OF_DICTS_FUNCTION_NAME,object = {'result': result})
-            return result
-    result = True
-    logger.end(IS_LIST_OF_DICTS_FUNCTION_NAME,object = {'result': result})
-    return result
-
-
-
-
-
-# componet id
-# sevirity 
-# output
-#minimum sevirity
-
-# init from debug file
-# get from 
+            is_list_of_dicts_result = False
+            logger.end(IS_LIST_OF_DICTS_FUNCTION_NAME,object = {'is_list_of_dicts_result': is_list_of_dicts_result})
+            return is_list_of_dicts_result
+    is_list_of_dicts_result = True
+    logger.end(IS_LIST_OF_DICTS_FUNCTION_NAME,object = {'is_list_of_dicts_result': is_list_of_dicts_result})
+    return is_list_of_dicts_result

sdk/tests/debug_mode_test.py

@@ -67,10 +67,10 @@ def test_debug_mode_init():
     assert result
 
 
-def test_fetch_debug_info_1():
+def test_is_logger_output_debug_info_1():
 
-    TEST_FETCH_DEBUG_INFO_1_FUNCTION_NAME = 'test_fetch_debug_info_1()'
-    logger.start(TEST_FETCH_DEBUG_INFO_1_FUNCTION_NAME)
+    TEST_is_logger_output_DEBUG_INFO_1_FUNCTION_NAME = 'test_is_logger_output_debug_info_1()'
+    logger.start(TEST_is_logger_output_DEBUG_INFO_1_FUNCTION_NAME)
 
     add_debug_file(EXAMPLE_DATA_1)
 
@@ -78,17 +78,17 @@ def test_fetch_debug_info_1():
 
     remove_debug_file()
 
-    result = debug.fetch('1', LoggerOutputEnum.Console.value, 501) == True
-    logger.end(TEST_FETCH_DEBUG_INFO_1_FUNCTION_NAME,
+    result = debug.is_logger_output('1', LoggerOutputEnum.Console.value, 501) == True
+    logger.end(TEST_is_logger_output_DEBUG_INFO_1_FUNCTION_NAME,
                object={'result': result})
 
     assert result
 
 
-def test_fetch_debug_mode_2():
+def test_is_logger_output_debug_mode_2():
 
-    TEST_FETCH_DEBUG_MODE_2_FUNCTION_NAME = 'test_fetch_debug_mode_2()'
-    logger.start(TEST_FETCH_DEBUG_MODE_2_FUNCTION_NAME)
+    TEST_is_logger_output_DEBUG_MODE_2_FUNCTION_NAME = 'test_is_logger_output_debug_mode_2()'
+    logger.start(TEST_is_logger_output_DEBUG_MODE_2_FUNCTION_NAME)
 
     add_debug_file(EXAMPLE_DATA_2)
 
@@ -96,12 +96,12 @@ def test_fetch_debug_mode_2():
 
     remove_debug_file()
 
-    result1 = debug.fetch('2', LoggerOutputEnum.Logzio.value, 502) == True
-    result2 = debug.fetch('2', LoggerOutputEnum.MySQLDatabase.value, 503) == True
-    result3 = debug.fetch('2', LoggerOutputEnum.Console.value, 499) == False
+    result1 = debug.is_logger_output('2', LoggerOutputEnum.Logzio.value, 502) == True
+    result2 = debug.is_logger_output('2', LoggerOutputEnum.MySQLDatabase.value, 503) == True
+    result3 = debug.is_logger_output('2', LoggerOutputEnum.Console.value, 499) == False
   
     result = result1 and result2 and result3
-    logger.end(TEST_FETCH_DEBUG_MODE_2_FUNCTION_NAME,
+    logger.end(TEST_is_logger_output_DEBUG_MODE_2_FUNCTION_NAME,
                object={'result': result})
     assert result
 
@@ -117,15 +117,74 @@ def test_minimum_sevirity():
 
     remove_debug_file()
 
-    result1 = debug.fetch('2', LoggerOutputEnum.Logzio.value, 501) == False
-    result2 = debug.fetch('2', LoggerOutputEnum.Logzio.value, 502) == True
+    result1 = debug.is_logger_output('2', LoggerOutputEnum.Logzio.value, 501) == False
+    result2 = debug.is_logger_output('2', LoggerOutputEnum.Logzio.value, 502) == True
 
     debug_mode.LOGGER_MINIMUM_SEVERITY = 0
 
     result = result1 and result2
     logger.end(TEST_MINIMUM_SEVIRITY_FUNCTION_NAME, object={'result': result})
     assert result
+
+def test_debug_everything():
     
+    TEST_DEBUG_EVERYTHING_FUNCTION_NAME = 'test_debug_everything()'
+    logger.start(TEST_DEBUG_EVERYTHING_FUNCTION_NAME)
+
+
+    debug = debug_mode.DebugMode() # file DNE, so debug_everything = True
+
+    result1 = debug.is_logger_output('2', LoggerOutputEnum.Logzio.value, 501) == True
+    result2 = debug.is_logger_output('2', LoggerOutputEnum.Logzio.value, 502) == True
+
+    debug_mode.LOGGER_MINIMUM_SEVERITY = 0
+
+    result = result1 and result2
+    logger.end(TEST_DEBUG_EVERYTHING_FUNCTION_NAME, object={'result': result})
+    assert result
+
+def test_invalid_logger_minimum_sevirity():
+
+    TEST_INVALID_LOGGER_MINIMUM_SEVIRITY_FUNCTION_NAME = 'test_invalid_logger_minimum_sevirity()'
+    logger.start(TEST_INVALID_LOGGER_MINIMUM_SEVIRITY_FUNCTION_NAME)
 
+    debug_mode.LOGGER_MINIMUM_SEVERITY = 'invalid'
+
+    try:
+        debug = debug_mode.DebugMode()
+    except Exception as e:
+        result = True
+    else:
+        result = False
+    
+    logger.end(TEST_INVALID_LOGGER_MINIMUM_SEVIRITY_FUNCTION_NAME, object={'result': result})
+    assert result
+
+def test_alpha_numeric_minimum_severity():
+
+    TEST_ALPHA_NUMERIC_MINIMUM_SEVERITY_FUNCTION_NAME = 'test_alpha_numeric_minimum_severity()'
+    logger.start(TEST_ALPHA_NUMERIC_MINIMUM_SEVERITY_FUNCTION_NAME)
+
+    debug_mode.LOGGER_MINIMUM_SEVERITY = '13'
+
+    debug = debug_mode.DebugMode()
+
+    result =debug_mode.LOGGER_MINIMUM_SEVERITY = 13
+
+    logger.end(TEST_ALPHA_NUMERIC_MINIMUM_SEVERITY_FUNCTION_NAME, object={'result': result})
+    assert result
+
+def test_enum_minimal_severity():
+        TEST_ENUM_MINIMAL_SEVERITY_FUNCTION_NAME = 'test_enum_minimal_severity()'
+        logger.start(TEST_ENUM_MINIMAL_SEVERITY_FUNCTION_NAME)
+    
+        debug_mode.LOGGER_MINIMUM_SEVERITY = 'Information'
+    
+        debug = debug_mode.DebugMode()
+    
+        result =debug_mode.LOGGER_MINIMUM_SEVERITY == 500
+    
+        logger.end(TEST_ENUM_MINIMAL_SEVERITY_FUNCTION_NAME, object={'result': result})
+        assert result
 
-test_minimum_sevirity()
+test_debug_everything()

python_sdk_local-0.0.24.dist-info/RECORD

@@ -1,12 +0,0 @@
-sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sdk/src/LoggerOutputEnum.py,sha256=KvYYBHTEWe85AR9l0F9uvZPbuJ1uTo-4jv3mYxlNnD8,242
-sdk/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sdk/src/debug_mode.py,sha256=7BheicjABZfceT4b0MGf8njhWY1qAi0lG8PJCtQ3tAk,2253
-sdk/src/utilities.py,sha256=VcwlskviysA5bP5Z3REQtjN6eh_GxVPZeZviVrqgG-I,2117
-sdk/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sdk/tests/debug_mode_test.py,sha256=VeWRcUUBeW4zTMNLHzoHB28PLBBaMoIrGYq_OzS1IBw,3616
-sdk/tests/utilities_test.py,sha256=_LHRhaZWAKXhtcQN1MwSJq2AqpSC0W3n3sQpzwUtKlc,1857
-python_sdk_local-0.0.24.dist-info/METADATA,sha256=dE8o7JxJQQONXozyR_cknedjFqgtrGh7pnxxNDLLUHs,468
-python_sdk_local-0.0.24.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-python_sdk_local-0.0.24.dist-info/top_level.txt,sha256=JuXS55gRP3EzGKmJgbLfVfUolO3cM_u69k3qvutnBuw,4
-python_sdk_local-0.0.24.dist-info/RECORD,,