scim2-client 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

scim2_client/client.py

@@ -48,6 +48,14 @@ class BaseSCIMClient:
 
     :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.
+    :param check_request_payload: If :data:`False`,
+        :code:`resource` is expected to be a dict that will be passed as-is in the request.
+        This value can be overwritten in methods.
+    :param check_response_payload: Whether to validate that the response payloads are valid.
+        If set, the raw payload will be returned. This value can be overwritten in methods.
+    :param raise_scim_errors: If :data:`True` and the server returned an
+        :class:`~scim2_models.Error` object during a request, a :class:`~scim2_client.SCIMResponseErrorObject`
+        exception will be raised. If :data:`False` the error object is returned. This value can be overwritten in methods.
 
     .. note::
 
@@ -134,10 +142,19 @@ class BaseSCIMClient:
     :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
     """
 
-    def __init__(self, resource_models: Optional[tuple[type[Resource]]] = None):
+    def __init__(
+        self,
+        resource_models: Optional[tuple[type[Resource]]] = None,
+        check_request_payload: bool = True,
+        check_response_payload: bool = True,
+        raise_scim_errors: bool = True,
+    ):
         self.resource_models = tuple(
             set(resource_models or []) | {ResourceType, Schema, ServiceProviderConfig}
         )
+        self.check_request_payload = True
+        self.check_response_payload = True
+        self.raise_scim_errors = True
 
     def check_resource_model(
         self, resource_model: type[Resource], payload=None
@@ -169,12 +186,15 @@ class BaseSCIMClient:
         headers: dict,
         expected_status_codes: Optional[list[int]] = None,
         expected_types: Optional[list[type[Resource]]] = None,
-        check_response_payload: bool = True,
-        raise_scim_errors: bool = True,
+        check_response_payload: Optional[bool] = None,
+        raise_scim_errors: Optional[bool] = None,
         scim_ctx: Optional[Context] = None,
     ) -> Union[Error, None, dict, type[Resource]]:
+        if raise_scim_errors is None:
+            raise_scim_errors = self.raise_scim_errors
+
         if expected_status_codes and status_code not in expected_status_codes:
-            raise UnexpectedStatusCode()
+            raise UnexpectedStatusCode(status_code)
 
         # Interoperability considerations:  The "application/scim+json" media
         # type is intended to identify JSON structure data that conforms to
@@ -198,6 +218,9 @@ class BaseSCIMClient:
         else:
             response_payload = payload
 
+        if check_response_payload is None:
+            check_response_payload = self.check_response_payload
+
         if not check_response_payload:
             return response_payload
 
@@ -207,7 +230,7 @@ class BaseSCIMClient:
         ):
             error = Error.model_validate(response_payload)
             if raise_scim_errors:
-                raise SCIMResponseErrorObject(source=error)
+                raise SCIMResponseErrorObject(obj=error.detail, source=error)
             return error
 
         if not expected_types:
@@ -240,15 +263,17 @@ class BaseSCIMClient:
     def prepare_create_request(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
         expected_status_codes: Optional[list[int]] = None,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> RequestPayload:
         req = RequestPayload(
             expected_status_codes=expected_status_codes,
             request_kwargs=kwargs,
         )
+        if check_request_payload is None:
+            check_request_payload = self.check_request_payload
 
         if not check_request_payload:
             req.payload = resource
@@ -289,9 +314,9 @@ class BaseSCIMClient:
         resource_model: Optional[type[Resource]] = None,
         id: Optional[str] = None,
         search_request: Optional[Union[SearchRequest, dict]] = None,
-        check_request_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
         expected_status_codes: Optional[list[int]] = None,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> RequestPayload:
         req = RequestPayload(
@@ -299,6 +324,9 @@ class BaseSCIMClient:
             request_kwargs=kwargs,
         )
 
+        if check_request_payload is None:
+            check_request_payload = self.check_request_payload
+
         if resource_model and check_request_payload:
             self.check_resource_model(resource_model)
 
@@ -341,9 +369,9 @@ class BaseSCIMClient:
     def prepare_search_request(
         self,
         search_request: Optional[SearchRequest] = None,
-        check_request_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
         expected_status_codes: Optional[list[int]] = None,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> RequestPayload:
         req = RequestPayload(
@@ -351,6 +379,9 @@ class BaseSCIMClient:
             request_kwargs=kwargs,
         )
 
+        if check_request_payload is None:
+            check_request_payload = self.check_request_payload
+
         if not check_request_payload:
             req.payload = search_request
 
@@ -372,7 +403,7 @@ class BaseSCIMClient:
         resource_model: type,
         id: str,
         expected_status_codes: Optional[list[int]] = None,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> RequestPayload:
         req = RequestPayload(
@@ -388,9 +419,9 @@ class BaseSCIMClient:
     def prepare_replace_request(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
         expected_status_codes: Optional[list[int]] = None,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> RequestPayload:
         req = RequestPayload(
@@ -398,6 +429,9 @@ class BaseSCIMClient:
             request_kwargs=kwargs,
         )
 
+        if check_request_payload is None:
+            check_request_payload = self.check_request_payload
+
         if not check_request_payload:
             req.payload = resource
             req.url = kwargs.pop("url", None)
@@ -449,27 +483,23 @@ class BaseSyncSCIMClient(BaseSCIMClient):
     def create(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSCIMClient.CREATION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
         """Perform a POST request to create, as defined in :rfc:`RFC7644 §3.3 <7644#section-3.3>`.
 
         :param resource: The resource to create
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If :data:`False`,
-            :code:`resource` is expected to be a dict that will be passed as-is in the request.
-        :param check_response_payload: Whether to validate that the response payload is valid.
-            If set, the raw payload will be returned.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If :data:`True` and the server returned an
-            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
-            exception will be raised. If :data:`False` the error object is returned.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request
             library.
 
