velocity-python 0.0.95__py3-none-any.whl → 0.0.96__py3-none-any.whl

velocity/__init__.py

@@ -1,4 +1,4 @@
-__version__ = version = "0.0.95"
+__version__ = version = "0.0.96"
 
 from . import aws
 from . import db

velocity/aws/handlers/sqs_handler.py

@@ -1,97 +1,230 @@
-from velocity.misc.format import to_json
+"""
+SQS Handler Module
+
+This module provides a base class for handling AWS SQS events in Lambda functions.
+It includes logging capabilities, action routing, and error handling.
+"""
+
 import json
-import sys
 import os
+import sys
 import traceback
+from typing import Any, Dict, Optional
+
 from velocity.aws import DEBUG
 from velocity.aws.handlers import context as VelocityContext
+from velocity.misc.format import to_json
 
 
 class SqsHandler:
+    """
+    Base class for handling SQS events in AWS Lambda functions.
+    
+    Provides structured processing of SQS records with automatic action routing,
+    logging capabilities, and error handling hooks.
+    """
+
+    def __init__(self, aws_event: Dict[str, Any], aws_context: Any, 
+                 context_class=VelocityContext.Context):
+        """
+        Initialize the SQS handler.
+        
+        Args:
+            aws_event: The AWS Lambda event containing SQS records
+            aws_context: The AWS Lambda context object
+            context_class: The context class to use for processing
+        """
+        self.aws_event = aws_event
+        self.aws_context = aws_context
+        self.serve_action_default = True
+        self.skip_action = False
+        self.ContextClass = context_class
 
-    def __init__(self, aws_event, aws_context, context_class=VelocityContext.Context):
         self.aws_event = aws_event
         self.aws_context = aws_context
         self.serve_action_default = True
         self.skip_action = False
         self.ContextClass = context_class
 
-    def log(self, tx, message, function=None):
+    def log(self, tx, message: str, function: Optional[str] = None):
+        """
+        Log a message to the system log table.
+        
+        Args:
+            tx: Database transaction object
+            message: The message to log
+            function: Optional function name, auto-detected if not provided
+        """
         if not function:
-            function = "<Unknown>"
-            idx = 0
-            while True:
-                try:
-                    temp = sys._getframe(idx).f_code.co_name
-                except ValueError as e:
-                    break
-                if temp in ["x", "log", "_transaction"]:
-                    idx += 1
-                    continue
-                function = temp
-                break
+            function = self._get_calling_function()
 
         data = {
-            "app_name": os.environ["ProjectName"],
+            "app_name": os.environ.get("ProjectName", "Unknown"),
             "referer": "SQS",
             "user_agent": "QueueHandler",
             "device_type": "Lambda",
             "function": function,
             "message": message,
-            "sys_modified_by": "lambda:BackOfficeQueueHandler",
+            "sys_modified_by": "Lambda:BackOfficeQueueHandler",
         }
         tx.table("sys_log").insert(data)
+    
+    def _get_calling_function(self) -> str:
+        """
+        Get the name of the calling function by inspecting the call stack.
+        
+        Returns:
+            The name of the calling function or "<Unknown>" if not found
+        """
+        skip_functions = {"x", "log", "_transaction", "_get_calling_function"}
+        
+        for idx in range(10):  # Limit search to prevent infinite loops
+            try:
+                frame = sys._getframe(idx)
+                function_name = frame.f_code.co_name
+                
+                if function_name not in skip_functions:
+                    return function_name
+                    
+            except ValueError:
+                # No more frames in the stack
+                break
+                
+        return "<Unknown>"
 
     def serve(self, tx):
+        """
+        Process all SQS records in the event.
+        
+        Args:
+            tx: Database transaction object
+        """
         records = self.aws_event.get("Records", [])
+        
         for record in records:
-            attrs = record.get("attributes")
-            postdata = {}
-            if record.get("body"):
-                postdata = json.loads(record.get("body"))
-
-            local_context = self.ContextClass(
-                aws_event=self.aws_event,
-                aws_context=self.aws_context,
-                args=attrs,
-                postdata=postdata,
-                response=None,
-                session=None,
-            )
+            self._process_record(tx, record)
+    
+    def _process_record(self, tx, record: Dict[str, Any]):
+        """
+        Process a single SQS record.
+        
+        Args:
+            tx: Database transaction object
+            record: Individual SQS record to process
+        """
+        attrs = record.get("attributes", {})
+        postdata = {}
+        
+        # Parse message body if present
+        body = record.get("body")
+        if body:
             try:
-                if hasattr(self, "beforeAction"):
-                    self.beforeAction(local_context)
-                actions = []
-                action = local_context.action()
-                if action:
-                    actions.append(
-                        f"on action {action.replace('-', ' ').replace('_', ' ')}".title().replace(
-                            " ", ""
-                        )
-                    )
-                if self.serve_action_default:
-                    actions.append("OnActionDefault")
-                for action in actions:
-                    if self.skip_action:
-                        return
-                    if hasattr(self, action):
-                        getattr(self, action)(local_context)
-                        break
-                if hasattr(self, "afterAction"):
-                    self.afterAction(local_context)
-            except Exception as e:
-                if hasattr(self, "onError"):
-                    self.onError(
-                        local_context,
-                        exc=e.__class__.__name__,
-                        tb=traceback.format_exc(),
-                    )
+                postdata = json.loads(body)
+            except json.JSONDecodeError as e:
+                print(f"Failed to parse SQS message body as JSON: {e}")
+                postdata = {"raw_body": body}
+
+        # Create local context for this record
+        local_context = self.ContextClass(
+            aws_event=self.aws_event,
+            aws_context=self.aws_context,
+            args=attrs,
+            postdata=postdata,
+            response=None,
+            session=None,
+        )
+        
+        try:
+            self._execute_actions(local_context)
+        except Exception as e:
+            if hasattr(self, "onError"):
+                self.onError(
+                    local_context,
+                    exc=e.__class__.__name__,
+                    tb=traceback.format_exc(),
+                )
+            else:
+                # Re-raise if no error handler is defined
+                raise
+    
+    def _execute_actions(self, local_context):
+        """
+        Execute the appropriate actions for the given context.
+        
+        Args:
+            local_context: The context object for this record
+        """
+        # Execute beforeAction hook if available
+        if hasattr(self, "beforeAction"):
+            self.beforeAction(local_context)
+        
+        # Determine which actions to execute
+        actions = self._get_actions_to_execute(local_context)
+        
+        # Execute the first matching action
+        for action in actions:
+            if self.skip_action:
+                return
+                
+            if hasattr(self, action):
+                getattr(self, action)(local_context)
+                break
+        
+        # Execute afterAction hook if available
+        if hasattr(self, "afterAction"):
+            self.afterAction(local_context)
+    
+    def _get_actions_to_execute(self, local_context) -> list:
+        """
+        Get the list of actions to execute for the given context.
+        
+        Args:
+            local_context: The context object for this record
+            
+        Returns:
+            List of action method names to try executing
+        """
+        actions = []
+        
+        # Add specific action if available
+        action = local_context.action()
+        if action:
+            action_method = self._format_action_name(action)
+            actions.append(action_method)
+        
+        # Add default action if enabled
+        if self.serve_action_default:
+            actions.append("OnActionDefault")
+            
+        return actions
+    
+    def _format_action_name(self, action: str) -> str:
+        """
+        Format an action string into a method name.
+        
+        Args:
+            action: The raw action string
+            
+        Returns:
+            Formatted method name
+        """
+        formatted = action.replace('-', ' ').replace('_', ' ')
+        return f"on action {formatted}".title().replace(" ", "")
 
     def OnActionDefault(self, tx, context):
-        print(
-            f"""
-            [Warn] Action handler not found. Calling default action `SqsHandler.OnActionDefault` with the following parameters for attrs, and postdata:
-            attrs: {str(context.args())}
-            postdata: {str(context.postdata())}
-            """
+        """
+        Default action handler when no specific action is found.
+        
+        Args:
+            tx: Database transaction object
+            context: The context object for this record
+        """
+        action = context.action() if hasattr(context, 'action') else 'unknown'
+        warning_message = (
+            f"[Warn] Action handler not found. Calling default action "
+            f"`SqsHandler.OnActionDefault` with the following parameters:\n"
+            f"  - action: {action}\n"
+            f"  - attrs: {context.args()}\n"
+            f"  - postdata: {context.postdata()}"
         )
+        print(warning_message)

{velocity_python-0.0.95.dist-info → velocity_python-0.0.96.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: velocity-python
-Version: 0.0.95
+Version: 0.0.96
 Summary: A rapid application development library for interfacing with data storage
 Author-email: Velocity Team <contact@example.com>
 License: MIT

{velocity_python-0.0.95.dist-info → velocity_python-0.0.96.dist-info}/RECORD

@@ -1,4 +1,4 @@
-velocity/__init__.py,sha256=Ia6_qjrZBVx6x83-y9sI4W7UBXzNOKPSIofuJb7lVrk,106
+velocity/__init__.py,sha256=Vu_ESj4QSJKxwVVLSBVPrZH3Wl_7Indluy1KRK1W9_Q,106
 velocity/app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 velocity/app/invoices.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 velocity/app/orders.py,sha256=W-HAXEwY8-IFXbKh82HnMeRVZM7P-TWGEQOWtkLIzI4,6298
@@ -10,7 +10,7 @@ velocity/aws/handlers/__init__.py,sha256=xnpFZJVlC2uoeeFW4zuPST8wA8ajaQDky5Y6iXZ
 velocity/aws/handlers/context.py,sha256=UIjNR83y2NSIyK8HMPX8t5tpJHFNabiZvNgmmdQL3HA,1822
 velocity/aws/handlers/lambda_handler.py,sha256=0KrT6UIxDILzBRpoRSvwDgHpQ-vWfubcZFOCbJsewDc,6516
 velocity/aws/handlers/response.py,sha256=LXhtizLKnVBWjtHyE0h0bk-NYDrRpj7CHa7tRz9KkC4,9324
-velocity/aws/handlers/sqs_handler.py,sha256=YBqrEkA6EfkQUVk_kwsSI-HjFJO8-JqYco-p0UYDNXE,3368
+velocity/aws/handlers/sqs_handler.py,sha256=akkDeZzTBShh2V1bSjl4VgRHCABBMt8fz3Zj9SgooPI,7340
 velocity/db/__init__.py,sha256=vrn2AFNAKaqTdnPwLFS0OcREcCtzUCOodlmH54U7ADg,200
 velocity/db/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 velocity/db/core/column.py,sha256=tAr8tL3a2nyaYpNHhGl508FrY_pGZTzyYgjAV5CEBv4,4092
@@ -47,8 +47,8 @@ velocity/misc/tools.py,sha256=_bGneHHA_BV-kUonzw5H3hdJ5AOJRCKfzhgpkFbGqIo,1502
 velocity/misc/conv/__init__.py,sha256=MLYF58QHjzfDSxb1rdnmLnuEQCa3gnhzzZ30CwZVvQo,40
 velocity/misc/conv/iconv.py,sha256=d4_BucW8HTIkGNurJ7GWrtuptqUf-9t79ObzjJ5N76U,10603
 velocity/misc/conv/oconv.py,sha256=h5Lo05DqOQnxoD3y6Px_MQP_V-pBbWf8Hkgkb9Xp1jk,6032
-velocity_python-0.0.95.dist-info/licenses/LICENSE,sha256=aoN245GG8s9oRUU89KNiGTU4_4OtnNmVi4hQeChg6rM,1076
-velocity_python-0.0.95.dist-info/METADATA,sha256=0ve_k4tFITuVudvOEsARj3hIPyuaAhTCEWXhTiTUA3g,33022
-velocity_python-0.0.95.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-velocity_python-0.0.95.dist-info/top_level.txt,sha256=JW2vJPmodgdgSz7H6yoZvnxF8S3fTMIv-YJWCT1sNW0,9
-velocity_python-0.0.95.dist-info/RECORD,,
+velocity_python-0.0.96.dist-info/licenses/LICENSE,sha256=aoN245GG8s9oRUU89KNiGTU4_4OtnNmVi4hQeChg6rM,1076
+velocity_python-0.0.96.dist-info/METADATA,sha256=n_d34QeGMb4TaeXSH5p-RJvynnHZLHde4a3SCCK-wzY,33022
+velocity_python-0.0.96.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+velocity_python-0.0.96.dist-info/top_level.txt,sha256=JW2vJPmodgdgSz7H6yoZvnxF8S3fTMIv-YJWCT1sNW0,9
+velocity_python-0.0.96.dist-info/RECORD,,