feat: raise_scim_errors is True by default

Author: azmeuk

doc/changelog.rst

@@ -8,6 +8,10 @@ Added
 ^^^^^
 - Replace :code:`check_status_code` parameter by :code:`expected_status_codes`.
 
+Changed
+^^^^^^^
+- :code:`raise_scim_errors` is :data:`True` by default.
+
 [0.1.11] - 2024-08-31
 ---------------------
 

doc/tutorial.rst

@@ -63,15 +63,15 @@ However sometimes you want to accept invalid inputs and outputs.
 To achieve this, all the methods provide the following parameters, all are :data:`True` by default:
 
 - :code:`check_request_payload`:
-  If :data:`True` a :class:`~pydantic.ValidationError` will be raised if the input does not respect the SCIM standard.
+  If :data:`True` (the default) a :class:`~pydantic.ValidationError` will be raised if the input does not respect the SCIM standard.
   If :data:`False`, input is expected to be a :data:`dict` that will be passed as-is in the request.
 - :code:`check_response_payload`:
-  If :data:`True` a :class:`~pydantic.ValidationError` will be raised if the server response does not respect the SCIM standard.
+  If :data:`True` (the default) a :class:`~pydantic.ValidationError` will be raised if the server response does not respect the SCIM standard.
   If :data:`False` the server response is returned as-is.
 - :code:`expected_status_codes`: The list of expected status codes in the response.
   If :data:`None` any status code is accepted.
   If an unexpected status code is returned, a :class:`~scim2_client.errors.UnexpectedStatusCode` exception is raised.
-- :code:`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.
+- :code:`raise_scim_errors`: If :data:`True` (the default) 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.
 
 

scim2_client/client.py

@@ -163,7 +163,7 @@ def check_response(
         expected_status_codes: List[int],
         expected_types: Optional[Type] = None,
         check_response_payload: bool = True,
-        raise_scim_errors: bool = False,
+        raise_scim_errors: bool = True,
         scim_ctx: Optional[Context] = None,
     ):
         if expected_status_codes and response.status_code not in expected_status_codes:
@@ -241,7 +241,7 @@ def create(
         check_request_payload: bool = True,
         check_response_payload: bool = True,
         expected_status_codes: Optional[List[int]] = CREATION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = False,
+        raise_scim_errors: bool = True,
         **kwargs,
     ) -> Union[AnyResource, Error, Dict]:
         """Perform a POST request to create, as defined in :rfc:`RFC7644 §3.3
@@ -334,7 +334,7 @@ def query(
         check_request_payload: bool = True,
         check_response_payload: bool = True,
         expected_status_codes: Optional[List[int]] = QUERY_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = False,
+        raise_scim_errors: bool = True,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, Dict]:
         """Perform a GET request to read resources, as defined in :rfc:`RFC7644
@@ -460,7 +460,7 @@ def search(
         check_request_payload: bool = True,
         check_response_payload: bool = True,
         expected_status_codes: Optional[List[int]] = SEARCH_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = False,
+        raise_scim_errors: bool = True,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, Dict]:
         """Perform a POST search request to read all available resources, as
@@ -540,7 +540,7 @@ def delete(
         id: str,
         check_response_payload: bool = True,
         expected_status_codes: Optional[List[int]] = DELETION_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = False,
+        raise_scim_errors: bool = True,
         **kwargs,
     ) -> Optional[Union[Error, Dict]]:
         """Perform a DELETE request to create, as defined in :rfc:`RFC7644 §3.6
@@ -597,7 +597,7 @@ def replace(
         check_request_payload: bool = True,
         check_response_payload: bool = True,
         expected_status_codes: Optional[List[int]] = REPLACEMENT_RESPONSE_STATUS_CODES,
-        raise_scim_errors: bool = False,
+        raise_scim_errors: bool = True,
         **kwargs,
     ) -> Union[AnyResource, Error, Dict]:
         """Perform a PUT request to replace a resource, as defined in

tests/test_create.py

@@ -211,7 +211,7 @@ def test_conflict(httpserver):
 
     client = Client(base_url=f"http://localhost:{httpserver.port}")
     scim_client = SCIMClient(client, resource_types=(User,))
-    response = scim_client.create(user_request)
+    response = scim_client.create(user_request, raise_scim_errors=False)
     assert response == Error(
         schemas=["urn:ietf:params:scim:api:messages:2.0:Error"],
         status=409,
@@ -264,7 +264,7 @@ def test_errors(httpserver, code):
 
     client = Client(base_url=f"http://localhost:{httpserver.port}")
     scim_client = SCIMClient(client, resource_types=(User,))
-    response = scim_client.create(user_request)
+    response = scim_client.create(user_request, raise_scim_errors=False)
 
     assert response == Error(
         schemas=["urn:ietf:params:scim:api:messages:2.0:Error"],

tests/test_delete.py

@@ -37,7 +37,9 @@ def test_errors(httpserver, code):
 
     client = Client(base_url=f"http://localhost:{httpserver.port}")
     scim_client = SCIMClient(client, resource_types=(User,))
-    response = scim_client.delete(User, "2819c223-7f76-453a-919d-413861904646")
+    response = scim_client.delete(
+        User, "2819c223-7f76-453a-919d-413861904646", raise_scim_errors=False
+    )
 
     assert response == Error(
         schemas=["urn:ietf:params:scim:api:messages:2.0:Error"],

tests/test_query.py

@@ -292,7 +292,9 @@ def test_user_with_valid_id(client):
             Group,
         ),
     )
-    response = scim_client.query(User, "2819c223-7f76-453a-919d-413861904646")
+    response = scim_client.query(
+        User, "2819c223-7f76-453a-919d-413861904646", raise_scim_errors=False
+    )
     assert response == User(
         id="2819c223-7f76-453a-919d-413861904646",
         user_name="[email protected]",
@@ -320,7 +322,7 @@ def test_user_with_invalid_id(client):
             Group,
         ),
     )
-    response = scim_client.query(User, "unknown")
+    response = scim_client.query(User, "unknown", raise_scim_errors=False)
     assert response == Error(detail="Resource unknown not found", status=404)
 
 
@@ -434,7 +436,7 @@ def test_bad_request(client):
             Group,
         ),
     )
-    response = scim_client.query(User, "bad-request")
+    response = scim_client.query(User, "bad-request", raise_scim_errors=False)
     assert response == Error(status=400, detail="Bad request")
 
 
@@ -446,7 +448,7 @@ class Foobar(Resource):
         pass
 
     scim_client = SCIMClient(client, resource_types=(Foobar,))
-    response = scim_client.query(Foobar)
+    response = scim_client.query(Foobar, raise_scim_errors=False)
     assert response == Error(status=404, detail="Invalid Resource")
 
 

tests/test_replace.py

@@ -246,7 +246,7 @@ def test_errors(httpserver, code):
 
     client = Client(base_url=f"http://localhost:{httpserver.port}")
     scim_client = SCIMClient(client, resource_types=(User,))
-    response = scim_client.replace(user_request)
+    response = scim_client.replace(user_request, raise_scim_errors=False)
 
     assert response == Error(
         schemas=["urn:ietf:params:scim:api:messages:2.0:Error"],

tests/test_search.py

@@ -238,7 +238,7 @@ def test_errors(httpserver, code):
             Group,
         ),
     )
-    response = scim_client.search()
+    response = scim_client.search(raise_scim_errors=False)
 
     assert response == Error(
         schemas=["urn:ietf:params:scim:api:messages:2.0:Error"],