add excludes for pks and through models in dict

tests/test_exclude_include_dict/test_dumping_model_to_dict.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import List, Optional
 
 import databases
 import pytest
@@ -11,16 +11,28 @@ metadata = sqlalchemy.MetaData()
 database = databases.Database(DATABASE_URL, force_rollback=True)
 
 
+class MainMeta(ormar.ModelMeta):
+    metadata = metadata
+    database = database
+
+
+class Role(ormar.Model):
+    class Meta(MainMeta):
+        pass
+
+    id: int = ormar.Integer(primary_key=True)
+    name: str = ormar.String(max_length=255, nullable=False)
+
+
 class User(ormar.Model):
-    class Meta:
+    class Meta(MainMeta):
         tablename: str = "users"
-        metadata = metadata
-        database = database
 
     id: int = ormar.Integer(primary_key=True)
     email: str = ormar.String(max_length=255, nullable=False)
     password: str = ormar.String(max_length=255, nullable=True)
     first_name: str = ormar.String(max_length=255, nullable=False)
+    roles: List[Role] = ormar.ManyToMany(Role)
 
 
 class Tier(ormar.Model):
@@ -58,12 +70,20 @@ class Item(ormar.Model):
 
 @pytest.fixture(autouse=True, scope="module")
 def sample_data():
-    user = User(email="test@test.com", password="ijacids7^*&", first_name="Anna")
-    tier = Tier(name="Tier I")
-    category1 = Category(name="Toys", tier=tier)
-    category2 = Category(name="Weapons", tier=tier)
-    item1 = Item(name="Teddy Bear", category=category1, created_by=user)
-    item2 = Item(name="M16", category=category2, created_by=user)
+    role = Role(name="User", id=1)
+    role2 = Role(name="Admin", id=2)
+    user = User(
+        id=1,
+        email="test@test.com",
+        password="ijacids7^*&",
+        first_name="Anna",
+        roles=[role, role2],
+    )
+    tier = Tier(id=1, name="Tier I")
+    category1 = Category(id=1, name="Toys", tier=tier)
+    category2 = Category(id=2, name="Weapons", tier=tier)
+    item1 = Item(id=1, name="Teddy Bear", category=category1, created_by=user)
+    item2 = Item(id=2, name="M16", category=category2, created_by=user)
     return item1, item2
 
 
@@ -139,4 +159,30 @@ def test_dumping_to_dict_exclude_and_include_nested_dict(sample_data):
     assert dict2["category"]["name"] == "Toys"
     assert "created_by" not in dict1
     assert dict1["category"]["tier"].get("name") is None
-    assert dict1["category"]["tier"]["id"] is None
+    assert dict1["category"]["tier"]["id"] == 1
+
+
+def test_dumping_dict_without_primary_keys(sample_data):
+    item1, item2 = sample_data
+    dict1 = item2.dict(exclude_primary_keys=True)
+    assert dict1 == {
+        "category": {"name": "Weapons", "tier": {"name": "Tier I"}},
+        "created_by": {
+            "email": "test@test.com",
+            "first_name": "Anna",
+            "password": "ijacids7^*&",
+            "roles": [{"name": "User"}, {"name": "Admin"}],
+        },
+        "name": "M16",
+    }
+    dict2 = item1.dict(exclude_primary_keys=True)
+    assert dict2 == {
+        "category": {"name": "Toys", "tier": {"name": "Tier I"}},
+        "created_by": {
+            "email": "test@test.com",
+            "first_name": "Anna",
+            "password": "ijacids7^*&",
+            "roles": [{"name": "User"}, {"name": "Admin"}],
+        },
+        "name": "Teddy Bear",
+    }

tests/test_fastapi/test_excluding_fields.py

@@ -0,0 +1,149 @@
+from typing import List
+
+import databases
+import pytest
+import sqlalchemy
+from fastapi import FastAPI
+from starlette.testclient import TestClient
+
+import ormar
+from tests.settings import DATABASE_URL
+
+app = FastAPI()
+metadata = sqlalchemy.MetaData()
+database = databases.Database(DATABASE_URL, force_rollback=True)
+app.state.database = database
+
+
+@app.on_event("startup")
+async def startup() -> None:
+    database_ = app.state.database
+    if not database_.is_connected:
+        await database_.connect()
+
+
+@app.on_event("shutdown")
+async def shutdown() -> None:
+    database_ = app.state.database
+    if database_.is_connected:
+        await database_.disconnect()
+
+
+class Category(ormar.Model):
+    class Meta:
+        tablename = "categories"
+        metadata = metadata
+        database = database
+
+    id: int = ormar.Integer(primary_key=True)
+    name: str = ormar.String(max_length=100)
+
+
+class Item(ormar.Model):
+    class Meta:
+        tablename = "items"
+        metadata = metadata
+        database = database
+
+    id: int = ormar.Integer(primary_key=True)
+    name: str = ormar.String(max_length=100)
+    categories: List[Category] = ormar.ManyToMany(Category)
+
+
+@pytest.fixture(autouse=True, scope="module")
+def create_test_database():
+    engine = sqlalchemy.create_engine(DATABASE_URL)
+    metadata.create_all(engine)
+    yield
+    metadata.drop_all(engine)
+
+
+@app.post("/items/", response_model=Item)
+async def create_item(item: Item):
+    await item.save_related(follow=True, save_all=True)
+    return item
+
+
+@app.get("/items/{item_id}")
+async def get_item(item_id: int):
+    item = await Item.objects.select_related("categories").get(pk=item_id)
+    return item.dict(exclude_primary_keys=True, exclude_through_models=True)
+
+
+@app.get("/categories/{category_id}")
+async def get_category(category_id: int):
+    category = await Category.objects.select_related("items").get(pk=category_id)
+    return category.dict(exclude_primary_keys=True)
+
+
+@app.get("/categories/nt/{category_id}")
+async def get_category_no_through(category_id: int):
+    category = await Category.objects.select_related("items").get(pk=category_id)
+    return category.dict(exclude_through_models=True)
+
+
+@app.get("/categories/ntp/{category_id}")
+async def get_category_no_pk_through(category_id: int):
+    category = await Category.objects.select_related("items").get(pk=category_id)
+    return category.dict(exclude_through_models=True, exclude_primary_keys=True)
+
+
+@app.get(
+    "/items/fex/{item_id}",
+    response_model=Item,
+    response_model_exclude={
+        "id",
+        "categories__id",
+        "categories__itemcategory",
+        "categories__items",
+    },
+)
+async def get_item_excl(item_id: int):
+    item = await Item.objects.select_all().get(pk=item_id)
+    return item
+
+
+def test_all_endpoints():
+    client = TestClient(app)
+    with client as client:
+        item = {
+            "name": "test",
+            "categories": [{"name": "test cat"}, {"name": "test cat2"}],
+        }
+        response = client.post("/items/", json=item)
+        item_check = Item(**response.json())
+        assert item_check.id is not None
+        assert item_check.categories[0].id is not None
+
+        no_pk_item = client.get(f"/items/{item_check.id}", json=item).json()
+        assert no_pk_item == item
+
+        no_pk_item2 = client.get(f"/items/fex/{item_check.id}", json=item).json()
+        assert no_pk_item2 == item
+
+        no_pk_category = client.get(
+            f"/categories/{item_check.categories[0].id}", json=item
+        ).json()
+        assert no_pk_category == {
+            "items": [
+                {
+                    "itemcategory": {"category": None, "id": 1, "item": None},
+                    "name": "test",
+                }
+            ],
+            "name": "test cat",
+        }
+
+        no_through_category = client.get(
+            f"/categories/nt/{item_check.categories[0].id}", json=item
+        ).json()
+        assert no_through_category == {
+            "id": 1,
+            "items": [{"id": 1, "name": "test"}],
+            "name": "test cat",
+        }
+
+        no_through_category = client.get(
+            f"/categories/ntp/{item_check.categories[0].id}", json=item
+        ).json()
+        assert no_through_category == {"items": [{"name": "test"}], "name": "test cat"}

tests/test_model_definition/test_model_definition.py

@@ -228,7 +228,7 @@ def test_binary_error_without_length_model_definition():
                 database = database
                 metadata = metadata
 
-            test: bytes = ormar.LargeBinary(primary_key=True)
+            test: bytes = ormar.LargeBinary(primary_key=True, max_length=-1)
 
 
 @typing.no_type_check
@@ -241,7 +241,7 @@ def test_string_error_in_model_definition():
                 database = database
                 metadata = metadata
 
-            test: str = ormar.String(primary_key=True)
+            test: str = ormar.String(primary_key=True, max_length=0)
 
 
 @typing.no_type_check