auto-rest-api 0.1.5__py3-none-any.whl → 0.1.6__py3-none-any.whl

auto_rest/app.py

@@ -44,9 +44,12 @@ async def logging_middleware(request: Request, call_next: callable) -> Response:
         "ip": request.client.host,
         "port": request.client.port,
         "method": request.method,
-        "endpoint": f"{request.url.path}?{request.url.query}",
+        "endpoint": request.url.path,
     }
 
+    if request.url.query:
+        request_meta["endpoint"] += "?" + request.url.query
+
     # Execute handling logic
     try:
         response = await call_next(request)

auto_rest/cli.py

@@ -35,7 +35,7 @@ import logging.config
 from argparse import ArgumentParser, HelpFormatter
 from pathlib import Path
 
-__all__ = ["configure_cli_logging", "create_cli_parser"]
+__all__ = ["configure_cli_logging", "create_cli_parser", "VERSION"]
 
 VERSION = importlib.metadata.version("auto-rest-api")
 

auto_rest/handlers.py

@@ -188,21 +188,42 @@ def create_list_records_handler(engine: DBEngine, table: Table) -> Callable[...,
     """
 
     interface = create_interface(table)
-    columns = tuple(table.columns.keys())
+    interface_opt = create_interface(table, mode="optional")
+    col_names = tuple(table.columns.keys())
 
     async def list_records_handler(
         response: Response,
         session: DBSession = Depends(create_session_iterator(engine)),
+        filters: interface_opt = Depends(),
         _limit_: int = Query(0, ge=0, description="The maximum number of records to return."),
         _offset_: int = Query(0, ge=0, description="The starting index of the returned records."),
-        _order_by_: Optional[Literal[*columns]] = Query(None, description="The field name to sort by."),
-        _direction_: Literal["asc", "desc"] = Query("asc", description="Sort results in 'asc' or 'desc' order.")
+        _order_by_: Optional[Literal[*col_names]] = Query(None, description="The field name to sort by."),
+        _direction_: Literal["asc", "desc"] = Query("asc", description="Sort results in 'asc' or 'desc' order."),
     ) -> list[interface]:
         """Fetch a list of records from the database.
 
         URL query parameters are used to enable filtering, ordering, and paginating returned values.
         """
 
+        query = select(table)
+
+        # Fetch data per the request parameters
+        for param, value in filters:
+            if value is not None:
+                column = getattr(table.c, param)
+                if value.lower() == "_null_":
+                    query = query.filter(column.is_(None))
+
+                else:
+                    query = query.filter(column.ilike(f"%{value}%"))
+
+        if _limit_ > 0:
+            query = query.offset(_offset_).limit(_limit_)
+
+        if _order_by_ is not None:
+            direction = {'desc': desc, 'asc': asc}[_direction_]
+            query = query.order_by(direction(_order_by_))
+
         # Determine total record count
         total_count_query = select(func.count()).select_from(table)
         total_count = await execute_session_query(session, total_count_query)
@@ -214,17 +235,8 @@ def create_list_records_handler(engine: DBEngine, table: Table) -> Callable[...,
         response.headers["x-order-by"] = str(_order_by_)
         response.headers["x-order-direction"] = str(_direction_)
 
-        # Fetch data per the request parameters
-        query = select(table)
-        if _limit_ > 0:
-            query = query.offset(_offset_).limit(_limit_)
-
-        if _order_by_ is not None:
-            direction = {'desc': desc, 'asc': asc}[_direction_]
-            query = query.order_by(direction(_order_by_))
-
-        result = await execute_session_query(session, query)
-        return [row._mapping for row in result.all()]
+        # noinspection PyTypeChecker
+        return await execute_session_query(session, query)
 
     return list_records_handler
 
@@ -257,7 +269,7 @@ def create_get_record_handler(engine: DBEngine, table: Table) -> Callable[..., A
     return get_record_handler
 
 
-def create_post_record_handler(engine: DBEngine, table: Table) -> Callable[..., Awaitable[PydanticModel]]:
+def create_post_record_handler(engine: DBEngine, table: Table) -> Callable[..., Awaitable[None]]:
     """Create a function for handling POST requests against a record in the database.
 
     Args:
@@ -276,7 +288,7 @@ def create_post_record_handler(engine: DBEngine, table: Table) -> Callable[...,
     ) -> None:
         """Create a new record in the database."""
 
-        query = insert(table).values(**data.dict())
+        query = insert(table).values(**data.model_dump())
         await execute_session_query(session, query)
         await commit_session(session)
 

auto_rest/models.py

@@ -32,7 +32,7 @@ connection and session handling are configured accordingly.
 import asyncio
 import logging
 from pathlib import Path
-from typing import Callable
+from typing import AsyncGenerator, Callable, Generator
 
 import yaml
 from sqlalchemy import create_engine, Engine, MetaData, URL
@@ -169,7 +169,7 @@ def create_db_metadata(engine: DBEngine) -> MetaData:
     return metadata
 
 
-def create_session_iterator(engine: DBEngine) -> Callable[[], DBSession]:
+def create_session_iterator(engine: DBEngine) -> Callable[[], Generator[Session, None, None] | AsyncGenerator[AsyncSession, None]]:
     """Create a generator for database sessions.
 
     Returns a synchronous or asynchronous function depending on whether
@@ -185,12 +185,12 @@ def create_session_iterator(engine: DBEngine) -> Callable[[], DBSession]:
     """
 
     if isinstance(engine, AsyncEngine):
-        async def session_iterator() -> AsyncSession:
+        async def session_iterator() -> AsyncGenerator[AsyncSession, None]:
             async with AsyncSession(bind=engine, autocommit=False, autoflush=True) as session:
                 yield session
 
     else:
-        def session_iterator() -> Session:
+        def session_iterator() -> Generator[Session, None, None]:
             with Session(bind=engine, autocommit=False, autoflush=True) as session:
                 yield session
 

{auto_rest_api-0.1.5.dist-info → auto_rest_api-0.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: auto-rest-api
-Version: 0.1.5
+Version: 0.1.6
 Summary: Automatically map database schemas and deploy per-table REST API endpoints.
 License: GPL-3.0-only
 Keywords: Better,HPC,automatic,rest,api

auto_rest_api-0.1.6.dist-info/RECORD

@@ -0,0 +1,14 @@
+auto_rest/__init__.py,sha256=9ICmv2urSoAo856FJylKdorF19UsUGc4eyORYLptf1Q,69
+auto_rest/__main__.py,sha256=VkLZ9j1Q9I0isYvO0Bj1HHCQ9Ew_r5O7a0Dn4fUi5Lo,2233
+auto_rest/app.py,sha256=1R8niLADFPI9Zpegdrpt9ITFMHaIj0E6tsgF59dRr38,3190
+auto_rest/cli.py,sha256=k07_ucmsxholhiikL41VgrAEPKHX3_ay-qGvRvmQwxA,6250
+auto_rest/handlers.py,sha256=QgiVnNxxi_LWon5pb0CktV347EPD1kcahSW726vAreA,13350
+auto_rest/interfaces.py,sha256=WB_0eMDjGF8DpnDN9INHqo7u4x3aklvzAYK4t3JwC7s,3779
+auto_rest/models.py,sha256=g_oLzgxl39WfNWzf3yAu4_HiPF5ht30yydjsGfB4pJA,6017
+auto_rest/queries.py,sha256=2e6f_S4n1xvaSY8rYJG-koDmqiXHreOIRUteRuqZlv8,3058
+auto_rest/routers.py,sha256=SZoOugauKdCk2Kqzzp9o6tGENusAsP1-YP-6Aam53tc,5636
+auto_rest_api-0.1.6.dist-info/LICENSE.md,sha256=zFRw_u1mGSOH8GrpOu0L1P765aX9fB5UpKz06mTxAos,34893
+auto_rest_api-0.1.6.dist-info/METADATA,sha256=Cv0Zw-T0nGfp9TpK-Hw0d6NQICOwtURzyifpwi3tM9k,2914
+auto_rest_api-0.1.6.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
+auto_rest_api-0.1.6.dist-info/entry_points.txt,sha256=zFynmBrHyYo3Ds0Uo4-bTFe1Tdr5mIXV4dPQOFb-W1w,53
+auto_rest_api-0.1.6.dist-info/RECORD,,

auto_rest_api-0.1.5.dist-info/RECORD

@@ -1,14 +0,0 @@
-auto_rest/__init__.py,sha256=9ICmv2urSoAo856FJylKdorF19UsUGc4eyORYLptf1Q,69
-auto_rest/__main__.py,sha256=VkLZ9j1Q9I0isYvO0Bj1HHCQ9Ew_r5O7a0Dn4fUi5Lo,2233
-auto_rest/app.py,sha256=AnBb2jt0yMxTLj_ICWB1mXLgu2pchjlapfdIk2CwNsQ,3128
-auto_rest/cli.py,sha256=3emee1GrUkQZ-DVAboy5O65jPE0vwmdcy-wfaxh2kBs,6239
-auto_rest/handlers.py,sha256=gwMiE5TKA65nrMizQ472A5iCNmYK7B7vlFDWL0Vrphw,12943
-auto_rest/interfaces.py,sha256=WB_0eMDjGF8DpnDN9INHqo7u4x3aklvzAYK4t3JwC7s,3779
-auto_rest/models.py,sha256=pi97l2PsDqjhW52tAIAZKx6bl2QvC-q5kM5OsVP3V_M,5887
-auto_rest/queries.py,sha256=2e6f_S4n1xvaSY8rYJG-koDmqiXHreOIRUteRuqZlv8,3058
-auto_rest/routers.py,sha256=SZoOugauKdCk2Kqzzp9o6tGENusAsP1-YP-6Aam53tc,5636
-auto_rest_api-0.1.5.dist-info/LICENSE.md,sha256=zFRw_u1mGSOH8GrpOu0L1P765aX9fB5UpKz06mTxAos,34893
-auto_rest_api-0.1.5.dist-info/METADATA,sha256=cgh43Yv81K8gaf9B-mAAiWX72VnJAGGuQHWa7Qi5-K4,2914
-auto_rest_api-0.1.5.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
-auto_rest_api-0.1.5.dist-info/entry_points.txt,sha256=zFynmBrHyYo3Ds0Uo4-bTFe1Tdr5mIXV4dPQOFb-W1w,53
-auto_rest_api-0.1.5.dist-info/RECORD,,