ic-python-db 0.7.1__py3-none-any.whl

ic_python_db/hooks.py

@@ -0,0 +1,51 @@
+"""Simple hook system for entity modifications.
+
+Entities can define an on_event static method to intercept and control changes:
+
+    from ic_python_db import Entity, String, ACTION_MODIFY
+
+    class User(Entity):
+        name = String()
+
+        @staticmethod
+        def on_event(entity, field_name, old_value, new_value, action):
+            # action: ACTION_CREATE, ACTION_MODIFY, or ACTION_DELETE
+            # Returns: (allow: bool, modified_value: any)
+
+            if action == ACTION_MODIFY and field_name == 'name':
+                return True, new_value.upper()  # Auto-capitalize
+
+            return True, new_value
+"""
+
+from typing import Any, Optional, Tuple
+
+from .constants import ACTION_CREATE, ACTION_DELETE, ACTION_MODIFY
+
+
+def call_entity_hook(
+    entity, field_name: Optional[str], old_value: Any, new_value: Any, action: str
+) -> Tuple[bool, Any]:
+    """Call entity's on_event hook if defined.
+
+    Args:
+        entity: Entity instance
+        field_name: Field being changed (None for entity-level actions)
+        old_value: Previous value
+        new_value: New value
+        action: ACTION_CREATE, ACTION_MODIFY, or ACTION_DELETE
+
+    Returns:
+        (allow: bool, modified_value: Any)
+    """
+    if hasattr(entity.__class__, "on_event"):
+        hook = entity.__class__.on_event
+        if callable(hook):
+            result = hook(entity, field_name, old_value, new_value, action)
+
+            if isinstance(result, tuple) and len(result) == 2:
+                return result
+            elif isinstance(result, bool):
+                return result, new_value
+
+    return True, new_value

ic_python_db/mixins.py

@@ -0,0 +1,65 @@
+"""Mixins for adding functionality to database entities."""
+
+from typing import Any, Dict, Optional
+
+from .system_time import SystemTime
+
+
+class TimestampedMixin:
+    """Mixin that adds creation and update timestamps to entities."""
+
+    def __init__(self):
+        self._timestamp_created = 0
+        self._timestamp_updated = 0
+        self._creator = None
+        self._updater = None
+        self._owner = None
+
+    def _update_timestamps(self, caller_id: Optional[str] = None) -> None:
+        """Update timestamps and track who made the changes.
+
+        Args:
+            caller_id: ID of the user/process making the change
+        """
+        now = SystemTime.get_instance().get_time()
+        if not self._timestamp_created:
+            self._timestamp_created = now
+            self._creator = caller_id
+            self._owner = caller_id
+
+        self._timestamp_updated = now
+        self._updater = caller_id
+
+    def set_owner(self, new_owner: str) -> None:
+        """Set a new owner for this entity.
+
+        Args:
+            new_owner: ID of the new owner
+        """
+        self._owner = new_owner
+
+    def check_ownership(self, caller_id: str) -> bool:
+        """Check if the caller owns this entity.
+
+        Args:
+            caller_id: ID of the caller to check
+
+        Returns:
+            bool: True if caller owns the entity, False otherwise
+        """
+        return self._owner == caller_id
+
+    def serialize(self) -> Dict[str, Any]:
+        """Convert timestamps and ownership info to a dictionary.
+
+        Returns:
+            Dict containing the timestamp and ownership data
+        """
+
+        return {
+            "timestamp_created": SystemTime.format_timestamp(self._timestamp_created),
+            "timestamp_updated": SystemTime.format_timestamp(self._timestamp_updated),
+            "creator": self._creator,
+            "updater": self._updater,
+            "owner": self._owner,
+        }