atk-common 1.60.0__py3-none-any.whl → 1.61.0__py3-none-any.whl

atk_common/__init__.py

@@ -1,4 +1,5 @@
 # __init__.py
+from atk_common.consumer_retry_handler import create_retrying_handler
 from atk_common.datetime_utils import \
     get_utc_date_time, \
     get_utc_date_time_str, \
@@ -9,6 +10,7 @@ from atk_common.datetime_utils import \
     convert_to_utc, \
     convert_to_utc_image_dt
 from atk_common.db_utils import sql, sql_with_record, convert_none_to_null, date_time_utc_column
+from atk_common.default_should_retry import default_should_retry
 from atk_common.docker_utils import get_current_container_info, set_container_metadata
 from atk_common.env_utils import get_env_value
 from atk_common.error_utils import get_message, create_error_log, get_error_entity, resend_error_entity, handle_error, get_response_error, get_error_type
@@ -22,6 +24,7 @@ from atk_common.mq_utils import decode_message
 from atk_common.rabbitmq_consumer import RabbitMQConsumer
 
 __all__ = [
+    'create_retrying_handler',
     'get_utc_date_time',
     'get_utc_date_time_str',
     'get_utc_date_time_str_with_z',
@@ -34,6 +37,7 @@ __all__ = [
     'sql_with_record',
     'convert_none_to_null',
     'date_time_utc_column',
+    'default_should_retry',
     'get_current_container_info',
     'set_container_metadata',
     'get_env_value',

atk_common/consumer_retry_handler.py

@@ -0,0 +1,49 @@
+from kombu import Producer
+from atk_common import *
+
+def create_retry_handler(process_func, connection, exchange, routing_key, should_retry, log, declare=None):
+    """
+    process_func: your original handler function (body, message)
+    retry_queue: kombu.Queue instance to republish to
+    should_retry: function(message_status) -> bool
+    log: function for logging
+    """
+
+    def handler(body, message):
+        try:
+            process_response = process_func(body, message)
+            if is_response_ok(process_response):
+                message.ack()
+            else:
+                if connection is not None:
+                    # Use retry queue
+                    if should_retry(process_response):
+                        log("Retrying after delay...")
+                        with connection.Producer() as producer:
+                            producer.publish(
+                                message.body,
+                                exchange=exchange,
+                                routing_key=routing_key,
+                                retry=True,
+                                declare=declare,
+                                content_type=message.content_type,
+                                content_encoding=message.content_encoding,
+                                headers=message.headers,
+                                timestamp=message.properties.get("timestamp")
+                            )
+                        message.ack()
+                    else:
+                        log("Sending to DLQ...")
+                        message.reject(requeue=False)
+                else:
+                    if should_retry(process_response):
+                        log("Requing...")
+                        message.requeue()
+                    else:
+                        log("Sending to DLQ...")
+                        message.reject(requeue=False)
+        except Exception as e:
+            log(f"Error during processing: {e}")
+            message.reject(requeue=False)
+
+    return handler

atk_common/default_should_retry.py

@@ -0,0 +1,19 @@
+from atk_common.enums.api_error_type_enum import ApiErrorType
+from atk_common.enums.response_status_type_enum import ResponseStatusType
+from atk_common.http_utils import is_http_status_internal, is_http_status_ok
+
+def default_should_retry(message_status):
+    if message_status['status'] == ResponseStatusType.HTTP:
+        status_code = message_status['statusCode']
+        if is_http_status_ok(status_code):
+            return False
+        elif is_http_status_internal(status_code):
+            #errorType = 1: connection error
+            #errorType = 2: api internal error (database, etc)
+            if message_status['responseMsg']['errorType'] == ApiErrorType.CONNECTION.value:
+                return True
+            else:
+                return False
+        else:
+            return True
+    return True

atk_common/env_utils.py

@@ -3,16 +3,25 @@ from atk_common.log_utils import add_log_item
 
 def val_str(value):
     if value is None:
-        return 'Empty'
+        return '<Empty>'
     if isinstance(value, str):
+        if value.strip() == '' or value.lower() == 'null':
+            return '<Null>'
         return value
     return str(value)
 
+def is_value_null_or_empty(value):
+    if isinstance(value, str):
+        return value.strip() == '' or value.lower() == 'null'
+    return False
+
 def get_env_value(key, abort_on_error=True):
     val = os.environ.get(key)
+    add_log_item(key + ':' + val_str(val))
     if val is None and abort_on_error:
         err_msg = f"Environment variable '{key}' is not set."
         add_log_item(err_msg)
         raise ValueError(err_msg)
-    add_log_item(key + ':' + val_str(val))
+    if is_value_null_or_empty(val):
+        return None
     return val

{atk_common-1.60.0.dist-info → atk_common-1.61.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: atk_common
-Version: 1.60.0
+Version: 1.61.0
 Summary: ATK common methods
 Home-page: https://github.com/pypa/atk_common
 Author: Roger

{atk_common-1.60.0.dist-info → atk_common-1.61.0.dist-info}/RECORD

@@ -1,8 +1,10 @@
-atk_common/__init__.py,sha256=mKQGfrr7s2-P4qSkk3NAGZ-nlmogn0JJtGIWEyA7MaI,2213
+atk_common/__init__.py,sha256=Jj4qRsn_GlEagAS2kDyHkk1tz-jsf9EZcjuQEhn0Zfk,2411
+atk_common/consumer_retry_handler.py,sha256=Djig-DIh0FeL_vKWkWg05dAxI8y991kNipQDrhKKBxQ,2082
 atk_common/datetime_utils.py,sha256=0SC5-Nai4RJH9B0VzvGKUQts_QeRXGb7tJLlsh73LJw,3556
 atk_common/db_utils.py,sha256=odUtXcS7Mumw5eGyVyVimL_U_lP7TqMX9v8nWO5nMvg,902
+atk_common/default_should_retry.py,sha256=lchNA42vnB0qz26BlNA-be05p2eKv_34E6qaRce5trU,832
 atk_common/docker_utils.py,sha256=Z7BGCV5IX-O38jLSTDBN8k617zMsYDHL3VWdhoBXVfs,2504
-atk_common/env_utils.py,sha256=YDeIhKMNLuw_zsBGjMrlQGl6IT3QKf_GIRA8uPeZIT4,513
+atk_common/env_utils.py,sha256=VCXEaAEGWFdQr5x7pKmks1Xs_g6gyrcwikqSz2XfETo,813
 atk_common/error_utils.py,sha256=kO-VQlajD8SO9MBxj8MHZRTK_uBXgPa09hy6pfjqZBY,2622
 atk_common/file_utils.py,sha256=UDwcRquO9IrqRrlUM0t-_g4R1-FKt8ZqQinSEqXOAk8,112
 atk_common/hash_utils.py,sha256=S_9o89CdI4lUQbVaqc85TDcqyDNuo30_E3VBaOrZKko,1047
@@ -52,7 +54,7 @@ atk_common/enums/speed_control_status_type_enum.py,sha256=qpURh0K1L1tSpbrzVnckoe
 atk_common/enums/speed_control_stop_reason.py,sha256=pvLS6fpDhsCiIDAmiQBsHctxZnq-Dl2BOgJOxQnT5Hc,200
 atk_common/enums/test_image_type_enum.py,sha256=HUjxJorehnzRXMNF2uHk2DrAJ3Y_ajQvp0jW-mtlOhU,140
 atk_common/enums/violation_type_enum.py,sha256=01qTHOj-O8bOc-nwIHVnxLosm4cusD_YuqXM3ZsiRRk,86
-atk_common-1.60.0.dist-info/licenses/license.txt,sha256=_0O6fWM00-wTurDjnZhUP_N5QiwGhItaQZqHq5eqadA,1063
+atk_common-1.61.0.dist-info/licenses/license.txt,sha256=_0O6fWM00-wTurDjnZhUP_N5QiwGhItaQZqHq5eqadA,1063
 atk_package/__init__.py,sha256=NcsmwFadivgIeWV0-5ACZxqmfo4EzTkJX0r4N6DFAdg,820
 atk_package/datetime_utils.py,sha256=qsVF7l90P1-xukG2tV_jLqG9J_Yfl5wTpyfrdPBlyMo,239
 atk_package/env_utils.py,sha256=bXOrxM3fZUslqfmZt75iphbEJHbG4riJa8XOVzPwIII,313
@@ -65,7 +67,7 @@ atk_package/enums/__init__.py,sha256=EtUr_--MQj1Rc_R0sF_ELXIThmhpfmhDWq3YaK9oQMk
 atk_package/enums/command_status_enum.py,sha256=M2Nln27a_DbzI07-gfytWQk2X087JhkU6Fmard5qVHs,127
 atk_package/enums/speed_control_status_enum.py,sha256=qpURh0K1L1tSpbrzVnckoe4hUn1illIkbo7k4mLfzIM,182
 shared_python_atk_enforcement/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atk_common-1.60.0.dist-info/METADATA,sha256=jzQN40D-3XiZxU8FekkTujTW_40YgLtRSXrKeiW5kQ4,1761
-atk_common-1.60.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-atk_common-1.60.0.dist-info/top_level.txt,sha256=4CwRjkLnheIdI4jQwc4tK3dbRc58WqUmoqjkdDTWlME,41
-atk_common-1.60.0.dist-info/RECORD,,
+atk_common-1.61.0.dist-info/METADATA,sha256=Mu-RG92UkV4P6uz09VmEsbvZmXbA9UkjlX00KdgXYy8,1761
+atk_common-1.61.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+atk_common-1.61.0.dist-info/top_level.txt,sha256=4CwRjkLnheIdI4jQwc4tK3dbRc58WqUmoqjkdDTWlME,41
+atk_common-1.61.0.dist-info/RECORD,,