@@ -501,12 +531,12 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         resource_model: Optional[type[Resource]] = None,
         id: Optional[str] = None,
         search_request: Optional[Union[SearchRequest, dict]] = None,
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSCIMClient.QUERY_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
         """Perform a GET request to read resources, as defined in :rfc:`RFC7644 §3.4.2 <7644#section-3.4.2>`.
@@ -517,15 +547,11 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         :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`,
-            :code:`search_request` is expected to be a dict that will be passed as-is in the request.
-        :param check_response_payload: Whether to validate that the response payload is valid.
-            If set, the raw payload will be returned.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If :data:`True` and the server returned an
-            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
-            exception will be raised. If :data:`False` the error object is returned.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request library.
 
         :return:
@@ -577,12 +603,12 @@ class BaseSyncSCIMClient(BaseSCIMClient):
     def search(
         self,
         search_request: Optional[SearchRequest] = None,
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSCIMClient.SEARCH_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> 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>`.
@@ -590,15 +616,11 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         :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`,
-            :code:`search_request` is expected to be a dict that will be passed as-is in the request.
-        :param check_response_payload: Whether to validate that the response payload is valid.
-            If set, the raw payload will be returned.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If :data:`True` and the server returned an
-            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
-            exception will be raised. If :data:`False` the error object is returned.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -630,24 +652,21 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         self,
         resource_model: type,
         id: str,
-        check_response_payload: bool = True,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSCIMClient.DELETION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Optional[Union[Error, dict]]:
         """Perform a DELETE request to create, as defined in :rfc:`RFC7644 §3.6 <7644#section-3.6>`.
 
         :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.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If :data:`True` and the server returned an
