Merge pull request #1779 from appwrite/fix/python-serializer-field-selection

fix(python): honour include and exclude in generic model serializers

Author: ChiragAgg5k

templates/python/package/models/model.py.twig

@@ -2,7 +2,7 @@
 {% set isGeneric = definition.additionalProperties or hasGenericProperty %}
 from typing import Any, Dict, List, Optional, Union, cast{% if isGeneric %}, Generic, TypeVar, Type{% endif %}
 
-from pydantic import Field, PrivateAttr{{ definition.additionalProperties ? ', model_serializer' : '' }}
+from pydantic import Field, PrivateAttr{{ definition.additionalProperties ? ', TypeAdapter, model_serializer' : '' }}
 
 from .base_model import AppwriteModel
 {% set added = [] %}
@@ -31,6 +31,10 @@ from .{{ subSchema | caseSnake }} import {{ subSchema | caseUcfirst }}
 
 T = TypeVar('T')
 {% endif %}
+{% if definition.additionalProperties %}
+
+_PAYLOAD_ADAPTER = TypeAdapter(Dict[str, Any])
+{% endif %}
 
 class {{ definition.name | caseUcfirst }}(AppwriteModel{% if isGeneric %}, Generic[T]{% endif %}):
     """
@@ -113,26 +117,71 @@ class {{ definition.name | caseUcfirst }}(AppwriteModel{% if isGeneric %}, Gener
     def {{ 'data' | caseSnake | removeDollarSign }}(self, value: T) -> None:
         object.__setattr__(self, '_{{ 'data' | caseSnake | removeDollarSign }}', value)
 
-    def _serialize_data(self, info):
+    def _serialize_data(self, info, include=None, exclude=None):
         if hasattr(self._{{ 'data' | caseSnake | removeDollarSign }}, 'model_dump'):
             return self._{{ 'data' | caseSnake | removeDollarSign }}.model_dump(
                 mode=info.mode,
                 by_alias=info.by_alias,
                 exclude_unset=info.exclude_unset,
                 exclude_defaults=info.exclude_defaults,
                 exclude_none=info.exclude_none,
+                include=include,
+                exclude=exclude,
+            )
+
+        if isinstance(self._{{ 'data' | caseSnake | removeDollarSign }}, dict) and (include is not None or exclude is not None):
+            return _PAYLOAD_ADAPTER.dump_python(
+                self._{{ 'data' | caseSnake | removeDollarSign }},
+                mode=info.mode,
+                by_alias=info.by_alias,
+                exclude_unset=info.exclude_unset,
+                exclude_defaults=info.exclude_defaults,
+                exclude_none=info.exclude_none,
+                include=include,
+                exclude=exclude,
             )
 
         return self._{{ 'data' | caseSnake | removeDollarSign }}
+{% if definition.properties | length > 0 %}
+
+    @staticmethod
+    def _select_data(selector):
+        """
+        Resolves a pydantic include/exclude selector against the '{{ 'data' }}' key, which is
+        serialized here rather than declared as a field. Returns whether the key was
+        named, and any nested selector to apply within it.
+        """
+        if selector is None:
+            return False, None
+
+        if isinstance(selector, dict):
+            if '{{ 'data' }}' not in selector:
+                return False, None
+
+            nested = selector['{{ 'data' }}']
+
+            return True, nested if isinstance(nested, (dict, set, frozenset, list, tuple)) else None
+
+        return '{{ 'data' }}' in selector, None
+{% endif %}
 
     @model_serializer(mode='wrap')
     def _serialize_model(self, handler, info):
         result = handler(self)
-        data = self._serialize_data(info)
 {% if definition.properties | length > 0 %}
-        result['{{ 'data' }}'] = data
+        included, include_fields = self._select_data(info.include)
+        excluded, exclude_fields = self._select_data(info.exclude)
+
+        if info.include is not None and not included:
+            return result
+
+        if excluded and exclude_fields is None:
+            return result
+
+        result['{{ 'data' }}'] = self._serialize_data(info, include_fields, exclude_fields)
         return result
 {% else %}
+        data = self._serialize_data(info, info.include, info.exclude)
         if isinstance(result, dict) and isinstance(data, dict):
             return {**result, **data}