switch to decorator used to register property_fields and save it on Meta inner class to expose to cloned fastapi models

ormar/__init__.py

@@ -1,3 +1,4 @@
+from ormar.decorators import property_field
 from ormar.exceptions import ModelDefinitionError, ModelNotSet, MultipleMatches, NoMatch
 from ormar.protocols import QuerySetProtocol, RelationProtocol  # noqa: I100
 from ormar.fields import (  # noqa: I100
@@ -58,4 +59,5 @@ __all__ = [
     "QuerySetProtocol",
     "RelationProtocol",
     "ModelMeta",
+    "property_field",
 ]

ormar/decorators/__init__.py

@@ -0,0 +1,5 @@
+from ormar.decorators.property_field import property_field
+
+__all__ = [
+    "property_field",
+]

ormar/decorators/property_field.py

@@ -0,0 +1,19 @@
+import inspect
+from collections.abc import Callable
+from typing import Union
+
+from ormar.exceptions import ModelDefinitionError
+
+
+def property_field(func: Callable) -> Union[property, Callable]:
+    if isinstance(func, property):  # pragma: no cover
+        func.fget.__property_field__ = True
+    else:
+        arguments = list(inspect.signature(func).parameters.keys())
+        if len(arguments) > 1 or arguments[0] != "self":
+            raise ModelDefinitionError(
+                "property_field decorator can be used "
+                "only on class methods with no arguments"
+            )
+        func.__dict__["__property_field__"] = True
+    return func

ormar/models/metaclass.py

@@ -1,7 +1,6 @@
-import inspect
 import logging
 import warnings
-from typing import Any, Dict, List, Optional, TYPE_CHECKING, Tuple, Type, Union
+from typing import Any, Dict, List, Optional, Set, TYPE_CHECKING, Tuple, Type, Union
 
 import databases
 import pydantic
@@ -16,7 +15,6 @@ from ormar import ForeignKey, Integer, ModelDefinitionError  # noqa I100
 from ormar.fields import BaseField
 from ormar.fields.foreign_key import ForeignKeyField
 from ormar.fields.many_to_many import ManyToMany, ManyToManyField
-from ormar.fields.model_fields import ModelFieldFactory
 from ormar.models.quick_access_views import quick_access_set
 from ormar.queryset import QuerySet
 from ormar.relations.alias_manager import AliasManager
@@ -39,8 +37,7 @@ class ModelMeta:
         str, Union[Type[BaseField], Type[ForeignKeyField], Type[ManyToManyField]]
     ]
     alias_manager: AliasManager
-    include_props_in_dict: bool
+    property_fields: Set
-    include_props_in_fields: bool
 
 
 def register_relation_on_build(table_name: str, field: Type[ForeignKeyField]) -> None:
@@ -328,40 +325,30 @@ def populate_default_options_values(
     if not hasattr(new_model.Meta, "model_fields"):
         new_model.Meta.model_fields = model_fields
 
-    if not hasattr(new_model.Meta, "include_props_in_dict"):
-        new_model.Meta.include_props_in_dict = True
-    if not hasattr(new_model.Meta, "include_props_in_fields"):
-        new_model.Meta.include_props_in_fields = False
-
 
 def add_cached_properties(new_model: Type["Model"]) -> None:
-    new_model._props = {
-        prop[0]
-        for prop in inspect.getmembers(new_model, lambda o: isinstance(o, property))
-        if prop[0] not in ("__values__", "__fields__", "fields", "pk_column", "saved")
-    }
     new_model._quick_access_fields = quick_access_set
     new_model._related_names = None
     new_model._pydantic_fields = {name for name in new_model.__fields__}
 
 
-def add_property_fields(new_model: Type["Model"]) -> None:
+def property_fields_not_set(new_model: Type["Model"]) -> bool:
-    pass
+    return (
+        not hasattr(new_model.Meta, "property_fields")
+        or not new_model.Meta.property_fields
+    )
 
 
-#     if new_model.Meta.include_props_in_fields:
+def add_property_fields(new_model: Type["Model"], attrs: Dict) -> None:  # noqa: CCR001
-#         for prop in new_model._props:
+    if property_fields_not_set(new_model):
-#             field_type = getattr(new_model, prop).fget.__annotations__.get("return")
+        props = set()
-#             new_model.Meta.model_fields[prop] = ModelFieldFactory(  # type: ignore
+        for var_name, value in attrs.items():
-#                 nullable=True, pydantic_only=True
+            if isinstance(value, property):
-#             )
+                value = value.fget
-#             new_model.__fields__[prop] = ModelField(
+            field_config = getattr(value, "__property_field__", None)
-#                 name=prop,
+            if field_config:
-#                 type_=Optional[field_type] if field_type is not None else Any,  # type: ignore
+                props.add(var_name)
-#                 model_config=new_model.__config__,
+        new_model.Meta.property_fields = props
-#                 required=False,
-#                 class_validators={},
-#             )
 
 
 class ModelMetaclass(pydantic.main.ModelMetaclass):
@@ -391,6 +378,6 @@ class ModelMetaclass(pydantic.main.ModelMetaclass):
                 )
             new_model.Meta.alias_manager = alias_manager
             new_model.objects = QuerySet(new_model)
-            add_property_fields(new_model)
+            add_property_fields(new_model, attrs)
 
         return new_model

ormar/models/modelproxy.py

@@ -45,7 +45,7 @@ class ModelTableProxy:
         pk: Any
         get_name: Callable
         _props: Set
-        dict: Callable
+        dict: Callable  # noqa:  A001, VNE003
 
     def _extract_own_model_fields(self) -> Dict:
         related_names = self.extract_related_names()

ormar/models/newbasemodel.py

@@ -1,4 +1,3 @@
-import inspect
 import json
 import uuid
 from typing import (
@@ -68,14 +67,12 @@ class NewBaseModel(
         _orm_saved: bool
         _related_names: Optional[Set]
         _related_names_hash: str
-        _props: Set
         _pydantic_fields: Set
         _quick_access_fields: Set
         Meta: ModelMeta
 
     # noinspection PyMissingConstructor
     def __init__(self, *args: Any, **kwargs: Any) -> None:  # type: ignore
-        caller_name = inspect.currentframe().f_back.f_code.co_name
         object.__setattr__(self, "_orm_id", uuid.uuid4().hex)
         object.__setattr__(self, "_orm_saved", False)
         object.__setattr__(
@@ -96,9 +93,14 @@ class NewBaseModel(
 
         if "pk" in kwargs:
             kwargs[self.Meta.pkname] = kwargs.pop("pk")
+
+        # remove property fields values from validation
+        kwargs = {
+            k: v
+            for k, v in kwargs.items()
+            if k not in object.__getattribute__(self, "Meta").property_fields
+        }
         # build the models to set them and validate but don't register
-        if self.Meta.include_props_in_dict:
-            kwargs = {k: v for k, v in kwargs.items() if k not in object.__getattribute__(self, '_props')}
         try:
             new_kwargs: Dict[str, Any] = {
                 k: self._convert_json(
@@ -136,7 +138,7 @@ class NewBaseModel(
             )
 
     def __setattr__(self, name: str, value: Any) -> None:  # noqa CCR001
-        if name in ("_orm_id", "_orm_saved", "_orm", "_related_names", "_props"):
+        if name in object.__getattribute__(self, "_quick_access_fields"):
             object.__setattr__(self, name, value)
         elif name == "pk":
             object.__setattr__(self, self.Meta.pkname, value)
@@ -168,8 +170,9 @@ class NewBaseModel(
             return object.__getattribute__(
                 self, "_extract_related_model_instead_of_field"
             )(item)
-        if item in object.__getattribute__(self, "_props"):
+        if item in object.__getattribute__(self, "Meta").property_fields:
-            return object.__getattribute__(self, item)
+            value = object.__getattribute__(self, item)
+            return value() if callable(value) else value
         if item in object.__getattribute__(self, "_pydantic_fields"):
             value = object.__getattribute__(self, "__dict__").get(item, None)
             value = object.__getattribute__(self, "_convert_json")(item, value, "loads")
@@ -229,7 +232,7 @@ class NewBaseModel(
         cls, include: Union[Set, Dict, None], exclude: Union[Set, Dict, None]
     ) -> Set[str]:
 
-        props = cls._props
+        props = cls.Meta.property_fields
         if include:
             props = {prop for prop in props if prop in include}
         if exclude:
@@ -339,8 +342,8 @@ class NewBaseModel(
             exclude=exclude,  # type: ignore
         )
 
-        # include model properties as fields
+        # include model properties as fields in dict
-        if self.Meta.include_props_in_dict:
+        if object.__getattribute__(self, "Meta").property_fields:
             props = self.get_properties(include=include, exclude=exclude)
             if props:
                 dict_instance.update({prop: getattr(self, prop) for prop in props})

ormar/models/quick_access_views.py

@@ -25,7 +25,6 @@ quick_access_set = {
     "_orm",
     "_orm_id",
     "_orm_saved",
-    "_props",
     "_related_names",
     "_skip_ellipsis",
     "_update_and_follow",

tests/test_excluding_fields_in_fastapi.py

@@ -10,6 +10,7 @@ from fastapi import FastAPI
 from starlette.testclient import TestClient
 
 import ormar
+from ormar import property_field
 from tests.settings import DATABASE_URL
 
 app = FastAPI()
@@ -74,8 +75,8 @@ class RandomModel(ormar.Model):
         server_default=sqlalchemy.func.now()
     )
 
-    @property
+    @property_field
-    def full_name(self):
+    def full_name(self) -> str:
         return " ".join([self.first_name, self.last_name])
 
 
@@ -140,7 +141,6 @@ async def create_user4(user: User2):
 @app.post("/random/", response_model=RandomModel)
 async def create_user5(user: RandomModel):
     user = await user.save()
-    print('returning')
     return user
 
 
@@ -170,24 +170,20 @@ def test_excluding_fields_in_endpoints():
             "last_name": "Doe",
         }
 
-        print('before call')
         response = client.post("/users/", json=user2)
         created_user = User(**response.json())
         assert created_user.pk is not None
         assert created_user.password is None
 
-        print('before call')
         response = client.post("/users2/", json=user)
         created_user2 = User(**response.json())
         assert created_user2.pk is not None
         assert created_user2.password is None
 
         # response has only 3 fields from UserBase
-        print('before call')
         response = client.post("/users3/", json=user)
         assert list(response.json().keys()) == ["email", "first_name", "last_name"]
 
-        print('before call')
         response = client.post("/users4/", json=user)
         assert list(response.json().keys()) == [
             "id",
@@ -197,40 +193,41 @@ def test_excluding_fields_in_endpoints():
             "category",
         ]
 
-        # user3 = {"last_name": "Test"}
-        # print('before call')
-        # response = client.post("/random/", json=user3)
-        # assert list(response.json().keys()) == [
-        #     "id",
-        #     "password",
-        #     "first_name",
-        #     "last_name",
-        #     "created_date",
-        #     "full_name",
-        # ]
-        # assert response.json().get("full_name") == "John Test"
-        #
-        # RandomModel.Meta.include_props_in_fields = False
-        # user3 = {"last_name": "Test"}
-        # print('before call')
-        # response = client.post("/random/", json=user3)
-        # assert list(response.json().keys()) == [
-        #     "id",
-        #     "password",
-        #     "first_name",
-        #     "last_name",
-        #     "created_date",
-        #     "full_name",
-        # ]
-        # assert response.json().get("full_name") == "John Test"
-
 
 def test_adding_fields_in_endpoints():
+    client = TestClient(app)
+    with client as client:
+        user3 = {"last_name": "Test"}
+        response = client.post("/random/", json=user3)
+        assert list(response.json().keys()) == [
+            "id",
+            "password",
+            "first_name",
+            "last_name",
+            "created_date",
+            "full_name",
+        ]
+        assert response.json().get("full_name") == "John Test"
+
+        RandomModel.Meta.include_props_in_fields = False
+        user3 = {"last_name": "Test"}
+        response = client.post("/random/", json=user3)
+        assert list(response.json().keys()) == [
+            "id",
+            "password",
+            "first_name",
+            "last_name",
+            "created_date",
+            "full_name",
+        ]
+        assert response.json().get("full_name") == "John Test"
+
+
+def test_adding_fields_in_endpoints2():
     client = TestClient(app)
     with client as client:
         RandomModel.Meta.include_props_in_dict = True
         user3 = {"last_name": "Test"}
-        print('before call')
         response = client.post("/random2/", json=user3)
         assert list(response.json().keys()) == [
             "id",

tests/test_properties.py

@@ -1,8 +1,10 @@
+# type: ignore
 import databases
 import pytest
 import sqlalchemy
 
 import ormar
+from ormar import ModelDefinitionError, property_field
 from tests.settings import DATABASE_URL
 
 database = databases.Database(DATABASE_URL, force_rollback=True)
@@ -19,15 +21,15 @@ class Song(ormar.Model):
     name: str = ormar.String(max_length=100)
     sort_order: int = ormar.Integer()
 
-    @property
+    @property_field
     def sorted_name(self):
         return f"{self.sort_order}: {self.name}"
 
-    @property
+    @property_field
     def sample(self):
         return "sample"
 
-    @property
+    @property_field
     def sample2(self):
         return "sample2"
 
@@ -66,3 +68,12 @@ async def test_sort_order_on_main_model():
         assert "sample" not in check_include
         assert "sample2" in check_include
         assert "sorted_name" in check_include
+
+
+def test_wrong_definition():
+    with pytest.raises(ModelDefinitionError):
+
+        class WrongModel(ormar.Model):  # pragma: no cover
+            @property_field
+            def test(self, aa=10, bb=30):
+                pass

tests/test_pydantic_only_fields.py

@@ -3,9 +3,9 @@ import datetime
 import databases
 import pytest
 import sqlalchemy
-from pydantic import validator
 
 import ormar
+from ormar import property_field
 from tests.settings import DATABASE_URL
 
 database = databases.Database(DATABASE_URL, force_rollback=True)
@@ -17,17 +17,27 @@ class Album(ormar.Model):
         tablename = "albums"
         metadata = metadata
         database = database
-        include_props_in_dict = True
-        include_props_in_fields = True
 
     id: int = ormar.Integer(primary_key=True)
     name: str = ormar.String(max_length=100)
     timestamp: datetime.datetime = ormar.DateTime(pydantic_only=True)
 
-    @property
+    @property_field
     def name10(self) -> str:
         return self.name + "_10"
 
+    @property_field
+    def name20(self) -> str:
+        return self.name + "_20"
+
+    @property
+    def name30(self) -> str:
+        return self.name + "_30"
+
+    @property_field
+    def name40(self) -> str:
+        return self.name + "_40"
+
 
 @pytest.fixture(autouse=True, scope="module")
 def create_test_database():
@@ -57,14 +67,13 @@ async def test_pydantic_only_fields():
             assert "timestamp" in test_dict
             assert test_dict["timestamp"] is None
 
+            assert album.name30 == "Hitchcock_30"
+
             album.timestamp = datetime.datetime.now()
             test_dict = album.dict()
             assert "timestamp" in test_dict
             assert test_dict["timestamp"] is not None
             assert test_dict.get("name10") == "Hitchcock_10"
-
+            assert test_dict.get("name20") == "Hitchcock_20"
-            Album.Meta.include_props_in_dict = False
+            assert test_dict.get("name40") == "Hitchcock_40"
-            test_dict = album.dict()
+            assert "name30" not in test_dict
-            assert "timestamp" in test_dict
-            assert test_dict["timestamp"] is not None
-            assert test_dict.get("name10", 'aa') == 'aa'