fastapi-toolsets 0.3.0__tar.gz → 0.4.0__tar.gz

{fastapi_toolsets-0.3.0 → fastapi_toolsets-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-toolsets
-Version: 0.3.0
+Version: 0.4.0
 Summary: Reusable tools for FastAPI: async CRUD, fixtures, CLI, and standardized responses for SQLAlchemy + PostgreSQL
 Keywords: fastapi,sqlalchemy,postgresql
 Author: d3vyce
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development

{fastapi_toolsets-0.3.0 → fastapi_toolsets-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-toolsets"
-version = "0.3.0"
+version = "0.4.0"
 description = "Reusable tools for FastAPI: async CRUD, fixtures, CLI, and standardized responses for SQLAlchemy + PostgreSQL"
 readme = "README.md"
 license = "MIT"
@@ -24,6 +24,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Software Development :: Libraries",
     "Topic :: Software Development",

{fastapi_toolsets-0.3.0 → fastapi_toolsets-0.4.0}/src/fastapi_toolsets/__init__.py

@@ -21,4 +21,4 @@ Example usage:
         return Response(data={"user": user.username}, message="Success")
 """
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"

fastapi_toolsets-0.4.0/src/fastapi_toolsets/crud/__init__.py

@@ -0,0 +1,17 @@
+"""Generic async CRUD operations for SQLAlchemy models."""
+
+from ..exceptions import NoSearchableFieldsError
+from .factory import CrudFactory
+from .search import (
+    SearchConfig,
+    SearchFieldType,
+    get_searchable_fields,
+)
+
+__all__ = [
+    "CrudFactory",
+    "get_searchable_fields",
+    "NoSearchableFieldsError",
+    "SearchConfig",
+    "SearchFieldType",
+]

fastapi_toolsets-0.3.0/src/fastapi_toolsets/crud.py → fastapi_toolsets-0.4.0/src/fastapi_toolsets/crud/factory.py

@@ -12,13 +12,9 @@ from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.orm import DeclarativeBase
 from sqlalchemy.sql.roles import WhereHavingRole
 
-from .db import get_transaction
-from .exceptions import NotFoundError
-
-__all__ = [
-    "AsyncCrud",
-    "CrudFactory",
-]
+from ..db import get_transaction
+from ..exceptions import NotFoundError
+from .search import SearchConfig, SearchFieldType, build_search_filters
 
 ModelType = TypeVar("ModelType", bound=DeclarativeBase)
 
@@ -27,20 +23,10 @@ class AsyncCrud(Generic[ModelType]):
     """Generic async CRUD operations for SQLAlchemy models.
 
     Subclass this and set the `model` class variable, or use `CrudFactory`.
-
-    Example:
-        class UserCrud(AsyncCrud[User]):
-            model = User
-
-        # Or use the factory:
-        UserCrud = CrudFactory(User)
-
-        # Then use it:
-        user = await UserCrud.get(session, [User.id == 1])
-        users = await UserCrud.get_multi(session, limit=10)
     """
 
     model: ClassVar[type[DeclarativeBase]]
+    searchable_fields: ClassVar[Sequence[SearchFieldType] | None] = None
 
     @classmethod
     async def create(
@@ -313,6 +299,8 @@ class AsyncCrud(Generic[ModelType]):
         order_by: Any | None = None,
         page: int = 1,
         items_per_page: int = 20,
+        search: str | SearchConfig | None = None,
+        search_fields: Sequence[SearchFieldType] | None = None,
     ) -> dict[str, Any]:
         """Get paginated results with metadata.
 
@@ -323,23 +311,54 @@ class AsyncCrud(Generic[ModelType]):
             order_by: Column or list of columns to order by
             page: Page number (1-indexed)
             items_per_page: Number of items per page
+            search: Search query string or SearchConfig object
+            search_fields: Fields to search in (overrides class default)
 
         Returns:
             Dict with 'data' and 'pagination' keys
         """
-        filters = filters or []
+        filters = list(filters) if filters else []
         offset = (page - 1) * items_per_page
+        joins: list[Any] = []
+
+        # Build search filters
+        if search:
+            search_filters, search_joins = build_search_filters(
+                cls.model,
+                search,
+                search_fields=search_fields,
+                default_fields=cls.searchable_fields,
+            )
+            filters.extend(search_filters)
+            joins.extend(search_joins)
 
-        items = await cls.get_multi(
-            session,
-            filters=filters,
-            load_options=load_options,
-            order_by=order_by,
-            limit=items_per_page,
-            offset=offset,
-        )
+        # Build query with joins
+        q = select(cls.model)
+        for join_rel in joins:
+            q = q.outerjoin(join_rel)
 
-        total_count = await cls.count(session, filters=filters)
+        if filters:
+            q = q.where(and_(*filters))
+        if load_options:
+            q = q.options(*load_options)
+        if order_by is not None:
+            q = q.order_by(order_by)
+
+        q = q.offset(offset).limit(items_per_page)
+        result = await session.execute(q)
+        items = result.unique().scalars().all()
+
+        # Count query (with same joins and filters)
+        pk_col = cls.model.__mapper__.primary_key[0]
+        count_q = select(func.count(func.distinct(getattr(cls.model, pk_col.name))))
+        count_q = count_q.select_from(cls.model)
+        for join_rel in joins:
+            count_q = count_q.outerjoin(join_rel)
+        if filters:
+            count_q = count_q.where(and_(*filters))
+
+        count_result = await session.execute(count_q)
+        total_count = count_result.scalar_one()
 
         return {
             "data": items,
@@ -354,11 +373,14 @@ class AsyncCrud(Generic[ModelType]):
 
 def CrudFactory(
     model: type[ModelType],
+    *,
+    searchable_fields: Sequence[SearchFieldType] | None = None,
 ) -> type[AsyncCrud[ModelType]]:
     """Create a CRUD class for a specific model.
 
     Args:
         model: SQLAlchemy model class
+        searchable_fields: Optional list of searchable fields
 
     Returns:
         AsyncCrud subclass bound to the model
@@ -370,9 +392,25 @@ def CrudFactory(
         UserCrud = CrudFactory(User)
         PostCrud = CrudFactory(Post)
 
+        # With searchable fields:
+        UserCrud = CrudFactory(
+            User,
+            searchable_fields=[User.username, User.email, (User.role, Role.name)]
+        )
+
         # Usage
         user = await UserCrud.get(session, [User.id == 1])
         posts = await PostCrud.get_multi(session, filters=[Post.user_id == user.id])
+
+        # With search
+        result = await UserCrud.paginate(session, search="john")
     """
-    cls = type(f"Async{model.__name__}Crud", (AsyncCrud,), {"model": model})
+    cls = type(
+        f"Async{model.__name__}Crud",
+        (AsyncCrud,),
+        {
+            "model": model,
+            "searchable_fields": searchable_fields,
+        },
+    )
     return cast(type[AsyncCrud[ModelType]], cls)

fastapi_toolsets-0.4.0/src/fastapi_toolsets/crud/search.py

@@ -0,0 +1,145 @@
+"""Search utilities for AsyncCrud."""
+
+from collections.abc import Sequence
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Any, Literal
+
+from sqlalchemy import String, or_
+from sqlalchemy.orm import DeclarativeBase
+from sqlalchemy.orm.attributes import InstrumentedAttribute
+
+from ..exceptions import NoSearchableFieldsError
+
+if TYPE_CHECKING:
+    from sqlalchemy.sql.elements import ColumnElement
+
+SearchFieldType = InstrumentedAttribute[Any] | tuple[InstrumentedAttribute[Any], ...]
+
+
+@dataclass
+class SearchConfig:
+    """Advanced search configuration.
+
+    Attributes:
+        query: The search string
+        fields: Fields to search (columns or tuples for relationships)
+        case_sensitive: Case-sensitive search (default: False)
+        match_mode: "any" (OR) or "all" (AND) to combine fields
+    """
+
+    query: str
+    fields: Sequence[SearchFieldType] | None = None
+    case_sensitive: bool = False
+    match_mode: Literal["any", "all"] = "any"
+
+
+def get_searchable_fields(
+    model: type[DeclarativeBase],
+    *,
+    include_relationships: bool = True,
+    max_depth: int = 1,
+) -> list[SearchFieldType]:
+    """Auto-detect String fields on a model and its relationships.
+
+    Args:
+        model: SQLAlchemy model class
+        include_relationships: Include fields from many-to-one/one-to-one relationships
+        max_depth: Max depth for relationship traversal (default: 1)
+
+    Returns:
+        List of columns and tuples (relationship, column)
+    """
+    fields: list[SearchFieldType] = []
+    mapper = model.__mapper__
+
+    # Direct String columns
+    for col in mapper.columns:
+        if isinstance(col.type, String):
+            fields.append(getattr(model, col.key))
+
+    # Relationships (one-to-one, many-to-one only)
+    if include_relationships and max_depth > 0:
+        for rel_name, rel_prop in mapper.relationships.items():
+            if rel_prop.uselist:  # Skip collections (one-to-many, many-to-many)
+                continue
+
+            rel_attr = getattr(model, rel_name)
+            related_model = rel_prop.mapper.class_
+
+            for col in related_model.__mapper__.columns:
+                if isinstance(col.type, String):
+                    fields.append((rel_attr, getattr(related_model, col.key)))
+
+    return fields
+
+
+def build_search_filters(
+    model: type[DeclarativeBase],
+    search: str | SearchConfig,
+    search_fields: Sequence[SearchFieldType] | None = None,
+    default_fields: Sequence[SearchFieldType] | None = None,
+) -> tuple[list["ColumnElement[bool]"], list[InstrumentedAttribute[Any]]]:
+    """Build SQLAlchemy filter conditions for search.
+
+    Args:
+        model: SQLAlchemy model class
+        search: Search string or SearchConfig
+        search_fields: Fields specified per-call (takes priority)
+        default_fields: Default fields (from ClassVar)
+
+    Returns:
+        Tuple of (filter_conditions, joins_needed)
+    """
+    # Normalize input
+    if isinstance(search, str):
+        config = SearchConfig(query=search, fields=search_fields)
+    else:
+        config = search
+        if search_fields is not None:
+            config = SearchConfig(
+                query=config.query,
+                fields=search_fields,
+                case_sensitive=config.case_sensitive,
+                match_mode=config.match_mode,
+            )
+
+    if not config.query or not config.query.strip():
+        return [], []
+
+    # Determine which fields to search
+    fields = config.fields or default_fields or get_searchable_fields(model)
+
+    if not fields:
+        raise NoSearchableFieldsError(model)
+
+    query = config.query.strip()
+    filters: list[ColumnElement[bool]] = []
+    joins: list[InstrumentedAttribute[Any]] = []
+    added_joins: set[str] = set()
+
+    for field in fields:
+        if isinstance(field, tuple):
+            # Relationship: (User.role, Role.name) or deeper
+            for rel in field[:-1]:
+                rel_key = str(rel)
+                if rel_key not in added_joins:
+                    joins.append(rel)
+                    added_joins.add(rel_key)
+            column = field[-1]
+        else:
+            column = field
+
+        # Build the filter
+        if config.case_sensitive:
+            filters.append(column.like(f"%{query}%"))
+        else:
+            filters.append(column.ilike(f"%{query}%"))
+
+    if not filters:
+        return [], []
+
+    # Combine based on match_mode
+    if config.match_mode == "any":
+        return [or_(*filters)], joins
+    else:
+        return filters, joins

{fastapi_toolsets-0.3.0 → fastapi_toolsets-0.4.0}/src/fastapi_toolsets/exceptions/__init__.py

@@ -2,6 +2,7 @@ from .exceptions import (
     ApiException,
     ConflictError,
     ForbiddenError,
+    NoSearchableFieldsError,
     NotFoundError,
     UnauthorizedError,
     generate_error_responses,
@@ -14,6 +15,7 @@ __all__ = [
     "ApiException",
     "ConflictError",
     "ForbiddenError",
+    "NoSearchableFieldsError",
     "NotFoundError",
     "UnauthorizedError",
 ]

{fastapi_toolsets-0.3.0 → fastapi_toolsets-0.4.0}/src/fastapi_toolsets/exceptions/exceptions.py

@@ -119,6 +119,25 @@ class RoleNotFoundError(NotFoundError):
     )
 
 
+class NoSearchableFieldsError(ApiException):
+    """Raised when search is requested but no searchable fields are available."""
+
+    api_error = ApiError(
+        code=400,
+        msg="No Searchable Fields",
+        desc="No searchable fields configured for this resource.",
+        err_code="SEARCH-400",
+    )
+
+    def __init__(self, model: type) -> None:
+        self.model = model
+        detail = (
+            f"No searchable fields found for model '{model.__name__}'. "
+            "Provide 'search_fields' parameter or set 'searchable_fields' on the CRUD class."
+        )
+        super().__init__(detail)
+
+
 def generate_error_responses(
     *errors: type[ApiException],
 ) -> dict[int | str, dict[str, Any]]: