sqlalchemy-events-lib 0.3.1__tar.gz → 0.3.2__tar.gz

{sqlalchemy_events_lib-0.3.1 → sqlalchemy_events_lib-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlalchemy-events-lib
-Version: 0.3.1
+Version: 0.3.2
 Summary: Event-driven extension for SQLAlchemy that enables listening to database CUD events. This library allows you to react to database changes in real time using a clean, declarative API.
 Author-email: Alexey Kostarev <normjkeeewm@gmail.com>
 License: MIT

{sqlalchemy_events_lib-0.3.1 → sqlalchemy_events_lib-0.3.2}/pyproject.toml

@@ -10,7 +10,7 @@ where = ["src"]
 
 [project]
 name = "sqlalchemy-events-lib"
-version = "0.3.1"
+version = "0.3.2"
 description = "Event-driven extension for SQLAlchemy that enables listening to database CUD events. This library allows you to react to database changes in real time using a clean, declarative API."
 requires-python = ">=3.12"
 authors = [

{sqlalchemy_events_lib-0.3.1 → sqlalchemy_events_lib-0.3.2}/src/sqlalchemy_events/__init__.py

@@ -11,4 +11,4 @@ __all__ = [
     'with_events',
     'SaEvent'
 ]
-__version__ = '0.3.1'
+__version__ = '0.3.2'

{sqlalchemy_events_lib-0.3.1 → sqlalchemy_events_lib-0.3.2}/src/sqlalchemy_events/callbacks_strategies/postgres_callback.py

@@ -66,4 +66,4 @@ class PostgresCallback(SaEventsCallbacksStrategy):
                     )
                 )
 
-        await asyncio.gather(*tasks)
+        return await asyncio.gather(*tasks)

{sqlalchemy_events_lib-0.3.1 → sqlalchemy_events_lib-0.3.2}/src/sqlalchemy_events/handlers.py

@@ -1,5 +1,3 @@
-import inspect
-from pathlib import Path
 from typing import Callable, Type
 
 from sqlalchemy.orm import DeclarativeBase
@@ -13,21 +11,20 @@ def __inner(func: Callable, sa_event: SaEvent, model: Type[DeclarativeBase]):
     if not issubclass(model, DeclarativeBase):
         raise RuntimeError('Model must inherit from DeclarativeBase')
 
+    if '.' in func.__qualname__ and not isinstance(func, staticmethod):
+        raise RuntimeError(f'Handler must be a regular function or staticmethod, not method or classmethod of '
+                           f'{func.__qualname__.split('.')[0]}')
+
+    if isinstance(func, staticmethod):
+        func = func.__func__
+
     event_handlers = get_event_handlers()
     trig_name = f'sa_{model.__tablename__}_{sa_event.lower()}_notify'
-    func_path = inspect.getsourcefile(func) or inspect.getfile(func)
-    func_path = Path(func_path)
-    func_path_name = f'{func_path.parent.name}/{func_path.name}/{func.__name__}'
     handlers: list[Handler] | None = event_handlers.get(trig_name)
+
     obj_handler = Handler(func=func, args={'model': model})
-    if handlers:
-        for handler in handlers:
-            handler_path = inspect.getsourcefile(handler.func) or inspect.getfile(handler.func)
-            handler_path = Path(handler_path)
-            handler_path_name = f'{handler_path.parent.name}/{handler_path.name}/{handler.func.__name__}'
-            if func_path_name == handler_path_name:
-                continue
-            handlers.append(obj_handler)
+    if handlers and obj_handler not in handlers:
+        handlers.append(obj_handler)
     else:
         event_handlers[trig_name] = [obj_handler]
 

{sqlalchemy_events_lib-0.3.1 → sqlalchemy_events_lib-0.3.2}/src/sqlalchemy_events/registry.py

@@ -11,5 +11,5 @@ if _GLOBAL_KEY not in sys.modules:
 _registry = sys.modules[_GLOBAL_KEY]
 
 
-def get_event_handlers():
+def get_event_handlers() -> dict:
     return _registry.handlers

sqlalchemy_events_lib-0.3.2/src/sqlalchemy_events/types.py

@@ -0,0 +1,40 @@
+import inspect
+from dataclasses import dataclass
+from enum import StrEnum
+from pathlib import Path
+from typing import Any, Awaitable, Callable, TypeAlias, Union
+
+
+class SaEvent(StrEnum):
+    INSERT = 'INSERT'
+    UPDATE = 'UPDATE'
+    DELETE = 'DELETE'
+
+
+class Dialect(StrEnum):
+    POSTGRESQL = 'postgresql'
+    SQLITE = 'sqlite'
+    MYSQL = 'mysql'
+    MSSQL = 'mssql'
+    ORACLE = 'oracle'
+
+
+@dataclass
+class Handler:
+    func: Union[Callable, Awaitable]
+    args: dict[str, Any]
+    full_path: str | None = None
+
+    def __post_init__(self):
+        func_path = inspect.getsourcefile(self.func) or inspect.getfile(self.func)
+        func_path = Path(func_path)
+        self.full_path = f'{func_path.parent.name}/{func_path.name}/{self.func.__name__}'
+
+    def __hash__(self):
+        return hash(self.full_path)
+
+    def __eq__(self, other):
+        return self.full_path == other.full_path
+
+
+DB_ID: TypeAlias = str | int

{sqlalchemy_events_lib-0.3.1 → sqlalchemy_events_lib-0.3.2}/src/sqlalchemy_events_lib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlalchemy-events-lib
-Version: 0.3.1
+Version: 0.3.2
 Summary: Event-driven extension for SQLAlchemy that enables listening to database CUD events. This library allows you to react to database changes in real time using a clean, declarative API.
 Author-email: Alexey Kostarev <normjkeeewm@gmail.com>
 License: MIT

