feat: implement BaseModel.model_dump_json

Author: azmeuk

doc/changelog.rst

@@ -1,11 +1,18 @@
 Changelog
 =========
 
-[0.2.5] - 2024-11-13
+[0.2.5] - Unreleased
 --------------------
+
 Fixed
 ^^^^^
+- Implement :meth:`~scim2_models.BaseModel.model_dump_json`.
 
+[0.2.5] - 2024-11-13
+--------------------
+
+Fixed
+^^^^^
 - :meth:`~scim2_models.BaseModel.model_validate` types.
 
 [0.2.4] - 2024-11-03

scim2_models/base.py

@@ -724,20 +724,13 @@ def model_validate(
         kwargs.setdefault("context", {}).setdefault("scim", scim_ctx)
         return super().model_validate(*args, **kwargs)
 
-    def model_dump(
+    def _prepare_model_dump(
         self,
-        *args,
         scim_ctx: Optional[Context] = Context.DEFAULT,
         attributes: Optional[list[str]] = None,
         excluded_attributes: Optional[list[str]] = None,
         **kwargs,
-    ) -> 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.
-        """
+    ):
         kwargs.setdefault("context", {}).setdefault("scim", scim_ctx)
         kwargs["context"]["scim_attributes"] = [
             validate_attribute_urn(attribute, self.__class__)
@@ -751,9 +744,48 @@ def model_dump(
         if scim_ctx:
             kwargs.setdefault("exclude_none", True)
             kwargs.setdefault("by_alias", True)
-            kwargs.setdefault("mode", "json")
 
-        return super().model_dump(*args, **kwargs)
+        return kwargs
+
+    def model_dump(
+        self,
+        *args,
+        scim_ctx: Optional[Context] = Context.DEFAULT,
+        attributes: Optional[list[str]] = None,
+        excluded_attributes: Optional[list[str]] = None,
+        **kwargs,
+    ) -> 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,
+        scim_ctx: Optional[Context] = Context.DEFAULT,
+        attributes: Optional[list[str]] = None,
+        excluded_attributes: Optional[list[str]] = None,
+        **kwargs,
+    ) -> dict:
+        """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.

tests/test_model_serialization.py

@@ -65,6 +65,13 @@ def mut_resource():
     )
 
 
+def test_model_dump_json(mut_resource):
+    assert (
+        mut_resource.model_dump_json()
+        == '{"schemas":["org:example:MutResource"],"id":"id","readOnly":"x","readWrite":"x","immutable":"x","writeOnly":"x"}'
+    )
+
+
 def test_dump_default(mut_resource):
     """By default, everything is dumped."""
     assert mut_resource.model_dump() == {