refactor: rename resource_types in resource_models.

Author: azmeuk

doc/changelog.rst

@@ -9,7 +9,8 @@ Changelog
     This version comes with breaking changes:
 
     - `httpx` is no longer a direct dependency, it is shipped in the `httpx` packaging extra.
-    - Use ``scim2_client.engines.httpx.SyncSCIMClient`` instead of ``scim2_client.SCIMClient``.
+    - ``scim2_client.SCIMClient`` has moved to ``scim2_client.engines.httpx.SyncSCIMClient``.
+    - The ``resource_types`` parameters has been renamed ``resource_models``.
 
 Added
 ^^^^^

scim2_client/client.py

@@ -36,7 +36,7 @@ class BaseSCIMClient:
 
     This class can be inherited and used as a basis for request engine integration.
 
-    :param resource_types: A tuple of :class:`~scim2_models.Resource` types expected to be handled by the SCIM client.
+    :param resource_models: A tuple of :class:`~scim2_models.Resource` types expected to be handled by the SCIM client.
         If a request payload describe a resource that is not in this list, an exception will be raised.
 
     .. note::
@@ -124,30 +124,32 @@ class BaseSCIMClient:
     :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
     """
 
-    def __init__(self, resource_types: Optional[tuple[type[Resource]]] = None):
-        self.resource_types = tuple(
-            set(resource_types or []) | {ResourceType, Schema, ServiceProviderConfig}
+    def __init__(self, resource_models: Optional[tuple[type[Resource]]] = None):
+        self.resource_models = tuple(
+            set(resource_models or []) | {ResourceType, Schema, ServiceProviderConfig}
         )
 
-    def check_resource_type(self, resource_type: type[Resource], payload=None) -> None:
-        if resource_type not in self.resource_types:
+    def check_resource_model(
+        self, resource_model: type[Resource], payload=None
+    ) -> None:
+        if resource_model not in self.resource_models:
             raise SCIMRequestError(
-                f"Unknown resource type: '{resource_type}'", source=payload
+                f"Unknown resource type: '{resource_model}'", source=payload
             )
 
-    def resource_endpoint(self, resource_type: Optional[type[Resource]]) -> str:
-        if resource_type is None:
+    def resource_endpoint(self, resource_model: Optional[type[Resource]]) -> str:
+        if resource_model is None:
             return "/"
 
         # This one takes no final 's'
-        if resource_type is ServiceProviderConfig:
+        if resource_model is ServiceProviderConfig:
             return "/ServiceProviderConfig"
 
         try:
-            first_bracket_index = resource_type.__name__.index("[")
-            root_name = resource_type.__name__[:first_bracket_index]
+            first_bracket_index = resource_model.__name__.index("[")
+            root_name = resource_model.__name__[:first_bracket_index]
         except ValueError:
-            root_name = resource_type.__name__
+            root_name = resource_model.__name__
         return f"/{root_name}s"
 
     def check_response(
@@ -288,25 +290,25 @@ def prepare_create_request(
 
         else:
             if isinstance(resource, Resource):
-                resource_type = resource.__class__
+                resource_model = resource.__class__
 
             else:
-                resource_type = Resource.get_by_payload(self.resource_types, resource)
-                if not resource_type:
+                resource_model = Resource.get_by_payload(self.resource_models, resource)
+                if not resource_model:
                     raise SCIMRequestError(
                         "Cannot guess resource type from the payload"
                     )
 
                 try:
-                    resource = resource_type.model_validate(resource)
+                    resource = resource_model.model_validate(resource)
                 except ValidationError as exc:
                     scim_validation_exc = RequestPayloadValidationError(source=resource)
                     if sys.version_info >= (3, 11):  # pragma: no cover
                         scim_validation_exc.add_note(str(exc))
                     raise scim_validation_exc from exc
 
-            self.check_resource_type(resource_type, resource)
-            url = kwargs.pop("url", self.resource_endpoint(resource_type))
+            self.check_resource_model(resource_model, resource)
+            url = kwargs.pop("url", self.resource_endpoint(resource_model))
             payload = resource.model_dump(scim_ctx=Context.RESOURCE_CREATION_REQUEST)
 
         expected_types = [resource.__class__] if check_request_payload else None
@@ -315,7 +317,7 @@ def prepare_create_request(
 
     def query(
         self,
-        resource_type: Optional[type[Resource]] = None,
+        resource_model: Optional[type[Resource]] = None,
         id: Optional[str] = None,
         search_request: Optional[Union[SearchRequest, dict]] = None,
         check_request_payload: bool = True,
@@ -329,7 +331,7 @@ def query(
         - If `id` is not :data:`None`, the resource with the exact id will be reached.
         - If `id` is :data:`None`, all the resources with the given type will be reached.
 
-        :param resource_type: A :class:`~scim2_models.Resource` subtype or :data:`None`
+        :param resource_model: A :class:`~scim2_models.Resource` subtype or :data:`None`
         :param id: The SCIM id of an object to get, or :data:`None`
         :param search_request: An object detailing the search query parameters.
         :param check_request_payload: If :data:`False`,
@@ -345,8 +347,8 @@ def query(
 
         :return:
             - A :class:`~scim2_models.Error` object in case of error.
-            - A `resource_type` object in case of success if `id` is not :data:`None`
-            - A :class:`~scim2_models.ListResponse[resource_type]` object in case of success if `id` is :data:`None`
+            - A `resource_model` object in case of success if `id` is not :data:`None`
+            - A :class:`~scim2_models.ListResponse[resource_model]` object in case of success if `id` is :data:`None`
 
         .. note::
 
@@ -391,7 +393,7 @@ def query(
 
     def prepare_query_request(
         self,
-        resource_type: Optional[type[Resource]] = None,
+        resource_model: Optional[type[Resource]] = None,
         id: Optional[str] = None,
         search_request: Optional[Union[SearchRequest, dict]] = None,
         check_request_payload: bool = True,
@@ -400,8 +402,8 @@ def prepare_query_request(
         raise_scim_errors: bool = True,
         **kwargs,
     ) -> tuple[str, Union[AnyResource, dict], Optional[list[type[Resource]]], dict]:
-        if resource_type and check_request_payload:
-            self.check_resource_type(resource_type)
+        if resource_model and check_request_payload:
+            self.check_resource_model(resource_model)
 
         payload: Optional[SearchRequest]
         if not check_request_payload:
@@ -416,25 +418,25 @@ def prepare_query_request(
         else:
             payload = None
 
-        url = kwargs.pop("url", self.resource_endpoint(resource_type))
+        url = kwargs.pop("url", self.resource_endpoint(resource_model))
 
-        if resource_type is None:
+        if resource_model is None:
             expected_types = [
-                *self.resource_types,
-                ListResponse[Union[self.resource_types]],
+                *self.resource_models,
+                ListResponse[Union[self.resource_models]],
             ]
 
-        elif resource_type == ServiceProviderConfig:
-            expected_types = [resource_type]
+        elif resource_model == ServiceProviderConfig:
+            expected_types = [resource_model]
             if id:
                 raise SCIMClientError("ServiceProviderConfig cannot have an id")
 
         elif id:
-            expected_types = [resource_type]
+            expected_types = [resource_model]
             url = f"{url}/{id}"
 
         else:
-            expected_types = [ListResponse[resource_type]]
+            expected_types = [ListResponse[resource_model]]
 
         return url, payload, expected_types, kwargs
 
@@ -449,7 +451,7 @@ def search(
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
         """Perform a POST search request to read all available resources, as defined in :rfc:`RFC7644 §3.4.3 <7644#section-3.4.3>`.
 
