python-sdk-remote 0.0.149__py3-none-any.whl → 0.0.151__py3-none-any.whl

python_sdk_remote/constants.py

@@ -1,5 +1,7 @@
 from logger_local.LoggerComponentEnum import LoggerComponentEnum
 
+# TODO Add SmartDatastoreAttributes Class which includes seller_sales_organization_id, seller_delivery_organization_id, buyer_organization_id, distribution_organization_id, end_customer_organization_id, organization_project_id, seller_case_id, customer_case_id, location_id, knowledge_base, segment_id, vertical_id, industry_id, practice_id, segment_id, vertical_id, business_unit_id, driver_id, distribution_line_id,  (Add it to python-sdk-remote as both Storage, SmartDataStore should use it)  # noqa E501
+
 PYTHON_SDK_REMOTE_COMPONENT_ID = 184
 PYTHON_SDK_REMOTE_COMPONENT_NAME = 'python_sdk_remote'
 
@@ -10,6 +12,7 @@ OBJECT_TO_INSERT_CODE = {
     'developer_email_address': 'sahar.g@circ.zone'
 }
 
+# Move this to the constants_test_python_sdk_remote file (based on the python-package-template)
 OBJECT_TO_INSERT_TEST = {
     'component_id': PYTHON_SDK_REMOTE_COMPONENT_ID,
     'component_name': PYTHON_SDK_REMOTE_COMPONENT_NAME,

python_sdk_remote/constants_src_mini_logger.py

@@ -0,0 +1,18 @@
+from enum import Enum
+
+
+# TODO I think enum values should be in uppercase
+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/mini_logger.py

@@ -1,6 +1,9 @@
 import logging
 import os
 import sys
+# from enum import Enum
+import inspect
+from .constants_src_mini_logger import LogMessageSeverity, StartEndEnum
 
 # TODO LOGGER_MINIMAL_SEVERITY_DEFAULT
 LOGGER_MINIMUM_SEVERITY = os.getenv("LOGGER_MINIMUM_SEVERITY", "INFO").upper()
@@ -9,18 +12,18 @@ if LOGGER_MINIMUM_SEVERITY.isdigit():
     # TODO logger_minimal_severity_default_value
     logger_minimum_severity = int(LOGGER_MINIMUM_SEVERITY)
     # TODO Change Magic Numbers and use the values from Logger.MessageSeverity
-    if logger_minimum_severity < 400:
+    if logger_minimum_severity < LogMessageSeverity.Start.value:
         # TODO LOGGER_MINIMAL_SEVERITY_DEFAULT_NAME =
-        # TODO Change "DEBUG", "INFO", "WARNING" ... into enum values from Logger.MessageSeverity
-        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 "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")
@@ -28,105 +31,108 @@ logger = logging.getLogger(__name__)
 
 
 class MiniLogger:
-    # TODO Can we have one generic function called by all as we have a lot of duplicated code here?
+    # TODO Can we so one generic function call by all
 
-    # TODO: print the caller function name
+    _is_write_to_sql = False  # Should be always False in MiniLogger
 
     @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.  # noqa E501
+    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 end(log_message: str = None, **kwargs):
+        """
+        Print a log message with the current time.
+
+        Parameters:
+            log_message (str): The message to be printed.
+        """
+        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  # noqa: E501
+    # 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 debug(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.debug(f"DEBUG - {message}")
-        else:
-            logger.debug(f"DEBUG {message} - {object}")
+        MiniLogger._log(LogMessageSeverity.Debug, log_message=log_message, **kwargs)
 
     @staticmethod
-    def info(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.
         """
-        if object is None:
-            logger.info(f"INFO - {message}")
-        else:
-            logger.info(f"INFO {message} - {object}")
+        MiniLogger._log(LogMessageSeverity.Info, log_message=log_message, **kwargs)
 
     @staticmethod
-    def warning(message: str = "", object: dict = None):
+    def warning(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.
         """
         # 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):
@@ -135,6 +141,9 @@ 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)
+
+    def is_write_to_sql(self):
+        return self._is_write_to_sql

python_sdk_remote/utilities.py

@@ -30,6 +30,7 @@ DEFAULT_LANG_CODE_STR = "en"
 # TODO If no one is using DEFAULT_DATETIME_FORMAT, let's comment it
 # TODO Let's split DEFAULT_DATETIME_FORMAT into two const 1. Displayable to Humans (MMM) 2. Internal (sortable) with %m
 DEFAULT_DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S"
+PRINT_STARS = "*** "
 
 
 def append_if_not_exist(lst: list, item: object) -> None:
@@ -279,6 +280,21 @@ def is_datetime_in_datetime_range(check_datetime: datetime, datetime_range: (dat
     return is_datetime_in_datetime_range_result
 
 
+# TODO add optional_prefix optional parameter. First check with optional_prefix, if not found, check without it.
+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,
+                         "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")  # noqa: E501
+    logger.end(object={"env_var": env_var})
+    return env_var
+
+
 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",
@@ -296,19 +312,21 @@ def get_environment_name(raise_if_not_found: bool = True,
     return environment_name
 
 
-# TODO add optional_prefix optional parameter. First check with optional_prefix, if not found, check without it.
-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,
-                         "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")  # noqa: E501
-    logger.end(object={"env_var": env_var})
-    return env_var
+def get_product_user_identifier(raise_if_not_found: bool = True,
+                                raise_if_empty: bool = False) -> str:
+    get_product_user_identifier_result = our_get_env("PRODUCT_USER_IDENTIFIER",
+                                                     raise_if_not_found=raise_if_not_found,  # noqa E501
+                                                     raise_if_empty=raise_if_empty)  # noqa E501
+    return get_product_user_identifier_result
+
+
+def get_product_user_password(raise_if_not_found: bool = True,
+                              raise_if_empty: bool = False) -> str:
+    # TODO Add support to PRODUCT_USER_PASSWORD and deprecation message for PRODUCT_PASSWORD (backward compatible)
+    get_product_user_password_result = our_get_env("PRODUCT_PASSWORD",
+                                                     raise_if_not_found=raise_if_not_found,  # noqa E501
+                                                     raise_if_empty=raise_if_empty)  # noqa E501
+    return get_product_user_password_result
 
 
 # TODO As only the database package uses those, let's move those three to the database package  # noqa: E501
@@ -418,7 +436,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.149.dist-info → python_sdk_remote-0.0.151.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sdk-remote
-Version: 0.0.149
+Version: 0.0.151
 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.149.dist-info → python_sdk_remote-0.0.151.dist-info}/RECORD

@@ -1,15 +1,16 @@
 python_sdk_remote/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-python_sdk_remote/constants.py,sha256=8n1iV8CJV5YdVeusue2Hfef8BGEFP72V3ycl2E0INLI,767
+python_sdk_remote/constants.py,sha256=UBJta5-UdA1Y-owTesMB4TMht-ZvHApYwXAG8EtL6uE,1372
+python_sdk_remote/constants_src_mini_logger.py,sha256=LnQ2Rkz1lEVDmL0yIxfoCwlkSgzCm8si0Cv7sbCTbbQ,301
 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=EAARhRUvUTQKeSJLDS5n9AxNra9Jk0DUyFsAMhX0wCs,4869
+python_sdk_remote/mini_logger.py,sha256=evQW5h9cXp0xAnp0RjqfzfzuJfthyriwU1Uckqs1auA,5801
 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=o-QyI5BnXmSmLbnJX3oJ-4yy5ltQxGKEVNmhHmV3E_8,17042
+python_sdk_remote/utilities.py,sha256=1tJ4PQ-T4oVIlCkmsl8B41vApxV_H2E43_N1xEfjQOU,18095
 python_sdk_remote/valid_json_versions.py,sha256=-ZU65JYI6gTEfK8o6gu9Dmm9SQmwzj5pDbEXiyUbBhQ,138
 python_sdk_remote/validate_environment.py,sha256=nzCHZDw56G56ekrTQT3gG48utjsU4VCwQi9dVsBDas0,2268
-python_sdk_remote-0.0.149.dist-info/METADATA,sha256=3GIleuiSvYJxv__8RQrkaY_XYqfztqR3XRXfIDvnKG8,729
-python_sdk_remote-0.0.149.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-python_sdk_remote-0.0.149.dist-info/top_level.txt,sha256=JTpEq_svPlI5hTlPq30Ne-NkR-u5464gjVDP2U74PvE,18
-python_sdk_remote-0.0.149.dist-info/RECORD,,
+python_sdk_remote-0.0.151.dist-info/METADATA,sha256=zCTBiou8C0-6yc6vaji3Sk6lgVOa1MB5Ma-VHspOdL4,729
+python_sdk_remote-0.0.151.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python_sdk_remote-0.0.151.dist-info/top_level.txt,sha256=JTpEq_svPlI5hTlPq30Ne-NkR-u5464gjVDP2U74PvE,18
+python_sdk_remote-0.0.151.dist-info/RECORD,,