Merge pull request #5 from creyD/dev

Co-authored-by: vikbhas <waraa.vignesh@gmail.com>
Co-authored-by: vikynoah <vigneshwaraa.sarangapani@noah.tech>
Co-authored-by: creyD <creyD@users.noreply.github.com>

.github/workflows/ci.yml

@@ -4,12 +4,17 @@ on:
   push:
     branches:
       - master
+      - dev
     paths-ignore:
       - "**/.github/**"
       - "**/.gitignore"
       - "**/.vscode/**"
       - "**/README.md"
       - "**/CHANGELOG.md"
+  pull_request:
+    branches:
+      - master
+      - dev
   workflow_dispatch:
 
 jobs:
@@ -41,6 +46,7 @@ jobs:
       - run: python test.py
 
   tag_and_publish:
+    if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     needs: test
     permissions:

.vscode/settings.json

@@ -26,10 +26,16 @@
     "**/db.sqlite3": true,
     "**/.DS_Store": true,
     "**/*.pyc": true,
-    "**/__pycache__/": true
+    "**/__pycache__/": true,
+    "**/build": true,
+    "**/dist": true,
+    "**/*.egg-info": true,
   },
   "search.exclude": {
     "**/.git": true,
+    "**/build": true,
+    "**/*.egg-info": true,
+    "**/dist": true,
     "**/.venv": true,
     "**/tmp": true,
     "htmlcov/*": true,

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.2.4
+
+- Enabled newer versions for all dependencies
+
+## 1.2.3
+
+- Added option to specify lookup_column for get_object_or_404
+
+## 1.2.2
+
+- Added order_by method
+
 ## 1.1.0
 
 - Added headers to testing

creyPY/fastapi/crud.py

@@ -10,8 +10,10 @@ from .models.base import Base
 T = TypeVar("T", bound=Base)
 
 
-def get_object_or_404(db_class: Type[T], id: UUID | str, db: Session, expunge: bool = False) -> T:
-    obj = db.query(db_class).filter(db_class.id == id).one_or_none()
+def get_object_or_404(
+    db_class: Type[T], id: UUID | str, db: Session, expunge: bool = False, lookup_column: str = "id"
+) -> T:
+    obj = db.query(db_class).filter(getattr(db_class, lookup_column) == id).one_or_none()
     if obj is None:
         raise HTTPException(status_code=404, detail="The object does not exist.")
     if expunge:
@@ -36,7 +38,7 @@ def update_obj_from_data(
     model: Type[T],
     id: UUID | str,
     db: Session,
-    partial: bool = False,
+    partial: bool = False,  # TODO: inverse, because it is currently the wrong way around
     ignore_fields=[],
     additional_data={},
     exclude={},

creyPY/fastapi/order_by.py

@@ -0,0 +1,25 @@
+from typing import Callable
+
+from pydantic.json_schema import SkipJsonSchema
+from sqlalchemy import String, asc, cast, desc
+from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.sql.selectable import Select
+
+
+def order_by(order_by: str | SkipJsonSchema[None] = None) -> Callable[[Select], Select]:
+    def _order_by(query: Select) -> Select:
+        if order_by:
+            direction = desc if order_by.startswith("-") else asc
+            column_name = order_by.lstrip("-")
+
+            # Get the column from the query
+            for column in query.inner_columns:
+                if column.key == column_name:
+                    # If the column is a UUID, cast it to a string
+                    if isinstance(column.type, UUID):
+                        column = cast(column, String)
+                    query = query.order_by(direction(column))
+                    break
+        return query
+
+    return _order_by

creyPY/fastapi/pagination.py

@@ -1,10 +1,21 @@
 from math import ceil
-from typing import Any, Generic, Optional, Self, Sequence, TypeVar
+from typing import Any, Generic, Optional, Self, Sequence, TypeVar, Union
 
 from fastapi_pagination import Params
 from fastapi_pagination.bases import AbstractPage, AbstractParams
-from fastapi_pagination.types import GreaterEqualOne, GreaterEqualZero
+from fastapi_pagination.types import (
+    GreaterEqualOne,
+    GreaterEqualZero,
+    AdditionalData,
+    SyncItemsTransformer,
+)
+from fastapi_pagination.api import create_page, apply_items_transformer
+from fastapi_pagination.utils import verify_params
+from fastapi_pagination.ext.sqlalchemy import create_paginate_query
 from pydantic.json_schema import SkipJsonSchema
+from sqlalchemy.sql.selectable import Select
+from sqlalchemy.orm.session import Session
+from sqlalchemy import select, func
 
 T = TypeVar("T")
 
@@ -70,3 +81,45 @@ def parse_page(response, page: int, size: int) -> Page:
         has_next=response.has_next,
         has_prev=response.has_prev,
     )
+
+
+def create_count_query(query: Select) -> Select:
+    return select(func.count()).select_from(query.subquery())
+
+
+def unwrap_scalars(
+    items: Sequence[Sequence[T]],
+    force_unwrap: bool = True,
+) -> Union[Sequence[T], Sequence[Sequence[T]]]:
+    return [item[0] if force_unwrap else item for item in items]
+
+
+def paginate(
+    connection: Session,
+    query: Select,
+    paginationFlag: bool = True,
+    params: Optional[AbstractParams] = None,
+    transformer: Optional[SyncItemsTransformer] = None,
+    additional_data: Optional[AdditionalData] = None,
+):
+
+    params, raw_params = verify_params(params, "limit-offset", "cursor")
+
+    count_query = create_count_query(query)
+    total = connection.scalar(count_query)
+
+    if paginationFlag is False:
+        params = Params(page=1, size=total)
+
+    query = create_paginate_query(query, params)
+    items = connection.execute(query).all()
+
+    items = unwrap_scalars(items)
+    t_items = apply_items_transformer(items, transformer)
+
+    return create_page(
+        t_items,
+        params=params,
+        total=total,
+        **(additional_data or {}),
+    )

requirements.build.txt

@@ -1,27 +1,27 @@
-certifi==2024.2.2
-charset-normalizer==3.3.2
-docutils==0.20.1
-idna==3.6
-importlib_metadata==7.1.0
-jaraco.classes==3.4.0
-jaraco.context==4.3.0
-jaraco.functools==4.0.0
-keyring==25.0.0
-markdown-it-py==3.0.0
-mdurl==0.1.2
-more-itertools==10.2.0
-nh3==0.2.17
-pkginfo==1.10.0
-Pygments==2.17.2
-readme_renderer==43.0
-requests==2.31.0
-requests-toolbelt==1.0.0
-rfc3986==2.0.0
-rich==13.7.1
-setuptools==69.2.0
-twine==5.0.0
-urllib3==2.2.1
-wheel==0.43.0
-zipp==3.18.1
+certifi>=2024.2.2
+charset-normalizer>=3.3.2
+docutils>=0.20.1
+idna>=3.6
+importlib_metadata>=7.1.0
+jaraco.classes>=3.4.0
+jaraco.context>=4.3.0
+jaraco.functools>=4.0.0
+keyring>=25.0.0
+markdown-it-py>=3.0.0
+mdurl>=0.1.2
+more-itertools>=10.2.0
+nh3>=0.2.17
+pkginfo>=1.10.0
+Pygments>=2.17.2
+readme_renderer>=43.0
+requests>=2.31.0
+requests-toolbelt>=1.0.0
+rfc3986>=2.0.0
+rich>=13.7.1
+setuptools>=69.2.0
+twine>=5.0.0
+urllib3>=2.2.1
+wheel>=0.43.0
+zipp>=3.18.1
 
 -r requirements.txt

requirements.txt

@@ -1,23 +1,23 @@
-annotated-types==0.6.0 # Pydantic
-pydantic==2.6.4 # Pydantic
-pydantic-core==2.16.3 # Pydantic
-typing-extensions==4.10.0 # Pydantic
+annotated-types>=0.7.0 # Pydantic
+pydantic>=2.8.2 # Pydantic
+pydantic-core>=2.20.1 # Pydantic
+typing-extensions>=4.12.2 # Pydantic
 
-anyio==4.3.0 # FastAPI
-fastapi==0.110.1 # FastAPI
-idna==3.6 # FastAPI
-sniffio==1.3.1 # FastAPI
-starlette==0.37.2 # FastAPI
+anyio>=4.4.0 # FastAPI
+fastapi>=0.111.0 # FastAPI
+idna>=3.7 # FastAPI
+sniffio>=1.3.1 # FastAPI
+starlette>=0.37.2 # FastAPI
 
-fastapi-pagination==0.12.21 # Pagination
-sqlalchemy==2.0.29 # SQLAlchemy
+fastapi-pagination>=0.12.26 # Pagination
+sqlalchemy>=2.0.31 # SQLAlchemy
 
-python-dotenv==1.0.1 # Environment variables
+python-dotenv>=1.0.1 # Environment variables
 
-psycopg==3.1.18 # PostgreSQL
-psycopg-binary==3.1.18 # PostgreSQL
-psycopg-pool==3.2.1 # PostgreSQL
+psycopg>=3.2.1 # PostgreSQL
+psycopg-binary>=3.2.1 # PostgreSQL
+psycopg-pool>=3.2.2 # PostgreSQL
 
-h11==0.14.0 # Testing
-httpcore==1.0.5 # Testing
-httpx==0.27.0 # Testing
+h11>=0.14.0 # Testing
+httpcore>=1.0.5 # Testing
+httpx>=0.27.0 # Testing