auto-rest-api 0.1.0__tar.gz → 0.1.2__tar.gz

{auto_rest_api-0.1.0 → auto_rest_api-0.1.2}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.3
 Name: auto-rest-api
-Version: 0.1.0
+Version: 0.1.2
 Summary: Automatically map database schemas and deploy per-table REST API endpoints.
 License: GPL-3.0-only
 Keywords: Better,HPC,automatic,rest,api
 Author: Better HPC LLC
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology

{auto_rest_api-0.1.0 → auto_rest_api-0.1.2}/auto_rest/__main__.py

@@ -3,10 +3,9 @@
 import logging
 from pathlib import Path
 
-import uvicorn
 import yaml
-from fastapi import FastAPI
 
+from .app import *
 from .cli import *
 from .models import *
 from .routers import *
@@ -70,24 +69,26 @@ def run_application(
         app_version: version number for the generated OpenAPI schema.
     """
 
-    # Connect to and map the database.
     logger.info(f"Mapping database schema for {db_name}.")
+
+    # Resolve database connection settings
     db_url = create_db_url(driver=db_driver, host=db_host, port=db_port, database=db_name, username=db_user, password=db_pass)
     db_kwargs = yaml.safe_load(db_config.read_text()) if db_config else {}
+
+    # Connect to and map the database.
     db_conn = create_db_engine(db_url, **db_kwargs)
     db_meta = create_db_metadata(db_conn)
-    db_models = create_db_models(db_meta)
 
     # Build an empty application and dynamically add the requested functionality.
     logger.info("Creating API application.")
-    app = FastAPI(title=app_title, version=app_version, docs_url="/docs/" if enable_docs else None, redoc_url=None)
+    app = create_app(app_title, app_version, enable_docs)
     app.include_router(create_welcome_router(), prefix="")
     app.include_router(create_meta_router(db_conn, db_meta, app_title, app_version), prefix="/meta")
 
-    for model_name, model in db_models.items():
-        logger.info(f"Adding `/db/{model_name}` endpoint.")
-        app.include_router(create_model_router(db_conn, model, enable_write), prefix=f"/db/{model_name}")
+    for table_name, table in db_meta.tables.items():
+        logger.info(f"Adding `/db/{table_name}` endpoint.")
+        app.include_router(create_table_router(db_conn, table, enable_write), prefix=f"/db/{table_name}")
 
     # Launch the API server.
     logger.info(f"Launching API server on http://{server_host}:{server_port}.")
-    uvicorn.run(app, host=server_host, port=server_port, log_level="error")
+    run_server(app, server_host, server_port)

auto_rest_api-0.1.2/auto_rest/app.py

@@ -0,0 +1,67 @@
+"""
+The `app` module provides factory functions and utilities for building and
+deploying Fast-API applications.
+
+
+!!! example "Example: Build and Deploy an API"
+
+    ```python
+    from auto_rest.app import create_app, run_server
+
+    app = create_app(app_title="My Application", app_version="1.2.3", enable_docs=True)
+    ... # Add endpoints to the application here
+    run_server(app, host="127.0.0.1", port=8081)
+    ```
+"""
+
+import uvicorn
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+
+__all__ = ["create_app", "run_server"]
+
+
+def create_app(app_title: str, app_version: str, enable_docs: bool) -> FastAPI:
+    """Create and configure a FastAPI application instance.
+
+    This function initializes a FastAPI app with a customizable title, version,
+    and optional documentation routes. It also configures application middleware
+    for CORS policies.
+
+    Args:
+        app_title: The title of the FastAPI application.
+        app_version: The version of the FastAPI application.
+        enable_docs: Whether to enable the `/docs/` endpoint.
+
+    Returns:
+        FastAPI: A configured FastAPI application instance.
+    """
+
+    app = FastAPI(
+        title=app_title,
+        version=app_version,
+        docs_url="/docs/" if enable_docs else None,
+        redoc_url=None,
+    )
+
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=["*"],
+        allow_credentials=True,
+        allow_methods=["*"],
+        allow_headers=["*"],
+    )
+
+    return app
+
+
+def run_server(app: FastAPI, host: str, port: int) -> None: # pragma: no cover
+    """Deploy a FastAPI application server.
+
+    Args:
+        app: The FastAPI application to run.
+        host: The hostname or IP address for the server to bind to.
+        port: The port number for the server to listen on.
+    """
+
+    uvicorn.run(app, host=host, port=port, log_level="error")

{auto_rest_api-0.1.0 → auto_rest_api-0.1.2}/auto_rest/handlers.py

@@ -55,10 +55,10 @@ from typing import Awaitable, Callable
 
 from fastapi import Depends, Response
 from pydantic import create_model
-from pydantic.main import ModelT
-from sqlalchemy import insert, MetaData, select
-from starlette.requests import Request
+from pydantic.main import BaseModel as PydanticModel
+from sqlalchemy import insert, MetaData, select, Table
 
+from .interfaces import *
 from .models import *
 from .params import *
 from .queries import *
@@ -79,7 +79,7 @@ __all__ = [
 logger = logging.getLogger(__name__)
 
 
-def create_welcome_handler() -> Callable[[], Awaitable[ModelT]]:
+def create_welcome_handler() -> Callable[[], Awaitable[PydanticModel]]:
     """Create an endpoint handler that returns an application welcome message.
 
     Returns:
@@ -96,7 +96,7 @@ def create_welcome_handler() -> Callable[[], Awaitable[ModelT]]:
     return welcome_handler
 
 
-def create_about_handler(name: str, version: str) -> Callable[[], Awaitable[ModelT]]:
+def create_about_handler(name: str, version: str) -> Callable[[], Awaitable[PydanticModel]]:
     """Create an endpoint handler that returns the application name and version number.
 
     Args:
@@ -104,7 +104,7 @@ def create_about_handler(name: str, version: str) -> Callable[[], Awaitable[Mode
         version: The returned version identifier.
 
     Returns:
-        An async function that returns aplication info.
+        An async function that returns application info.
     """
 
     interface = create_model("Version", version=(str, version), name=(str, name))
@@ -117,7 +117,7 @@ def create_about_handler(name: str, version: str) -> Callable[[], Awaitable[Mode
     return about_handler
 
 
-def create_engine_handler(engine: DBEngine) -> Callable[[], Awaitable[ModelT]]:
+def create_engine_handler(engine: DBEngine) -> Callable[[], Awaitable[PydanticModel]]:
     """Create an endpoint handler that returns configuration details for a database engine.
 
     Args:
@@ -141,7 +141,7 @@ def create_engine_handler(engine: DBEngine) -> Callable[[], Awaitable[ModelT]]:
     return meta_handler
 
 
-def create_schema_handler(metadata: MetaData) -> Callable[[], Awaitable[ModelT]]:
+def create_schema_handler(metadata: MetaData) -> Callable[[], Awaitable[PydanticModel]]:
     """Create an endpoint handler that returns the database schema.
 
     Args:
@@ -180,120 +180,121 @@ def create_schema_handler(metadata: MetaData) -> Callable[[], Awaitable[ModelT]]
     return schema_handler
 
 
-def create_list_records_handler(engine: DBEngine, model: DBModel) -> Callable[..., Awaitable[list[ModelT]]]:
+def create_list_records_handler(engine: DBEngine, table: Table) -> Callable[..., Awaitable[list[PydanticModel]]]:
     """Create an endpoint handler that returns a list of records from a database table.
 
     Args:
         engine: Database engine to use when executing queries.
-        model: The ORM object to use for database manipulations.
+        table: The database table to query against.
 
     Returns:
         An async function that returns a list of records from the given database model.
     """
 
-    interface = create_db_interface(model)
+    interface = create_interface(table)
 
     async def list_records_handler(
         response: Response,
         session: DBSession = Depends(create_session_iterator(engine)),
-        pagination_params: dict[str, int] = Depends(get_pagination_params),
-        ordering_params: dict[str, int] = Depends(get_ordering_params),
+        pagination_params: dict[str, int] = create_pagination_dependency(table),
+        ordering_params: dict[str, int] = create_ordering_dependency(table),
     ) -> 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(model)
+        query = select(table)
         query = apply_pagination_params(query, pagination_params, response)
         query = apply_ordering_params(query, ordering_params, response)
+
         result = await execute_session_query(session, query)
-        return [interface.model_validate(record.__dict__) for record in result.scalars().all()]
+        return [row._mapping for row in result.all()]
 
     return list_records_handler
 
 
-def create_get_record_handler(engine: DBEngine, model: DBModel) -> Callable[..., Awaitable[ModelT]]:
+def create_get_record_handler(engine: DBEngine, table: Table) -> Callable[..., Awaitable[PydanticModel]]:
     """Create a function for handling GET requests against a single record in the database.
 
     Args:
         engine: Database engine to use when executing queries.
-        model: The ORM object to use for database manipulations.
+        table: The database table to query against.
 
     Returns:
-        An async function that returns a single record from the given database model.
+        An async function that returns a single record from the given database table.
     """
 
-    interface = create_db_interface(model)
+    interface = create_interface(table)
+    pk_interface = create_interface(table, pk_only=True, mode='required')
 
     async def get_record_handler(
-        request: Request,
+        pk: pk_interface = Depends(),
         session: DBSession = Depends(create_session_iterator(engine)),
     ) -> interface:
         """Fetch a single record from the database."""
 
-        query = select(model).filter_by(**request.path_params)
+        query = select(table).filter_by(**pk.model_dump())
         result = await execute_session_query(session, query)
         record = get_record_or_404(result)
-        return interface.model_validate(record.__dict__)
+        return record
 
     return get_record_handler
 
 
-def create_post_record_handler(engine: DBEngine, model: DBModel) -> Callable[..., Awaitable[ModelT]]:
+def create_post_record_handler(engine: DBEngine, table: Table) -> Callable[..., Awaitable[PydanticModel]]:
     """Create a function for handling POST requests against a record in the database.
 
     Args:
         engine: Database engine to use when executing queries.
-        model: The ORM object to use for database manipulations.
+        table: The database table to query against.
 
     Returns:
         An async function that handles record creation.
     """
 
-    interface = create_db_interface(model)
+    interface = create_interface(table)
 
     async def post_record_handler(
         data: interface,
         session: DBSession = Depends(create_session_iterator(engine)),
-    ) -> interface:
+    ) -> None:
         """Create a new record in the database."""
 
-        query = insert(model).values(**data.dict())
-        result = await execute_session_query(session, query)
-        record = get_record_or_404(result)
-
+        query = insert(table).values(**data.dict())
+        await execute_session_query(session, query)
         await commit_session(session)
-        return interface.model_validate(record.__dict__)
 
     return post_record_handler
 
 
-def create_put_record_handler(engine: DBEngine, model: DBModel) -> Callable[..., Awaitable[ModelT]]:
+def create_put_record_handler(engine: DBEngine, table: Table) -> Callable[..., Awaitable[PydanticModel]]:
     """Create a function for handling PUT requests against a record in the database.
 
     Args:
         engine: Database engine to use when executing queries.
-        model: The ORM object to use for database manipulations.
+        table: The database table to query against.
 
     Returns:
         An async function that handles record updates.
     """
 
-    interface = create_db_interface(model)
+    interface = create_interface(table)
+    opt_interface = create_interface(table, mode='optional')
+    pk_interface = create_interface(table, pk_only=True, mode='required')
 
     async def put_record_handler(
-        request: Request,
-        data: interface,
+        data: opt_interface,
+        pk: pk_interface = Depends(),
         session: DBSession = Depends(create_session_iterator(engine)),
     ) -> interface:
         """Replace record values in the database with the provided data."""
 
-        query = select(model).filter_by(**request.path_params)
+        query = select(table).filter_by(**pk.model_dump())
         result = await execute_session_query(session, query)
         record = get_record_or_404(result)
 
-        for key, value in data.dict().items():
+        for key, value in data.model_dump().items():
             setattr(record, key, value)
 
         await commit_session(session)
@@ -302,57 +303,60 @@ def create_put_record_handler(engine: DBEngine, model: DBModel) -> Callable[...,
     return put_record_handler
 
 
-def create_patch_record_handler(engine: DBEngine, model: DBModel) -> Callable[..., Awaitable[ModelT]]:
+def create_patch_record_handler(engine: DBEngine, table: Table) -> Callable[..., Awaitable[PydanticModel]]:
     """Create a function for handling PATCH requests against a record in the database.
 
     Args:
         engine: Database engine to use when executing queries.
-        model: The ORM object to use for database manipulations.
+        table: The database table to query against.
 
     Returns:
         An async function that handles record updates.
     """
 
-    interface = create_db_interface(model)
+    interface = create_interface(table)
+    pk_interface = create_interface(table, pk_only=True, mode='required')
 
     async def patch_record_handler(
-        request: Request,
         data: interface,
+        pk: pk_interface = Depends(),
         session: DBSession = Depends(create_session_iterator(engine)),
     ) -> interface:
         """Update record values in the database with the provided data."""
 
-        query = select(model).filter_by(**request.path_params)
+        query = select(table).filter_by(**pk.model_dump())
         result = await execute_session_query(session, query)
         record = get_record_or_404(result)
 
-        for key, value in data.dict(exclude_unset=True).items():
+        for key, value in data.model_dump(exclude_unset=True).items():
             setattr(record, key, value)
 
         await commit_session(session)
-        return interface(record.__dict__)
+        return record
 
     return patch_record_handler
 
 
-def create_delete_record_handler(engine: DBEngine, model: DBModel) -> Callable[..., Awaitable[None]]:
+def create_delete_record_handler(engine: DBEngine, table: Table) -> Callable[..., Awaitable[None]]:
     """Create a function for handling DELETE requests against a record in the database.
 
     Args:
         engine: Database engine to use when executing queries.
-        model: The ORM object to use for database manipulations.
+        table: The database table to query against.
 
     Returns:
         An async function that handles record deletion.
     """
 
+    pk_interface = create_interface(table, pk_only=True, mode='required')
+
     async def delete_record_handler(
-        request: Request,
+        pk: pk_interface = Depends(),
         session: DBSession = Depends(create_session_iterator(engine)),
     ) -> None:
         """Delete a record from the database."""
 
-        query = select(model).filter_by(**request.path_params)
+        query = select(table).filter_by(**pk.model_dump())
         result = await execute_session_query(session, query)
         record = get_record_or_404(result)
 

auto_rest_api-0.1.2/auto_rest/interfaces.py

@@ -0,0 +1,126 @@
+"""Pydantic models are used to facilitate data validation and to define
+interfaces for FastAPI endpoint handlers. The `interfaces` module
+provides utility functions for converting SQLAlchemy models into
+Pydantic interfaces. Interfaces can be created using different modes
+which force interface fields to be optional or read only.
+
+!!! example "Example: Creating an Interface"
+
+    The `create_interface_default` method creates an interface class
+    based on a SQLAlchemy table.
+
+    ```python
+    default_interface = create_interface_default(database_model)
+    required_interface = create_interface_required(database_model, mode="required")
+    optional_interface = create_interface_optional(database_model, mode="optional")
+    ```
+"""
+from typing import Iterator, Literal
+
+from pydantic import BaseModel as PydanticModel, create_model
+from sqlalchemy import Column, Table
+
+__all__ = ["create_interface"]
+
+from sqlalchemy.sql.schema import ScalarElementColumnDefault
+
+MODES = Literal["default", "required", "optional"]
+
+
+def iter_columns(table: Table, pk_only: bool = False) -> Iterator[Column]:
+    """Iterate over the columns of a SQLAlchemy model.
+
+    Args:
+        table: The table to iterate columns over.
+        pk_only: If True, only iterate over primary key columns.
+
+    Yields:
+        A column of the SQLAlchemy model.
+    """
+
+    for column in table.columns:
+        if column.primary_key or not pk_only:
+            yield column
+
+
+def get_column_type(col: Column) -> type[any]:
+    """Return the Python type corresponding to a column's DB datatype.
+
+    Returns the `any` type for DBMS drivers that do not support mapping DB
+    types to Python primitives,
+
+    Args:
+        col: The column to determine a type for.
+
+    Returns:
+        The equivalent Python type for the column data.
+    """
+
+    try:
+        return col.type.python_type
+
+    # Catch any error, but list the expected ones explicitly
+    except (NotImplementedError, Exception):
+        return any
+
+
+def get_column_default(col: Column, mode: MODES) -> any:
+    """Return the default value for a column.
+
+    Args:
+        col: The column to determine a default value for.
+        mode: The mode to use when determining the default value.
+
+    Returns:
+        The default value for the column.
+    """
+
+    # Extract the default value from the SQLAlchemy wrapper class
+    sqla_default = col.default
+    default = getattr(sqla_default, "arg", None) or sqla_default
+
+    if mode == "required":
+        return ...
+
+    elif mode == "optional":
+        return default
+
+    elif mode == "default":
+        if col.nullable or (col.default is not None):
+            return default
+
+        return ...
+
+    raise RuntimeError(f"Unknown mode: {mode}")
+
+
+def create_interface(
+    table: Table,
+    pk_only: bool = False,
+    mode: MODES = "default"
+) -> type[PydanticModel]:
+    """Create a Pydantic interface for a SQLAlchemy model where all fields are required.
+
+    Args:
+        table: The SQLAlchemy table to create an interface for.
+        pk_only: If True, only include primary key columns.
+        mode: Whether to force fields to all be optional or required.
+
+    Returns:
+        A dynamically generated Pydantic model with all fields required.
+    """
+
+    # Map field names to the column type and default value.
+    columns = iter_columns(table, pk_only)
+    fields = {
+        col.name: (get_column_type(col), get_column_default(col, mode))
+        for col in columns
+    }
+
+    # Dynamically create a unique name for the interface
+    name_parts = [table.name, mode.title()]
+    if pk_only:
+        name_parts.insert(1, 'PK')
+
+    interface_name = '-'.join(name_parts)
+    return create_model(interface_name, **fields)

{auto_rest_api-0.1.0 → auto_rest_api-0.1.2}/auto_rest/models.py

@@ -5,18 +5,16 @@ on the popular SQLAlchemy package, it natively supports multiple
 Database Management Systems (DBMS) without requiring custom configuration
 or setup.
 
-!!! example "Example: Creating ORM objects"
+!!! example "Example: Mapping Database Metadata"
 
-    Utility functions are provided for connecting to the database,
-    mapping the schema, and dynamically generating ORM models based on
-    the existing database structure.
+    Utility functions are provided for connecting to the database
+    and mapping the underlying schema.
 
     ```python
     connection_args = dict(...)
     db_url = create_db_url(**connection_args)
     db_conn = create_db_engine(db_url)
     db_meta = create_db_metadata(db_conn)
-    db_models = create_db_models(db_meta)
     ```
 
 Support for asynchronous operations is automatically determined based on
@@ -36,19 +34,15 @@ import logging
 from pathlib import Path
 from typing import Callable
 
-from pydantic.main import create_model, ModelT
 from sqlalchemy import create_engine, Engine, MetaData, URL
 from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession, create_async_engine
-from sqlalchemy.orm import declarative_base, Session
+from sqlalchemy.orm import Session
 
 __all__ = [
     "DBEngine",
-    "DBModel",
     "DBSession",
     "create_db_engine",
-    "create_db_interface",
     "create_db_metadata",
-    "create_db_models",
     "create_db_url",
     "create_session_iterator",
 ]
@@ -56,7 +50,6 @@ __all__ = [
 logger = logging.getLogger(__name__)
 
 # Base classes and typing objects.
-DBModel = declarative_base()
 DBEngine = Engine | AsyncEngine
 DBSession = Session | AsyncSession
 
@@ -131,7 +124,7 @@ async def _async_reflect_metadata(engine: AsyncEngine, metadata: MetaData) -> No
     """Helper function used to reflect database metadata using an async engine."""
 
     async with engine.connect() as connection:
-        await connection.run_sync(metadata.reflect)
+        await connection.run_sync(metadata.reflect, views=True)
 
 
 def create_db_metadata(engine: DBEngine) -> MetaData:
@@ -151,55 +144,11 @@ def create_db_metadata(engine: DBEngine) -> MetaData:
         asyncio.run(_async_reflect_metadata(engine, metadata))
 
     else:
-        metadata.reflect(bind=engine)
+        metadata.reflect(bind=engine, views=True)
 
     return metadata
 
 
-def create_db_models(metadata: MetaData) -> dict[str, DBModel]:
-    """Dynamically generate database models from a metadata instance.
-
-    Args:
-        metadata: A reflection of database metadata.
-
-    Returns:
-        A dictionary mapping table names to database models.
-    """
-
-    logger.debug("Building database models...")
-    models = {}
-
-    # Dynamically create a class for each table.
-    for table_name, table in metadata.tables.items():
-        logger.debug(f"> Creating model for table {table_name}.")
-        models[table_name] = type(
-            table_name.capitalize(),
-            (DBModel,),
-            {"__table__": table},
-        )
-
-    logger.debug(f"Successfully generated {len(models)} models.")
-    return models
-
-
-def create_db_interface(model: DBModel) -> type[ModelT]:
-    """Create a Pydantic interface for a SQLAlchemy model.
-
-    Args:
-        model: A SQLAlchemy model to create an interface for.
-
-    Returns:
-        A Pydantic model class with the same structure as the provided SQLAlchemy model.
-    """
-
-    fields = {
-        col.name: (col.type.python_type, col.default if col.default is not None else ...)
-        for col in model.__table__.columns
-    }
-
-    return create_model(model.__name__, **fields)
-
-
 def create_session_iterator(engine: DBEngine) -> Callable[[], DBSession]:
     """Create a generator for database sessions.