refactor: move attribute inclusion/exclusion logic in ScimObject

Author: azmeuk

scim2_models/base.py

@@ -371,18 +371,18 @@ def set_complex_attribute_urns(self) -> None:
         from .attributes import ComplexAttribute
         from .attributes import is_complex_attribute
 
+        if isinstance(self, ComplexAttribute):
+            main_schema = self.attribute_urn
+            separator = "."
+        else:
+            main_schema = self.__class__.model_fields["schemas"].default[0]
+            separator = ":"
+
         for field_name in self.__class__.model_fields:
             attr_type = self.get_field_root_type(field_name)
             if not attr_type or not is_complex_attribute(attr_type):
                 continue
 
-            if isinstance(self, ComplexAttribute):
-                main_schema = self.attribute_urn
-                separator = "."
-            else:
-                main_schema = self.__class__.model_fields["schemas"].default[0]
-                separator = ":"
-
             schema = f"{main_schema}{separator}{field_name}"
 
             if attr_value := getattr(self, field_name):
@@ -505,66 +505,16 @@ def model_validate(
     def _prepare_model_dump(
         self,
         scim_ctx: Optional[Context] = Context.DEFAULT,
-        attributes: Optional[list[str]] = None,
-        excluded_attributes: Optional[list[str]] = None,
         **kwargs: Any,
     ) -> dict[str, Any]:
         kwargs.setdefault("context", {}).setdefault("scim", scim_ctx)
-        kwargs["context"]["scim_attributes"] = [
-            validate_attribute_urn(attribute, self.__class__)
-            for attribute in (attributes or [])
-        ]
-        kwargs["context"]["scim_excluded_attributes"] = [
-            validate_attribute_urn(attribute, self.__class__)
-            for attribute in (excluded_attributes or [])
-        ]
 
         if scim_ctx:
             kwargs.setdefault("exclude_none", True)
             kwargs.setdefault("by_alias", True)
 
         return kwargs
 
-    def model_dump(
-        self,
-        *args: Any,
-        scim_ctx: Optional[Context] = Context.DEFAULT,
-        attributes: Optional[list[str]] = None,
-        excluded_attributes: Optional[list[str]] = None,
-        **kwargs: Any,
-    ) -> dict:
-        """Create a model representation that can be included in SCIM messages by using Pydantic :code:`BaseModel.model_dump`.
-
-        :param scim_ctx: If a SCIM context is passed, some default values of
-            Pydantic :code:`BaseModel.model_dump` are tuned to generate valid SCIM
-            messages. Pass :data:`None` to get the default Pydantic behavior.
-        """
-        dump_kwargs = self._prepare_model_dump(
-            scim_ctx, attributes, excluded_attributes, **kwargs
-        )
-        if scim_ctx:
-            dump_kwargs.setdefault("mode", "json")
-        return super().model_dump(*args, **dump_kwargs)
-
-    def model_dump_json(
-        self,
-        *args: Any,
-        scim_ctx: Optional[Context] = Context.DEFAULT,
-        attributes: Optional[list[str]] = None,
-        excluded_attributes: Optional[list[str]] = None,
-        **kwargs: Any,
-    ) -> str:
-        """Create a JSON model representation that can be included in SCIM messages by using Pydantic :code:`BaseModel.model_dump_json`.
-
-        :param scim_ctx: If a SCIM context is passed, some default values of
-            Pydantic :code:`BaseModel.model_dump` are tuned to generate valid SCIM
-            messages. Pass :data:`None` to get the default Pydantic behavior.
-        """
-        dump_kwargs = self._prepare_model_dump(
-            scim_ctx, attributes, excluded_attributes, **kwargs
-        )
-        return super().model_dump_json(*args, **dump_kwargs)
-
     def get_attribute_urn(self, field_name: str) -> str:
         """Build the full URN of the attribute.
 

scim2_models/rfc7643/resource.py

@@ -26,7 +26,6 @@
 from ..base import BaseModel
 from ..base import BaseModelType
 from ..reference import Reference
-from ..scim_object import SchemaObject
 from ..scim_object import ScimObject
 from ..utils import UNION_TYPES
 from ..utils import normalize_attribute_name
@@ -87,7 +86,7 @@ class Meta(ComplexAttribute):
     """
 
 
-class Extension(SchemaObject):
+class Extension(ScimObject):
     @classmethod
     def to_schema(cls) -> "Schema":
         """Build a :class:`~scim2_models.Schema` from the current extension class."""

scim2_models/scim_object.py

@@ -1,17 +1,86 @@
 """Base SCIM object classes with schema identification."""
 
 from typing import Annotated
+from typing import Any
+from typing import Optional
 
 from .annotations import Required
 from .base import BaseModel
+from .base import validate_attribute_urn
+from .context import Context
 
 
-class SchemaObject(BaseModel):
+class ScimObject(BaseModel):
     schemas: Annotated[list[str], Required.true]
     """The "schemas" attribute is a REQUIRED attribute and is an array of
     Strings containing URIs that are used to indicate the namespaces of the
     SCIM schemas that define the attributes present in the current JSON
     structure."""
 
+    def _prepare_model_dump(
+        self,
+        scim_ctx: Optional[Context] = Context.DEFAULT,
+        attributes: Optional[list[str]] = None,
+        excluded_attributes: Optional[list[str]] = None,
+        **kwargs: Any,
+    ) -> dict[str, Any]:
+        kwargs = super()._prepare_model_dump(scim_ctx, **kwargs)
+        kwargs["context"]["scim_attributes"] = [
+            validate_attribute_urn(attribute, self.__class__)
+            for attribute in (attributes or [])
+        ]
+        kwargs["context"]["scim_excluded_attributes"] = [
+            validate_attribute_urn(attribute, self.__class__)
+            for attribute in (excluded_attributes or [])
+        ]
+        return kwargs
 
-class ScimObject(SchemaObject): ...
+    def model_dump(
+        self,
+        *args: Any,
+        scim_ctx: Optional[Context] = Context.DEFAULT,
+        attributes: Optional[list[str]] = None,
+        excluded_attributes: Optional[list[str]] = None,
+        **kwargs: Any,
+    ) -> dict:
+        """Create a model representation that can be included in SCIM messages by using Pydantic :code:`BaseModel.model_dump`.
+
+        :param scim_ctx: If a SCIM context is passed, some default values of
+            Pydantic :code:`BaseModel.model_dump` are tuned to generate valid SCIM
+            messages. Pass :data:`None` to get the default Pydantic behavior.
+        :param attributes: A multi-valued list of strings indicating the names of resource
+            attributes to return in the response, overriding the set of attributes that
+            would be returned by default.
+        :param excluded_attributes: A multi-valued list of strings indicating the names of resource
+            attributes to be removed from the default set of attributes to return.
+        """
+        dump_kwargs = self._prepare_model_dump(
+            scim_ctx, attributes, excluded_attributes, **kwargs
+        )
+        if scim_ctx:
+            dump_kwargs.setdefault("mode", "json")
+        return super(BaseModel, self).model_dump(*args, **dump_kwargs)
+
+    def model_dump_json(
+        self,
+        *args: Any,
+        scim_ctx: Optional[Context] = Context.DEFAULT,
+        attributes: Optional[list[str]] = None,
+        excluded_attributes: Optional[list[str]] = None,
+        **kwargs: Any,
+    ) -> str:
+        """Create a JSON model representation that can be included in SCIM messages by using Pydantic :code:`BaseModel.model_dump_json`.
+
+        :param scim_ctx: If a SCIM context is passed, some default values of
+            Pydantic :code:`BaseModel.model_dump` are tuned to generate valid SCIM
+            messages. Pass :data:`None` to get the default Pydantic behavior.
+        :param attributes: A multi-valued list of strings indicating the names of resource
+            attributes to return in the response, overriding the set of attributes that
+            would be returned by default.
+        :param excluded_attributes: A multi-valued list of strings indicating the names of resource
+            attributes to be removed from the default set of attributes to return.
+        """
+        dump_kwargs = self._prepare_model_dump(
+            scim_ctx, attributes, excluded_attributes, **kwargs
+        )
+        return super(BaseModel, self).model_dump_json(*args, **dump_kwargs)