Feat/support pydantic expansion in filters (#136)

* add tests for expanding pydantic models returned by filter lambdas

* expand pydantic objects returned by filter lambdas

* bumpversion and changelog

Author: dshafer

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.31.2
+current_version = 0.31.3
 
 [bumpversion:file:pyproject.toml]
 

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [0.31.3] - 2023-09-30
+- [PR 136](https://github.com/salesforce/django-declarative-apis/pull/136) Fix filter expansion for pydantic objects
+
+
 # [0.31.2 = 2023-09-11]
 - [PR 134](https://github.com/salesforce/django-declarative-apis/pull/134) Make filter caching work for all datatypes
 - [PR 131](https://github.com/salesforce/django-declarative-apis/pull/131) Support non-utf8 request body

django_declarative_apis/machinery/filtering.py

@@ -10,6 +10,7 @@
 import logging
 import types
 
+import pydantic
 from django.conf import settings
 from django.core.exceptions import FieldDoesNotExist
 from django.db import models
@@ -171,7 +172,7 @@ def _get_filtered_field_value(  # noqa: C901
 
     # should this value be passed through the filters itself?
     if val.__class__ in filter_def or isinstance(
-        val, (list, tuple, models.Model, models.query.QuerySet)
+        val, (list, tuple, models.Model, models.query.QuerySet, pydantic.BaseModel)
     ):
         val = _apply_filters_to_object(
             val, filter_def, expand_children, val.__class__, filter_cache, model_cache

docs/source/conf.py

@@ -74,7 +74,7 @@
 # built documents.
 
 # The full version, including alpha/beta/rc tags.
-release = '0.31.2'  # set by bumpversion
+release = '0.31.3'  # set by bumpversion
 
 # The short X.Y version.
 version = release.rsplit('.', 1)[0]

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "django-declarative-apis"
-version = "0.31.2"  # set by bumpversion
+version = "0.31.3"  # set by bumpversion
 description = "Simple, readable, declarative APIs for Django"
 readme = "README.md"
 dependencies = [

tests/filters.py

@@ -49,12 +49,14 @@
     models.InefficientLeaf: {"id": ALWAYS},
     models.InefficientBranchA: {"leaf": lambda inst: inst.leaf},
     models.InefficientBranchB: {"leaf": lambda inst: inst.leaf},
+    models.PydanticBranch: {"id": ALWAYS},
     models.InefficientRoot: {"branch_a": ALWAYS, "branch_b": ALWAYS},
     models.InefficientPydanticRoot: {
         "default_factory": NEVER,
         "__len__": NEVER,
         "branch_a": lambda inst: inst.branch_a,
         "branch_b": lambda inst: inst.branch_b,
+        "branch_p": lambda inst: inst.branch_p,
     },
 }
 

tests/machinery/test_base.py

@@ -766,21 +766,26 @@ def setUp(self):
         leaf = models.InefficientLeaf.objects.create(id=1)
         branch_a = models.InefficientBranchA.objects.create(id=1, leaf=leaf)
         branch_b = models.InefficientBranchB.objects.create(id=1, leaf=leaf)
+        branch_p = models.PydanticBranchChildClass(id=1)
         self.root = models.InefficientPydanticRoot(
-            id=4, branch_a=branch_a, branch_b=branch_b
+            id=4, branch_a=branch_a, branch_b=branch_b, branch_p=branch_p
         )
 
     def test_filtering_accepts_nonhashable_root_item(self):
         with override_settings(
             DDA_FILTER_MODEL_CACHING_ENABLED=True, DDA_FILTER_CACHE_DEBUG_LOG=True
         ):
             try:
-                filtering.apply_filters_to_object(
+                filtered = filtering.apply_filters_to_object(
                     self.root, filters.INEFFICIENT_FUNCTION_FILTERS
                 )
             except TypeError:
                 self.fail("should be able to use filter caching on pydantic objects")
 
+            # make sure the pydantic child class was expanded
+            self.assertIsInstance(filtered["branch_p"], dict)
+            self.assertEqual(1, filtered["branch_p"]["id"])
+
 
 class ResourceUpdateEndpointDefinitionTestCase(
     testutils.RequestCreatorMixin, django.test.TestCase

tests/models.py

@@ -73,10 +73,19 @@ class InefficientRoot(models.Model):
     branch_b = models.ForeignKey(InefficientBranchB, on_delete=models.CASCADE)
 
 
+class PydanticBranch(pydantic.BaseModel):
+    id: int = None
+
+
+class PydanticBranchChildClass(PydanticBranch):
+    pass
+
+
 class InefficientPydanticRoot(pydantic.BaseModel, arbitrary_types_allowed=True):
     id: int = None
     branch_a: InefficientBranchA = None
     branch_b: InefficientBranchB = None
+    branch_p: PydanticBranch = None
 
 
 try: