Add BaseUseCase Class

.github/workflows/pr.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - 'main'
+      - 'develop'
 
 jobs:
   mf_data_test:

README.ko.md

@@ -202,7 +202,7 @@ SQLAlchemy에서 기본적으로 제공하는 작업 단위 패턴 외에 직접
 from sqlalchemy.engine import Engine
 from sqlalchemy.ext.asyncio import AsyncEngine
 
-from pymfdata.rdb.command import AsyncSQLAlchemyUnitOfWork, SyncSQLAlchemyUnitOfWork
+from pymfdata.rdb.usecase import AsyncSQLAlchemyUnitOfWork, SyncSQLAlchemyUnitOfWork
 from pymfdata.rdb.transaction import async_transactional
 
 
@@ -214,7 +214,7 @@ class AsyncMemoUseCaseUnitOfWork(AsyncSQLAlchemyUnitOfWork):
         await super().__aenter__()
 
         self.memo_repository: MemoRepository = MemoRepository(self.session)
-            
+
 
 class MemoUseCase:
     def __init__(self, uow: AsyncMemoUseCaseUnitOfWork) -> None:

README.md

@@ -203,7 +203,7 @@ SQLAlchemy uses the unit of work pattern by default, but if you want to define y
 from sqlalchemy.engine import Engine
 from sqlalchemy.ext.asyncio import AsyncEngine
 
-from pymfdata.rdb.command import AsyncSQLAlchemyUnitOfWork, SyncSQLAlchemyUnitOfWork
+from pymfdata.rdb.usecase import AsyncSQLAlchemyUnitOfWork, SyncSQLAlchemyUnitOfWork
 from pymfdata.rdb.transaction import async_transactional
 
 
@@ -215,7 +215,7 @@ class AsyncMemoUseCaseUnitOfWork(AsyncSQLAlchemyUnitOfWork):
         await super().__aenter__()
 
         self.memo_repository: MemoRepository = MemoRepository(self.session)
-            
+
 
 class MemoUseCase:
     def __init__(self, uow: AsyncMemoUseCaseUnitOfWork) -> None:

pymfdata/common/command.py → pymfdata/common/usecase.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Optional, Type
+from typing import final, Optional, Protocol, Type, Union
 
 
 class AsyncBaseUnitOfWork(ABC):
@@ -36,3 +36,12 @@ def commit(self):
     @abstractmethod
     def rollback(self):
         raise NotImplementedError("Choice ORM rollback func")
+
+
+class BaseUseCase(Protocol):
+    _uow: Union[AsyncBaseUnitOfWork, SyncBaseUnitOfWork]
+
+    @property
+    def uow(self):
+        assert self._uow is not None
+        return self._uow

pymfdata/rdb/transaction.py

@@ -1,6 +1,6 @@
 import enum
 
-from pymfdata.rdb.command import AsyncSession, Session
+from pymfdata.rdb.usecase import AsyncSession, Session
 
 
 class Propagation(enum.Enum):

pymfdata/rdb/command.py → pymfdata/rdb/usecase.py

@@ -3,7 +3,7 @@
 from sqlalchemy.orm import Session
 from typing import Optional, Type
 
-from pymfdata.common.command import AsyncBaseUnitOfWork, SyncBaseUnitOfWork
+from pymfdata.common.usecase import AsyncBaseUnitOfWork, SyncBaseUnitOfWork
 
 
 class AsyncSQLAlchemyUnitOfWork(AsyncBaseUnitOfWork):

tests/rdb/domain/usecase.py

@@ -1,7 +1,8 @@
 from sqlalchemy.engine import Engine
 from sqlalchemy.ext.asyncio import AsyncEngine
 
-from pymfdata.rdb.command import AsyncSQLAlchemyUnitOfWork, SyncSQLAlchemyUnitOfWork
+from pymfdata.common.usecase import BaseUseCase
+from pymfdata.rdb.usecase import AsyncSQLAlchemyUnitOfWork, SyncSQLAlchemyUnitOfWork
 from pymfdata.rdb.transaction import async_transactional
 
 from tests.rdb.domain.dto import MemoRequest
@@ -28,9 +29,9 @@ def __enter__(self):
         self.memo_repository: SyncMemoRepository = SyncMemoRepository(self.session)
 
 
-class MemoUseCase:
+class MemoUseCase(BaseUseCase):
     def __init__(self, uow: AsyncMemoUseCaseUnitOfWork) -> None:
-        self.uow = uow
+        self._uow = uow
 
     @async_transactional(read_only=True)
     async def find_by_id(self, item_id: int):