{sqlalchemy_events_lib-0.3.1 → sqlalchemy_events_lib-0.3.2}/src/tests/conftest.py

@@ -1,4 +1,3 @@
-import asyncio
 import os
 
 import pytest_asyncio
@@ -7,6 +6,8 @@ from dotenv import load_dotenv
 from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker
 from sqlalchemy import text
 from sqlalchemy_events import SQLAlchemyEvents
+from sqlalchemy_events.events import sa_events_strategy
+from sqlalchemy_events.utils import dialect_resolver
 
 from tests.test_models import Base
 
@@ -45,4 +46,10 @@ async def session(engine):
 
     async with async_session() as session:
         yield session
-        await session.rollback()
+        await session.rollback()
+
+
+@pytest_asyncio.fixture
+async def mock_callback(engine):
+    dialect = dialect_resolver(engine)
+    yield sa_events_strategy[dialect].callback

{sqlalchemy_events_lib-0.3.1 → sqlalchemy_events_lib-0.3.2}/src/tests/test_autodiscover.py

@@ -117,18 +117,17 @@ async def test_discover_handlers():
     assert handlers
     result_handlers = []
     for key, handler_list in handlers.items():
-        assert len(handler_list) == 1
         if 'insert' in key:
             assert handler_list[0].func.__name__ == 'insert_handler'
-            result_handlers.extend(handler_list)
+            result_handlers.append(handler_list[0])
         if 'update' in key:
             assert handler_list[0].func.__name__ == 'update_handler'
-            result_handlers.extend(handler_list)
+            result_handlers.append(handler_list[0])
         if 'delete' in key:
             assert handler_list[0].func.__name__ == 'delete_handler'
-            result_handlers.extend(handler_list)
+            result_handlers.append(handler_list[0])
 
-    assert len(result_handlers) == len(handlers)
+    assert len(result_handlers) == 3
 
 
 def test_invalid_autodiscover_path():

sqlalchemy_events_lib-0.3.2/src/tests/test_handlers.py

@@ -0,0 +1,79 @@
+import json
+import pytest
+
+from sqlalchemy_events import sa_delete_handler, sa_insert_handler, sa_update_handler
+from tests.test_models import UserModel
+
+
+def test_invalid_model_in_handler():
+    with pytest.raises(RuntimeError):
+        @sa_insert_handler(object)
+        def test_func():
+            pass
+
+
+def test_handler_signature():
+    with pytest.raises(TypeError):
+        @sa_insert_handler()
+        def test_func():
+            pass
+
+
+class Test:
+    def test_method(self):
+        pass
+
+    @classmethod
+    def test_class_method(cls):
+        pass
+
+    @staticmethod
+    def test_static_method():
+        pass
+
+
+def test_handler_in_class():
+    with pytest.raises(RuntimeError):
+        sa_insert_handler(UserModel)(Test().test_method)
+
+    with pytest.raises(RuntimeError):
+        sa_update_handler(UserModel)(Test.test_class_method)
+
+
+@sa_insert_handler(UserModel)
+async def insert_user_handler(rows):
+    assert rows == [1, 2, 3]
+    return rows
+
+
+@sa_update_handler(UserModel)
+async def update_user_handler(rows):
+    assert rows == [4, 5, 6]
+    return rows
+
+
+@sa_delete_handler(UserModel)
+async def delete_user_handler(rows):
+    assert rows == [7, 8, 9]
+    return rows
+
+
+@pytest.mark.parametrize(
+    'op,rows,resp',
+    [
+        ('insert', [1, 2, 3], [None, [1, 2, 3]]),
+        ('update', [4, 5, 6], [None, [4, 5, 6]]),
+        ('delete', [7, 8, 9], [None, [7, 8, 9]]),
+    ]
+)
+async def test_handlers(mock_callback, op, rows, resp):
+    response = await mock_callback.handle(
+        None, None, None, json.dumps(
+            {
+                'op': op,
+                'table': 'users',
+                'rows': rows
+            }
+        )
+    )
+    assert response == resp

sqlalchemy_events_lib-0.3.1/src/sqlalchemy_events/types.py

@@ -1,26 +0,0 @@
-from dataclasses import dataclass
-from enum import StrEnum
-from typing import Any, Awaitable, Callable, TypeAlias, Union
-
-
-class SaEvent(StrEnum):
-    INSERT = 'INSERT'
-    UPDATE = 'UPDATE'
-    DELETE = 'DELETE'
-
-
-class Dialect(StrEnum):
-    POSTGRESQL = 'postgresql'
-    SQLITE = 'sqlite'
-    MYSQL = 'mysql'
-    MSSQL = 'mssql'
-    ORACLE = 'oracle'
-
-
-@dataclass
-class Handler:
-    func: Union[Callable, Awaitable]
-    args: dict[str, Any]
-
-
-DB_ID: TypeAlias = str | int

sqlalchemy_events_lib-0.3.1/src/tests/test_handlers.py

@@ -1,17 +0,0 @@
-import pytest
-
-from sqlalchemy_events import sa_insert_handler
-
-
-def test_invalid_model_in_handler():
-    with pytest.raises(RuntimeError):
-        @sa_insert_handler(object)
-        def test_func():
-            pass
-
-
-def test_handler_signature():
-    with pytest.raises(TypeError):
-        @sa_insert_handler()
-        def test_func():
-            pass