-            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
-            exception will be raised. If :data:`False` the error object is returned.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -670,27 +689,23 @@ class BaseSyncSCIMClient(BaseSCIMClient):
     def replace(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSCIMClient.REPLACEMENT_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
         """Perform a PUT request to replace a resource, as defined in :rfc:`RFC7644 §3.5.1 <7644#section-3.5.1>`.
 
         :param resource: The new resource to replace.
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If :data:`False`,
-            :code:`resource` is expected to be a dict that will be passed as-is in the request.
-        :param check_response_payload: Whether to validate that the response payload is valid.
-            If set, the raw payload will be returned.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If :data:`True` and the server returned an
-            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
-            exception will be raised. If :data:`False` the error object is returned.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -725,27 +740,23 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
     async def create(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSCIMClient.CREATION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
         """Perform a POST request to create, as defined in :rfc:`RFC7644 §3.3 <7644#section-3.3>`.
 
         :param resource: The resource to create
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If :data:`False`,
-            :code:`resource` is expected to be a dict that will be passed as-is in the request.
-        :param check_response_payload: Whether to validate that the response payload is valid.
-            If set, the raw payload will be returned.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If :data:`True` and the server returned an
-            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
-            exception will be raised. If :data:`False` the error object is returned.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request
             library.
 
@@ -777,12 +788,12 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         resource_model: Optional[type[Resource]] = None,
         id: Optional[str] = None,
         search_request: Optional[Union[SearchRequest, dict]] = None,
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSCIMClient.QUERY_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
         """Perform a GET request to read resources, as defined in :rfc:`RFC7644 §3.4.2 <7644#section-3.4.2>`.
@@ -793,15 +804,11 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         :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`,
-            :code:`search_request` is expected to be a dict that will be passed as-is in the request.
-        :param check_response_payload: Whether to validate that the response payload is valid.
-            If set, the raw payload will be returned.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If :data:`True` and the server returned an
-            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
-            exception will be raised. If :data:`False` the error object is returned.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request library.
 
         :return:
@@ -853,12 +860,12 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
     async def search(
         self,
         search_request: Optional[SearchRequest] = None,
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSCIMClient.SEARCH_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> 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>`.
@@ -866,15 +873,11 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         :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`,
-            :code:`search_request` is expected to be a dict that will be passed as-is in the request.
-        :param check_response_payload: Whether to validate that the response payload is valid.
-            If set, the raw payload will be returned.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If :data:`True` and the server returned an
-            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
-            exception will be raised. If :data:`False` the error object is returned.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -906,24 +909,21 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         self,
         resource_model: type,
         id: str,
-        check_response_payload: bool = True,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSCIMClient.DELETION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Optional[Union[Error, dict]]:
         """Perform a DELETE request to create, as defined in :rfc:`RFC7644 §3.6 <7644#section-3.6>`.
 
         :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.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If :data:`True` and the server returned an
-            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
-            exception will be raised. If :data:`False` the error object is returned.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -946,27 +946,23 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
     async def replace(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSCIMClient.REPLACEMENT_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
         """Perform a PUT request to replace a resource, as defined in :rfc:`RFC7644 §3.5.1 <7644#section-3.5.1>`.
 
         :param resource: The new resource to replace.
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If :data:`False`,
-            :code:`resource` is expected to be a dict that will be passed as-is in the request.
-        :param check_response_payload: Whether to validate that the response payload is valid.
-            If set, the raw payload will be returned.
+        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If :data:`True` and the server returned an
-            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
-            exception will be raised. If :data:`False` the error object is returned.
+        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 

scim2_client/engines/httpx.py

@@ -52,23 +52,29 @@ class SyncSCIMClient(BaseSyncSCIMClient):
     :param client: A :class:`httpx.Client` instance that will be used to send requests.
     :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.
+    :param check_request_payload: If :data:`False`,
+        :code:`resource` is expected to be a dict that will be passed as-is in the request.
+        This value can be overwritten in methods.
+    :param check_response_payload: Whether to validate that the response payloads are valid.
+        If set, the raw payload will be returned. This value can be overwritten in methods.
+    :param raise_scim_errors: If :data:`True` and the server returned an
+        :class:`~scim2_models.Error` object during a request, a :class:`~scim2_client.SCIMResponseErrorObject`
+        exception will be raised. If :data:`False` the error object is returned. This value can be overwritten in methods.
     """
 
-    def __init__(
-        self, client: Client, resource_models: Optional[tuple[type[Resource]]] = None
-    ):
-        super().__init__(resource_models=resource_models)
+    def __init__(self, client: Client, *args, **kwargs):
+        super().__init__(*args, **kwargs)
         self.client = client
 
     def create(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSyncSCIMClient.CREATION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
         req = self.prepare_create_request(
@@ -99,12 +105,12 @@ class SyncSCIMClient(BaseSyncSCIMClient):
         resource_model: Optional[type[Resource]] = None,
         id: Optional[str] = None,
         search_request: Optional[Union[SearchRequest, dict]] = None,
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSyncSCIMClient.QUERY_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ):
         req = self.prepare_query_request(
@@ -137,12 +143,12 @@ class SyncSCIMClient(BaseSyncSCIMClient):
     def search(
         self,
         search_request: Optional[SearchRequest] = None,
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSyncSCIMClient.SEARCH_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
         req = self.prepare_search_request(
@@ -172,11 +178,11 @@ class SyncSCIMClient(BaseSyncSCIMClient):
         self,
         resource_model: type,
         id: str,
-        check_response_payload: bool = True,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSyncSCIMClient.DELETION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Optional[Union[Error, dict]]:
         req = self.prepare_delete_request(
@@ -203,12 +209,12 @@ class SyncSCIMClient(BaseSyncSCIMClient):
     def replace(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSyncSCIMClient.REPLACEMENT_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
         req = self.prepare_replace_request(
@@ -241,23 +247,30 @@ class AsyncSCIMClient(BaseAsyncSCIMClient):
     :param client: A :class:`httpx.AsyncClient` instance that will be used to send requests.
     :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.
+    :param check_request_payload: If :data:`False`,
+        :code:`resource` is expected to be a dict that will be passed as-is in the request.
+        This value can be overwritten in methods.
+    :param check_response_payload: Whether to validate that the response payloads are valid.
+        If set, the raw payload will be returned. This value can be overwritten in methods.
+    :param raise_scim_errors: If :data:`True` and the server returned an
+        :class:`~scim2_models.Error` object during a request, a :class:`~scim2_client.SCIMResponseErrorObject`
+        exception will be raised. If :data:`False` the error object is returned. This value can be overwritten in methods.
+
     """
 
-    def __init__(
-        self, client: Client, resource_models: Optional[tuple[type[Resource]]] = None
-    ):
-        super().__init__(resource_models=resource_models)
+    def __init__(self, client: Client, *args, **kwargs):
+        super().__init__(*args, **kwargs)
         self.client = client
 
     async def create(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseAsyncSCIMClient.CREATION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
         req = self.prepare_create_request(
@@ -290,12 +303,12 @@ class AsyncSCIMClient(BaseAsyncSCIMClient):
         resource_model: Optional[type[Resource]] = None,
         id: Optional[str] = None,
         search_request: Optional[Union[SearchRequest, dict]] = None,
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseAsyncSCIMClient.QUERY_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ):
         req = self.prepare_query_request(
@@ -328,12 +341,12 @@ class AsyncSCIMClient(BaseAsyncSCIMClient):
     async def search(
         self,
         search_request: Optional[SearchRequest] = None,
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseAsyncSCIMClient.SEARCH_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
         req = self.prepare_search_request(
@@ -365,11 +378,11 @@ class AsyncSCIMClient(BaseAsyncSCIMClient):
         self,
         resource_model: type,
         id: str,
-        check_response_payload: bool = True,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseAsyncSCIMClient.DELETION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Optional[Union[Error, dict]]:
         req = self.prepare_delete_request(
@@ -396,12 +409,12 @@ class AsyncSCIMClient(BaseAsyncSCIMClient):
     async def replace(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseAsyncSCIMClient.REPLACEMENT_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
         req = self.prepare_replace_request(

scim2_client/engines/werkzeug.py

@@ -36,6 +36,14 @@ class TestSCIMClient(BaseSyncSCIMClient):
     :param scim_prefix: The scim root endpoint in the application.
     :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.
+    :param check_request_payload: If :data:`False`,
+        :code:`resource` is expected to be a dict that will be passed as-is in the request.
+        This value can be overwritten in methods.
+    :param check_response_payload: Whether to validate that the response payloads are valid.
+        If set, the raw payload will be returned. This value can be overwritten in methods.
+    :param raise_scim_errors: If :data:`True` and the server returned an
+        :class:`~scim2_models.Error` object during a request, a :class:`~scim2_client.SCIMResponseErrorObject`
+        exception will be raised. If :data:`False` the error object is returned. This value can be overwritten in methods.
 
     .. code-block:: python
 
@@ -50,13 +58,8 @@ class TestSCIMClient(BaseSyncSCIMClient):
         assert response_user.user_name == "foo"
     """
 
-    def __init__(
-        self,
-        app,
-        scim_prefix: str = "",
-        resource_models: Optional[tuple[type[Resource]]] = None,
-    ):
-        super().__init__(resource_models=resource_models)
+    def __init__(self, app, *args, scim_prefix: str = "", **kwargs):
+        super().__init__(*args, **kwargs)
         self.client = Client(app)
         self.scim_prefix = scim_prefix
 
@@ -71,12 +74,12 @@ class TestSCIMClient(BaseSyncSCIMClient):
     def create(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSyncSCIMClient.CREATION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
         req = self.prepare_create_request(
@@ -108,12 +111,12 @@ class TestSCIMClient(BaseSyncSCIMClient):
         resource_model: Optional[type[Resource]] = None,
         id: Optional[str] = None,
         search_request: Optional[Union[SearchRequest, dict]] = None,
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSyncSCIMClient.QUERY_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ):
         req = self.prepare_query_request(
@@ -146,12 +149,12 @@ class TestSCIMClient(BaseSyncSCIMClient):
     def search(
         self,
         search_request: Optional[SearchRequest] = None,
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSyncSCIMClient.SEARCH_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
         req = self.prepare_search_request(
@@ -182,11 +185,11 @@ class TestSCIMClient(BaseSyncSCIMClient):
         self,
         resource_model: type,
         id: str,
-        check_response_payload: bool = True,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSyncSCIMClient.DELETION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Optional[Union[Error, dict]]:
         req = self.prepare_delete_request(
@@ -212,12 +215,12 @@ class TestSCIMClient(BaseSyncSCIMClient):
     def replace(
         self,
         resource: Union[AnyResource, dict],
-        check_request_payload: bool = True,
-        check_response_payload: bool = True,
+        check_request_payload: Optional[bool] = None,
+        check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
         ] = BaseSyncSCIMClient.REPLACEMENT_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = True,
+        raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
         req = self.prepare_replace_request(

scim2_client/errors.py

@@ -69,12 +69,9 @@ class SCIMResponseErrorObject(SCIMResponseError):
     Those errors are only raised when the :code:`raise_scim_errors` parameter is :data:`True`.
     """
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, obj, *args, **kwargs):
         message = kwargs.pop(
-            "message",
-            f"The server returned a SCIM Error object: {kwargs['source'].detail}"
-            if kwargs.get("source")
-            else "The server returned a SCIM Error object",
+            "message", f"The server returned a SCIM Error object: {obj}"
         )
         super().__init__(message, *args, **kwargs)
 
@@ -82,12 +79,9 @@ class SCIMResponseErrorObject(SCIMResponseError):
 class UnexpectedStatusCode(SCIMResponseError):
     """Error raised when a server returned an unexpected status code for a given :class:`~scim2_models.Context`."""
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, status_code: int, *args, **kwargs):
         message = kwargs.pop(
-            "message",
-            f"Unexpected response status code: {kwargs['source'].status_code}"
-            if kwargs.get("source")
-            else "Unexpected response status code",
+            "message", f"Unexpected response status code: {status_code}"
         )
         super().__init__(message, *args, **kwargs)
 

{scim2_client-0.3.0.dist-info → scim2_client-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-client
-Version: 0.3.0
+Version: 0.3.2
 Summary: Pythonically build SCIM requests and parse SCIM responses
 Project-URL: documentation, https://scim2-client.readthedocs.io
 Project-URL: repository, https://github.com/python-scim/scim2-client

scim2_client-0.3.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+scim2_client/__init__.py,sha256=KpNDJW9e2WseqSsQ6FltkQzemHM52NACfpJTd3eSIuY,853
+scim2_client/client.py,sha256=C45mWwWlesXv7zdANmDf9psz3JczV02cI7Pc6becg3M,39742
+scim2_client/errors.py,sha256=mxjUvarjvX3797w2NzdLqc6zxCQZlOga8cYABWpUAXM,4401
+scim2_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scim2_client/engines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scim2_client/engines/httpx.py,sha256=L39ZZHjqe43uIQpgh_r_maqM2gkf3_Rk6d8MeNe57gk,17781
+scim2_client/engines/werkzeug.py,sha256=s7BV8CEbLewnkF0EAsF-3J3khOhaT7CkEN9v230ZA8w,9838
+scim2_client-0.3.2.dist-info/METADATA,sha256=Zu2tIFT443yoDOKu2AjAtBSWxRB1x9WXqpf1GM0Af0w,16997
+scim2_client-0.3.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+scim2_client-0.3.2.dist-info/licenses/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+scim2_client-0.3.2.dist-info/RECORD,,

scim2_client-0.3.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-scim2_client/__init__.py,sha256=KpNDJW9e2WseqSsQ6FltkQzemHM52NACfpJTd3eSIuY,853
-scim2_client/client.py,sha256=CPXPqnmYNcXgn5ViPFpapI-oEg0oX8kXnwdWWmjm4eI,40130
-scim2_client/errors.py,sha256=VDomHej2WH07up6a2wr7q0BVdj6RG4MyrM2t9UHx0Iw,4623
-scim2_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scim2_client/engines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scim2_client/engines/httpx.py,sha256=uqONJhFUdFf8W-GndL-mB_Z33FRuwgXAb2PczTB7wLg,16268
-scim2_client/engines/werkzeug.py,sha256=9KcViIJVzSda6cpeiM-_dFjp5HFDBFkfiGRaUx4utrk,9107
-scim2_client-0.3.0.dist-info/METADATA,sha256=1aFhLfcE_1TXEI7iMjJUc8G99dmaViqJoN01BM8-_Rk,16997
-scim2_client-0.3.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-scim2_client-0.3.0.dist-info/licenses/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-scim2_client-0.3.0.dist-info/RECORD,,