Extract simple classes and types in common.py and create public repository.py interface

Author: febus982

README.md

@@ -178,7 +178,7 @@ to check [SQLAlchemy asyncio documentation](https://docs.sqlalchemy.org/en/20/or
 The `SQLAlchemyRepository` and `SQLAlchemyAsyncRepository` class can be used simply by extending them.
 
 ```python
-from sqlalchemy_bind_manager import SQLAlchemyRepository
+from sqlalchemy_bind_manager.repository import SQLAlchemyRepository
 
 
 class MyModel(model_declarative_base):

pyproject.toml

@@ -72,3 +72,4 @@ select = ["E", "F", "I"]
 
 [tool.ruff.per-file-ignores]
 "__init__.py" = ["F401"]
+"repository.py" = ["F401"]

sqlalchemy_bind_manager/__init__.py

@@ -3,12 +3,6 @@
     SQLAlchemyBindManager,
     SQLAlchemyConfig,
 )
-from ._repository import (
-    PaginatedResult,
-    SortDirection,
-    SQLAlchemyAsyncRepository,
-    SQLAlchemyRepository,
-)
 from ._unit_of_work import (
     AsyncUnitOfWork,
     UnitOfWork,

sqlalchemy_bind_manager/_repository/__init__.py

@@ -1,3 +1,4 @@
 from .async_ import SQLAlchemyAsyncRepository
-from .base_repository import PaginatedResult, SortDirection
+from .base_repository import SortDirection
+from .common import Cursor, CursorPaginatedResult, PaginatedResult
 from .sync import SQLAlchemyRepository

sqlalchemy_bind_manager/_repository/async_.py

@@ -18,14 +18,10 @@
 from .._transaction_handler import AsyncSessionHandler
 from ..exceptions import InvalidConfig, ModelNotFound
 from .base_repository import (
-    MODEL,
-    PRIMARY_KEY,
     BaseRepository,
-    Cursor,
-    CursorPaginatedResult,
-    PaginatedResult,
     SortDirection,
 )
+from .common import MODEL, PRIMARY_KEY, Cursor, CursorPaginatedResult, PaginatedResult
 
 
 class SQLAlchemyAsyncRepository(Generic[MODEL], BaseRepository[MODEL], ABC):

sqlalchemy_bind_manager/_repository/base_repository.py

@@ -12,61 +12,31 @@
     Mapping,
     Tuple,
     Type,
-    TypeVar,
     Union,
 )
 
-from pydantic import BaseModel
-from pydantic.generics import GenericModel
 from sqlalchemy import asc, desc, func, inspect, select
 from sqlalchemy.orm import Mapper, aliased, class_mapper, lazyload
 from sqlalchemy.orm.exc import UnmappedClassError
 from sqlalchemy.sql import Select
 
 from sqlalchemy_bind_manager.exceptions import InvalidModel, UnmappedProperty
 
-MODEL = TypeVar("MODEL")
-PRIMARY_KEY = Union[str, int, tuple, dict]
+from .common import (
+    MODEL,
+    Cursor,
+    CursorPageInfo,
+    CursorPaginatedResult,
+    PageInfo,
+    PaginatedResult,
+)
 
 
 class SortDirection(Enum):
     ASC = partial(asc)
     DESC = partial(desc)
 
 
-class PageInfo(BaseModel):
-    page: int
-    items_per_page: int
-    total_pages: int
-    total_items: int
-    has_next_page: bool
-    has_previous_page: bool
-
-
-class PaginatedResult(GenericModel, Generic[MODEL]):
-    items: List[MODEL]
-    page_info: PageInfo
-
-
-class CursorPageInfo(BaseModel):
-    items_per_page: int
-    total_items: int
-    has_next_page: bool = False
-    has_previous_page: bool = False
-    start_cursor: Union[str, None] = None
-    end_cursor: Union[str, None] = None
-
-
-class CursorPaginatedResult(GenericModel, Generic[MODEL]):
-    items: List[MODEL]
-    page_info: CursorPageInfo
-
-
-class Cursor(BaseModel):
-    column: str
-    value: str
-
-
 class BaseRepository(Generic[MODEL], ABC):
     _max_query_limit: int = 50
     _model: Type[MODEL]
@@ -435,7 +405,8 @@ def _build_cursor_paginated_result(
         return result_structure
 
     def encode_cursor(self, cursor: Cursor) -> str:
-        return b64encode(cursor.json().encode()).decode()
+        serialised_cursor = cursor.json()
+        return b64encode(serialised_cursor.encode()).decode()
 
     def decode_cursor(self, cursor: str) -> Cursor:
         return Cursor.parse_raw(b64decode(cursor))

sqlalchemy_bind_manager/_repository/common.py

@@ -0,0 +1,40 @@
+from typing import Generic, List, TypeVar, Union
+
+from pydantic import BaseModel
+from pydantic.generics import GenericModel
+
+MODEL = TypeVar("MODEL")
+PRIMARY_KEY = Union[str, int, tuple, dict]
+
+
+class PageInfo(BaseModel):
+    page: int
+    items_per_page: int
+    total_pages: int
+    total_items: int
+    has_next_page: bool
+    has_previous_page: bool
+
+
+class PaginatedResult(GenericModel, Generic[MODEL]):
+    items: List[MODEL]
+    page_info: PageInfo
+
+
+class CursorPageInfo(BaseModel):
+    items_per_page: int
+    total_items: int
+    has_next_page: bool = False
+    has_previous_page: bool = False
+    start_cursor: Union[str, None] = None
+    end_cursor: Union[str, None] = None
+
+
+class CursorPaginatedResult(GenericModel, Generic[MODEL]):
+    items: List[MODEL]
+    page_info: CursorPageInfo
+
+
+class Cursor(BaseModel):
+    column: str
+    value: str

sqlalchemy_bind_manager/_repository/sync.py

@@ -18,14 +18,10 @@
 from .._transaction_handler import SessionHandler
 from ..exceptions import InvalidConfig, ModelNotFound
 from .base_repository import (
-    MODEL,
-    PRIMARY_KEY,
     BaseRepository,
-    Cursor,
-    CursorPaginatedResult,
-    PaginatedResult,
     SortDirection,
 )
+from .common import MODEL, PRIMARY_KEY, Cursor, CursorPaginatedResult, PaginatedResult
 
 
 class SQLAlchemyRepository(Generic[MODEL], BaseRepository[MODEL], ABC):

sqlalchemy_bind_manager/_unit_of_work.py

@@ -4,12 +4,15 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.orm import Session
 
-from sqlalchemy_bind_manager import SQLAlchemyAsyncRepository, SQLAlchemyRepository
 from sqlalchemy_bind_manager._bind_manager import SQLAlchemyAsyncBind, SQLAlchemyBind
 from sqlalchemy_bind_manager._transaction_handler import (
     AsyncSessionHandler,
     SessionHandler,
 )
+from sqlalchemy_bind_manager.repository import (
+    SQLAlchemyAsyncRepository,
+    SQLAlchemyRepository,
+)
 
 
 class UnitOfWork:

sqlalchemy_bind_manager/protocols.py

@@ -9,9 +9,11 @@
     runtime_checkable,
 )
 
-from sqlalchemy_bind_manager._repository.base_repository import (
+from sqlalchemy_bind_manager._repository.common import (
     MODEL,
     PRIMARY_KEY,
+)
+from sqlalchemy_bind_manager.repository import (
     Cursor,
     CursorPaginatedResult,
     PaginatedResult,