-        :param resource_types: Resource type or union of types expected
+        :param resource_models: Resource type or union of types expected
             to be read from the response.
         :param search_request: An object detailing the search query parameters.
         :param check_request_payload: If :data:`False`,
@@ -466,7 +468,7 @@ def search(
 
         :return:
             - A :class:`~scim2_models.Error` object in case of error.
-            - A :class:`~scim2_models.ListResponse[resource_type]` object in case of success.
+            - A :class:`~scim2_models.ListResponse[resource_model]` object in case of success.
 
         :usage:
 
@@ -510,12 +512,12 @@ def prepare_search_request(
             )
 
         url = kwargs.pop("url", "/.search")
-        expected_types = [ListResponse[Union[self.resource_types]]]
+        expected_types = [ListResponse[Union[self.resource_models]]]
         return url, payload, expected_types, kwargs
 
     def delete(
         self,
-        resource_type: type,
+        resource_model: type,
         id: str,
         check_response_payload: bool = True,
         expected_status_codes: Optional[list[int]] = DELETION_RESPONSE_STATUS_CODES,
@@ -524,7 +526,7 @@ def delete(
     ) -> Optional[Union[Error, dict]]:
         """Perform a DELETE request to create, as defined in :rfc:`RFC7644 §3.6 <7644#section-3.6>`.
 
-        :param resource_type: The type of the resource to delete.
+        :param resource_model: The type of the resource to delete.
         :param id: The type id the resource to delete.
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
@@ -554,15 +556,15 @@ def delete(
 
     def prepare_delete_request(
         self,
-        resource_type: type,
+        resource_model: type,
         id: str,
         check_response_payload: bool = True,
         expected_status_codes: Optional[list[int]] = DELETION_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = True,
         **kwargs,
     ) -> tuple[str, dict]:
-        self.check_resource_type(resource_type)
-        delete_url = self.resource_endpoint(resource_type) + f"/{id}"
+        self.check_resource_model(resource_model)
+        delete_url = self.resource_endpoint(resource_model) + f"/{id}"
         url = kwargs.pop("url", delete_url)
         return url, kwargs
 
@@ -630,25 +632,25 @@ def prepare_replace_request(
 
         else:
             if isinstance(resource, Resource):
-                resource_type = resource.__class__
+                resource_model = resource.__class__
 
             else:
-                resource_type = Resource.get_by_payload(self.resource_types, resource)
-                if not resource_type:
+                resource_model = Resource.get_by_payload(self.resource_models, resource)
+                if not resource_model:
                     raise SCIMRequestError(
                         "Cannot guess resource type from the payload",
                         source=resource,
                     )
 
                 try:
-                    resource = resource_type.model_validate(resource)
+                    resource = resource_model.model_validate(resource)
                 except ValidationError as exc:
                     scim_validation_exc = RequestPayloadValidationError(source=resource)
                     if sys.version_info >= (3, 11):  # pragma: no cover
                         scim_validation_exc.add_note(str(exc))
                     raise scim_validation_exc from exc
 
-            self.check_resource_type(resource_type, resource)
+            self.check_resource_model(resource_model, resource)
 
             if not resource.id:
                 raise SCIMRequestError("Resource must have an id", source=resource)

scim2_client/engines/httpx.py

@@ -52,9 +52,9 @@ class SyncSCIMClient(BaseSCIMClient):
     """
 
     def __init__(
-        self, client: Client, resource_types: Optional[tuple[type[Resource]]] = None
+        self, client: Client, resource_models: Optional[tuple[type[Resource]]] = None
     ):
-        super().__init__(resource_types=resource_types)
+        super().__init__(resource_models=resource_models)
         self.client = client
 
     def create(
@@ -94,7 +94,7 @@ def create(
 
     def query(
         self,
-        resource_type: Optional[type[Resource]] = None,
+        resource_model: Optional[type[Resource]] = None,
         id: Optional[str] = None,
         search_request: Optional[Union[SearchRequest, dict]] = None,
         check_request_payload: bool = True,
@@ -106,7 +106,7 @@ def query(
         **kwargs,
     ):
         url, payload, expected_types, request_kwargs = self.prepare_query_request(
-            resource_type=resource_type,
+            resource_model=resource_model,
             id=id,
             search_request=search_request,
             check_request_payload=check_request_payload,
@@ -168,7 +168,7 @@ def search(
 
     def delete(
         self,
-        resource_type: type,
+        resource_model: type,
         id: str,
         check_response_payload: bool = True,
         expected_status_codes: Optional[
@@ -178,7 +178,7 @@ def delete(
         **kwargs,
     ) -> Optional[Union[Error, dict]]:
         url, request_kwargs = self.prepare_delete_request(
-            resource_type=resource_type,
+            resource_model=resource_model,
             id=id,
             check_response_payload=check_response_payload,
             expected_status_codes=expected_status_codes,

scim2_client/engines/werkzeug.py

@@ -34,14 +34,14 @@ class TestSCIMClient(BaseSCIMClient):
 
     :param client: A WSGI application instance that will be used to send requests.
     :param scim_prefix: The scim root endpoint in the application.
-    :param resource_types: The client resource types.
+    :param resource_models: The client resource types.
 
     .. code-block:: python
 
         from scim2_client.engines.werkzeug import TestSCIMClient
         from scim2_models import User, Group
 
-        testclient = TestSCIMClient(app=scim_provider, resource_types=(User, Group))
+        testclient = TestSCIMClient(app=scim_provider, resource_models=(User, Group))
 
         request_user = User(user_name="foo", display_name="bar")
         response_user = scim_client.create(request_user)
@@ -52,9 +52,9 @@ def __init__(
         self,
         app,
         scim_prefix: str = "",
-        resource_types: Optional[tuple[type[Resource]]] = None,
+        resource_models: Optional[tuple[type[Resource]]] = None,
     ):
-        super().__init__(resource_types=resource_types)
+        super().__init__(resource_models=resource_models)
         self.client = Client(app)
         self.scim_prefix = scim_prefix
 
@@ -102,7 +102,7 @@ def create(
 
     def query(
         self,
-        resource_type: Optional[type[Resource]] = None,
+        resource_model: Optional[type[Resource]] = None,
         id: Optional[str] = None,
         search_request: Optional[Union[SearchRequest, dict]] = None,
         check_request_payload: bool = True,
@@ -114,7 +114,7 @@ def query(
         **kwargs,
     ):
         url, payload, expected_types, request_kwargs = self.prepare_query_request(
-            resource_type=resource_type,
+            resource_model=resource_model,
             id=id,
             search_request=search_request,
             check_request_payload=check_request_payload,
@@ -177,7 +177,7 @@ def search(
 
     def delete(
         self,
-        resource_type: type,
+        resource_model: type,
         id: str,
         check_response_payload: bool = True,
         expected_status_codes: Optional[
@@ -187,7 +187,7 @@ def delete(
         **kwargs,
     ) -> Optional[Union[Error, dict]]:
         url, request_kwargs = self.prepare_delete_request(
-            resource_type=resource_type,
+            resource_model=resource_model,
             id=id,
             check_response_payload=check_response_payload,
             expected_status_codes=expected_status_codes,

tests/engines/test_werkzeug.py

@@ -31,7 +31,7 @@ def scim_provider():
 
 @pytest.fixture
 def scim_client(scim_provider):
-    return TestSCIMClient(app=scim_provider, resource_types=(User,))
+    return TestSCIMClient(app=scim_provider, resource_models=(User,))
 
 
 def test_werkzeug_engine(scim_client):