Merge pull request #9 from mts-ai/feature/includes-and-other-huge-improvements

Includes and generics

Author: Znbiz

.coveragerc

@@ -0,0 +1,36 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+omit =
+    tests/*
+    examples/*
+    docs/*
+    # omit anything in a .local directory anywhere
+    # */.local/*
+    # omit everything in /usr
+    # /usr/*
+    # omit this single file
+    # utils/tirefire.py
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_also =
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+    # Don't complain about abstract methods, they aren't run:
+    @(abc\.)?abstractmethod
+
+ignore_errors = True
+
+[html]
+directory = coverage_html_report

.github/workflows/testing.yml

@@ -0,0 +1,31 @@
+name: Python testing
+
+on:
+  - push
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install poetry
+        run: |
+          python -m pip install --upgrade pip poetry pre-commit
+          poetry config virtualenvs.create false --local
+      - name: Install dependencies
+        run: poetry install --all-extras
+      - name: Lint code
+        run: pre-commit run --all-files
+      - name: Test with pytest
+        run: pytest -s -vv tests/

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v3.2.0"
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: mixed-line-ending
+      - id: requirements-txt-fixer
+
+  - repo: https://github.com/psf/black
+    rev: "23.3.0"
+    hooks:
+      - id: black
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.0.269"
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

MANIFEST.in

@@ -1,3 +1,3 @@
 include README.md
 include LICENSE
-include requirements.txt
+include requirements.txt

README.md

@@ -1,3 +1,6 @@
+[![Documentation Status](https://readthedocs.org/projects/fastapi-jsonapi/badge/?version=latest)](https://fastapi-jsonapi.readthedocs.io/en/latest/?badge=latest)
+![PyPI](https://img.shields.io/pypi/v/fastapi-jsonapi?label=PyPI)
+
 # FastAPI-JSONAPI
 
 FastAPI-JSONAPI is a FastAPI extension for building REST APIs.
@@ -36,7 +39,6 @@ from sqlalchemy.sql import Select
 from fastapi_jsonapi import RoutersJSONAPI
 from fastapi_jsonapi import SqlalchemyEngine
 from fastapi_jsonapi.data_layers.orm import DBORMType
-from fastapi_jsonapi.openapi import custom_openapi
 from fastapi_jsonapi.querystring import QueryStringManager
 from fastapi_jsonapi.schema import JSONAPIResultListSchema
 from fastapi_jsonapi.schema import collect_app_orm_schemas
@@ -115,7 +117,12 @@ class UserDetail:
         return UserSchema.from_orm(user)
 
     @classmethod
-    async def patch(cls, obj_id: int, data: UserPatchSchema, session: AsyncSession = Depends(Connector.get_session)) -> UserSchema:
+    async def patch(
+        cls,
+        obj_id: int,
+        data: UserPatchSchema,
+        session: AsyncSession = Depends(Connector.get_session),
+    ) -> UserSchema:
         user: User = (await session.execute(select(User).where(User.id == obj_id))).scalar_one()
         user.first_name = data.first_name
         await session.commit()
@@ -131,7 +138,9 @@ class UserDetail:
 class UserList:
     @classmethod
     async def get(
-            cls, query_params: QueryStringManager, session: AsyncSession = Depends(Connector.get_session)
+        cls,
+        query_params: QueryStringManager,
+        session: AsyncSession = Depends(Connector.get_session),
     ) -> Union[Select, JSONAPIResultListSchema]:
         user_query = select(User)
         dl = SqlalchemyEngine(query=user_query, schema=UserSchema, model=User, session=session)
@@ -161,7 +170,7 @@ def add_routes(app: FastAPI) -> List[Dict[str, Any]]:
 
     routers: APIRouter = APIRouter()
     RoutersJSONAPI(
-        routers=routers,
+        router=routers,
         path="/user",
         tags=["User"],
         class_detail=UserDetail,
@@ -200,14 +209,12 @@ def create_app() -> FastAPI:
     )
     add_routes(app)
     app.on_event("startup")(sqlalchemy_init)
-    custom_openapi(app, title="API for SQLAlchemy")
     collect_app_orm_schemas(app)
     return app
 
 
 app = create_app()
 
-
 if __name__ == "__main__":
     uvicorn.run(
         "test:app",

docs/api_filtering_example.rst

@@ -86,4 +86,3 @@ Response:
 
 .. literalinclude:: ./http_snippets/snippets/api_filtering__get_persons__filter_word_contains_in_array_result
   :language: HTTP
-

docs/changelog.rst

@@ -1,8 +1,34 @@
 Changelog
+#########
+
+
+**1.0.0**
 *********
 
+Backward-incompatible changes, improvements, bug fixes
+======================================================
+
+* Includes (see :ref:`example with many-to-many <include_many_to_many>`) - any level of includes is now supported (tested with 4);
+* View Classes generics (Detail View and List View);
+* View Classes now use instance-level methods (breaking change, previously ``classmethods`` were used);
+* Pydantic schemas now have to be inherited from custom BaseModel methods (breaking change, previously all schemas were supported). It uses custom `registry class <https://github.com/mts-ai/FastAPI-JSONAPI/blob/188093e967bb80b7a1f0a86e754a52e47f252044/fastapi_jsonapi/schema_base.py#L33>`_, so we can collect and resolve all schemas. Maybe there's some workaround to collect all known schemas;
+* Improved interactive docs, request and response examples now have more info, more schemas appear in docs;
+* Reworked schemas resolving and building;
+* Fixed filtering (schemas resolving fix);
+* Create custom sql filters :ref:`example <custom_sql_filtering>`;
+* Add linters: black, ruff;
+* Add pre-commit;
+* Add autotests with pytest;
+* Add poetry, configure dependencies groups;
+* Add GitHub Action with linting and testing;
+* Upgrade examples;
+* Update docs.
+
+`@mahenzon`_
+
+
 **0.2.1**
-=========
+*********
 
 Enhancements and bug fixes
 ==========================
@@ -11,7 +37,7 @@ Enhancements and bug fixes
 
 
 **0.2.0**
-=========
+*********
 
 Enhancements and bug fixes
 ==========================
@@ -21,3 +47,4 @@ Enhancements and bug fixes
 
 
 .. _`@znbiz`: https://github.com/znbiz
+.. _`@mahenzon`: https://github.com/mahenzon

docs/conf.py

@@ -33,6 +33,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
+    "sphinx.ext.autosectionlabel",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -137,6 +138,8 @@
     "page_width": "1080px",
     "fixed_sidebar": True,
     "code_font_size": "0.8em",
+    "show_nav_level": 2,
+    "navigation_depth": 2,
 }
 
 # Add any paths that contain custom themes here, relative to this directory.

docs/custom_sql_filtering.rst

@@ -0,0 +1,54 @@
+.. _custom_sql_filtering:
+
+
+Custom SQL filtering
+####################
+
+.. currentmodule:: fastapi_jsonapi
+
+Sometimes you need custom filtering that's not supported natively.
+You can define new filtering rules as in this example:
+
+
+
+Prepare pydantic schema which is used in RoutersJSONAPI as schema
+-----------------------------------------------------------------
+
+
+``schemas/picture.py``:
+
+.. literalinclude:: ../examples/custom_filter_example.py
+    :language: python
+
+
+Declare models as usual, create routes as usual.
+
+Search for objects
+------------------
+
+
+.. note::
+    Note that url has to be quoted. It's unquoted only for an example
+
+Request:
+
+
+.. sourcecode:: http
+
+    GET /pictures?filter=[{"name":"picture.meta","op":"jsonb_contains","val":{"location":"Moscow"}}] HTTP/1.1
+    Accept: application/vnd.api+json
+
+
+Filter value has to be a valid JSON:
+
+.. sourcecode:: JSON
+
+    [
+       {
+          "name":"picture.meta",
+          "op":"jsonb_contains",
+          "val":{
+             "location":"Moscow"
+          }
+       }
+    ]